blob: a8f36745c8bd678f55b4bf89edcfc9016b53bf6a [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
TRodziewicz18cddc02021-07-13 12:19:15 +02001003 /*
1004 * As the return error code may not be handled in case of multiple errors,
1005 * do our best to report an unexpected lock counter: if available call
1006 * MBEDTLS_TEST_HOOK_TEST_ASSERT that may terminate execution (if called as
1007 * part of the execution of a test suite this will stop the test suite
1008 * execution).
1009 */
Ronald Cron5c522922020-11-14 16:35:34 +01001010 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001011 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001012 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001013 status = PSA_ERROR_CORRUPTION_DETECTED;
1014 }
1015
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001016 /* Multipart operations may still be using the key. This is safe
1017 * because all multipart operation objects are independent from
1018 * the key slot: if they need to access the key after the setup
1019 * phase, they have a copy of the key. Note that this means that
1020 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001021 /* At this point, key material and other type-specific content has
1022 * been wiped. Clear remaining metadata. We can call memset and not
1023 * zeroize because the metadata is not particularly sensitive. */
1024 memset( slot, 0, sizeof( *slot ) );
1025 return( status );
1026}
1027
Ronald Croncf56a0a2020-08-04 09:51:30 +02001028psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001029{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001030 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001031 psa_status_t status; /* status of the last operation */
1032 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001033#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1034 psa_se_drv_table_entry_t *driver;
1035#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001036
Ronald Croncf56a0a2020-08-04 09:51:30 +02001037 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001038 return( PSA_SUCCESS );
1039
Ronald Cronf2911112020-10-29 17:51:10 +01001040 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001041 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001042 * key, this will load the key description from persistent memory if not
1043 * done yet. We cannot avoid this loading as without it we don't know if
1044 * the key is operated by an SE or not and this information is needed by
1045 * the current implementation.
1046 */
Ronald Cron5c522922020-11-14 16:35:34 +01001047 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001048 if( status != PSA_SUCCESS )
1049 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001050
Ronald Cronf2911112020-10-29 17:51:10 +01001051 /*
1052 * If the key slot containing the key description is under access by the
1053 * library (apart from the present access), the key cannot be destroyed
1054 * yet. For the time being, just return in error. Eventually (to be
1055 * implemented), the key should be destroyed when all accesses have
1056 * stopped.
1057 */
Ronald Cron5c522922020-11-14 16:35:34 +01001058 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001059 {
Ronald Cron5c522922020-11-14 16:35:34 +01001060 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001061 return( PSA_ERROR_GENERIC_ERROR );
1062 }
1063
Gilles Peskine6687cd02021-04-21 22:32:05 +02001064 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1065 {
1066 /* Refuse the destruction of a read-only key (which may or may not work
1067 * if we attempt it, depending on whether the key is merely read-only
1068 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001069 * Just do the best we can, which is to wipe the copy in memory
1070 * (done in this function's cleanup code). */
1071 overall_status = PSA_ERROR_NOT_PERMITTED;
1072 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001073 }
1074
Gilles Peskine354f7672019-07-12 23:46:38 +02001075#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001077 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001078 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001079 /* For a key in a secure element, we need to do three things:
1080 * remove the key file in internal storage, destroy the
1081 * key inside the secure element, and update the driver's
1082 * persistent data. Start a transaction that will encompass these
1083 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001085 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001086 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001087 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 status = psa_crypto_save_transaction( );
1089 if( status != PSA_SUCCESS )
1090 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001091 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 /* We should still try to destroy the key in the secure
1093 * element and the key metadata in storage. This is especially
1094 * important if the error is that the storage is full.
1095 * But how to do it exactly without risking an inconsistent
1096 * state after a reset?
1097 * https://github.com/ARMmbed/mbed-crypto/issues/215
1098 */
1099 overall_status = status;
1100 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001101 }
1102
Ronald Cronea0f8a62020-11-25 17:52:23 +01001103 status = psa_destroy_se_key( driver,
1104 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001105 if( overall_status == PSA_SUCCESS )
1106 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001107 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001108#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1109
Darryl Greend49a4992018-06-18 17:27:26 +01001110#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001111 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001112 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001113 status = psa_destroy_persistent_key( slot->attr.id );
1114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
1116
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001117 /* TODO: other slots may have a copy of the same key. We should
1118 * invalidate them.
1119 * https://github.com/ARMmbed/mbed-crypto/issues/214
1120 */
Darryl Greend49a4992018-06-18 17:27:26 +01001121 }
1122#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001123
Gilles Peskinefc762652019-07-22 19:30:34 +02001124#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1125 if( driver != NULL )
1126 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001127 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128 if( overall_status == PSA_SUCCESS )
1129 overall_status = status;
1130 status = psa_crypto_stop_transaction( );
1131 if( overall_status == PSA_SUCCESS )
1132 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001133 }
1134#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1135
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001137 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001138 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001139 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 overall_status = status;
1141 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001142}
1143
John Durkop07cc04a2020-11-16 22:08:34 -08001144#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001145 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001146static psa_status_t psa_get_rsa_public_exponent(
1147 const mbedtls_rsa_context *rsa,
1148 psa_key_attributes_t *attributes )
1149{
1150 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001152 uint8_t *buffer = NULL;
1153 size_t buflen;
1154 mbedtls_mpi_init( &mpi );
1155
1156 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1157 if( ret != 0 )
1158 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001159 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1160 {
1161 /* It's the default value, which is reported as an empty string,
1162 * so there's nothing to do. */
1163 goto exit;
1164 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001165
1166 buflen = mbedtls_mpi_size( &mpi );
1167 buffer = mbedtls_calloc( 1, buflen );
1168 if( buffer == NULL )
1169 {
1170 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1171 goto exit;
1172 }
1173 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1174 if( ret != 0 )
1175 goto exit;
1176 attributes->domain_parameters = buffer;
1177 attributes->domain_parameters_size = buflen;
1178
1179exit:
1180 mbedtls_mpi_free( &mpi );
1181 if( ret != 0 )
1182 mbedtls_free( buffer );
1183 return( mbedtls_to_psa_error( ret ) );
1184}
John Durkop07cc04a2020-11-16 22:08:34 -08001185#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001186 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001187
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001188/** Retrieve all the publicly-accessible attributes of a key.
1189 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001190psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001191 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001192{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001194 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001195 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001196
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001197 psa_reset_key_attributes( attributes );
1198
Ronald Cron5c522922020-11-14 16:35:34 +01001199 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001200 if( status != PSA_SUCCESS )
1201 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001202
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001203 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001204 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1205 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1206
1207#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1208 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001209 psa_set_key_slot_number( attributes,
1210 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001211#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001212
Gilles Peskine8e338702019-07-30 20:06:31 +02001213 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001214 {
John Durkop07cc04a2020-11-16 22:08:34 -08001215#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001216 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001217 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001218 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001219#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001220 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001221 * is not yet implemented.
1222 * https://github.com/ARMmbed/mbed-crypto/issues/216
1223 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001224 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001225 break;
1226#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001227 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001228 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001229
Ronald Cron90857082020-11-25 14:58:33 +01001230 status = mbedtls_psa_rsa_load_representation(
1231 slot->attr.type,
1232 slot->key.data,
1233 slot->key.bytes,
1234 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001235 if( status != PSA_SUCCESS )
1236 break;
1237
Steven Cooremana2371e52020-07-28 14:30:39 +02001238 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001239 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001240 mbedtls_rsa_free( rsa );
1241 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001242 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001243 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001244#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001245 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001246 default:
1247 /* Nothing else to do. */
1248 break;
1249 }
1250
1251 if( status != PSA_SUCCESS )
1252 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001253
Ronald Cron5c522922020-11-14 16:35:34 +01001254 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Ronald Cron5c522922020-11-14 16:35:34 +01001256 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257}
1258
Gilles Peskinec8000c02019-08-02 20:15:51 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1260psa_status_t psa_get_key_slot_number(
1261 const psa_key_attributes_t *attributes,
1262 psa_key_slot_number_t *slot_number )
1263{
1264 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1265 {
1266 *slot_number = attributes->slot_number;
1267 return( PSA_SUCCESS );
1268 }
1269 else
1270 return( PSA_ERROR_INVALID_ARGUMENT );
1271}
1272#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1273
Ronald Crond18b5f82020-11-25 16:46:05 +01001274static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1275 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001276 uint8_t *data,
1277 size_t data_size,
1278 size_t *data_length )
1279{
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001281 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 memcpy( data, key_buffer, key_buffer_size );
1283 memset( data + key_buffer_size, 0,
1284 data_size - key_buffer_size );
1285 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001286 return( PSA_SUCCESS );
1287}
1288
Ronald Cron7285cda2020-11-26 14:46:37 +01001289psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001290 const psa_key_attributes_t *attributes,
1291 const uint8_t *key_buffer, size_t key_buffer_size,
1292 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001293{
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 psa_key_type_t type = attributes->core.type;
1295
Ronald Crond18b5f82020-11-25 16:46:05 +01001296 if( key_type_is_raw_bytes( type ) ||
1297 PSA_KEY_TYPE_IS_RSA( type ) ||
1298 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001299 {
1300 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001301 key_buffer, key_buffer_size,
1302 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001303 }
1304 else
1305 {
1306 /* This shouldn't happen in the reference implementation, but
1307 it is valid for a special-purpose implementation to omit
1308 support for exporting certain key types. */
1309 return( PSA_ERROR_NOT_SUPPORTED );
1310 }
1311}
1312
1313psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1314 uint8_t *data,
1315 size_t data_size,
1316 size_t *data_length )
1317{
1318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1319 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1320 psa_key_slot_t *slot;
1321
Ronald Crone907e552021-01-18 13:22:38 +01001322 /* Reject a zero-length output buffer now, since this can never be a
1323 * valid key representation. This way we know that data must be a valid
1324 * pointer and we can do things like memset(data, ..., data_size). */
1325 if( data_size == 0 )
1326 return( PSA_ERROR_BUFFER_TOO_SMALL );
1327
Ronald Cron9486f9d2020-11-26 13:36:23 +01001328 /* Set the key to empty now, so that even when there are errors, we always
1329 * set data_length to a value between 0 and data_size. On error, setting
1330 * the key to empty is a good choice because an empty key representation is
1331 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001332 *data_length = 0;
1333
Ronald Cron9486f9d2020-11-26 13:36:23 +01001334 /* Export requires the EXPORT flag. There is an exception for public keys,
1335 * which don't require any flag, but
1336 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1337 */
1338 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1339 PSA_KEY_USAGE_EXPORT, 0 );
1340 if( status != PSA_SUCCESS )
1341 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001342
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 psa_key_attributes_t attributes = {
1344 .core = slot->attr
1345 };
Ronald Cron67227982020-11-26 15:16:05 +01001346 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 slot->key.data, slot->key.bytes,
1348 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001349
Ronald Cron9486f9d2020-11-26 13:36:23 +01001350 unlock_status = psa_unlock_key_slot( slot );
1351
1352 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1353}
1354
Ronald Cron7285cda2020-11-26 14:46:37 +01001355psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 const psa_key_attributes_t *attributes,
1357 const uint8_t *key_buffer,
1358 size_t key_buffer_size,
1359 uint8_t *data,
1360 size_t data_size,
1361 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362{
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001364
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001366 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001368 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001371 key_buffer, key_buffer_size,
1372 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001373 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001374
Ronald Crond18b5f82020-11-25 16:46:05 +01001375 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001376 {
John Durkop0e005192020-10-31 22:06:54 -07001377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1378 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001379 return( mbedtls_psa_rsa_export_public_key( attributes,
1380 key_buffer,
1381 key_buffer_size,
1382 data,
1383 data_size,
1384 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001385#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001386 /* We don't know how to convert a private RSA key to public. */
1387 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001390 }
1391 else
Moran Pekera998bc62018-04-16 18:16:20 +03001392 {
John Durkop6ba40d12020-11-10 08:50:04 -08001393#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1394 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001395 return( mbedtls_psa_ecp_export_public_key( attributes,
1396 key_buffer,
1397 key_buffer_size,
1398 data,
1399 data_size,
1400 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001401#else
1402 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001403 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001404#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1405 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001406 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001407 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001408 else
1409 {
1410 /* This shouldn't happen in the reference implementation, but
1411 it is valid for a special-purpose implementation to omit
1412 support for exporting certain key types. */
1413 return( PSA_ERROR_NOT_SUPPORTED );
1414 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001415}
Ronald Crond18b5f82020-11-25 16:46:05 +01001416
Ronald Croncf56a0a2020-08-04 09:51:30 +02001417psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001418 uint8_t *data,
1419 size_t data_size,
1420 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001421{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001423 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001424 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001425
Ronald Crone907e552021-01-18 13:22:38 +01001426 /* Reject a zero-length output buffer now, since this can never be a
1427 * valid key representation. This way we know that data must be a valid
1428 * pointer and we can do things like memset(data, ..., data_size). */
1429 if( data_size == 0 )
1430 return( PSA_ERROR_BUFFER_TOO_SMALL );
1431
Darryl Greendd8fb772018-11-07 16:00:44 +00001432 /* Set the key to empty now, so that even when there are errors, we always
1433 * set data_length to a value between 0 and data_size. On error, setting
1434 * the key to empty is a good choice because an empty key representation is
1435 * unlikely to be accepted anywhere. */
1436 *data_length = 0;
1437
1438 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001439 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001440 if( status != PSA_SUCCESS )
1441 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001442
Ronald Cron9486f9d2020-11-26 13:36:23 +01001443 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1444 {
1445 status = PSA_ERROR_INVALID_ARGUMENT;
1446 goto exit;
1447 }
1448
Ronald Crond18b5f82020-11-25 16:46:05 +01001449 psa_key_attributes_t attributes = {
1450 .core = slot->attr
1451 };
Ronald Cron67227982020-11-26 15:16:05 +01001452 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001453 &attributes, slot->key.data, slot->key.bytes,
1454 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001455
1456exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001457 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001458
Ronald Cron5c522922020-11-14 16:35:34 +01001459 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001460}
1461
Gilles Peskine91e8c332019-08-02 19:19:39 +02001462#if defined(static_assert)
1463static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1464 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001465static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001466 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001467static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001468 "One or more key attribute flag is listed as both internal-only and external-only" );
1469#endif
1470
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001471/** Validate that a key policy is internally well-formed.
1472 *
1473 * This function only rejects invalid policies. It does not validate the
1474 * consistency of the policy with respect to other attributes of the key
1475 * such as the key type.
1476 */
1477static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001478{
1479 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001480 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001481 PSA_KEY_USAGE_ENCRYPT |
1482 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001483 PSA_KEY_USAGE_SIGN_MESSAGE |
1484 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001485 PSA_KEY_USAGE_SIGN_HASH |
1486 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001487 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001488 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1489 return( PSA_ERROR_INVALID_ARGUMENT );
1490
Gilles Peskine4747d192019-04-17 15:05:45 +02001491 return( PSA_SUCCESS );
1492}
1493
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001494/** Validate the internal consistency of key attributes.
1495 *
1496 * This function only rejects invalid attribute values. If does not
1497 * validate the consistency of the attributes with any key data that may
1498 * be involved in the creation of the key.
1499 *
1500 * Call this function early in the key creation process.
1501 *
1502 * \param[in] attributes Key attributes for the new key.
1503 * \param[out] p_drv On any return, the driver for the key, if any.
1504 * NULL for a transparent key.
1505 *
1506 */
1507static psa_status_t psa_validate_key_attributes(
1508 const psa_key_attributes_t *attributes,
1509 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001510{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001511 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001513 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514
Ronald Cron54b90082020-10-29 15:26:43 +01001515 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001516 if( status != PSA_SUCCESS )
1517 return( status );
1518
Ronald Crond2ed4812020-07-17 16:11:30 +02001519 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001520 if( status != PSA_SUCCESS )
1521 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001522
Ronald Cron65f38a32020-10-23 17:11:13 +02001523 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1524 {
1525 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1526 return( PSA_ERROR_INVALID_ARGUMENT );
1527 }
1528 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001529 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001530 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1531 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001532 }
1533
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001535 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 return( status );
1537
1538 /* Refuse to create overly large keys.
1539 * Note that this doesn't trigger on import if the attributes don't
1540 * explicitly specify a size (so psa_get_key_bits returns 0), so
1541 * psa_import_key() needs its own checks. */
1542 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1543 return( PSA_ERROR_NOT_SUPPORTED );
1544
Gilles Peskine91e8c332019-08-02 19:19:39 +02001545 /* Reject invalid flags. These should not be reachable through the API. */
1546 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1547 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1548 return( PSA_ERROR_INVALID_ARGUMENT );
1549
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001550 return( PSA_SUCCESS );
1551}
1552
Gilles Peskine4747d192019-04-17 15:05:45 +02001553/** Prepare a key slot to receive key material.
1554 *
1555 * This function allocates a key slot and sets its metadata.
1556 *
1557 * If this function fails, call psa_fail_key_creation().
1558 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001559 * This function is intended to be used as follows:
1560 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001561 * it with the specified attributes, and in case of a volatile key assign it
1562 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001563 * -# Populate the slot with the key material.
1564 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1565 * In case of failure at any step, stop the sequence and call
1566 * psa_fail_key_creation().
1567 *
Ronald Cron5c522922020-11-14 16:35:34 +01001568 * On success, the key slot is locked. It is the responsibility of the caller
1569 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001570 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001571 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001572 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001573 * \param[out] p_slot On success, a pointer to the prepared slot.
1574 * \param[out] p_drv On any return, the driver for the key, if any.
1575 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001576 *
1577 * \retval #PSA_SUCCESS
1578 * The key slot is ready to receive key material.
1579 * \return If this function fails, the key slot is an invalid state.
1580 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001581 */
1582static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001583 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001584 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001585 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001586 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001587{
1588 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001589 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001590 psa_key_slot_t *slot;
1591
Gilles Peskinedf179142019-07-15 22:02:14 +02001592 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001593 *p_drv = NULL;
1594
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001595 status = psa_validate_key_attributes( attributes, p_drv );
1596 if( status != PSA_SUCCESS )
1597 return( status );
1598
Ronald Cronc4d1b512020-07-31 11:26:37 +02001599 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001600 if( status != PSA_SUCCESS )
1601 return( status );
1602 slot = *p_slot;
1603
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001604 /* We're storing the declared bit-size of the key. It's up to each
1605 * creation mechanism to verify that this information is correct.
1606 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001607 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001608 * is optional (import, copy). In case of a volatile key, assign it the
1609 * volatile key identifier associated to the slot returned to contain its
1610 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001611
1612 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001613 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1614 {
1615#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1616 slot->attr.id = volatile_key_id;
1617#else
1618 slot->attr.id.key_id = volatile_key_id;
1619#endif
1620 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001621
Gilles Peskine91e8c332019-08-02 19:19:39 +02001622 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001623 * external-only flags, query `attributes`. Thanks to the check
1624 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001625 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001626 * may have set. */
1627 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001628
Gilles Peskinecbaff462019-07-12 23:46:04 +02001629#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001630 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001631 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001632 * create the key file in internal storage, create the
1633 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001634 * persistent data. This is done by starting a transaction that will
1635 * encompass these three actions.
1636 * For registering a volatile key, we just need to find an appropriate
1637 * slot number inside the SE. Since the key is designated volatile, creating
1638 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001639 /* The first thing to do is to find a slot number for the new key.
1640 * We save the slot number in persistent storage as part of the
1641 * transaction data. It will be needed to recover if the power
1642 * fails during the key creation process, to clean up on the secure
1643 * element side after restarting. Obtaining a slot number from the
1644 * secure element driver updates its persistent state, but we do not yet
1645 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001646 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001647 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001648 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001649 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001650 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001652 if( status != PSA_SUCCESS )
1653 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001654
1655 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001656 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001657 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1658 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001659 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001660 psa_crypto_transaction.key.id = slot->attr.id;
1661 status = psa_crypto_save_transaction( );
1662 if( status != PSA_SUCCESS )
1663 {
1664 (void) psa_crypto_stop_transaction( );
1665 return( status );
1666 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001667 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001668
1669 status = psa_copy_key_material_into_slot(
1670 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001671 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001672
1673 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1674 {
1675 /* Key registration only makes sense with a secure element. */
1676 return( PSA_ERROR_INVALID_ARGUMENT );
1677 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001678#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1679
Ronald Cronc4d1b512020-07-31 11:26:37 +02001680 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001681}
Gilles Peskine4747d192019-04-17 15:05:45 +02001682
1683/** Finalize the creation of a key once its key material has been set.
1684 *
1685 * This entails writing the key to persistent storage.
1686 *
1687 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001688 * See the documentation of psa_start_key_creation() for the intended use
1689 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001690 *
Ronald Cron5c522922020-11-14 16:35:34 +01001691 * If the finalization succeeds, the function unlocks the key slot (it was
1692 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1693 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001694 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001695 * \param[in,out] slot Pointer to the slot with key material.
1696 * \param[in] driver The secure element driver for the key,
1697 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001698 * \param[out] key On success, identifier of the key. Note that the
1699 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001700 *
1701 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001702 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001703 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1704 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1705 * \retval #PSA_ERROR_ALREADY_EXISTS
1706 * \retval #PSA_ERROR_DATA_INVALID
1707 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001708 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001709 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001710 * \return If this function fails, the key slot is an invalid state.
1711 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001712 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001713static psa_status_t psa_finish_key_creation(
1714 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001715 psa_se_drv_table_entry_t *driver,
1716 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001717{
1718 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001719 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001720 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001721
1722#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001723 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001724 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001725#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1726 if( driver != NULL )
1727 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001728 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729 psa_key_slot_number_t slot_number =
1730 psa_key_slot_get_slot_number( slot ) ;
1731
Gilles Peskineb46bef22019-07-30 21:32:04 +02001732#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001733 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001734 sizeof( data.slot_number ),
1735 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001736#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001737 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001738 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001739 (uint8_t*) &data,
1740 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001741 }
1742 else
1743#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1744 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001745 /* Key material is saved in export representation in the slot, so
1746 * just pass the slot buffer for storage. */
1747 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001748 slot->key.data,
1749 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001750 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001752#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1753
Gilles Peskinecbaff462019-07-12 23:46:04 +02001754#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001755 /* Finish the transaction for a key creation. This does not
1756 * happen when registering an existing key. Detect this case
1757 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001758 * creation of a persistent key in a secure element requires a transaction,
1759 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001760 if( driver != NULL &&
1761 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001762 {
1763 status = psa_save_se_persistent_data( driver );
1764 if( status != PSA_SUCCESS )
1765 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001766 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001767 return( status );
1768 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001769 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001770 }
1771#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1772
Ronald Cron50972942020-11-14 11:28:25 +01001773 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001774 {
1775 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001776 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001777 if( status != PSA_SUCCESS )
1778 *key = MBEDTLS_SVC_KEY_ID_INIT;
1779 }
Ronald Cron50972942020-11-14 11:28:25 +01001780
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 return( status );
1782}
1783
1784/** Abort the creation of a key.
1785 *
1786 * You may call this function after calling psa_start_key_creation(),
1787 * or after psa_finish_key_creation() fails. In other circumstances, this
1788 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001789 * See the documentation of psa_start_key_creation() for the intended use
1790 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001791 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 * \param[in,out] slot Pointer to the slot with key material.
1793 * \param[in] driver The secure element driver for the key,
1794 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001795 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001796static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001797 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001798{
Gilles Peskine011e4282019-06-26 18:34:38 +02001799 (void) driver;
1800
Gilles Peskine4747d192019-04-17 15:05:45 +02001801 if( slot == NULL )
1802 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001803
1804#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001805 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001806 * element, and the failure happened later (when saving metadata
1807 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001808 * element.
1809 * https://github.com/ARMmbed/mbed-crypto/issues/217
1810 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001811
Gilles Peskined7729582019-08-05 15:55:54 +02001812 /* Abort the ongoing transaction if any (there may not be one if
1813 * the creation process failed before starting one, or if the
1814 * key creation is a registration of a key in a secure element).
1815 * Earlier functions must already have done what it takes to undo any
1816 * partial creation. All that's left is to update the transaction data
1817 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001818 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001819#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1820
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 psa_wipe_key_slot( slot );
1822}
1823
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001824/** Validate optional attributes during key creation.
1825 *
1826 * Some key attributes are optional during key creation. If they are
1827 * specified in the attributes structure, check that they are consistent
1828 * with the data in the slot.
1829 *
1830 * This function should be called near the end of key creation, after
1831 * the slot in memory is fully populated but before saving persistent data.
1832 */
1833static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 const psa_key_slot_t *slot,
1835 const psa_key_attributes_t *attributes )
1836{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001837 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001838 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001839 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 return( PSA_ERROR_INVALID_ARGUMENT );
1841 }
1842
1843 if( attributes->domain_parameters_size != 0 )
1844 {
John Durkop0e005192020-10-31 22:06:54 -07001845#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1846 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001847 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001850 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001851 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001852
Ronald Cron90857082020-11-25 14:58:33 +01001853 psa_status_t status = mbedtls_psa_rsa_load_representation(
1854 slot->attr.type,
1855 slot->key.data,
1856 slot->key.bytes,
1857 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001858 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001859 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001860
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001861 mbedtls_mpi_init( &actual );
1862 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001863 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001864 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001865 mbedtls_rsa_free( rsa );
1866 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001867 if( ret != 0 )
1868 goto rsa_exit;
1869 ret = mbedtls_mpi_read_binary( &required,
1870 attributes->domain_parameters,
1871 attributes->domain_parameters_size );
1872 if( ret != 0 )
1873 goto rsa_exit;
1874 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1875 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1876 rsa_exit:
1877 mbedtls_mpi_free( &actual );
1878 mbedtls_mpi_free( &required );
1879 if( ret != 0)
1880 return( mbedtls_to_psa_error( ret ) );
1881 }
1882 else
John Durkop9814fa22020-11-04 12:28:15 -08001883#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1884 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001885 {
1886 return( PSA_ERROR_INVALID_ARGUMENT );
1887 }
1888 }
1889
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001890 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001891 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001892 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893 return( PSA_ERROR_INVALID_ARGUMENT );
1894 }
1895
1896 return( PSA_SUCCESS );
1897}
1898
Gilles Peskine4747d192019-04-17 15:05:45 +02001899psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001900 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001901 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001902 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001903{
1904 psa_status_t status;
1905 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001906 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001907 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908
Ronald Cron81709fc2020-11-14 12:10:32 +01001909 *key = MBEDTLS_SVC_KEY_ID_INIT;
1910
Gilles Peskine0f84d622019-09-12 19:03:13 +02001911 /* Reject zero-length symmetric keys (including raw data key objects).
1912 * This also rejects any key which might be encoded as an empty string,
1913 * which is never valid. */
1914 if( data_length == 0 )
1915 return( PSA_ERROR_INVALID_ARGUMENT );
1916
Gilles Peskinedf179142019-07-15 22:02:14 +02001917 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001918 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001919 if( status != PSA_SUCCESS )
1920 goto exit;
1921
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001922 /* In the case of a transparent key or an opaque key stored in local
1923 * storage (thus not in the case of generating a key in a secure element
1924 * or cryptoprocessor with storage), we have to allocate a buffer to
1925 * hold the generated key material. */
1926 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001927 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001928 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001929 if( status != PSA_SUCCESS )
1930 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001931 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001932
1933 bits = slot->attr.bits;
1934 status = psa_driver_wrapper_import_key( attributes,
1935 data, data_length,
1936 slot->key.data,
1937 slot->key.bytes,
1938 &slot->key.bytes, &bits );
1939 if( status != PSA_SUCCESS )
1940 goto exit;
1941
1942 if( slot->attr.bits == 0 )
1943 slot->attr.bits = (psa_key_bits_t) bits;
1944 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001945 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001946 status = PSA_ERROR_INVALID_ARGUMENT;
1947 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001948 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001949
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001950 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001951 if( status != PSA_SUCCESS )
1952 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001953
Ronald Cron81709fc2020-11-14 12:10:32 +01001954 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001956 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001957 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001958
Gilles Peskine4747d192019-04-17 15:05:45 +02001959 return( status );
1960}
1961
Gilles Peskined7729582019-08-05 15:55:54 +02001962#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1963psa_status_t mbedtls_psa_register_se_key(
1964 const psa_key_attributes_t *attributes )
1965{
1966 psa_status_t status;
1967 psa_key_slot_t *slot = NULL;
1968 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001969 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001970
1971 /* Leaving attributes unspecified is not currently supported.
1972 * It could make sense to query the key type and size from the
1973 * secure element, but not all secure elements support this
1974 * and the driver HAL doesn't currently support it. */
1975 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1976 return( PSA_ERROR_NOT_SUPPORTED );
1977 if( psa_get_key_bits( attributes ) == 0 )
1978 return( PSA_ERROR_NOT_SUPPORTED );
1979
1980 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001981 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001982 if( status != PSA_SUCCESS )
1983 goto exit;
1984
Ronald Cron81709fc2020-11-14 12:10:32 +01001985 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001986
1987exit:
1988 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001989 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001990
Gilles Peskined7729582019-08-05 15:55:54 +02001991 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001992 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001993 return( status );
1994}
1995#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1996
Gilles Peskinef603c712019-01-19 13:40:11 +01001997static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001998 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001999{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002000 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002001 source->key.data,
2002 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002003 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002004 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002005
Steven Cooreman398aee52020-10-13 14:35:45 +02002006 target->attr.type = source->attr.type;
2007 target->attr.bits = source->attr.bits;
2008
2009 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002010}
2011
Ronald Croncf56a0a2020-08-04 09:51:30 +02002012psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002013 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002014 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002015{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002016 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002017 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002018 psa_key_slot_t *source_slot = NULL;
2019 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002021 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002022
Ronald Cron81709fc2020-11-14 12:10:32 +01002023 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2024
Ronald Cron5c522922020-11-14 16:35:34 +01002025 status = psa_get_and_lock_transparent_key_slot_with_policy(
2026 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002027 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002028 goto exit;
2029
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002030 status = psa_validate_optional_attributes( source_slot,
2031 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002032 if( status != PSA_SUCCESS )
2033 goto exit;
2034
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002035 status = psa_restrict_key_policy( source_slot->attr.type,
2036 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002037 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002038 if( status != PSA_SUCCESS )
2039 goto exit;
2040
Ronald Cron81709fc2020-11-14 12:10:32 +01002041 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2042 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002043 if( status != PSA_SUCCESS )
2044 goto exit;
2045
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002046#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2047 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002048 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002049 /* Copying to a secure element is not implemented yet. */
2050 status = PSA_ERROR_NOT_SUPPORTED;
2051 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002052 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002053#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002054
Ronald Cron6cc66312021-04-02 12:27:47 +02002055 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2056 {
2057 /*
2058 * Copying through an opaque driver is not implemented yet, consider
2059 * a lifetime with an external location as an invalid parameter for
2060 * now.
2061 */
2062 status = PSA_ERROR_INVALID_ARGUMENT;
2063 goto exit;
2064 }
2065
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002066 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002067 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002068 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002069
Ronald Cron81709fc2020-11-14 12:10:32 +01002070 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002071exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002072 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002073 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002074
Ronald Cron5c522922020-11-14 16:35:34 +01002075 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002076
Ronald Cron5c522922020-11-14 16:35:34 +01002077 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002078}
2079
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002080
2081
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002082/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002083/* Message digests */
2084/****************************************************************/
2085
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002086psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2087{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002088 /* Aborting a non-active operation is allowed */
2089 if( operation->id == 0 )
2090 return( PSA_SUCCESS );
2091
2092 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2093 operation->id = 0;
2094
2095 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002096}
2097
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002098psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002099 psa_algorithm_t alg )
2100{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002101 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002102
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002103 /* A context must be freshly initialized before it can be set up. */
2104 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002105 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002106 status = PSA_ERROR_BAD_STATE;
2107 goto exit;
2108 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002109
2110 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002111 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002112 status = PSA_ERROR_INVALID_ARGUMENT;
2113 goto exit;
2114 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002115
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002116 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2117 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002118 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2119
Dave Rodgman685b6a72021-06-24 11:49:14 +01002120 status = psa_driver_wrapper_hash_setup( operation, alg );
2121
2122exit:
2123 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002124 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002125
2126 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002127}
2128
2129psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2130 const uint8_t *input,
2131 size_t input_length )
2132{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002133 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2134
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002135 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002136 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002137 status = PSA_ERROR_BAD_STATE;
2138 goto exit;
2139 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002140
Steven Cooremanc8288352021-03-04 14:02:19 +01002141 /* Don't require hash implementations to behave correctly on a
2142 * zero-length input, which may have an invalid pointer. */
2143 if( input_length == 0 )
2144 return( PSA_SUCCESS );
2145
Dave Rodgman685b6a72021-06-24 11:49:14 +01002146 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2147
2148exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002149 if( status != PSA_SUCCESS )
2150 psa_hash_abort( operation );
2151
2152 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002153}
2154
2155psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2156 uint8_t *hash,
2157 size_t hash_size,
2158 size_t *hash_length )
2159{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002160 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002161 if( operation->id == 0 )
2162 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002163
Steven Cooreman1e582352021-02-18 17:24:37 +01002164 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002165 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002166 psa_hash_abort( operation );
2167 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002168}
2169
Gilles Peskine2d277862018-06-18 15:41:12 +02002170psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2171 const uint8_t *hash,
2172 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173{
2174 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2175 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002176 psa_status_t status = psa_hash_finish(
2177 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002178 actual_hash, sizeof( actual_hash ),
2179 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002180
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002181 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002182 goto exit;
2183
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002185 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002186 status = PSA_ERROR_INVALID_SIGNATURE;
2187 goto exit;
2188 }
2189
Steven Cooreman36876a02021-04-29 16:37:59 +02002190 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002191 status = PSA_ERROR_INVALID_SIGNATURE;
2192
2193exit:
2194 if( status != PSA_SUCCESS )
2195 psa_hash_abort(operation);
2196
2197 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002198}
2199
Gilles Peskine0a749c82019-11-28 19:33:58 +01002200psa_status_t psa_hash_compute( psa_algorithm_t alg,
2201 const uint8_t *input, size_t input_length,
2202 uint8_t *hash, size_t hash_size,
2203 size_t *hash_length )
2204{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002205 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002206 if( !PSA_ALG_IS_HASH( alg ) )
2207 return( PSA_ERROR_INVALID_ARGUMENT );
2208
Steven Cooreman1e582352021-02-18 17:24:37 +01002209 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2210 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002211}
2212
2213psa_status_t psa_hash_compare( psa_algorithm_t alg,
2214 const uint8_t *input, size_t input_length,
2215 const uint8_t *hash, size_t hash_length )
2216{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002217 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2218 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002219
2220 if( !PSA_ALG_IS_HASH( alg ) )
2221 return( PSA_ERROR_INVALID_ARGUMENT );
2222
Steven Cooreman1e582352021-02-18 17:24:37 +01002223 psa_status_t status = psa_driver_wrapper_hash_compute(
2224 alg, input, input_length,
2225 actual_hash, sizeof(actual_hash),
2226 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002227 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002228 return( status );
2229 if( actual_hash_length != hash_length )
2230 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002231 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002232 return( PSA_ERROR_INVALID_SIGNATURE );
2233 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002234}
2235
Gilles Peskineeb35d782019-01-22 17:56:16 +01002236psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2237 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002238{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002239 if( source_operation->id == 0 ||
2240 target_operation->id != 0 )
2241 {
2242 return( PSA_ERROR_BAD_STATE );
2243 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002244
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002245 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2246 target_operation );
2247 if( status != PSA_SUCCESS )
2248 psa_hash_abort( target_operation );
2249
2250 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002251}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002252
2253
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002255/* MAC */
2256/****************************************************************/
2257
Steven Cooremane6804192021-03-19 18:28:56 +01002258psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002259{
Steven Cooremane6804192021-03-19 18:28:56 +01002260 /* Aborting a non-active operation is allowed */
2261 if( operation->id == 0 )
2262 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002263
Steven Cooremane6804192021-03-19 18:28:56 +01002264 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002265 operation->mac_size = 0;
2266 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002267 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002268
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002269 return( status );
2270}
2271
Ronald Cron2dff3b22021-06-17 16:33:22 +02002272static psa_status_t psa_mac_finalize_alg_and_key_validation(
2273 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002274 const psa_key_attributes_t *attributes,
2275 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002276{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002278 psa_key_type_t key_type = psa_get_key_type( attributes );
2279 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002280
Ronald Cron28ea0502021-06-17 16:10:24 +02002281 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002282 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002283
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002284 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002285 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002286 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002287 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002288
Steven Cooremand1a68f12021-05-10 11:13:41 +02002289 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002290 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002291
Ronald Cron79bdd822021-06-17 16:46:44 +02002292 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002293 {
2294 /* A very short MAC is too short for security since it can be
2295 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2296 * so we make this our minimum, even though 32 bits is still
2297 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002298 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002299 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002300
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2302 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002303 {
2304 /* It's impossible to "truncate" to a larger length than the full length
2305 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002306 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002307 }
2308
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002310}
2311
Gilles Peskinee59236f2018-01-27 23:32:46 +01002312static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2313 mbedtls_svc_key_id_t key,
2314 psa_algorithm_t alg,
2315 int is_sign )
2316{
2317 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2318 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002319 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320
2321 /* A context must be freshly initialized before it can be set up. */
2322 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002323 {
Dave Rodgman54648242021-06-24 11:49:45 +01002324 status = PSA_ERROR_BAD_STATE;
2325 goto exit;
2326 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002327
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328 status = psa_get_and_lock_key_slot_with_policy(
2329 key,
2330 &slot,
2331 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2332 alg );
2333 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002334 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002335
2336 psa_key_attributes_t attributes = {
2337 .core = slot->attr
2338 };
2339
Ronald Cron79bdd822021-06-17 16:46:44 +02002340 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2341 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002342 if( status != PSA_SUCCESS )
2343 goto exit;
2344
2345 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002346 /* Dispatch the MAC setup call with validated input */
2347 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002348 {
Steven Cooremane6804192021-03-19 18:28:56 +01002349 status = psa_driver_wrapper_mac_sign_setup( operation,
2350 &attributes,
2351 slot->key.data,
2352 slot->key.bytes,
2353 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002354 }
2355 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002356 {
Steven Cooremane6804192021-03-19 18:28:56 +01002357 status = psa_driver_wrapper_mac_verify_setup( operation,
2358 &attributes,
2359 slot->key.data,
2360 slot->key.bytes,
2361 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002362 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002363
Gilles Peskinefbfac682018-07-08 20:51:54 +02002364exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002365 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002366 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002367
Ronald Cron5c522922020-11-14 16:35:34 +01002368 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002369
Ronald Cron5c522922020-11-14 16:35:34 +01002370 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002371}
2372
Gilles Peskine89167cb2018-07-08 20:12:23 +02002373psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002374 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002375 psa_algorithm_t alg )
2376{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002377 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002378}
2379
2380psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002381 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002382 psa_algorithm_t alg )
2383{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002384 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002385}
2386
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002387psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002388 const uint8_t *input,
2389 size_t input_length )
2390{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002391 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002392 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002393
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002394 /* Don't require hash implementations to behave correctly on a
2395 * zero-length input, which may have an invalid pointer. */
2396 if( input_length == 0 )
2397 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002398
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002399 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2400 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002401 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002402 psa_mac_abort( operation );
2403
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002404 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002405}
2406
Steven Cooremana5b860a2021-03-19 19:04:39 +01002407psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002408 uint8_t *mac,
2409 size_t mac_size,
2410 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002411{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2413 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002414
Steven Cooremana5b860a2021-03-19 19:04:39 +01002415 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002416 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002417 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002418 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002419 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002420
Steven Cooreman72f736a2021-05-07 14:14:37 +02002421 if( ! operation->is_sign )
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 Cooreman72f736a2021-05-07 14:14:37 +02002426
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002427 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2428 * once all the error checks are done. */
2429 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002430 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002431 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002432 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002433 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002434
2435 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002436 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002437 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002438 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002439 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002440
Steven Cooremana5b860a2021-03-19 19:04:39 +01002441 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002442 mac, operation->mac_size,
2443 mac_length );
2444
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002445exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002446 /* In case of success, set the potential excess room in the output buffer
2447 * to an invalid value, to avoid potentially leaking a longer MAC.
2448 * In case of error, set the output length and content to a safe default,
2449 * such that in case the caller misses an error check, the output would be
2450 * an unachievable MAC.
2451 */
2452 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002453 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002454 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002455 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002456 }
mohammad16036df908f2018-04-02 08:34:15 -07002457
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002458 if( mac_size > operation->mac_size )
2459 memset( &mac[operation->mac_size], '!',
2460 mac_size - operation->mac_size );
2461
Steven Cooremana5b860a2021-03-19 19:04:39 +01002462 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002463
Steven Cooremana5b860a2021-03-19 19:04:39 +01002464 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002465}
2466
Steven Cooremana5b860a2021-03-19 19:04:39 +01002467psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002468 const uint8_t *mac,
2469 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002470{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002471 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2472 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002473
Steven Cooremana5b860a2021-03-19 19:04:39 +01002474 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002475 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002476 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002477 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002478 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002479
Steven Cooreman72f736a2021-05-07 14:14:37 +02002480 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002481 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002482 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002483 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002484 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002485
2486 if( operation->mac_size != mac_length )
2487 {
2488 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002489 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002490 }
2491
Steven Cooremana5b860a2021-03-19 19:04:39 +01002492 status = psa_driver_wrapper_mac_verify_finish( operation,
2493 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002494
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002495exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002496 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002497
Steven Cooremana5b860a2021-03-19 19:04:39 +01002498 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002499}
2500
Ronald Croncd989b52021-06-18 14:23:33 +02002501static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2502 psa_algorithm_t alg,
2503 const uint8_t *input,
2504 size_t input_length,
2505 uint8_t *mac,
2506 size_t mac_size,
2507 size_t *mac_length,
2508 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002509{
2510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002511 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2512 psa_key_slot_t *slot;
2513 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002514
Ronald Cron51131b52021-06-17 17:17:20 +02002515 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002516 key, &slot,
2517 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2518 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002519 if( status != PSA_SUCCESS )
2520 goto exit;
2521
Ronald Cron51131b52021-06-17 17:17:20 +02002522 psa_key_attributes_t attributes = {
2523 .core = slot->attr
2524 };
2525
2526 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2527 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002528 if( status != PSA_SUCCESS )
2529 goto exit;
2530
Ronald Cron51131b52021-06-17 17:17:20 +02002531 if( mac_size < operation_mac_size )
2532 {
2533 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002534 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002535 }
2536
2537 status = psa_driver_wrapper_mac_compute(
2538 &attributes,
2539 slot->key.data, slot->key.bytes,
2540 alg,
2541 input, input_length,
2542 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002543
2544exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002545 /* In case of success, set the potential excess room in the output buffer
2546 * to an invalid value, to avoid potentially leaking a longer MAC.
2547 * In case of error, set the output length and content to a safe default,
2548 * such that in case the caller misses an error check, the output would be
2549 * an unachievable MAC.
2550 */
2551 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002552 {
Ronald Cron51131b52021-06-17 17:17:20 +02002553 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002554 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002555 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002556 if( mac_size > operation_mac_size )
2557 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002558
Ronald Cron51131b52021-06-17 17:17:20 +02002559 unlock_status = psa_unlock_key_slot( slot );
2560
2561 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002562}
2563
Ronald Croncd989b52021-06-18 14:23:33 +02002564psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2565 psa_algorithm_t alg,
2566 const uint8_t *input,
2567 size_t input_length,
2568 uint8_t *mac,
2569 size_t mac_size,
2570 size_t *mac_length)
2571{
2572 return( psa_mac_compute_internal( key, alg,
2573 input, input_length,
2574 mac, mac_size, mac_length, 1 ) );
2575}
2576
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002577psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2578 psa_algorithm_t alg,
2579 const uint8_t *input,
2580 size_t input_length,
2581 const uint8_t *mac,
2582 size_t mac_length)
2583{
2584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002585 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2586 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002587
Ronald Crona587cbc2021-06-18 14:51:29 +02002588 status = psa_mac_compute_internal( key, alg,
2589 input, input_length,
2590 actual_mac, sizeof( actual_mac ),
2591 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002592 if( status != PSA_SUCCESS )
2593 goto exit;
2594
Ronald Crona587cbc2021-06-18 14:51:29 +02002595 if( mac_length != actual_mac_length )
2596 {
2597 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002598 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002599 }
2600 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2601 {
2602 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002603 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002604 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002605
2606exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002607 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002608
2609 return ( status );
2610}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002611
Gilles Peskinee59236f2018-01-27 23:32:46 +01002612/****************************************************************/
2613/* Asymmetric cryptography */
2614/****************************************************************/
2615
gabor-mezei-armf0486182021-05-12 11:03:09 +02002616static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002617 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002618{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002619 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002620 {
2621 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2622 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002623
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002624 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2625 {
2626 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2627 return( PSA_ERROR_INVALID_ARGUMENT );
2628 }
2629 }
2630 else
2631 {
2632 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2633 return( PSA_ERROR_INVALID_ARGUMENT );
2634 }
2635
2636 return( PSA_SUCCESS );
2637}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002638
2639static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002640 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002641 psa_algorithm_t alg,
2642 const uint8_t * input,
2643 size_t input_length,
2644 uint8_t * signature,
2645 size_t signature_size,
2646 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002647{
2648 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2649 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2650 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002651
2652 *signature_length = 0;
2653
gabor-mezei-armf0486182021-05-12 11:03:09 +02002654 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002655 if( status != PSA_SUCCESS )
2656 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002657
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002658 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002659 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002660 * buffer can in principle be empty since it doesn't actually have
2661 * to be a hash.) */
2662 if( signature_size == 0 )
2663 return( PSA_ERROR_BUFFER_TOO_SMALL );
2664
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002665 status = psa_get_and_lock_key_slot_with_policy(
2666 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002667 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2668 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002669 alg );
2670
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002671 if( status != PSA_SUCCESS )
2672 goto exit;
2673
2674 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2675 {
2676 status = PSA_ERROR_INVALID_ARGUMENT;
2677 goto exit;
2678 }
2679
2680 psa_key_attributes_t attributes = {
2681 .core = slot->attr
2682 };
2683
gabor-mezei-armf0486182021-05-12 11:03:09 +02002684 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002685 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002686 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002687 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002688 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002689 signature, signature_size, signature_length );
2690 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002691 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002692 {
2693
2694 status = psa_driver_wrapper_sign_hash(
2695 &attributes, slot->key.data, slot->key.bytes,
2696 alg, input, input_length,
2697 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002698 }
2699
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002700
2701exit:
2702 /* Fill the unused part of the output buffer (the whole buffer on error,
2703 * the trailing part on success) with something that isn't a valid signature
2704 * (barring an attack on the signature and deliberately-crafted input),
2705 * in case the caller doesn't check the return status properly. */
2706 if( status == PSA_SUCCESS )
2707 memset( signature + *signature_length, '!',
2708 signature_size - *signature_length );
2709 else
2710 memset( signature, '!', signature_size );
2711 /* If signature_size is 0 then we have nothing to do. We must not call
2712 * memset because signature may be NULL in this case. */
2713
2714 unlock_status = psa_unlock_key_slot( slot );
2715
2716 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2717}
2718
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002719static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002720 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002721 psa_algorithm_t alg,
2722 const uint8_t * input,
2723 size_t input_length,
2724 const uint8_t * signature,
2725 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002726{
2727 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2728 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2729 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002730
gabor-mezei-armf0486182021-05-12 11:03:09 +02002731 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002732 if( status != PSA_SUCCESS )
2733 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002734
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002735 status = psa_get_and_lock_key_slot_with_policy(
2736 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002737 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2738 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002740
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741 if( status != PSA_SUCCESS )
2742 return( status );
2743
2744 psa_key_attributes_t attributes = {
2745 .core = slot->attr
2746 };
2747
gabor-mezei-armf0486182021-05-12 11:03:09 +02002748 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002749 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002750 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002751 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002752 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002753 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002754 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002755 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002756 {
2757 status = psa_driver_wrapper_verify_hash(
2758 &attributes, slot->key.data, slot->key.bytes,
2759 alg, input, input_length,
2760 signature, signature_length );
2761 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002762
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002763 unlock_status = psa_unlock_key_slot( slot );
2764
2765 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002766
2767}
2768
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002769psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002770 const psa_key_attributes_t *attributes,
2771 const uint8_t *key_buffer,
2772 size_t key_buffer_size,
2773 psa_algorithm_t alg,
2774 const uint8_t *input,
2775 size_t input_length,
2776 uint8_t *signature,
2777 size_t signature_size,
2778 size_t *signature_length )
2779{
2780 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002781
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002782 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2783 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002784 size_t hash_length;
2785 uint8_t hash[PSA_HASH_MAX_SIZE];
2786
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002787 status = psa_driver_wrapper_hash_compute(
2788 PSA_ALG_SIGN_GET_HASH( alg ),
2789 input, input_length,
2790 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002791
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002792 if( status != PSA_SUCCESS )
2793 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002794
2795 return psa_driver_wrapper_sign_hash(
2796 attributes, key_buffer, key_buffer_size,
2797 alg, hash, hash_length,
2798 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002799 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002800
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002801 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002802}
2803
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002804psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2805 psa_algorithm_t alg,
2806 const uint8_t * input,
2807 size_t input_length,
2808 uint8_t * signature,
2809 size_t signature_size,
2810 size_t * signature_length )
2811{
2812 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002813 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002814 signature, signature_size, signature_length );
2815}
2816
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002817psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002818 const psa_key_attributes_t *attributes,
2819 const uint8_t *key_buffer,
2820 size_t key_buffer_size,
2821 psa_algorithm_t alg,
2822 const uint8_t *input,
2823 size_t input_length,
2824 const uint8_t *signature,
2825 size_t signature_length )
2826{
2827 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002828
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002829 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2830 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002831 size_t hash_length;
2832 uint8_t hash[PSA_HASH_MAX_SIZE];
2833
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002834 status = psa_driver_wrapper_hash_compute(
2835 PSA_ALG_SIGN_GET_HASH( alg ),
2836 input, input_length,
2837 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002838
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002839 if( status != PSA_SUCCESS )
2840 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002841
2842 return psa_driver_wrapper_verify_hash(
2843 attributes, key_buffer, key_buffer_size,
2844 alg, hash, hash_length,
2845 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002846 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002847
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002848 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002849}
2850
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002851psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2852 psa_algorithm_t alg,
2853 const uint8_t * input,
2854 size_t input_length,
2855 const uint8_t * signature,
2856 size_t signature_length )
2857{
2858 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002859 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002860 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002861}
2862
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002863psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002864 const psa_key_attributes_t *attributes,
2865 const uint8_t *key_buffer, size_t key_buffer_size,
2866 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2867 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002868{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002869 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002870 {
Ronald Cron4501c982021-03-19 20:09:32 +01002871 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2872 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002873 {
Ronald Cron4501c982021-03-19 20:09:32 +01002874#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2875 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2876 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002877 attributes,
2878 key_buffer, key_buffer_size,
2879 alg, hash, hash_length,
2880 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002881#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2882 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002883 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002884 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002885 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002886 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002887 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002888 }
2889 else
Ronald Cron4501c982021-03-19 20:09:32 +01002890 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2891 {
2892 if( PSA_ALG_IS_ECDSA( alg ) )
2893 {
2894#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2895 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2896 return( mbedtls_psa_ecdsa_sign_hash(
2897 attributes,
2898 key_buffer, key_buffer_size,
2899 alg, hash, hash_length,
2900 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002901#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2902 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002903 }
2904 else
2905 {
2906 return( PSA_ERROR_INVALID_ARGUMENT );
2907 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002908 }
Ronald Cron4501c982021-03-19 20:09:32 +01002909
2910 (void)key_buffer;
2911 (void)key_buffer_size;
2912 (void)hash;
2913 (void)hash_length;
2914 (void)signature;
2915 (void)signature_size;
2916 (void)signature_length;
2917
2918 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002919}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002920
2921psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2922 psa_algorithm_t alg,
2923 const uint8_t *hash,
2924 size_t hash_length,
2925 uint8_t *signature,
2926 size_t signature_size,
2927 size_t *signature_length )
2928{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002929 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002930 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002931 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002932}
2933
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002934psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002935 const psa_key_attributes_t *attributes,
2936 const uint8_t *key_buffer, size_t key_buffer_size,
2937 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2938 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002939{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002940 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002941 {
Ronald Cron4501c982021-03-19 20:09:32 +01002942 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2943 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002944 {
Ronald Cron4501c982021-03-19 20:09:32 +01002945#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2946 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2947 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002948 attributes,
2949 key_buffer, key_buffer_size,
2950 alg, hash, hash_length,
2951 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002952#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2953 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002954 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002955 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002956 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002957 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002958 }
itayzafrir5c753392018-05-08 11:18:38 +03002959 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002960 else
Ronald Cron4501c982021-03-19 20:09:32 +01002961 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002962 {
Ronald Cron4501c982021-03-19 20:09:32 +01002963 if( PSA_ALG_IS_ECDSA( alg ) )
2964 {
2965#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2966 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2967 return( mbedtls_psa_ecdsa_verify_hash(
2968 attributes,
2969 key_buffer, key_buffer_size,
2970 alg, hash, hash_length,
2971 signature, signature_length ) );
2972#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2973 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2974 }
2975 else
2976 {
2977 return( PSA_ERROR_INVALID_ARGUMENT );
2978 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002979 }
Ronald Cron4501c982021-03-19 20:09:32 +01002980
2981 (void)key_buffer;
2982 (void)key_buffer_size;
2983 (void)hash;
2984 (void)hash_length;
2985 (void)signature;
2986 (void)signature_length;
2987
2988 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002989}
2990
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002991psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2992 psa_algorithm_t alg,
2993 const uint8_t *hash,
2994 size_t hash_length,
2995 const uint8_t *signature,
2996 size_t signature_length )
2997{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002998 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002999 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003000 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003001}
3002
John Durkop0e005192020-10-31 22:06:54 -07003003#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003004static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3005 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003006{
3007 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3008 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3009 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003010
3011 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003012}
John Durkop0e005192020-10-31 22:06:54 -07003013#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003014
Ronald Croncf56a0a2020-08-04 09:51:30 +02003015psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003016 psa_algorithm_t alg,
3017 const uint8_t *input,
3018 size_t input_length,
3019 const uint8_t *salt,
3020 size_t salt_length,
3021 uint8_t *output,
3022 size_t output_size,
3023 size_t *output_length )
3024{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003025 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003026 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003027 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003028
Darryl Green5cc689a2018-07-24 15:34:10 +01003029 (void) input;
3030 (void) input_length;
3031 (void) salt;
3032 (void) output;
3033 (void) output_size;
3034
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003035 *output_length = 0;
3036
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003037 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3038 return( PSA_ERROR_INVALID_ARGUMENT );
3039
Ronald Cron5c522922020-11-14 16:35:34 +01003040 status = psa_get_and_lock_transparent_key_slot_with_policy(
3041 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003042 if( status != PSA_SUCCESS )
3043 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003044 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3045 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003046 {
3047 status = PSA_ERROR_INVALID_ARGUMENT;
3048 goto exit;
3049 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003050
John Durkop6ba40d12020-11-10 08:50:04 -08003051#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3052 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003053 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003054 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003055 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003056 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3057 slot->key.data,
3058 slot->key.bytes,
3059 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003060 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003061 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003062
3063 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003064 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003065 status = PSA_ERROR_BUFFER_TOO_SMALL;
3066 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003067 }
John Durkop0e005192020-10-31 22:06:54 -07003068#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003069 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3070 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003071 status = mbedtls_to_psa_error(
3072 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003073 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003074 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003075 input_length,
3076 input,
3077 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003078 }
3079 else
John Durkop0e005192020-10-31 22:06:54 -07003080#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3081#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003082 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3083 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003084 status = mbedtls_to_psa_error(
3085 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3086 if( status != PSA_SUCCESS )
3087 goto rsa_exit;
3088
Steven Cooreman4fed4552020-08-03 14:46:03 +02003089 status = mbedtls_to_psa_error(
3090 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003091 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003092 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003093 salt, salt_length,
3094 input_length,
3095 input,
3096 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 }
3098 else
John Durkop0e005192020-10-31 22:06:54 -07003099#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003101 status = PSA_ERROR_INVALID_ARGUMENT;
3102 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003104rsa_exit:
3105 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003106 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003107
Steven Cooremana2371e52020-07-28 14:30:39 +02003108 mbedtls_rsa_free( rsa );
3109 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111 else
John Durkop9814fa22020-11-04 12:28:15 -08003112#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003113 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003115 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003117
3118exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003119 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003120
Ronald Cron5c522922020-11-14 16:35:34 +01003121 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003122}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003123
Ronald Croncf56a0a2020-08-04 09:51:30 +02003124psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003125 psa_algorithm_t alg,
3126 const uint8_t *input,
3127 size_t input_length,
3128 const uint8_t *salt,
3129 size_t salt_length,
3130 uint8_t *output,
3131 size_t output_size,
3132 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003134 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003135 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003136 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003137
Darryl Green5cc689a2018-07-24 15:34:10 +01003138 (void) input;
3139 (void) input_length;
3140 (void) salt;
3141 (void) output;
3142 (void) output_size;
3143
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003144 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003145
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003146 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3147 return( PSA_ERROR_INVALID_ARGUMENT );
3148
Ronald Cron5c522922020-11-14 16:35:34 +01003149 status = psa_get_and_lock_transparent_key_slot_with_policy(
3150 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003151 if( status != PSA_SUCCESS )
3152 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003153 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003154 {
3155 status = PSA_ERROR_INVALID_ARGUMENT;
3156 goto exit;
3157 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003158
John Durkop6ba40d12020-11-10 08:50:04 -08003159#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3160 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003161 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003163 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003164 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3165 slot->key.data,
3166 slot->key.bytes,
3167 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003168 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003169 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170
Steven Cooremana2371e52020-07-28 14:30:39 +02003171 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003172 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003173 status = PSA_ERROR_INVALID_ARGUMENT;
3174 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003175 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003176
John Durkop0e005192020-10-31 22:06:54 -07003177#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003178 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003179 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003180 status = mbedtls_to_psa_error(
3181 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003182 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003183 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003184 output_length,
3185 input,
3186 output,
3187 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003188 }
3189 else
John Durkop0e005192020-10-31 22:06:54 -07003190#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3191#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003192 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003193 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003194 status = mbedtls_to_psa_error(
3195 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3196 if( status != PSA_SUCCESS )
3197 goto rsa_exit;
3198
Steven Cooreman4fed4552020-08-03 14:46:03 +02003199 status = mbedtls_to_psa_error(
3200 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003201 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003202 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003203 salt, salt_length,
3204 output_length,
3205 input,
3206 output,
3207 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003208 }
3209 else
John Durkop0e005192020-10-31 22:06:54 -07003210#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003212 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003214
Steven Cooreman4fed4552020-08-03 14:46:03 +02003215rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003216 mbedtls_rsa_free( rsa );
3217 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003218 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219 else
John Durkop6ba40d12020-11-10 08:50:04 -08003220#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3221 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003222 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003223 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003224 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003225
3226exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003227 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003228
Ronald Cron5c522922020-11-14 16:35:34 +01003229 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003230}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003231
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003232
3233
mohammad1603503973b2018-03-12 15:59:30 +02003234/****************************************************************/
3235/* Symmetric cryptography */
3236/****************************************************************/
3237
Ronald Cronab99ac22020-10-01 16:38:28 +02003238static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3239 mbedtls_svc_key_id_t key,
3240 psa_algorithm_t alg,
3241 mbedtls_operation_t cipher_operation )
3242{
3243 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3244 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003245 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003246 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3247 PSA_KEY_USAGE_ENCRYPT :
3248 PSA_KEY_USAGE_DECRYPT );
3249
3250 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003251 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003252 {
Dave Rodgman54648242021-06-24 11:49:45 +01003253 status = PSA_ERROR_BAD_STATE;
3254 goto exit;
3255 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003256
Ronald Cronab99ac22020-10-01 16:38:28 +02003257 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003258 {
Dave Rodgman54648242021-06-24 11:49:45 +01003259 status = PSA_ERROR_INVALID_ARGUMENT;
3260 goto exit;
3261 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003262
Ronald Cronab99ac22020-10-01 16:38:28 +02003263 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3264 if( status != PSA_SUCCESS )
3265 goto exit;
3266
Ronald Cron49fafa92021-03-10 08:34:23 +01003267 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003268 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003269 * so we only set it (in the driver wrapper) after resources have been
3270 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003271 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003272 if( alg == PSA_ALG_ECB_NO_PADDING )
3273 operation->iv_required = 0;
3274 else
3275 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003276 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003277
Ronald Crona4af55f2020-12-14 14:36:06 +01003278 psa_key_attributes_t attributes = {
3279 .core = slot->attr
3280 };
3281
Ronald Cronab99ac22020-10-01 16:38:28 +02003282 /* Try doing the operation through a driver before using software fallback. */
3283 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003284 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3285 &attributes,
3286 slot->key.data,
3287 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003288 alg );
3289 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003290 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3291 &attributes,
3292 slot->key.data,
3293 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003294 alg );
3295
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003296exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003297 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003298 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003299
Ronald Cron5c522922020-11-14 16:35:34 +01003300 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003301
Ronald Cron5c522922020-11-14 16:35:34 +01003302 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003303}
3304
Gilles Peskinefe119512018-07-08 21:39:34 +02003305psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003306 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003307 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003308{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003309 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003310}
3311
Gilles Peskinefe119512018-07-08 21:39:34 +02003312psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003313 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003314 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003315{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003316 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003317}
3318
Gilles Peskinefe119512018-07-08 21:39:34 +02003319psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003320 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003321 size_t iv_size,
3322 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003323{
Ronald Cron6d051732020-10-01 14:10:20 +02003324 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003325
Ronald Cron5618a392021-03-26 09:52:26 +01003326 *iv_length = 0;
3327
Ronald Cron49fafa92021-03-10 08:34:23 +01003328 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003329 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003330 status = PSA_ERROR_BAD_STATE;
3331 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003332 }
3333
Steven Cooreman7df02922020-09-09 15:28:49 +02003334 if( operation->iv_set || ! operation->iv_required )
3335 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003336 status = PSA_ERROR_BAD_STATE;
3337 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003338 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003339
Ronald Cron5618a392021-03-26 09:52:26 +01003340 if( iv_size < operation->default_iv_length )
3341 {
3342 status = PSA_ERROR_BUFFER_TOO_SMALL;
3343 goto exit;
3344 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003345
Ronald Cron5618a392021-03-26 09:52:26 +01003346 status = psa_generate_random( iv, operation->default_iv_length );
3347 if( status != PSA_SUCCESS )
3348 goto exit;
3349
3350 status = psa_driver_wrapper_cipher_set_iv( operation,
3351 iv,
3352 operation->default_iv_length );
3353
3354exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003355 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003356 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003358 *iv_length = operation->default_iv_length;
3359 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003360 else
Moran Peker395db872018-05-31 14:07:14 +03003361 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003362
itayzafrir534bd7c2018-08-02 13:56:32 +03003363 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003364}
3365
Gilles Peskinefe119512018-07-08 21:39:34 +02003366psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003367 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003368 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003369{
Ronald Cron6d051732020-10-01 14:10:20 +02003370 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003371
Ronald Cron49fafa92021-03-10 08:34:23 +01003372 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003373 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003374 status = PSA_ERROR_BAD_STATE;
3375 goto exit;
3376 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003377
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003379 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003380 status = PSA_ERROR_BAD_STATE;
3381 goto exit;
3382 }
Ronald Crona0d68172021-03-26 10:15:08 +01003383
3384 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003385 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003386 status = PSA_ERROR_INVALID_ARGUMENT;
3387 goto exit;
3388 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003389
Ronald Crondd24c9b2020-12-15 14:10:01 +01003390 status = psa_driver_wrapper_cipher_set_iv( operation,
3391 iv,
3392 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003393
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003394exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003395 if( status == PSA_SUCCESS )
3396 operation->iv_set = 1;
3397 else
mohammad1603503973b2018-03-12 15:59:30 +02003398 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003399 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003400}
3401
Gilles Peskinee553c652018-06-04 16:22:46 +02003402psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3403 const uint8_t *input,
3404 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003405 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003406 size_t output_size,
3407 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003408{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003409 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003410
Ronald Cron49fafa92021-03-10 08:34:23 +01003411 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003412 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003413 status = PSA_ERROR_BAD_STATE;
3414 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003415 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003416
Steven Cooreman7df02922020-09-09 15:28:49 +02003417 if( operation->iv_required && ! operation->iv_set )
3418 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003419 status = PSA_ERROR_BAD_STATE;
3420 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003421 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003422
Ronald Crondd24c9b2020-12-15 14:10:01 +01003423 status = psa_driver_wrapper_cipher_update( operation,
3424 input,
3425 input_length,
3426 output,
3427 output_size,
3428 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003429
3430exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003431 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003432 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003433
itayzafrir534bd7c2018-08-02 13:56:32 +03003434 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003435}
3436
Gilles Peskinee553c652018-06-04 16:22:46 +02003437psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3438 uint8_t *output,
3439 size_t output_size,
3440 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003441{
David Saadab4ecc272019-02-14 13:48:10 +02003442 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003443
Ronald Cron49fafa92021-03-10 08:34:23 +01003444 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003445 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003446 status = PSA_ERROR_BAD_STATE;
3447 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003448 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003449
Steven Cooreman7df02922020-09-09 15:28:49 +02003450 if( operation->iv_required && ! operation->iv_set )
3451 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003452 status = PSA_ERROR_BAD_STATE;
3453 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003454 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003455
Ronald Crondd24c9b2020-12-15 14:10:01 +01003456 status = psa_driver_wrapper_cipher_finish( operation,
3457 output,
3458 output_size,
3459 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003460
3461exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003462 if( status == PSA_SUCCESS )
3463 return( psa_cipher_abort( operation ) );
3464 else
3465 {
3466 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003467 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003468
Steven Cooremanef8575e2020-09-11 11:44:50 +02003469 return( status );
3470 }
mohammad1603503973b2018-03-12 15:59:30 +02003471}
3472
Gilles Peskinee553c652018-06-04 16:22:46 +02003473psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3474{
Ronald Cron49fafa92021-03-10 08:34:23 +01003475 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003476 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003477 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003478 * in use. It's ok to call abort on such an object, and there's
3479 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003480 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003481 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003482
Ronald Crondd24c9b2020-12-15 14:10:01 +01003483 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003484
Ronald Cron49fafa92021-03-10 08:34:23 +01003485 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003486 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003487 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003488
Moran Peker395db872018-05-31 14:07:14 +03003489 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003490}
3491
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003492psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3493 psa_algorithm_t alg,
3494 const uint8_t *input,
3495 size_t input_length,
3496 uint8_t *output,
3497 size_t output_size,
3498 size_t *output_length )
3499{
3500 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003501 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3502 psa_key_slot_t *slot;
3503 psa_key_type_t key_type;
3504 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003505
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003506 *output_length = 0;
3507
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003508 if( ! PSA_ALG_IS_CIPHER( alg ) )
3509 return( PSA_ERROR_INVALID_ARGUMENT );
3510
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003511 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3512 PSA_KEY_USAGE_ENCRYPT,
3513 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003514 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003515 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003516
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003517 psa_key_attributes_t attributes = {
3518 .core = slot->attr
3519 };
3520
3521 key_type = slot->attr.type;
3522 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3523
3524 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003525 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003526 if( output_size < iv_length )
3527 {
3528 status = PSA_ERROR_BUFFER_TOO_SMALL;
3529 goto exit;
3530 }
3531
3532 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003533 if( status != PSA_SUCCESS )
3534 goto exit;
3535 }
3536
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003537 status = psa_driver_wrapper_cipher_encrypt(
3538 &attributes, slot->key.data, slot->key.bytes,
3539 alg, input, input_length,
3540 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003541
3542exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003543 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003544
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003545 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003546}
3547
3548psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3549 psa_algorithm_t alg,
3550 const uint8_t *input,
3551 size_t input_length,
3552 uint8_t *output,
3553 size_t output_size,
3554 size_t *output_length )
3555{
3556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003557 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3558 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003559
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003560 *output_length = 0;
3561
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 if( ! PSA_ALG_IS_CIPHER( alg ) )
3563 return( PSA_ERROR_INVALID_ARGUMENT );
3564
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003565 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3566 PSA_KEY_USAGE_DECRYPT,
3567 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003568 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003569 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003570
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003571 psa_key_attributes_t attributes = {
3572 .core = slot->attr
3573 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003574
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003575 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3576 {
3577 status = PSA_ERROR_INVALID_ARGUMENT;
3578 goto exit;
3579 }
3580
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003581 status = psa_driver_wrapper_cipher_decrypt(
3582 &attributes, slot->key.data, slot->key.bytes,
3583 alg, input, input_length,
3584 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003585
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003586exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003587 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003588
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003589 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003590}
3591
3592
mohammad16035955c982018-04-26 00:53:03 +03003593/****************************************************************/
3594/* AEAD */
3595/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003596
Ronald Croncf56a0a2020-08-04 09:51:30 +02003597psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003598 psa_algorithm_t alg,
3599 const uint8_t *nonce,
3600 size_t nonce_length,
3601 const uint8_t *additional_data,
3602 size_t additional_data_length,
3603 const uint8_t *plaintext,
3604 size_t plaintext_length,
3605 uint8_t *ciphertext,
3606 size_t ciphertext_size,
3607 size_t *ciphertext_length )
3608{
Ronald Cron215633c2021-03-16 17:15:37 +01003609 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3610 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003611
mohammad1603f08a5502018-06-03 15:05:47 +03003612 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003613
Steven Cooremanea7ab132021-03-17 16:28:00 +01003614 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3615 return( PSA_ERROR_NOT_SUPPORTED );
3616
Ronald Cron9a986162021-03-26 12:40:07 +01003617 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003618 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003619 if( status != PSA_SUCCESS )
3620 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003621
Ronald Cron215633c2021-03-16 17:15:37 +01003622 psa_key_attributes_t attributes = {
3623 .core = slot->attr
3624 };
mohammad16035955c982018-04-26 00:53:03 +03003625
Ronald Cronde822812021-03-17 16:08:20 +01003626 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003627 &attributes, slot->key.data, slot->key.bytes,
3628 alg,
3629 nonce, nonce_length,
3630 additional_data, additional_data_length,
3631 plaintext, plaintext_length,
3632 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003633
Gilles Peskineedf9a652018-08-17 18:11:56 +02003634 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3635 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003636
Ronald Cron9f310172021-03-16 16:36:37 +01003637 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003638
mohammad16035955c982018-04-26 00:53:03 +03003639 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003640}
3641
Ronald Croncf56a0a2020-08-04 09:51:30 +02003642psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003643 psa_algorithm_t alg,
3644 const uint8_t *nonce,
3645 size_t nonce_length,
3646 const uint8_t *additional_data,
3647 size_t additional_data_length,
3648 const uint8_t *ciphertext,
3649 size_t ciphertext_length,
3650 uint8_t *plaintext,
3651 size_t plaintext_size,
3652 size_t *plaintext_length )
3653{
Ronald Cron215633c2021-03-16 17:15:37 +01003654 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3655 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003656
Gilles Peskineee652a32018-06-01 19:23:52 +02003657 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003658
Steven Cooremanea7ab132021-03-17 16:28:00 +01003659 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3660 return( PSA_ERROR_NOT_SUPPORTED );
3661
Ronald Cron9a986162021-03-26 12:40:07 +01003662 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003663 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003664 if( status != PSA_SUCCESS )
3665 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003666
Ronald Cron215633c2021-03-16 17:15:37 +01003667 psa_key_attributes_t attributes = {
3668 .core = slot->attr
3669 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003670
Ronald Cronde822812021-03-17 16:08:20 +01003671 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003672 &attributes, slot->key.data, slot->key.bytes,
3673 alg,
3674 nonce, nonce_length,
3675 additional_data, additional_data_length,
3676 ciphertext, ciphertext_length,
3677 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003678
Gilles Peskineedf9a652018-08-17 18:11:56 +02003679 if( status != PSA_SUCCESS && plaintext_size != 0 )
3680 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003681
Ronald Cron215633c2021-03-16 17:15:37 +01003682 psa_unlock_key_slot( slot );
3683
Gilles Peskineedf9a652018-08-17 18:11:56 +02003684 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003685}
3686
Gilles Peskinee59236f2018-01-27 23:32:46 +01003687/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003688/* Generators */
3689/****************************************************************/
3690
John Durkop07cc04a2020-11-16 22:08:34 -08003691#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3692 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3693 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3694#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003695#endif /* At least one builtin KDF */
3696
3697#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)
3700static psa_status_t psa_key_derivation_start_hmac(
3701 psa_mac_operation_t *operation,
3702 psa_algorithm_t hash_alg,
3703 const uint8_t *hmac_key,
3704 size_t hmac_key_length )
3705{
3706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3707 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3708 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3709 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3710 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3711
Steven Cooreman72f736a2021-05-07 14:14:37 +02003712 operation->is_sign = 1;
3713 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3714
Steven Cooreman094a77e2021-05-06 17:58:36 +02003715 status = psa_driver_wrapper_mac_sign_setup( operation,
3716 &attributes,
3717 hmac_key, hmac_key_length,
3718 PSA_ALG_HMAC( hash_alg ) );
3719
3720 psa_reset_key_attributes( &attributes );
3721 return( status );
3722}
3723#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003724
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003725#define HKDF_STATE_INIT 0 /* no input yet */
3726#define HKDF_STATE_STARTED 1 /* got salt */
3727#define HKDF_STATE_KEYED 2 /* got key */
3728#define HKDF_STATE_OUTPUT 3 /* output started */
3729
Gilles Peskinecbe66502019-05-16 16:59:18 +02003730static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003731 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003732{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003733 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3734 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003735 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003736 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003737}
3738
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003739psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003740{
3741 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003742 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003743 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003744 {
3745 /* The object has (apparently) been initialized but it is not
3746 * in use. It's ok to call abort on such an object, and there's
3747 * nothing to do. */
3748 }
3749 else
John Durkopd0321952020-10-29 21:37:36 -07003750#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003751 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003752 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003753 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003754 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003755 }
John Durkop07cc04a2020-11-16 22:08:34 -08003756 else
3757#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3758#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3759 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3760 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003761 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003762 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003763 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003764 if( operation->ctx.tls12_prf.secret != NULL )
3765 {
3766 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3767 operation->ctx.tls12_prf.secret_length );
3768 mbedtls_free( operation->ctx.tls12_prf.secret );
3769 }
3770
Janos Follath6a1d2622019-06-11 10:37:28 +01003771 if( operation->ctx.tls12_prf.seed != NULL )
3772 {
3773 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3774 operation->ctx.tls12_prf.seed_length );
3775 mbedtls_free( operation->ctx.tls12_prf.seed );
3776 }
3777
3778 if( operation->ctx.tls12_prf.label != NULL )
3779 {
3780 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3781 operation->ctx.tls12_prf.label_length );
3782 mbedtls_free( operation->ctx.tls12_prf.label );
3783 }
3784
Steven Cooremana6df6042021-04-29 19:32:25 +02003785 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003786
3787 /* We leave the fields Ai and output_block to be erased safely by the
3788 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003789 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003790 else
John Durkop07cc04a2020-11-16 22:08:34 -08003791#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3792 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003793 {
3794 status = PSA_ERROR_BAD_STATE;
3795 }
Janos Follath083036a2019-06-11 10:22:26 +01003796 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003797 return( status );
3798}
3799
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003800psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003801 size_t *capacity)
3802{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003803 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003804 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003805 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003806 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003807 }
3808
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003809 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003810 return( PSA_SUCCESS );
3811}
3812
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003813psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003814 size_t capacity )
3815{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003816 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003817 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003818 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003819 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003820 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003821 return( PSA_SUCCESS );
3822}
3823
John Durkopd0321952020-10-29 21:37:36 -07003824#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003825/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003826 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003827static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003828 psa_algorithm_t hash_alg,
3829 uint8_t *output,
3830 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003831{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003832 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003833 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003834 psa_status_t status;
3835
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003836 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3837 return( PSA_ERROR_BAD_STATE );
3838 hkdf->state = HKDF_STATE_OUTPUT;
3839
Gilles Peskinebef7f142018-07-12 17:22:21 +02003840 while( output_length != 0 )
3841 {
3842 /* Copy what remains of the current block */
3843 uint8_t n = hash_length - hkdf->offset_in_block;
3844 if( n > output_length )
3845 n = (uint8_t) output_length;
3846 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3847 output += n;
3848 output_length -= n;
3849 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003850 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003851 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003852 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003853 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003854 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003855 * object was corrupted or if this function is called directly
3856 * inside the library. */
3857 if( hkdf->block_number == 0xff )
3858 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003859
3860 /* We need a new block */
3861 ++hkdf->block_number;
3862 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003863
Steven Cooreman094a77e2021-05-06 17:58:36 +02003864 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3865 hash_alg,
3866 hkdf->prk,
3867 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003868 if( status != PSA_SUCCESS )
3869 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003870
Gilles Peskinebef7f142018-07-12 17:22:21 +02003871 if( hkdf->block_number != 1 )
3872 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003873 status = psa_mac_update( &hkdf->hmac,
3874 hkdf->output_block,
3875 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003876 if( status != PSA_SUCCESS )
3877 return( status );
3878 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003879 status = psa_mac_update( &hkdf->hmac,
3880 hkdf->info,
3881 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003882 if( status != PSA_SUCCESS )
3883 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003884 status = psa_mac_update( &hkdf->hmac,
3885 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003886 if( status != PSA_SUCCESS )
3887 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003888 status = psa_mac_sign_finish( &hkdf->hmac,
3889 hkdf->output_block,
3890 sizeof( hkdf->output_block ),
3891 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003892 if( status != PSA_SUCCESS )
3893 return( status );
3894 }
3895
3896 return( PSA_SUCCESS );
3897}
John Durkop07cc04a2020-11-16 22:08:34 -08003898#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003899
John Durkop07cc04a2020-11-16 22:08:34 -08003900#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3901 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003902static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3903 psa_tls12_prf_key_derivation_t *tls12_prf,
3904 psa_algorithm_t alg )
3905{
3906 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003907 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003908 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3909 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003910 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003911
Janos Follath7742fee2019-06-17 12:58:10 +01003912 /* We can't be wanting more output after block 0xff, otherwise
3913 * the capacity check in psa_key_derivation_output_bytes() would have
3914 * prevented this call. It could happen only if the operation
3915 * object was corrupted or if this function is called directly
3916 * inside the library. */
3917 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003918 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003919
3920 /* We need a new block */
3921 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003922 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003923
3924 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3925 *
3926 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3927 *
3928 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3929 * HMAC_hash(secret, A(2) + seed) +
3930 * HMAC_hash(secret, A(3) + seed) + ...
3931 *
3932 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003933 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003934 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003935 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003936 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003937 * is currently extracted as `output_block` and where i is
3938 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003939 */
3940
Steven Cooreman094a77e2021-05-06 17:58:36 +02003941 status = psa_key_derivation_start_hmac( &hmac,
3942 hash_alg,
3943 tls12_prf->secret,
3944 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003945 if( status != PSA_SUCCESS )
3946 goto cleanup;
3947
3948 /* Calculate A(i) where i = tls12_prf->block_number. */
3949 if( tls12_prf->block_number == 1 )
3950 {
3951 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3952 * the variable seed and in this instance means it in the context of the
3953 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003954 status = psa_mac_update( &hmac,
3955 tls12_prf->label,
3956 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003957 if( status != PSA_SUCCESS )
3958 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003959 status = psa_mac_update( &hmac,
3960 tls12_prf->seed,
3961 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003962 if( status != PSA_SUCCESS )
3963 goto cleanup;
3964 }
3965 else
3966 {
3967 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003968 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003969 if( status != PSA_SUCCESS )
3970 goto cleanup;
3971 }
3972
Steven Cooremana6df6042021-04-29 19:32:25 +02003973 status = psa_mac_sign_finish( &hmac,
3974 tls12_prf->Ai, hash_length,
3975 &hmac_output_length );
3976 if( hmac_output_length != hash_length )
3977 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003978 if( status != PSA_SUCCESS )
3979 goto cleanup;
3980
3981 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003982 status = psa_key_derivation_start_hmac( &hmac,
3983 hash_alg,
3984 tls12_prf->secret,
3985 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003986 if( status != PSA_SUCCESS )
3987 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003988 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003989 if( status != PSA_SUCCESS )
3990 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003991 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_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->seed, tls12_prf->seed_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_sign_finish( &hmac,
3998 tls12_prf->output_block, hash_length,
3999 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004000 if( status != PSA_SUCCESS )
4001 goto cleanup;
4002
Janos Follath7742fee2019-06-17 12:58:10 +01004003
4004cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004005 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004006 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4007 status = cleanup_status;
4008
4009 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004010}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004011
Janos Follath844eb0e2019-06-19 12:10:49 +01004012static psa_status_t psa_key_derivation_tls12_prf_read(
4013 psa_tls12_prf_key_derivation_t *tls12_prf,
4014 psa_algorithm_t alg,
4015 uint8_t *output,
4016 size_t output_length )
4017{
4018 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004019 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004020 psa_status_t status;
4021 uint8_t offset, length;
4022
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004023 switch( tls12_prf->state )
4024 {
4025 case PSA_TLS12_PRF_STATE_LABEL_SET:
4026 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4027 break;
4028 case PSA_TLS12_PRF_STATE_OUTPUT:
4029 break;
4030 default:
4031 return( PSA_ERROR_BAD_STATE );
4032 }
4033
Janos Follath844eb0e2019-06-19 12:10:49 +01004034 while( output_length != 0 )
4035 {
4036 /* Check if we have fully processed the current block. */
4037 if( tls12_prf->left_in_block == 0 )
4038 {
4039 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4040 alg );
4041 if( status != PSA_SUCCESS )
4042 return( status );
4043
4044 continue;
4045 }
4046
4047 if( tls12_prf->left_in_block > output_length )
4048 length = (uint8_t) output_length;
4049 else
4050 length = tls12_prf->left_in_block;
4051
4052 offset = hash_length - tls12_prf->left_in_block;
4053 memcpy( output, tls12_prf->output_block + offset, length );
4054 output += length;
4055 output_length -= length;
4056 tls12_prf->left_in_block -= length;
4057 }
4058
4059 return( PSA_SUCCESS );
4060}
John Durkop07cc04a2020-11-16 22:08:34 -08004061#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4062 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004063
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004064psa_status_t psa_key_derivation_output_bytes(
4065 psa_key_derivation_operation_t *operation,
4066 uint8_t *output,
4067 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004068{
4069 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004070 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004071
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004072 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004073 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004074 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004075 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004076 }
4077
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004078 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004079 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004080 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004081 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004082 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004083 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004084 goto exit;
4085 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004086 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004087 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004088 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004089 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004090 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4091 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004092 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004093 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004094 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004095 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004096 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004097
John Durkopd0321952020-10-29 21:37:36 -07004098#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004099 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004100 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004101 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004102 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004103 output, output_length );
4104 }
Janos Follathadbec812019-06-14 11:05:39 +01004105 else
John Durkop07cc04a2020-11-16 22:08:34 -08004106#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4107#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4108 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004109 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004110 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004111 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004112 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004113 kdf_alg, output,
4114 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004115 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004116 else
John Durkop07cc04a2020-11-16 22:08:34 -08004117#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4118 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004119 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004120 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004121 return( PSA_ERROR_BAD_STATE );
4122 }
4123
4124exit:
4125 if( status != PSA_SUCCESS )
4126 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004127 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004128 * This allows us to differentiate between exhausted operations and
4129 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4130 * operations. */
4131 psa_algorithm_t alg = operation->alg;
4132 psa_key_derivation_abort( operation );
4133 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004134 memset( output, '!', output_length );
4135 }
4136 return( status );
4137}
4138
David Brown7807bf72021-02-09 16:28:23 -07004139#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004140static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4141{
4142 if( data_size >= 8 )
4143 mbedtls_des_key_set_parity( data );
4144 if( data_size >= 16 )
4145 mbedtls_des_key_set_parity( data + 8 );
4146 if( data_size >= 24 )
4147 mbedtls_des_key_set_parity( data + 16 );
4148}
David Brown7807bf72021-02-09 16:28:23 -07004149#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004150
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004151static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004152 psa_key_slot_t *slot,
4153 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004154 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004155{
4156 uint8_t *data = NULL;
4157 size_t bytes = PSA_BITS_TO_BYTES( bits );
4158 psa_status_t status;
4159
Gilles Peskine8e338702019-07-30 20:06:31 +02004160 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004161 return( PSA_ERROR_INVALID_ARGUMENT );
4162 if( bits % 8 != 0 )
4163 return( PSA_ERROR_INVALID_ARGUMENT );
4164 data = mbedtls_calloc( 1, bytes );
4165 if( data == NULL )
4166 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4167
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004168 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004169 if( status != PSA_SUCCESS )
4170 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004171#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004172 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004173 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004174#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004175
4176 status = psa_allocate_buffer_to_slot( slot, bytes );
4177 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004178 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004179
Ronald Cronbf33c932020-11-28 18:06:53 +01004180 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004181 psa_key_attributes_t attributes = {
4182 .core = slot->attr
4183 };
4184
Ronald Cronbf33c932020-11-28 18:06:53 +01004185 status = psa_driver_wrapper_import_key( &attributes,
4186 data, bytes,
4187 slot->key.data,
4188 slot->key.bytes,
4189 &slot->key.bytes, &bits );
4190 if( bits != slot->attr.bits )
4191 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004192
4193exit:
4194 mbedtls_free( data );
4195 return( status );
4196}
4197
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004198psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004199 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004200 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004201{
4202 psa_status_t status;
4203 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004204 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004205
Ronald Cron81709fc2020-11-14 12:10:32 +01004206 *key = MBEDTLS_SVC_KEY_ID_INIT;
4207
Gilles Peskine0f84d622019-09-12 19:03:13 +02004208 /* Reject any attempt to create a zero-length key so that we don't
4209 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4210 if( psa_get_key_bits( attributes ) == 0 )
4211 return( PSA_ERROR_INVALID_ARGUMENT );
4212
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004213 if( ! operation->can_output_key )
4214 return( PSA_ERROR_NOT_PERMITTED );
4215
Ronald Cron81709fc2020-11-14 12:10:32 +01004216 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4217 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004218#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4219 if( driver != NULL )
4220 {
4221 /* Deriving a key in a secure element is not implemented yet. */
4222 status = PSA_ERROR_NOT_SUPPORTED;
4223 }
4224#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004225 if( status == PSA_SUCCESS )
4226 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004227 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004228 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004229 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004230 }
4231 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004232 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004233 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004234 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004235
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004236 return( status );
4237}
4238
Gilles Peskineeab56e42018-07-12 17:12:33 +02004239
4240
4241/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004242/* Key derivation */
4243/****************************************************************/
4244
Steven Cooreman932ffb72021-02-15 12:14:32 +01004245#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004246static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004247 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004248 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004249{
John Durkop07cc04a2020-11-16 22:08:34 -08004250 int is_kdf_alg_supported;
4251
Janos Follath5fe19732019-06-20 15:09:30 +01004252 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4253 * initialisers for this union leave some bytes unspecified.) */
4254 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4255
Gilles Peskine969c5d62019-01-16 15:53:06 +01004256 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004257#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004258 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4259 is_kdf_alg_supported = 1;
4260 else
4261#endif
4262#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4263 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4264 is_kdf_alg_supported = 1;
4265 else
4266#endif
4267#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4268 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4269 is_kdf_alg_supported = 1;
4270 else
4271#endif
4272 is_kdf_alg_supported = 0;
4273
4274 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004275 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004276 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004277 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004278 if( hash_size == 0 )
4279 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004280 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4281 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004282 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004283 {
4284 return( PSA_ERROR_NOT_SUPPORTED );
4285 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004286 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004287 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004288 }
John Durkop07cc04a2020-11-16 22:08:34 -08004289
4290 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004291}
John Durkop07cc04a2020-11-16 22:08:34 -08004292#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004293
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004294psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004295 psa_algorithm_t alg )
4296{
4297 psa_status_t status;
4298
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004299 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004300 return( PSA_ERROR_BAD_STATE );
4301
Gilles Peskine6843c292019-01-18 16:44:49 +01004302 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4303 return( PSA_ERROR_INVALID_ARGUMENT );
4304 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004305 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004306#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004307 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004308 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004309#else
4310 return( PSA_ERROR_NOT_SUPPORTED );
4311#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004312 }
4313 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4314 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004315#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004316 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004317#else
4318 return( PSA_ERROR_NOT_SUPPORTED );
4319#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004320 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004321 else
4322 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004323
4324 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004325 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004326 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004327}
4328
John Durkopd0321952020-10-29 21:37:36 -07004329#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004330static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331 psa_algorithm_t hash_alg,
4332 psa_key_derivation_step_t step,
4333 const uint8_t *data,
4334 size_t data_length )
4335{
4336 psa_status_t status;
4337 switch( step )
4338 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004339 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004340 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004341 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004342 else
4343 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004344 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4345 hash_alg,
4346 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004347 if( status != PSA_SUCCESS )
4348 return( status );
4349 hkdf->state = HKDF_STATE_STARTED;
4350 return( PSA_SUCCESS );
4351 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004352 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004353 /* If no salt was provided, use an empty salt. */
4354 if( hkdf->state == HKDF_STATE_INIT )
4355 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004356 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4357 hash_alg,
4358 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004359 if( status != PSA_SUCCESS )
4360 return( status );
4361 hkdf->state = HKDF_STATE_STARTED;
4362 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004363 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004364 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004365 status = psa_mac_update( &hkdf->hmac,
4366 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004367 if( status != PSA_SUCCESS )
4368 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004369 status = psa_mac_sign_finish( &hkdf->hmac,
4370 hkdf->prk,
4371 sizeof( hkdf->prk ),
4372 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004373 if( status != PSA_SUCCESS )
4374 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004375 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004376 hkdf->block_number = 0;
4377 hkdf->state = HKDF_STATE_KEYED;
4378 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004379 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004380 if( hkdf->state == HKDF_STATE_OUTPUT )
4381 return( PSA_ERROR_BAD_STATE );
4382 if( hkdf->info_set )
4383 return( PSA_ERROR_BAD_STATE );
4384 hkdf->info_length = data_length;
4385 if( data_length != 0 )
4386 {
4387 hkdf->info = mbedtls_calloc( 1, data_length );
4388 if( hkdf->info == NULL )
4389 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4390 memcpy( hkdf->info, data, data_length );
4391 }
4392 hkdf->info_set = 1;
4393 return( PSA_SUCCESS );
4394 default:
4395 return( PSA_ERROR_INVALID_ARGUMENT );
4396 }
4397}
John Durkop07cc04a2020-11-16 22:08:34 -08004398#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004399
John Durkop07cc04a2020-11-16 22:08:34 -08004400#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4401 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004402static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4403 const uint8_t *data,
4404 size_t data_length )
4405{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004406 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004407 return( PSA_ERROR_BAD_STATE );
4408
Janos Follathd6dce9f2019-07-04 09:11:38 +01004409 if( data_length != 0 )
4410 {
4411 prf->seed = mbedtls_calloc( 1, data_length );
4412 if( prf->seed == NULL )
4413 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004414
Janos Follathd6dce9f2019-07-04 09:11:38 +01004415 memcpy( prf->seed, data, data_length );
4416 prf->seed_length = data_length;
4417 }
Janos Follathf08e2652019-06-13 09:05:41 +01004418
Gilles Peskine43f958b2020-12-13 14:55:14 +01004419 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004420
4421 return( PSA_SUCCESS );
4422}
4423
Janos Follath81550542019-06-13 14:26:34 +01004424static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004425 const uint8_t *data,
4426 size_t data_length )
4427{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004428 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004429 return( PSA_ERROR_BAD_STATE );
4430
Steven Cooremana6df6042021-04-29 19:32:25 +02004431 if( data_length != 0 )
4432 {
4433 prf->secret = mbedtls_calloc( 1, data_length );
4434 if( prf->secret == NULL )
4435 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4436
4437 memcpy( prf->secret, data, data_length );
4438 prf->secret_length = data_length;
4439 }
Janos Follath81550542019-06-13 14:26:34 +01004440
Gilles Peskine43f958b2020-12-13 14:55:14 +01004441 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004442
4443 return( PSA_SUCCESS );
4444}
4445
Janos Follath63028dd2019-06-13 09:15:47 +01004446static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4447 const uint8_t *data,
4448 size_t data_length )
4449{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004450 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004451 return( PSA_ERROR_BAD_STATE );
4452
Janos Follathd6dce9f2019-07-04 09:11:38 +01004453 if( data_length != 0 )
4454 {
4455 prf->label = mbedtls_calloc( 1, data_length );
4456 if( prf->label == NULL )
4457 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004458
Janos Follathd6dce9f2019-07-04 09:11:38 +01004459 memcpy( prf->label, data, data_length );
4460 prf->label_length = data_length;
4461 }
Janos Follath63028dd2019-06-13 09:15:47 +01004462
Gilles Peskine43f958b2020-12-13 14:55:14 +01004463 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004464
4465 return( PSA_SUCCESS );
4466}
4467
Janos Follathb03233e2019-06-11 15:30:30 +01004468static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004469 psa_key_derivation_step_t step,
4470 const uint8_t *data,
4471 size_t data_length )
4472{
Janos Follathb03233e2019-06-11 15:30:30 +01004473 switch( step )
4474 {
Janos Follathf08e2652019-06-13 09:05:41 +01004475 case PSA_KEY_DERIVATION_INPUT_SEED:
4476 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004477 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004478 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004479 case PSA_KEY_DERIVATION_INPUT_LABEL:
4480 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004481 default:
4482 return( PSA_ERROR_INVALID_ARGUMENT );
4483 }
4484}
John Durkop07cc04a2020-11-16 22:08:34 -08004485#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4486 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4487
4488#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4489static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4490 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004491 const uint8_t *data,
4492 size_t data_length )
4493{
4494 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004495 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004496 uint8_t *cur = pms;
4497
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004498 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004499 return( PSA_ERROR_INVALID_ARGUMENT );
4500
4501 /* Quoting RFC 4279, Section 2:
4502 *
4503 * The premaster secret is formed as follows: if the PSK is N octets
4504 * long, concatenate a uint16 with the value N, N zero octets, a second
4505 * uint16 with the value N, and the PSK itself.
4506 */
4507
4508 *cur++ = ( data_length >> 8 ) & 0xff;
4509 *cur++ = ( data_length >> 0 ) & 0xff;
4510 memset( cur, 0, data_length );
4511 cur += data_length;
4512 *cur++ = pms[0];
4513 *cur++ = pms[1];
4514 memcpy( cur, data, data_length );
4515 cur += data_length;
4516
Steven Cooremana6df6042021-04-29 19:32:25 +02004517 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004518
4519 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4520 return( status );
4521}
Janos Follath6660f0e2019-06-17 08:44:03 +01004522
4523static psa_status_t psa_tls12_prf_psk_to_ms_input(
4524 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004525 psa_key_derivation_step_t step,
4526 const uint8_t *data,
4527 size_t data_length )
4528{
4529 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004530 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004531 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004532 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004533 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004534
Steven Cooremana6df6042021-04-29 19:32:25 +02004535 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004536}
John Durkop07cc04a2020-11-16 22:08:34 -08004537#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004538
Gilles Peskineb8965192019-09-24 16:21:10 +02004539/** Check whether the given key type is acceptable for the given
4540 * input step of a key derivation.
4541 *
4542 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4543 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4544 * Both secret and non-secret inputs can alternatively have the type
4545 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4546 * that the input was passed as a buffer rather than via a key object.
4547 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004548static int psa_key_derivation_check_input_type(
4549 psa_key_derivation_step_t step,
4550 psa_key_type_t key_type )
4551{
4552 switch( step )
4553 {
4554 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004555 if( key_type == PSA_KEY_TYPE_DERIVE )
4556 return( PSA_SUCCESS );
4557 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004558 return( PSA_SUCCESS );
4559 break;
4560 case PSA_KEY_DERIVATION_INPUT_LABEL:
4561 case PSA_KEY_DERIVATION_INPUT_SALT:
4562 case PSA_KEY_DERIVATION_INPUT_INFO:
4563 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004564 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4565 return( PSA_SUCCESS );
4566 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004567 return( PSA_SUCCESS );
4568 break;
4569 }
4570 return( PSA_ERROR_INVALID_ARGUMENT );
4571}
4572
Janos Follathb80a94e2019-06-12 15:54:46 +01004573static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004574 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004575 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004576 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004577 const uint8_t *data,
4578 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004579{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004580 psa_status_t status;
4581 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4582
4583 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004584 if( status != PSA_SUCCESS )
4585 goto exit;
4586
John Durkopd0321952020-10-29 21:37:36 -07004587#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004588 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004589 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004590 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004591 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004592 step, data, data_length );
4593 }
John Durkop07cc04a2020-11-16 22:08:34 -08004594 else
4595#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4596#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4597 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004598 {
Janos Follathb03233e2019-06-11 15:30:30 +01004599 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004600 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004601 }
John Durkop07cc04a2020-11-16 22:08:34 -08004602 else
4603#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4604#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4605 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004606 {
4607 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004608 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004609 }
4610 else
John Durkop07cc04a2020-11-16 22:08:34 -08004611#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004612 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004613 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004614 (void) data;
4615 (void) data_length;
4616 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004617 return( PSA_ERROR_BAD_STATE );
4618 }
4619
Gilles Peskine224b0d62019-09-23 18:13:17 +02004620exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004621 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004622 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004623 return( status );
4624}
4625
Janos Follath51f4a0f2019-06-14 11:35:55 +01004626psa_status_t psa_key_derivation_input_bytes(
4627 psa_key_derivation_operation_t *operation,
4628 psa_key_derivation_step_t step,
4629 const uint8_t *data,
4630 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004631{
Gilles Peskineb8965192019-09-24 16:21:10 +02004632 return( psa_key_derivation_input_internal( operation, step,
4633 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004634 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004635}
4636
Janos Follath51f4a0f2019-06-14 11:35:55 +01004637psa_status_t psa_key_derivation_input_key(
4638 psa_key_derivation_operation_t *operation,
4639 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004640 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004641{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004642 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004643 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004644 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004645
Ronald Cron5c522922020-11-14 16:35:34 +01004646 status = psa_get_and_lock_transparent_key_slot_with_policy(
4647 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004648 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004649 {
4650 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004651 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004652 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004653
4654 /* Passing a key object as a SECRET input unlocks the permission
4655 * to output to a key object. */
4656 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4657 operation->can_output_key = 1;
4658
Ronald Cronf95a2b12020-10-22 15:24:49 +02004659 status = psa_key_derivation_input_internal( operation,
4660 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004661 slot->key.data,
4662 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004663
Ronald Cron5c522922020-11-14 16:35:34 +01004664 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004665
Ronald Cron5c522922020-11-14 16:35:34 +01004666 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004667}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004668
4669
4670
4671/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004672/* Key agreement */
4673/****************************************************************/
4674
John Durkop6ba40d12020-11-10 08:50:04 -08004675#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004676static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4677 size_t peer_key_length,
4678 const mbedtls_ecp_keypair *our_key,
4679 uint8_t *shared_secret,
4680 size_t shared_secret_size,
4681 size_t *shared_secret_length )
4682{
Steven Cooremand4867872020-08-05 16:31:39 +02004683 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004684 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004685 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004686 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004687 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004688 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004689
Ronald Cron90857082020-11-25 14:58:33 +01004690 status = mbedtls_psa_ecp_load_representation(
4691 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004692 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004693 peer_key,
4694 peer_key_length,
4695 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004696 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004697 goto exit;
4698
Jaeden Amero97271b32019-01-10 19:38:51 +00004699 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004700 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004701 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004702 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004703 status = mbedtls_to_psa_error(
4704 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4705 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004706 goto exit;
4707
Jaeden Amero97271b32019-01-10 19:38:51 +00004708 status = mbedtls_to_psa_error(
4709 mbedtls_ecdh_calc_secret( &ecdh,
4710 shared_secret_length,
4711 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004712 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004713 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004714 if( status != PSA_SUCCESS )
4715 goto exit;
4716 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4717 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004718
4719exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004720 if( status != PSA_SUCCESS )
4721 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004722 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004723 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004724 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004725
Jaeden Amero97271b32019-01-10 19:38:51 +00004726 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004727}
John Durkop6ba40d12020-11-10 08:50:04 -08004728#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004729
Gilles Peskine01d718c2018-09-18 12:01:02 +02004730#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4731
Gilles Peskine0216fe12019-04-11 21:23:21 +02004732static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4733 psa_key_slot_t *private_key,
4734 const uint8_t *peer_key,
4735 size_t peer_key_length,
4736 uint8_t *shared_secret,
4737 size_t shared_secret_size,
4738 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004739{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004740 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004741 {
John Durkop6ba40d12020-11-10 08:50:04 -08004742#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004743 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004744 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004745 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004746 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004747 psa_status_t status = mbedtls_psa_ecp_load_representation(
4748 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004749 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004750 private_key->key.data,
4751 private_key->key.bytes,
4752 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004753 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004754 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004755 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004756 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004757 shared_secret, shared_secret_size,
4758 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004759 mbedtls_ecp_keypair_free( ecp );
4760 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004761 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004762#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004763 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004764 (void) private_key;
4765 (void) peer_key;
4766 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004767 (void) shared_secret;
4768 (void) shared_secret_size;
4769 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004770 return( PSA_ERROR_NOT_SUPPORTED );
4771 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004772}
4773
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004774/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004775 * to potentially free embedded data structures and wipe confidential data.
4776 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004777static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004778 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004779 psa_key_slot_t *private_key,
4780 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004781 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004782{
4783 psa_status_t status;
4784 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4785 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004786 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004787
4788 /* Step 1: run the secret agreement algorithm to generate the shared
4789 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004790 status = psa_key_agreement_raw_internal( ka_alg,
4791 private_key,
4792 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004793 shared_secret,
4794 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004795 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004796 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004797 goto exit;
4798
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004799 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004800 * the shared secret. A shared secret is permitted wherever a key
4801 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004802 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004803 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004804 shared_secret,
4805 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004806exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004807 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004808 return( status );
4809}
4810
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004811psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004812 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004813 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004814 const uint8_t *peer_key,
4815 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004816{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004817 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004818 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004819 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004820
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004821 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004822 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004823 status = psa_get_and_lock_transparent_key_slot_with_policy(
4824 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004825 if( status != PSA_SUCCESS )
4826 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004827 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004828 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004829 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004830 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004831 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004832 else
4833 {
4834 /* If a private key has been added as SECRET, we allow the derived
4835 * key material to be used as a key in PSA Crypto. */
4836 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4837 operation->can_output_key = 1;
4838 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004839
Ronald Cron5c522922020-11-14 16:35:34 +01004840 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004841
Ronald Cron5c522922020-11-14 16:35:34 +01004842 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004843}
4844
Gilles Peskinebe697d82019-05-16 18:00:41 +02004845psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004846 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004847 const uint8_t *peer_key,
4848 size_t peer_key_length,
4849 uint8_t *output,
4850 size_t output_size,
4851 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004852{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004853 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004854 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004855 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004856
4857 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4858 {
4859 status = PSA_ERROR_INVALID_ARGUMENT;
4860 goto exit;
4861 }
Ronald Cron5c522922020-11-14 16:35:34 +01004862 status = psa_get_and_lock_transparent_key_slot_with_policy(
4863 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004864 if( status != PSA_SUCCESS )
4865 goto exit;
4866
4867 status = psa_key_agreement_raw_internal( alg, slot,
4868 peer_key, peer_key_length,
4869 output, output_size,
4870 output_length );
4871
4872exit:
4873 if( status != PSA_SUCCESS )
4874 {
4875 /* If an error happens and is not handled properly, the output
4876 * may be used as a key to protect sensitive data. Arrange for such
4877 * a key to be random, which is likely to result in decryption or
4878 * verification errors. This is better than filling the buffer with
4879 * some constant data such as zeros, which would result in the data
4880 * being protected with a reproducible, easily knowable key.
4881 */
4882 psa_generate_random( output, output_size );
4883 *output_length = output_size;
4884 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004885
Ronald Cron5c522922020-11-14 16:35:34 +01004886 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004887
Ronald Cron5c522922020-11-14 16:35:34 +01004888 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004889}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004890
4891
Gilles Peskine30524eb2020-11-13 17:02:26 +01004892
Gilles Peskine86a440b2018-11-12 18:39:40 +01004893/****************************************************************/
4894/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004895/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004896
Gilles Peskine30524eb2020-11-13 17:02:26 +01004897/** Initialize the PSA random generator.
4898 */
4899static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4900{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004901#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4902 memset( rng, 0, sizeof( *rng ) );
4903#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4904
Gilles Peskine30524eb2020-11-13 17:02:26 +01004905 /* Set default configuration if
4906 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4907 if( rng->entropy_init == NULL )
4908 rng->entropy_init = mbedtls_entropy_init;
4909 if( rng->entropy_free == NULL )
4910 rng->entropy_free = mbedtls_entropy_free;
4911
4912 rng->entropy_init( &rng->entropy );
4913#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4914 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4915 /* The PSA entropy injection feature depends on using NV seed as an entropy
4916 * source. Add NV seed as an entropy source for PSA entropy injection. */
4917 mbedtls_entropy_add_source( &rng->entropy,
4918 mbedtls_nv_seed_poll, NULL,
4919 MBEDTLS_ENTROPY_BLOCK_SIZE,
4920 MBEDTLS_ENTROPY_SOURCE_STRONG );
4921#endif
4922
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004923 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004924#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004925}
4926
4927/** Deinitialize the PSA random generator.
4928 */
4929static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4930{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004931#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4932 memset( rng, 0, sizeof( *rng ) );
4933#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004934 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004935 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004936#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004937}
4938
4939/** Seed the PSA random generator.
4940 */
4941static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4942{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004943#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4944 /* Do nothing: the external RNG seeds itself. */
4945 (void) rng;
4946 return( PSA_SUCCESS );
4947#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004948 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004949 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4950 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004951 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004952#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004953}
4954
Gilles Peskinee59236f2018-01-27 23:32:46 +01004955psa_status_t psa_generate_random( uint8_t *output,
4956 size_t output_size )
4957{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004958 GUARD_MODULE_INITIALIZED;
4959
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004960#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4961
4962 size_t output_length = 0;
4963 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4964 output, output_size,
4965 &output_length );
4966 if( status != PSA_SUCCESS )
4967 return( status );
4968 /* Breaking up a request into smaller chunks is currently not supported
4969 * for the extrernal RNG interface. */
4970 if( output_length != output_size )
4971 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4972 return( PSA_SUCCESS );
4973
4974#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4975
Gilles Peskine71ddab92021-01-04 21:01:07 +01004976 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004977 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004978 size_t request_size =
4979 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4980 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4981 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004982 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4983 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004984 if( ret != 0 )
4985 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004986 output_size -= request_size;
4987 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004988 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004989 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004990#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004991}
4992
Gilles Peskine8814fc42020-12-14 15:33:44 +01004993/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004994 *
4995 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4996 * `psa_generate_random(...)`. The state parameter is ignored since the
4997 * PSA API doesn't support passing an explicit state.
4998 *
4999 * In the non-external case, psa_generate_random() calls an
5000 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5001 * and semantics as mbedtls_psa_get_random(). As an optimization,
5002 * instead of doing this back-and-forth between the PSA API and the
5003 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5004 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005005 */
5006#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5007int mbedtls_psa_get_random( void *p_rng,
5008 unsigned char *output,
5009 size_t output_size )
5010{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005011 /* This function takes a pointer to the RNG state because that's what
5012 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5013 * its own state internally and doesn't let the caller access that state.
5014 * So we just ignore the state parameter, and in practice we'll pass
5015 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005016 (void) p_rng;
5017 psa_status_t status = psa_generate_random( output, output_size );
5018 if( status == PSA_SUCCESS )
5019 return( 0 );
5020 else
5021 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5022}
5023#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5024
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005025#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005026#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005027
Gilles Peskine7228da22019-07-15 11:06:15 +02005028psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005029 size_t seed_size )
5030{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005031 if( global_data.initialized )
5032 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005033
5034 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5035 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5036 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5037 return( PSA_ERROR_INVALID_ARGUMENT );
5038
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005039 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005040}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005041#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005042
Ronald Cron3772afe2021-02-08 16:10:05 +01005043/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005044 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005045 * \param type The key type
5046 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005047 *
5048 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005049 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005050 * \retval #PSA_ERROR_INVALID_ARGUMENT
5051 * The size in bits of the key is not valid.
5052 * \retval #PSA_ERROR_NOT_SUPPORTED
5053 * The type and/or the size in bits of the key or the combination of
5054 * the two is not supported.
5055 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005056static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5057 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005058{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005060
Gilles Peskinee59236f2018-01-27 23:32:46 +01005061 if( key_type_is_raw_bytes( type ) )
5062 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005063 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005064 if( status != PSA_SUCCESS )
5065 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005066 }
5067 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005068#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005069 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5070 {
5071 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5072 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005073
Ronald Cron01b2aba2020-10-05 09:42:02 +02005074 /* Accept only byte-aligned keys, for the same reasons as
5075 * in psa_import_rsa_key(). */
5076 if( bits % 8 != 0 )
5077 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005078 }
5079 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005080#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005081
Ronald Cron5c4d3862020-12-07 11:07:24 +01005082#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005083 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5084 {
Ronald Crond81ab562021-02-16 09:01:16 +01005085 /* To avoid empty block, return successfully here. */
5086 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005087 }
5088 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005089#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005090 {
5091 return( PSA_ERROR_NOT_SUPPORTED );
5092 }
5093
5094 return( PSA_SUCCESS );
5095}
5096
Ronald Cron55ed0592020-10-05 10:30:40 +02005097psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005098 const psa_key_attributes_t *attributes,
5099 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005100{
5101 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005102 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005103
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005104 if( ( attributes->domain_parameters == NULL ) &&
5105 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005106 return( PSA_ERROR_INVALID_ARGUMENT );
5107
Ronald Cron01b2aba2020-10-05 09:42:02 +02005108 if( key_type_is_raw_bytes( type ) )
5109 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005110 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005111 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005112 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005113
David Brown12ca5032021-02-11 11:02:00 -07005114#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005115 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005116 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005117#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005118 }
5119 else
5120
Jaeden Amero424fa932021-05-14 08:34:32 +01005121#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5122 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005123 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005124 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005125 return( mbedtls_psa_rsa_generate_key( attributes,
5126 key_buffer,
5127 key_buffer_size,
5128 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005129 }
5130 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005131#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5132 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005133
John Durkop9814fa22020-11-04 12:28:15 -08005134#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005135 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005136 {
Ronald Cron7023db52020-11-20 18:17:42 +01005137 return( mbedtls_psa_ecp_generate_key( attributes,
5138 key_buffer,
5139 key_buffer_size,
5140 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005141 }
5142 else
John Durkop9814fa22020-11-04 12:28:15 -08005143#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005144 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005145 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005146 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005147 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005148
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005149 return( PSA_SUCCESS );
5150}
Darryl Green0c6575a2018-11-07 16:05:30 +00005151
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005152psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005153 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005154{
5155 psa_status_t status;
5156 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005157 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005158 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005159
Ronald Cron81709fc2020-11-14 12:10:32 +01005160 *key = MBEDTLS_SVC_KEY_ID_INIT;
5161
Gilles Peskine0f84d622019-09-12 19:03:13 +02005162 /* Reject any attempt to create a zero-length key so that we don't
5163 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5164 if( psa_get_key_bits( attributes ) == 0 )
5165 return( PSA_ERROR_INVALID_ARGUMENT );
5166
Ronald Cron81709fc2020-11-14 12:10:32 +01005167 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5168 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005169 if( status != PSA_SUCCESS )
5170 goto exit;
5171
Ronald Cron977c2472020-10-13 08:32:21 +02005172 /* In the case of a transparent key or an opaque key stored in local
5173 * storage (thus not in the case of generating a key in a secure element
5174 * or cryptoprocessor with storage), we have to allocate a buffer to
5175 * hold the generated key material. */
5176 if( slot->key.data == NULL )
5177 {
5178 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5179 PSA_KEY_LOCATION_LOCAL_STORAGE )
5180 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005181 status = psa_validate_key_type_and_size_for_key_generation(
5182 attributes->core.type, attributes->core.bits );
5183 if( status != PSA_SUCCESS )
5184 goto exit;
5185
5186 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5187 attributes->core.type,
5188 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005189 }
5190 else
5191 {
5192 status = psa_driver_wrapper_get_key_buffer_size(
5193 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005194 if( status != PSA_SUCCESS )
5195 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005196 }
Ronald Cron977c2472020-10-13 08:32:21 +02005197
5198 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5199 if( status != PSA_SUCCESS )
5200 goto exit;
5201 }
5202
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005203 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005204 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005205
Ronald Cron2b56bc82020-10-05 10:02:26 +02005206 if( status != PSA_SUCCESS )
5207 psa_remove_key_data_from_memory( slot );
5208
Gilles Peskine11792082019-08-06 18:36:36 +02005209exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005210 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005211 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005212 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005213 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005214
Darryl Green0c6575a2018-11-07 16:05:30 +00005215 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005216}
5217
Gilles Peskinee59236f2018-01-27 23:32:46 +01005218/****************************************************************/
5219/* Module setup */
5220/****************************************************************/
5221
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005222#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005223psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5224 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5225 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5226{
5227 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5228 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005229 global_data.rng.entropy_init = entropy_init;
5230 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005231 return( PSA_SUCCESS );
5232}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005233#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005234
Gilles Peskinee59236f2018-01-27 23:32:46 +01005235void mbedtls_psa_crypto_free( void )
5236{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005237 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005238 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5239 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005240 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005241 }
5242 /* Wipe all remaining data, including configuration.
5243 * In particular, this sets all state indicator to the value
5244 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005245 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005246#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005247 /* Unregister all secure element drivers, so that we restart from
5248 * a pristine state. */
5249 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005250#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005251}
5252
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005253#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5254/** Recover a transaction that was interrupted by a power failure.
5255 *
5256 * This function is called during initialization, before psa_crypto_init()
5257 * returns. If this function returns a failure status, the initialization
5258 * fails.
5259 */
5260static psa_status_t psa_crypto_recover_transaction(
5261 const psa_crypto_transaction_t *transaction )
5262{
5263 switch( transaction->unknown.type )
5264 {
5265 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5266 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005267 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005268 * is implemented.
5269 * https://github.com/ARMmbed/mbed-crypto/issues/218
5270 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005271 default:
5272 /* We found an unsupported transaction in the storage.
5273 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005274 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005275 }
5276}
5277#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5278
Gilles Peskinee59236f2018-01-27 23:32:46 +01005279psa_status_t psa_crypto_init( void )
5280{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005281 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005282
Gilles Peskinec6b69072018-11-20 21:42:52 +01005283 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005284 if( global_data.initialized != 0 )
5285 return( PSA_SUCCESS );
5286
Gilles Peskine30524eb2020-11-13 17:02:26 +01005287 /* Initialize and seed the random generator. */
5288 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005289 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005290 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005291 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005292 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005293 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005294
Gilles Peskine66fb1262018-12-10 16:29:04 +01005295 status = psa_initialize_key_slots( );
5296 if( status != PSA_SUCCESS )
5297 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005298
Gilles Peskined9348f22019-10-01 15:22:29 +02005299#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5300 status = psa_init_all_se_drivers( );
5301 if( status != PSA_SUCCESS )
5302 goto exit;
5303#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5304
Gilles Peskine4b734222019-07-24 15:56:31 +02005305#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005306 status = psa_crypto_load_transaction( );
5307 if( status == PSA_SUCCESS )
5308 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005309 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5310 if( status != PSA_SUCCESS )
5311 goto exit;
5312 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005313 }
5314 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5315 {
5316 /* There's no transaction to complete. It's all good. */
5317 status = PSA_SUCCESS;
5318 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005319#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005320
Gilles Peskinec6b69072018-11-20 21:42:52 +01005321 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005322 global_data.initialized = 1;
5323
5324exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005325 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005326 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005327 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005328}
5329
5330#endif /* MBEDTLS_PSA_CRYPTO_C */