blob: 8b102bb05bc7d13b367c83fc0f447b77c2d9ac55 [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 Peskinea5905292018-02-07 20:59:33 +0100269
Gilles Peskineff2d2002019-05-06 15:26:23 +0200270 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
271 return( PSA_ERROR_HARDWARE_FAILURE );
272 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
273 return( PSA_ERROR_NOT_SUPPORTED );
274
Gilles Peskinea5905292018-02-07 20:59:33 +0100275 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_RSA_INVALID_PADDING:
278 return( PSA_ERROR_INVALID_PADDING );
279 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
280 return( PSA_ERROR_HARDWARE_FAILURE );
281 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
282 return( PSA_ERROR_INVALID_ARGUMENT );
283 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
284 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200285 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100286 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
287 return( PSA_ERROR_INVALID_SIGNATURE );
288 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
289 return( PSA_ERROR_BUFFER_TOO_SMALL );
290 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100291 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200292
itayzafrir5c753392018-05-08 11:18:38 +0300293 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300294 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300295 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
297 return( PSA_ERROR_BUFFER_TOO_SMALL );
298 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
299 return( PSA_ERROR_NOT_SUPPORTED );
300 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
301 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
302 return( PSA_ERROR_INVALID_SIGNATURE );
303 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
304 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100305 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307
Janos Follatha13b9052019-11-22 12:48:59 +0000308 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
309 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300310
Gilles Peskinee59236f2018-01-27 23:32:46 +0100311 default:
David Saadab4ecc272019-02-14 13:48:10 +0200312 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 }
314}
315
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200316
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200317
318
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100319/****************************************************************/
320/* Key management */
321/****************************************************************/
322
Gilles Peskine73167e12019-07-12 23:44:37 +0200323#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
324static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
325{
Gilles Peskine8e338702019-07-30 20:06:31 +0200326 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200327}
328#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
329
John Durkop07cc04a2020-11-16 22:08:34 -0800330/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
331 * current test driver in key_management.c is using this function
332 * when accelerators are used for ECC key pair and public key.
333 * Once that dependency is resolved these guards can be removed.
334 */
John Durkop9814fa22020-11-04 12:28:15 -0800335#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800336 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
337 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
338 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100339mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100340 size_t bits,
341 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200342{
343 switch( curve )
344 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100345 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100346 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100347 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100348#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100349 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100350 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100351#endif
352#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100353 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100354 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100355#endif
356#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100357 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100358 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100359#endif
360#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100362 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100363#endif
364#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100365 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100366 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100367 case 528:
368 if( bits_is_sloppy )
369 return( MBEDTLS_ECP_DP_SECP521R1 );
370 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100371#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 }
373 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100374
Paul Elliott8ff510a2020-06-02 17:19:28 +0100375 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100379 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100381#endif
382#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100383 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100384 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100385#endif
386#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100387 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100388 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100389#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 }
391 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100392
Paul Elliott8ff510a2020-06-02 17:19:28 +0100393 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100397 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 256:
400 if( bits_is_sloppy )
401 return( MBEDTLS_ECP_DP_CURVE25519 );
402 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100403#endif
404#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100407#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#endif
418#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100421#endif
422#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100425#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 }
427 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200428 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100429
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100430 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432}
John Durkop9814fa22020-11-04 12:28:15 -0800433#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800434 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
435 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
436 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200437
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200438static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
439 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440{
441 /* Check that the bit size is acceptable for the key type */
442 switch( type )
443 {
444 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200445 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200446 case PSA_KEY_TYPE_DERIVE:
447 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100448#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200449 case PSA_KEY_TYPE_AES:
450 if( bits != 128 && bits != 192 && bits != 256 )
451 return( PSA_ERROR_INVALID_ARGUMENT );
452 break;
453#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100454#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455 case PSA_KEY_TYPE_CAMELLIA:
456 if( bits != 128 && bits != 192 && bits != 256 )
457 return( PSA_ERROR_INVALID_ARGUMENT );
458 break;
459#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100460#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461 case PSA_KEY_TYPE_DES:
462 if( bits != 64 && bits != 128 && bits != 192 )
463 return( PSA_ERROR_INVALID_ARGUMENT );
464 break;
465#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100466#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200467 case PSA_KEY_TYPE_CHACHA20:
468 if( bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472 default:
473 return( PSA_ERROR_NOT_SUPPORTED );
474 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200475 if( bits % 8 != 0 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200477
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478 return( PSA_SUCCESS );
479}
480
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 *
Steven Cooremancd640932021-03-08 12:00:27 +0100483 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
484 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100485 *
486 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \param[in] key_type The key type of the key to be used with the
488 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 *
490 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100491 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100492 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100493 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100494 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100495MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100496 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100497 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498{
Steven Cooremancd640932021-03-08 12:00:27 +0100499 if( PSA_ALG_IS_HMAC( algorithm ) )
500 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100501 if( key_type == PSA_KEY_TYPE_HMAC )
502 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504
505 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100506 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100507 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
508 * key. */
509 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
510 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
511 {
512 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
513 * the block length (larger than 1) for block ciphers. */
514 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
515 return( PSA_SUCCESS );
516 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100517 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100518
519 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100520}
521
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200522psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
523 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200524{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100525 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200526 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200527
Ronald Cronea0f8a62020-11-25 17:52:23 +0100528 slot->key.data = mbedtls_calloc( 1, buffer_length );
529 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200530 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200531
Ronald Cronea0f8a62020-11-25 17:52:23 +0100532 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200533 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200534}
535
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200536psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
537 const uint8_t* data,
538 size_t data_length )
539{
540 psa_status_t status = psa_allocate_buffer_to_slot( slot,
541 data_length );
542 if( status != PSA_SUCCESS )
543 return( status );
544
Ronald Cronea0f8a62020-11-25 17:52:23 +0100545 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200546 return( PSA_SUCCESS );
547}
548
Ronald Crona0fe59f2020-11-29 11:14:53 +0100549psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 const psa_key_attributes_t *attributes,
551 const uint8_t *data, size_t data_length,
552 uint8_t *key_buffer, size_t key_buffer_size,
553 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100554{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
556 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100557
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200558 /* zero-length keys are never supported. */
559 if( data_length == 0 )
560 return( PSA_ERROR_NOT_SUPPORTED );
561
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100562 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100563 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200565
Steven Cooreman75b74362020-07-28 14:30:13 +0200566 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
567 if( data_length > SIZE_MAX / 8 )
568 return( PSA_ERROR_NOT_SUPPORTED );
569
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200570 /* Enforce a size limit, and in particular ensure that the bit
571 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100572 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200573 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200574
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100575 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200576 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200577 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200578
Ronald Crondd04d422020-11-28 15:14:42 +0100579 /* Copy the key material. */
580 memcpy( key_buffer, data, data_length );
581 *key_buffer_length = data_length;
582 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200583
Steven Cooreman40120f62020-10-29 11:42:22 +0100584 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100585 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100586 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200587 {
John Durkop9814fa22020-11-04 12:28:15 -0800588#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
589 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100590 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200591 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100592 return( mbedtls_psa_ecp_import_key( attributes,
593 data, data_length,
594 key_buffer, key_buffer_size,
595 key_buffer_length,
596 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100597 }
John Durkop9814fa22020-11-04 12:28:15 -0800598#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
599 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700600#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
601 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100602 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200603 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100604 return( mbedtls_psa_rsa_import_key( attributes,
605 data, data_length,
606 key_buffer, key_buffer_size,
607 key_buffer_length,
608 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200609 }
John Durkop9814fa22020-11-04 12:28:15 -0800610#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
611 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100612 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100613
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100614 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100615}
616
Gilles Peskinef603c712019-01-19 13:40:11 +0100617/** Calculate the intersection of two algorithm usage policies.
618 *
619 * Return 0 (which allows no operation) on incompatibility.
620 */
621static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100622 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100623 psa_algorithm_t alg1,
624 psa_algorithm_t alg2 )
625{
Gilles Peskine549ea862019-05-22 11:45:59 +0200626 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100627 if( alg1 == alg2 )
628 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100629 /* If the policies are from the same hash-and-sign family, check
630 * if one is a wildcard. If so the other has the specific algorithm. */
631 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
632 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
633 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100634 {
Steven Cooreman03488022021-02-18 12:07:20 +0100635 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
636 return( alg2 );
637 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
638 return( alg1 );
639 }
640 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100641 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100642 * restrictive tag length. */
643 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
644 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
645 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
646 {
647 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
648 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100649 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100650
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100651 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100652 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
653 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100654 {
Steven Cooremancd640932021-03-08 12:00:27 +0100655 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
656 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100657 }
658 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100659 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100660 ( alg1_len <= alg2_len ) )
661 {
662 return( alg2 );
663 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100664 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100665 ( alg2_len <= alg1_len ) )
666 {
667 return( alg1 );
668 }
669 }
670 /* If the policies are from the same MAC family, check whether one
671 * of them is a minimum-MAC-length policy. Calculate the most
672 * restrictive tag length. */
673 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
674 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
675 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
676 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100677 /* Validate the combination of key type and algorithm. Since the base
678 * algorithm of alg1 and alg2 are the same, we only need this once. */
679 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100680 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100681
Steven Cooreman31a876d2021-03-03 20:47:40 +0100682 /* Get the (exact or at-least) output lengths for both sides of the
683 * requested intersection. None of the currently supported algorithms
684 * have an output length dependent on the actual key size, so setting it
685 * to a bogus value of 0 is currently OK.
686 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100687 * Note that for at-least-this-length wildcard algorithms, the output
688 * length is set to the shortest allowed length, which allows us to
689 * calculate the most restrictive tag length for the intersection. */
690 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
691 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100692 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100693
Steven Cooremana1d83222021-02-25 10:20:29 +0100694 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100695 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
696 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100697 {
Steven Cooremancd640932021-03-08 12:00:27 +0100698 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100699 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700
701 /* If only one is an at-least-this-length policy, the intersection would
702 * be the other (fixed-length) policy as long as said fixed length is
703 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100704 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100705 {
Steven Cooremancd640932021-03-08 12:00:27 +0100706 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100707 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100708 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100709 {
Steven Cooremancd640932021-03-08 12:00:27 +0100710 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100711 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100712
Steven Cooremancd640932021-03-08 12:00:27 +0100713 /* If none of them are wildcards, check whether they define the same tag
714 * length. This is still possible here when one is default-length and
715 * the other specific-length. Ensure to always return the
716 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100717 if( alg1_len == alg2_len )
718 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100719 }
720 /* If the policies are incompatible, allow nothing. */
721 return( 0 );
722}
723
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100724static int psa_key_algorithm_permits( psa_key_type_t key_type,
725 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200726 psa_algorithm_t requested_alg )
727{
Gilles Peskine549ea862019-05-22 11:45:59 +0200728 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200729 if( requested_alg == policy_alg )
730 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100731 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
732 * and requested_alg is the same hash-and-sign family with any hash,
733 * then requested_alg is compliant with policy_alg. */
734 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
735 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200736 {
Steven Cooreman03488022021-02-18 12:07:20 +0100737 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
738 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
739 }
740 /* If policy_alg is a wildcard AEAD algorithm of the same base as
741 * the requested algorithm, check the requested tag length to be
742 * equal-length or longer than the wildcard-specified length. */
743 if( PSA_ALG_IS_AEAD( policy_alg ) &&
744 PSA_ALG_IS_AEAD( requested_alg ) &&
745 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
746 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100747 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100748 {
749 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
750 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
751 }
Steven Cooremancd640932021-03-08 12:00:27 +0100752 /* If policy_alg is a MAC algorithm of the same base as the requested
753 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100754 if( PSA_ALG_IS_MAC( policy_alg ) &&
755 PSA_ALG_IS_MAC( requested_alg ) &&
756 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100757 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100758 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 /* Validate the combination of key type and algorithm. Since the policy
760 * and requested algorithms are the same, we only need this once. */
761 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100762 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100763
Steven Cooreman31a876d2021-03-03 20:47:40 +0100764 /* Get both the requested output length for the algorithm which is to be
765 * verified, and the default output length for the base algorithm.
766 * Note that none of the currently supported algorithms have an output
767 * length dependent on actual key size, so setting it to a bogus value
768 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100769 size_t requested_output_length = PSA_MAC_LENGTH(
770 key_type, 0, requested_alg );
771 size_t default_output_length = PSA_MAC_LENGTH(
772 key_type, 0,
773 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100774
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100775 /* If the policy is default-length, only allow an algorithm with
776 * a declared exact-length matching the default. */
777 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100778 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100779
780 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100781 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
783 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
784 {
785 return( 1 );
786 }
787
Steven Cooremancd640932021-03-08 12:00:27 +0100788 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
789 * check for the requested MAC length to be equal to or longer than the
790 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100791 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
792 {
793 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100794 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200796 }
Steven Cooremance48e852020-10-05 16:02:45 +0200797 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200798 * a key derivation with that key agreement should also be allowed. This
799 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200800 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
801 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
802 {
803 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
804 policy_alg );
805 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100806 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200807 return( 0 );
808}
809
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100810/** Test whether a policy permits an algorithm.
811 *
812 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100813 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100814 * \note This function requires providing the key type for which the policy is
815 * being validated, since some algorithm policy definitions (e.g. MAC)
816 * have different properties depending on what kind of cipher it is
817 * combined with.
818 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100819 * \retval PSA_SUCCESS When \p alg is a specific algorithm
820 * allowed by the \p policy.
821 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
822 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
823 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100824 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100825static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100826 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100827 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100828{
Steven Cooremand788fab2021-02-25 11:29:17 +0100829 /* '0' is not a valid algorithm */
830 if( alg == 0 )
831 return( PSA_ERROR_INVALID_ARGUMENT );
832
Steven Cooreman7e39f052021-02-23 14:18:32 +0100833 /* A requested algorithm cannot be a wildcard. */
834 if( PSA_ALG_IS_WILDCARD( alg ) )
835 return( PSA_ERROR_INVALID_ARGUMENT );
836
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100837 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
838 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100839 return( PSA_SUCCESS );
840 else
841 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100842}
843
Gilles Peskinef603c712019-01-19 13:40:11 +0100844/** Restrict a key policy based on a constraint.
845 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100846 * \note This function requires providing the key type for which the policy is
847 * being restricted, since some algorithm policy definitions (e.g. MAC)
848 * have different properties depending on what kind of cipher it is
849 * combined with.
850 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100851 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100852 * \param[in,out] policy The policy to restrict.
853 * \param[in] constraint The policy constraint to apply.
854 *
855 * \retval #PSA_SUCCESS
856 * \c *policy contains the intersection of the original value of
857 * \c *policy and \c *constraint.
858 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100859 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100860 * \c *policy is unchanged.
861 */
862static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100863 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100864 psa_key_policy_t *policy,
865 const psa_key_policy_t *constraint )
866{
867 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100868 psa_key_policy_algorithm_intersection( key_type, policy->alg,
869 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100871 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
872 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
874 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200875 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
876 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100877 policy->usage &= constraint->usage;
878 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200879 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 return( PSA_SUCCESS );
881}
882
Ronald Cron5c522922020-11-14 16:35:34 +0100883/** Get the description of a key given its identifier and policy constraints
884 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200885 *
Ronald Cron5c522922020-11-14 16:35:34 +0100886 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100887 * nonzero, the key must allow operations with this algorithm. If \p alg is
888 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100889 *
Ronald Cron5c522922020-11-14 16:35:34 +0100890 * In case of a persistent key, the function loads the description of the key
891 * into a key slot if not already done.
892 *
893 * On success, the returned key slot is locked. It is the responsibility of
894 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 */
Ronald Cron5c522922020-11-14 16:35:34 +0100896static psa_status_t psa_get_and_lock_key_slot_with_policy(
897 mbedtls_svc_key_id_t key,
898 psa_key_slot_t **p_slot,
899 psa_key_usage_t usage,
900 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100901{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200902 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
903 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100904
Ronald Cron5c522922020-11-14 16:35:34 +0100905 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100906 if( status != PSA_SUCCESS )
907 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200908 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100909
910 /* Enforce that usage policy for the key slot contains all the flags
911 * required by the usage parameter. There is one exception: public
912 * keys can always be exported, so we treat public key objects as
913 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200914 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100915 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200916
Gilles Peskine8e338702019-07-30 20:06:31 +0200917 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100918 {
919 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200920 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100921 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100922
923 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 if( alg != 0 )
925 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100926 status = psa_key_policy_permits( &slot->attr.policy,
927 slot->attr.type,
928 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100929 if( status != PSA_SUCCESS )
930 goto error;
931 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100932
Darryl Green06fd18d2018-07-16 11:21:11 +0100933 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200934
935error:
936 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100937 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200938
939 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100940}
Darryl Green940d72c2018-07-13 13:18:51 +0100941
Ronald Cron5c522922020-11-14 16:35:34 +0100942/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200943 *
944 * A transparent key is a key for which the key material is directly
945 * available, as opposed to a key in a secure element.
946 *
Ronald Cron5c522922020-11-14 16:35:34 +0100947 * This is a temporary function to use instead of
948 * psa_get_and_lock_key_slot_with_policy() until secure element support is
949 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200950 *
Ronald Cron5c522922020-11-14 16:35:34 +0100951 * On success, the returned key slot is locked. It is the responsibility of the
952 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200953 */
954#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100955static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
956 mbedtls_svc_key_id_t key,
957 psa_key_slot_t **p_slot,
958 psa_key_usage_t usage,
959 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960{
Ronald Cron5c522922020-11-14 16:35:34 +0100961 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
962 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200963 if( status != PSA_SUCCESS )
964 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200965
Gilles Peskineadad8132019-07-25 11:31:23 +0200966 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967 {
Ronald Cron5c522922020-11-14 16:35:34 +0100968 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969 *p_slot = NULL;
970 return( PSA_ERROR_NOT_SUPPORTED );
971 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200972
Gilles Peskine28f8f302019-07-24 13:30:31 +0200973 return( PSA_SUCCESS );
974}
975#else /* MBEDTLS_PSA_CRYPTO_SE_C */
976/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100977#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
978 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200979#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
980
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200981psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000982{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100983 /* Data pointer will always be either a valid pointer or NULL in an
984 * initialized slot, so we can just free it. */
985 if( slot->key.data != NULL )
986 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
987
988 mbedtls_free( slot->key.data );
989 slot->key.data = NULL;
990 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000991
992 return( PSA_SUCCESS );
993}
994
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100995/** Completely wipe a slot in memory, including its policy.
996 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100997psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100998{
999 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001000
Ronald Cron5c522922020-11-14 16:35:34 +01001001 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001002 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001003 status = PSA_ERROR_CORRUPTION_DETECTED;
1004 }
1005
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001006 /* Multipart operations may still be using the key. This is safe
1007 * because all multipart operation objects are independent from
1008 * the key slot: if they need to access the key after the setup
1009 * phase, they have a copy of the key. Note that this means that
1010 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001011 /* At this point, key material and other type-specific content has
1012 * been wiped. Clear remaining metadata. We can call memset and not
1013 * zeroize because the metadata is not particularly sensitive. */
1014 memset( slot, 0, sizeof( *slot ) );
1015 return( status );
1016}
1017
Ronald Croncf56a0a2020-08-04 09:51:30 +02001018psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001019{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001020 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001021 psa_status_t status; /* status of the last operation */
1022 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001023#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1024 psa_se_drv_table_entry_t *driver;
1025#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001026
Ronald Croncf56a0a2020-08-04 09:51:30 +02001027 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001028 return( PSA_SUCCESS );
1029
Ronald Cronf2911112020-10-29 17:51:10 +01001030 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001031 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001032 * key, this will load the key description from persistent memory if not
1033 * done yet. We cannot avoid this loading as without it we don't know if
1034 * the key is operated by an SE or not and this information is needed by
1035 * the current implementation.
1036 */
Ronald Cron5c522922020-11-14 16:35:34 +01001037 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001038 if( status != PSA_SUCCESS )
1039 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001040
Ronald Cronf2911112020-10-29 17:51:10 +01001041 /*
1042 * If the key slot containing the key description is under access by the
1043 * library (apart from the present access), the key cannot be destroyed
1044 * yet. For the time being, just return in error. Eventually (to be
1045 * implemented), the key should be destroyed when all accesses have
1046 * stopped.
1047 */
Ronald Cron5c522922020-11-14 16:35:34 +01001048 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001049 {
Ronald Cron5c522922020-11-14 16:35:34 +01001050 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001051 return( PSA_ERROR_GENERIC_ERROR );
1052 }
1053
Gilles Peskine6687cd02021-04-21 22:32:05 +02001054 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1055 {
1056 /* Refuse the destruction of a read-only key (which may or may not work
1057 * if we attempt it, depending on whether the key is merely read-only
1058 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001059 * Just do the best we can, which is to wipe the copy in memory
1060 * (done in this function's cleanup code). */
1061 overall_status = PSA_ERROR_NOT_PERMITTED;
1062 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001063 }
1064
Gilles Peskine354f7672019-07-12 23:46:38 +02001065#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001066 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001067 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001068 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001069 /* For a key in a secure element, we need to do three things:
1070 * remove the key file in internal storage, destroy the
1071 * key inside the secure element, and update the driver's
1072 * persistent data. Start a transaction that will encompass these
1073 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001074 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001075 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001076 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001077 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001078 status = psa_crypto_save_transaction( );
1079 if( status != PSA_SUCCESS )
1080 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001081 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001082 /* We should still try to destroy the key in the secure
1083 * element and the key metadata in storage. This is especially
1084 * important if the error is that the storage is full.
1085 * But how to do it exactly without risking an inconsistent
1086 * state after a reset?
1087 * https://github.com/ARMmbed/mbed-crypto/issues/215
1088 */
1089 overall_status = status;
1090 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001091 }
1092
Ronald Cronea0f8a62020-11-25 17:52:23 +01001093 status = psa_destroy_se_key( driver,
1094 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001095 if( overall_status == PSA_SUCCESS )
1096 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001097 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001098#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1099
Darryl Greend49a4992018-06-18 17:27:26 +01001100#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001101 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001102 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001103 status = psa_destroy_persistent_key( slot->attr.id );
1104 if( overall_status == PSA_SUCCESS )
1105 overall_status = status;
1106
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001107 /* TODO: other slots may have a copy of the same key. We should
1108 * invalidate them.
1109 * https://github.com/ARMmbed/mbed-crypto/issues/214
1110 */
Darryl Greend49a4992018-06-18 17:27:26 +01001111 }
1112#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001113
Gilles Peskinefc762652019-07-22 19:30:34 +02001114#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1115 if( driver != NULL )
1116 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001117 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118 if( overall_status == PSA_SUCCESS )
1119 overall_status = status;
1120 status = psa_crypto_stop_transaction( );
1121 if( overall_status == PSA_SUCCESS )
1122 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001123 }
1124#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1125
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001126exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001127 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001129 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001130 overall_status = status;
1131 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001132}
1133
John Durkop07cc04a2020-11-16 22:08:34 -08001134#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001135 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001136static psa_status_t psa_get_rsa_public_exponent(
1137 const mbedtls_rsa_context *rsa,
1138 psa_key_attributes_t *attributes )
1139{
1140 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001142 uint8_t *buffer = NULL;
1143 size_t buflen;
1144 mbedtls_mpi_init( &mpi );
1145
1146 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1147 if( ret != 0 )
1148 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001149 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1150 {
1151 /* It's the default value, which is reported as an empty string,
1152 * so there's nothing to do. */
1153 goto exit;
1154 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001155
1156 buflen = mbedtls_mpi_size( &mpi );
1157 buffer = mbedtls_calloc( 1, buflen );
1158 if( buffer == NULL )
1159 {
1160 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1161 goto exit;
1162 }
1163 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1164 if( ret != 0 )
1165 goto exit;
1166 attributes->domain_parameters = buffer;
1167 attributes->domain_parameters_size = buflen;
1168
1169exit:
1170 mbedtls_mpi_free( &mpi );
1171 if( ret != 0 )
1172 mbedtls_free( buffer );
1173 return( mbedtls_to_psa_error( ret ) );
1174}
John Durkop07cc04a2020-11-16 22:08:34 -08001175#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001176 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001177
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001178/** Retrieve all the publicly-accessible attributes of a key.
1179 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001180psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001181 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001182{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001184 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001185 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001186
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001187 psa_reset_key_attributes( attributes );
1188
Ronald Cron5c522922020-11-14 16:35:34 +01001189 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001190 if( status != PSA_SUCCESS )
1191 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001192
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001193 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001194 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1195 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1196
1197#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1198 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001199 psa_set_key_slot_number( attributes,
1200 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001201#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001202
Gilles Peskine8e338702019-07-30 20:06:31 +02001203 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001204 {
John Durkop07cc04a2020-11-16 22:08:34 -08001205#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001206 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001207 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001208 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001209#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001210 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001211 * is not yet implemented.
1212 * https://github.com/ARMmbed/mbed-crypto/issues/216
1213 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001214 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001215 break;
1216#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001217 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001218 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001219
Ronald Cron90857082020-11-25 14:58:33 +01001220 status = mbedtls_psa_rsa_load_representation(
1221 slot->attr.type,
1222 slot->key.data,
1223 slot->key.bytes,
1224 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 if( status != PSA_SUCCESS )
1226 break;
1227
Steven Cooremana2371e52020-07-28 14:30:39 +02001228 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001229 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001230 mbedtls_rsa_free( rsa );
1231 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001232 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001233 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001234#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001235 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 default:
1237 /* Nothing else to do. */
1238 break;
1239 }
1240
1241 if( status != PSA_SUCCESS )
1242 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001243
Ronald Cron5c522922020-11-14 16:35:34 +01001244 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001245
Ronald Cron5c522922020-11-14 16:35:34 +01001246 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001247}
1248
Gilles Peskinec8000c02019-08-02 20:15:51 +02001249#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1250psa_status_t psa_get_key_slot_number(
1251 const psa_key_attributes_t *attributes,
1252 psa_key_slot_number_t *slot_number )
1253{
1254 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1255 {
1256 *slot_number = attributes->slot_number;
1257 return( PSA_SUCCESS );
1258 }
1259 else
1260 return( PSA_ERROR_INVALID_ARGUMENT );
1261}
1262#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1263
Ronald Crond18b5f82020-11-25 16:46:05 +01001264static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1265 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001266 uint8_t *data,
1267 size_t data_size,
1268 size_t *data_length )
1269{
Ronald Crond18b5f82020-11-25 16:46:05 +01001270 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001271 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 memcpy( data, key_buffer, key_buffer_size );
1273 memset( data + key_buffer_size, 0,
1274 data_size - key_buffer_size );
1275 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001276 return( PSA_SUCCESS );
1277}
1278
Ronald Cron7285cda2020-11-26 14:46:37 +01001279psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 const psa_key_attributes_t *attributes,
1281 const uint8_t *key_buffer, size_t key_buffer_size,
1282 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001283{
Ronald Crond18b5f82020-11-25 16:46:05 +01001284 psa_key_type_t type = attributes->core.type;
1285
Ronald Crond18b5f82020-11-25 16:46:05 +01001286 if( key_type_is_raw_bytes( type ) ||
1287 PSA_KEY_TYPE_IS_RSA( type ) ||
1288 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001289 {
1290 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001291 key_buffer, key_buffer_size,
1292 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001293 }
1294 else
1295 {
1296 /* This shouldn't happen in the reference implementation, but
1297 it is valid for a special-purpose implementation to omit
1298 support for exporting certain key types. */
1299 return( PSA_ERROR_NOT_SUPPORTED );
1300 }
1301}
1302
1303psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1304 uint8_t *data,
1305 size_t data_size,
1306 size_t *data_length )
1307{
1308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1309 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1310 psa_key_slot_t *slot;
1311
Ronald Crone907e552021-01-18 13:22:38 +01001312 /* Reject a zero-length output buffer now, since this can never be a
1313 * valid key representation. This way we know that data must be a valid
1314 * pointer and we can do things like memset(data, ..., data_size). */
1315 if( data_size == 0 )
1316 return( PSA_ERROR_BUFFER_TOO_SMALL );
1317
Ronald Cron9486f9d2020-11-26 13:36:23 +01001318 /* Set the key to empty now, so that even when there are errors, we always
1319 * set data_length to a value between 0 and data_size. On error, setting
1320 * the key to empty is a good choice because an empty key representation is
1321 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001322 *data_length = 0;
1323
Ronald Cron9486f9d2020-11-26 13:36:23 +01001324 /* Export requires the EXPORT flag. There is an exception for public keys,
1325 * which don't require any flag, but
1326 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1327 */
1328 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1329 PSA_KEY_USAGE_EXPORT, 0 );
1330 if( status != PSA_SUCCESS )
1331 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001332
Ronald Crond18b5f82020-11-25 16:46:05 +01001333 psa_key_attributes_t attributes = {
1334 .core = slot->attr
1335 };
Ronald Cron67227982020-11-26 15:16:05 +01001336 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001337 slot->key.data, slot->key.bytes,
1338 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001339
Ronald Cron9486f9d2020-11-26 13:36:23 +01001340 unlock_status = psa_unlock_key_slot( slot );
1341
1342 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1343}
1344
Ronald Cron7285cda2020-11-26 14:46:37 +01001345psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001346 const psa_key_attributes_t *attributes,
1347 const uint8_t *key_buffer,
1348 size_t key_buffer_size,
1349 uint8_t *data,
1350 size_t data_size,
1351 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352{
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001354
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001356 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001358 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001359 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001360 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 key_buffer, key_buffer_size,
1362 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001363 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001364
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001366 {
John Durkop0e005192020-10-31 22:06:54 -07001367#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1368 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001369 return( mbedtls_psa_rsa_export_public_key( attributes,
1370 key_buffer,
1371 key_buffer_size,
1372 data,
1373 data_size,
1374 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001375#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001376 /* We don't know how to convert a private RSA key to public. */
1377 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001378#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1379 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001380 }
1381 else
Moran Pekera998bc62018-04-16 18:16:20 +03001382 {
John Durkop6ba40d12020-11-10 08:50:04 -08001383#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1384 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001385 return( mbedtls_psa_ecp_export_public_key( attributes,
1386 key_buffer,
1387 key_buffer_size,
1388 data,
1389 data_size,
1390 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001391#else
1392 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001393 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001394#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1395 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001396 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001397 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001398 else
1399 {
1400 /* This shouldn't happen in the reference implementation, but
1401 it is valid for a special-purpose implementation to omit
1402 support for exporting certain key types. */
1403 return( PSA_ERROR_NOT_SUPPORTED );
1404 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001405}
Ronald Crond18b5f82020-11-25 16:46:05 +01001406
Ronald Croncf56a0a2020-08-04 09:51:30 +02001407psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001408 uint8_t *data,
1409 size_t data_size,
1410 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001411{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001413 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001414 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001415
Ronald Crone907e552021-01-18 13:22:38 +01001416 /* Reject a zero-length output buffer now, since this can never be a
1417 * valid key representation. This way we know that data must be a valid
1418 * pointer and we can do things like memset(data, ..., data_size). */
1419 if( data_size == 0 )
1420 return( PSA_ERROR_BUFFER_TOO_SMALL );
1421
Darryl Greendd8fb772018-11-07 16:00:44 +00001422 /* Set the key to empty now, so that even when there are errors, we always
1423 * set data_length to a value between 0 and data_size. On error, setting
1424 * the key to empty is a good choice because an empty key representation is
1425 * unlikely to be accepted anywhere. */
1426 *data_length = 0;
1427
1428 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001429 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001430 if( status != PSA_SUCCESS )
1431 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001432
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1434 {
1435 status = PSA_ERROR_INVALID_ARGUMENT;
1436 goto exit;
1437 }
1438
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 psa_key_attributes_t attributes = {
1440 .core = slot->attr
1441 };
Ronald Cron67227982020-11-26 15:16:05 +01001442 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001443 &attributes, slot->key.data, slot->key.bytes,
1444 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001445
1446exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001447 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001448
Ronald Cron5c522922020-11-14 16:35:34 +01001449 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001450}
1451
Gilles Peskine91e8c332019-08-02 19:19:39 +02001452#if defined(static_assert)
1453static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1454 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001455static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001456 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001457static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001458 "One or more key attribute flag is listed as both internal-only and external-only" );
1459#endif
1460
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001461/** Validate that a key policy is internally well-formed.
1462 *
1463 * This function only rejects invalid policies. It does not validate the
1464 * consistency of the policy with respect to other attributes of the key
1465 * such as the key type.
1466 */
1467static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001468{
1469 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001470 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001471 PSA_KEY_USAGE_ENCRYPT |
1472 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001473 PSA_KEY_USAGE_SIGN_MESSAGE |
1474 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001475 PSA_KEY_USAGE_SIGN_HASH |
1476 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001477 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001478 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1479 return( PSA_ERROR_INVALID_ARGUMENT );
1480
Gilles Peskine4747d192019-04-17 15:05:45 +02001481 return( PSA_SUCCESS );
1482}
1483
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001484/** Validate the internal consistency of key attributes.
1485 *
1486 * This function only rejects invalid attribute values. If does not
1487 * validate the consistency of the attributes with any key data that may
1488 * be involved in the creation of the key.
1489 *
1490 * Call this function early in the key creation process.
1491 *
1492 * \param[in] attributes Key attributes for the new key.
1493 * \param[out] p_drv On any return, the driver for the key, if any.
1494 * NULL for a transparent key.
1495 *
1496 */
1497static psa_status_t psa_validate_key_attributes(
1498 const psa_key_attributes_t *attributes,
1499 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001500{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001501 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001502 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001503 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001504
Ronald Cron54b90082020-10-29 15:26:43 +01001505 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001506 if( status != PSA_SUCCESS )
1507 return( status );
1508
Ronald Crond2ed4812020-07-17 16:11:30 +02001509 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001510 if( status != PSA_SUCCESS )
1511 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001512
Ronald Cron65f38a32020-10-23 17:11:13 +02001513 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1514 {
1515 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1516 return( PSA_ERROR_INVALID_ARGUMENT );
1517 }
1518 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001519 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001520 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1521 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001522 }
1523
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001524 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001525 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001526 return( status );
1527
1528 /* Refuse to create overly large keys.
1529 * Note that this doesn't trigger on import if the attributes don't
1530 * explicitly specify a size (so psa_get_key_bits returns 0), so
1531 * psa_import_key() needs its own checks. */
1532 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1533 return( PSA_ERROR_NOT_SUPPORTED );
1534
Gilles Peskine91e8c332019-08-02 19:19:39 +02001535 /* Reject invalid flags. These should not be reachable through the API. */
1536 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1537 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1538 return( PSA_ERROR_INVALID_ARGUMENT );
1539
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001540 return( PSA_SUCCESS );
1541}
1542
Gilles Peskine4747d192019-04-17 15:05:45 +02001543/** Prepare a key slot to receive key material.
1544 *
1545 * This function allocates a key slot and sets its metadata.
1546 *
1547 * If this function fails, call psa_fail_key_creation().
1548 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001549 * This function is intended to be used as follows:
1550 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001551 * it with the specified attributes, and in case of a volatile key assign it
1552 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001553 * -# Populate the slot with the key material.
1554 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1555 * In case of failure at any step, stop the sequence and call
1556 * psa_fail_key_creation().
1557 *
Ronald Cron5c522922020-11-14 16:35:34 +01001558 * On success, the key slot is locked. It is the responsibility of the caller
1559 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001560 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001561 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001562 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001563 * \param[out] p_slot On success, a pointer to the prepared slot.
1564 * \param[out] p_drv On any return, the driver for the key, if any.
1565 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001566 *
1567 * \retval #PSA_SUCCESS
1568 * The key slot is ready to receive key material.
1569 * \return If this function fails, the key slot is an invalid state.
1570 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001571 */
1572static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001573 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001575 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001576 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001577{
1578 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001579 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001580 psa_key_slot_t *slot;
1581
Gilles Peskinedf179142019-07-15 22:02:14 +02001582 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001583 *p_drv = NULL;
1584
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001585 status = psa_validate_key_attributes( attributes, p_drv );
1586 if( status != PSA_SUCCESS )
1587 return( status );
1588
Ronald Cronc4d1b512020-07-31 11:26:37 +02001589 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001590 if( status != PSA_SUCCESS )
1591 return( status );
1592 slot = *p_slot;
1593
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001594 /* We're storing the declared bit-size of the key. It's up to each
1595 * creation mechanism to verify that this information is correct.
1596 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001597 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001598 * is optional (import, copy). In case of a volatile key, assign it the
1599 * volatile key identifier associated to the slot returned to contain its
1600 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001601
1602 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001603 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1604 {
1605#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1606 slot->attr.id = volatile_key_id;
1607#else
1608 slot->attr.id.key_id = volatile_key_id;
1609#endif
1610 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001611
Gilles Peskine91e8c332019-08-02 19:19:39 +02001612 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001613 * external-only flags, query `attributes`. Thanks to the check
1614 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001615 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001616 * may have set. */
1617 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001618
Gilles Peskinecbaff462019-07-12 23:46:04 +02001619#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001620 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001621 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001622 * create the key file in internal storage, create the
1623 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001624 * persistent data. This is done by starting a transaction that will
1625 * encompass these three actions.
1626 * For registering a volatile key, we just need to find an appropriate
1627 * slot number inside the SE. Since the key is designated volatile, creating
1628 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001629 /* The first thing to do is to find a slot number for the new key.
1630 * We save the slot number in persistent storage as part of the
1631 * transaction data. It will be needed to recover if the power
1632 * fails during the key creation process, to clean up on the secure
1633 * element side after restarting. Obtaining a slot number from the
1634 * secure element driver updates its persistent state, but we do not yet
1635 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001636 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001637 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001638 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001639 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001640 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001641 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001642 if( status != PSA_SUCCESS )
1643 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644
1645 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001646 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001647 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1648 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001649 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001650 psa_crypto_transaction.key.id = slot->attr.id;
1651 status = psa_crypto_save_transaction( );
1652 if( status != PSA_SUCCESS )
1653 {
1654 (void) psa_crypto_stop_transaction( );
1655 return( status );
1656 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001657 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001658
1659 status = psa_copy_key_material_into_slot(
1660 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001661 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001662
1663 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1664 {
1665 /* Key registration only makes sense with a secure element. */
1666 return( PSA_ERROR_INVALID_ARGUMENT );
1667 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001668#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1669
Ronald Cronc4d1b512020-07-31 11:26:37 +02001670 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001671}
Gilles Peskine4747d192019-04-17 15:05:45 +02001672
1673/** Finalize the creation of a key once its key material has been set.
1674 *
1675 * This entails writing the key to persistent storage.
1676 *
1677 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001678 * See the documentation of psa_start_key_creation() for the intended use
1679 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001680 *
Ronald Cron5c522922020-11-14 16:35:34 +01001681 * If the finalization succeeds, the function unlocks the key slot (it was
1682 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1683 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001684 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001685 * \param[in,out] slot Pointer to the slot with key material.
1686 * \param[in] driver The secure element driver for the key,
1687 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001688 * \param[out] key On success, identifier of the key. Note that the
1689 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001690 *
1691 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001692 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001693 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1694 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1695 * \retval #PSA_ERROR_ALREADY_EXISTS
1696 * \retval #PSA_ERROR_DATA_INVALID
1697 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001698 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001699 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001700 * \return If this function fails, the key slot is an invalid state.
1701 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001703static psa_status_t psa_finish_key_creation(
1704 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001705 psa_se_drv_table_entry_t *driver,
1706 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001707{
1708 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001709 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001710 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001711
1712#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001713 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001714 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001715#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1716 if( driver != NULL )
1717 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 psa_key_slot_number_t slot_number =
1720 psa_key_slot_get_slot_number( slot ) ;
1721
Gilles Peskineb46bef22019-07-30 21:32:04 +02001722#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001723 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001724 sizeof( data.slot_number ),
1725 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001726#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001727 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001728 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001729 (uint8_t*) &data,
1730 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001731 }
1732 else
1733#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1734 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001735 /* Key material is saved in export representation in the slot, so
1736 * just pass the slot buffer for storage. */
1737 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738 slot->key.data,
1739 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001740 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001741 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001742#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1743
Gilles Peskinecbaff462019-07-12 23:46:04 +02001744#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001745 /* Finish the transaction for a key creation. This does not
1746 * happen when registering an existing key. Detect this case
1747 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001748 * creation of a persistent key in a secure element requires a transaction,
1749 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001750 if( driver != NULL &&
1751 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001752 {
1753 status = psa_save_se_persistent_data( driver );
1754 if( status != PSA_SUCCESS )
1755 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001756 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001757 return( status );
1758 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001759 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001760 }
1761#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1762
Ronald Cron50972942020-11-14 11:28:25 +01001763 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001764 {
1765 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001766 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 if( status != PSA_SUCCESS )
1768 *key = MBEDTLS_SVC_KEY_ID_INIT;
1769 }
Ronald Cron50972942020-11-14 11:28:25 +01001770
Gilles Peskine4747d192019-04-17 15:05:45 +02001771 return( status );
1772}
1773
1774/** Abort the creation of a key.
1775 *
1776 * You may call this function after calling psa_start_key_creation(),
1777 * or after psa_finish_key_creation() fails. In other circumstances, this
1778 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001779 * See the documentation of psa_start_key_creation() for the intended use
1780 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 * \param[in,out] slot Pointer to the slot with key material.
1783 * \param[in] driver The secure element driver for the key,
1784 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001786static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001787 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001788{
Gilles Peskine011e4282019-06-26 18:34:38 +02001789 (void) driver;
1790
Gilles Peskine4747d192019-04-17 15:05:45 +02001791 if( slot == NULL )
1792 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001793
1794#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001795 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001796 * element, and the failure happened later (when saving metadata
1797 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001798 * element.
1799 * https://github.com/ARMmbed/mbed-crypto/issues/217
1800 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001801
Gilles Peskined7729582019-08-05 15:55:54 +02001802 /* Abort the ongoing transaction if any (there may not be one if
1803 * the creation process failed before starting one, or if the
1804 * key creation is a registration of a key in a secure element).
1805 * Earlier functions must already have done what it takes to undo any
1806 * partial creation. All that's left is to update the transaction data
1807 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001808 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001809#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1810
Gilles Peskine4747d192019-04-17 15:05:45 +02001811 psa_wipe_key_slot( slot );
1812}
1813
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001814/** Validate optional attributes during key creation.
1815 *
1816 * Some key attributes are optional during key creation. If they are
1817 * specified in the attributes structure, check that they are consistent
1818 * with the data in the slot.
1819 *
1820 * This function should be called near the end of key creation, after
1821 * the slot in memory is fully populated but before saving persistent data.
1822 */
1823static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 const psa_key_slot_t *slot,
1825 const psa_key_attributes_t *attributes )
1826{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001827 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001829 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830 return( PSA_ERROR_INVALID_ARGUMENT );
1831 }
1832
1833 if( attributes->domain_parameters_size != 0 )
1834 {
John Durkop0e005192020-10-31 22:06:54 -07001835#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1836 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001837 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001838 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001839 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001840 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001841 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001842
Ronald Cron90857082020-11-25 14:58:33 +01001843 psa_status_t status = mbedtls_psa_rsa_load_representation(
1844 slot->attr.type,
1845 slot->key.data,
1846 slot->key.bytes,
1847 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001848 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001849 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001850
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851 mbedtls_mpi_init( &actual );
1852 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001853 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001855 mbedtls_rsa_free( rsa );
1856 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 if( ret != 0 )
1858 goto rsa_exit;
1859 ret = mbedtls_mpi_read_binary( &required,
1860 attributes->domain_parameters,
1861 attributes->domain_parameters_size );
1862 if( ret != 0 )
1863 goto rsa_exit;
1864 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1865 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1866 rsa_exit:
1867 mbedtls_mpi_free( &actual );
1868 mbedtls_mpi_free( &required );
1869 if( ret != 0)
1870 return( mbedtls_to_psa_error( ret ) );
1871 }
1872 else
John Durkop9814fa22020-11-04 12:28:15 -08001873#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1874 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 {
1876 return( PSA_ERROR_INVALID_ARGUMENT );
1877 }
1878 }
1879
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001880 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001881 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001882 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001883 return( PSA_ERROR_INVALID_ARGUMENT );
1884 }
1885
1886 return( PSA_SUCCESS );
1887}
1888
Gilles Peskine4747d192019-04-17 15:05:45 +02001889psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001890 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001891 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001892 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001893{
1894 psa_status_t status;
1895 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001896 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001897 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001898
Ronald Cron81709fc2020-11-14 12:10:32 +01001899 *key = MBEDTLS_SVC_KEY_ID_INIT;
1900
Gilles Peskine0f84d622019-09-12 19:03:13 +02001901 /* Reject zero-length symmetric keys (including raw data key objects).
1902 * This also rejects any key which might be encoded as an empty string,
1903 * which is never valid. */
1904 if( data_length == 0 )
1905 return( PSA_ERROR_INVALID_ARGUMENT );
1906
Gilles Peskinedf179142019-07-15 22:02:14 +02001907 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001908 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 if( status != PSA_SUCCESS )
1910 goto exit;
1911
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001912 /* In the case of a transparent key or an opaque key stored in local
1913 * storage (thus not in the case of generating a key in a secure element
1914 * or cryptoprocessor with storage), we have to allocate a buffer to
1915 * hold the generated key material. */
1916 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001917 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001918 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001919 if( status != PSA_SUCCESS )
1920 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001921 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001922
1923 bits = slot->attr.bits;
1924 status = psa_driver_wrapper_import_key( attributes,
1925 data, data_length,
1926 slot->key.data,
1927 slot->key.bytes,
1928 &slot->key.bytes, &bits );
1929 if( status != PSA_SUCCESS )
1930 goto exit;
1931
1932 if( slot->attr.bits == 0 )
1933 slot->attr.bits = (psa_key_bits_t) bits;
1934 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001935 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001936 status = PSA_ERROR_INVALID_ARGUMENT;
1937 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001938 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001939
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001940 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001941 if( status != PSA_SUCCESS )
1942 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001943
Ronald Cron81709fc2020-11-14 12:10:32 +01001944 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001946 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001947 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001948
Gilles Peskine4747d192019-04-17 15:05:45 +02001949 return( status );
1950}
1951
Gilles Peskined7729582019-08-05 15:55:54 +02001952#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1953psa_status_t mbedtls_psa_register_se_key(
1954 const psa_key_attributes_t *attributes )
1955{
1956 psa_status_t status;
1957 psa_key_slot_t *slot = NULL;
1958 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001959 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001960
1961 /* Leaving attributes unspecified is not currently supported.
1962 * It could make sense to query the key type and size from the
1963 * secure element, but not all secure elements support this
1964 * and the driver HAL doesn't currently support it. */
1965 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1966 return( PSA_ERROR_NOT_SUPPORTED );
1967 if( psa_get_key_bits( attributes ) == 0 )
1968 return( PSA_ERROR_NOT_SUPPORTED );
1969
1970 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001971 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001972 if( status != PSA_SUCCESS )
1973 goto exit;
1974
Ronald Cron81709fc2020-11-14 12:10:32 +01001975 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001976
1977exit:
1978 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001979 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001980
Gilles Peskined7729582019-08-05 15:55:54 +02001981 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001982 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001983 return( status );
1984}
1985#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1986
Gilles Peskinef603c712019-01-19 13:40:11 +01001987static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001988 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001989{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001990 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001991 source->key.data,
1992 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001993 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001994 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001995
Steven Cooreman398aee52020-10-13 14:35:45 +02001996 target->attr.type = source->attr.type;
1997 target->attr.bits = source->attr.bits;
1998
1999 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002000}
2001
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002004 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002005{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002006 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002007 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002008 psa_key_slot_t *source_slot = NULL;
2009 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002010 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002011 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002012
Ronald Cron81709fc2020-11-14 12:10:32 +01002013 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2014
Ronald Cron5c522922020-11-14 16:35:34 +01002015 status = psa_get_and_lock_transparent_key_slot_with_policy(
2016 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002017 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002018 goto exit;
2019
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002020 status = psa_validate_optional_attributes( source_slot,
2021 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022 if( status != PSA_SUCCESS )
2023 goto exit;
2024
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002025 status = psa_restrict_key_policy( source_slot->attr.type,
2026 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002027 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002028 if( status != PSA_SUCCESS )
2029 goto exit;
2030
Ronald Cron81709fc2020-11-14 12:10:32 +01002031 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2032 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002033 if( status != PSA_SUCCESS )
2034 goto exit;
2035
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002036#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2037 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002038 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002039 /* Copying to a secure element is not implemented yet. */
2040 status = PSA_ERROR_NOT_SUPPORTED;
2041 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002042 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002043#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002044
Ronald Cron6cc66312021-04-02 12:27:47 +02002045 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2046 {
2047 /*
2048 * Copying through an opaque driver is not implemented yet, consider
2049 * a lifetime with an external location as an invalid parameter for
2050 * now.
2051 */
2052 status = PSA_ERROR_INVALID_ARGUMENT;
2053 goto exit;
2054 }
2055
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002056 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002057 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002058 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002059
Ronald Cron81709fc2020-11-14 12:10:32 +01002060 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002061exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002062 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002063 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002064
Ronald Cron5c522922020-11-14 16:35:34 +01002065 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002066
Ronald Cron5c522922020-11-14 16:35:34 +01002067 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002068}
2069
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002070
2071
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002072/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002073/* Message digests */
2074/****************************************************************/
2075
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002076psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2077{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002078 /* Aborting a non-active operation is allowed */
2079 if( operation->id == 0 )
2080 return( PSA_SUCCESS );
2081
2082 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2083 operation->id = 0;
2084
2085 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002086}
2087
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002088psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002089 psa_algorithm_t alg )
2090{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002091 /* A context must be freshly initialized before it can be set up. */
2092 if( operation->id != 0 )
2093 return( PSA_ERROR_BAD_STATE );
2094
2095 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002096 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002097
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002098 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2099 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002100 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2101
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002102 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002103}
2104
2105psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2106 const uint8_t *input,
2107 size_t input_length )
2108{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002109 if( operation->id == 0 )
2110 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002111
Steven Cooremanc8288352021-03-04 14:02:19 +01002112 /* Don't require hash implementations to behave correctly on a
2113 * zero-length input, which may have an invalid pointer. */
2114 if( input_length == 0 )
2115 return( PSA_SUCCESS );
2116
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002117 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2118 input, input_length );
2119 if( status != PSA_SUCCESS )
2120 psa_hash_abort( operation );
2121
2122 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002123}
2124
2125psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2126 uint8_t *hash,
2127 size_t hash_size,
2128 size_t *hash_length )
2129{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002130 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131 if( operation->id == 0 )
2132 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002133
Steven Cooreman1e582352021-02-18 17:24:37 +01002134 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002135 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002136 psa_hash_abort( operation );
2137 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002138}
2139
Gilles Peskine2d277862018-06-18 15:41:12 +02002140psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2141 const uint8_t *hash,
2142 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002143{
2144 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2145 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002146 psa_status_t status = psa_hash_finish(
2147 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002148 actual_hash, sizeof( actual_hash ),
2149 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002150 if( status != PSA_SUCCESS )
2151 return( status );
2152 if( actual_hash_length != hash_length )
2153 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002154 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155 return( PSA_ERROR_INVALID_SIGNATURE );
2156 return( PSA_SUCCESS );
2157}
2158
Gilles Peskine0a749c82019-11-28 19:33:58 +01002159psa_status_t psa_hash_compute( psa_algorithm_t alg,
2160 const uint8_t *input, size_t input_length,
2161 uint8_t *hash, size_t hash_size,
2162 size_t *hash_length )
2163{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002164 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002165 if( !PSA_ALG_IS_HASH( alg ) )
2166 return( PSA_ERROR_INVALID_ARGUMENT );
2167
Steven Cooreman1e582352021-02-18 17:24:37 +01002168 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2169 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002170}
2171
2172psa_status_t psa_hash_compare( psa_algorithm_t alg,
2173 const uint8_t *input, size_t input_length,
2174 const uint8_t *hash, size_t hash_length )
2175{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002176 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2177 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002178
2179 if( !PSA_ALG_IS_HASH( alg ) )
2180 return( PSA_ERROR_INVALID_ARGUMENT );
2181
Steven Cooreman1e582352021-02-18 17:24:37 +01002182 psa_status_t status = psa_driver_wrapper_hash_compute(
2183 alg, input, input_length,
2184 actual_hash, sizeof(actual_hash),
2185 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002186 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002187 return( status );
2188 if( actual_hash_length != hash_length )
2189 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002190 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002191 return( PSA_ERROR_INVALID_SIGNATURE );
2192 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002193}
2194
Gilles Peskineeb35d782019-01-22 17:56:16 +01002195psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2196 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002197{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002198 if( source_operation->id == 0 ||
2199 target_operation->id != 0 )
2200 {
2201 return( PSA_ERROR_BAD_STATE );
2202 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002203
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002204 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2205 target_operation );
2206 if( status != PSA_SUCCESS )
2207 psa_hash_abort( target_operation );
2208
2209 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002210}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002211
2212
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002213/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002214/* MAC */
2215/****************************************************************/
2216
Steven Cooremane6804192021-03-19 18:28:56 +01002217psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002218{
Steven Cooremane6804192021-03-19 18:28:56 +01002219 /* Aborting a non-active operation is allowed */
2220 if( operation->id == 0 )
2221 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002222
Steven Cooremane6804192021-03-19 18:28:56 +01002223 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002224 operation->mac_size = 0;
2225 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002226 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002227
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002228 return( status );
2229}
2230
Ronald Cron2dff3b22021-06-17 16:33:22 +02002231static psa_status_t psa_mac_finalize_alg_and_key_validation(
2232 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002233 const psa_key_attributes_t *attributes,
2234 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002235{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002237 psa_key_type_t key_type = psa_get_key_type( attributes );
2238 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002239
Ronald Cron28ea0502021-06-17 16:10:24 +02002240 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002241 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002242
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002243 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002244 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002245 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002246 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002247
Steven Cooremand1a68f12021-05-10 11:13:41 +02002248 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002249 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002250
Ronald Cron79bdd822021-06-17 16:46:44 +02002251 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002252 {
2253 /* A very short MAC is too short for security since it can be
2254 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2255 * so we make this our minimum, even though 32 bits is still
2256 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002257 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002258 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002259
Ronald Cron79bdd822021-06-17 16:46:44 +02002260 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2261 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002262 {
2263 /* It's impossible to "truncate" to a larger length than the full length
2264 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002265 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002266 }
2267
Ronald Cron79bdd822021-06-17 16:46:44 +02002268 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002269}
2270
Gilles Peskinee59236f2018-01-27 23:32:46 +01002271static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2272 mbedtls_svc_key_id_t key,
2273 psa_algorithm_t alg,
2274 int is_sign )
2275{
2276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2277 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2278 psa_key_slot_t *slot;
2279
2280 /* A context must be freshly initialized before it can be set up. */
2281 if( operation->id != 0 )
2282 return( PSA_ERROR_BAD_STATE );
2283
Gilles Peskine8c9def32018-02-08 10:02:12 +01002284 status = psa_get_and_lock_key_slot_with_policy(
2285 key,
2286 &slot,
2287 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2288 alg );
2289 if( status != PSA_SUCCESS )
2290 return( status );
2291
2292 psa_key_attributes_t attributes = {
2293 .core = slot->attr
2294 };
2295
Ronald Cron79bdd822021-06-17 16:46:44 +02002296 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2297 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002298 if( status != PSA_SUCCESS )
2299 goto exit;
2300
2301 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002302 /* Dispatch the MAC setup call with validated input */
2303 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002304 {
Steven Cooremane6804192021-03-19 18:28:56 +01002305 status = psa_driver_wrapper_mac_sign_setup( operation,
2306 &attributes,
2307 slot->key.data,
2308 slot->key.bytes,
2309 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002310 }
2311 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002312 {
Steven Cooremane6804192021-03-19 18:28:56 +01002313 status = psa_driver_wrapper_mac_verify_setup( operation,
2314 &attributes,
2315 slot->key.data,
2316 slot->key.bytes,
2317 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002318 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002319
Gilles Peskinefbfac682018-07-08 20:51:54 +02002320exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002321 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002322 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002323
Ronald Cron5c522922020-11-14 16:35:34 +01002324 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002325
Ronald Cron5c522922020-11-14 16:35:34 +01002326 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002327}
2328
Gilles Peskine89167cb2018-07-08 20:12:23 +02002329psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002330 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002331 psa_algorithm_t alg )
2332{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002333 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002334}
2335
2336psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002337 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002338 psa_algorithm_t alg )
2339{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002340 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341}
2342
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002343psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002344 const uint8_t *input,
2345 size_t input_length )
2346{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002347 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002348 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002350 /* Don't require hash implementations to behave correctly on a
2351 * zero-length input, which may have an invalid pointer. */
2352 if( input_length == 0 )
2353 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002354
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002355 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2356 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002357 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002358 psa_mac_abort( operation );
2359
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002360 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361}
2362
Steven Cooremana5b860a2021-03-19 19:04:39 +01002363psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002364 uint8_t *mac,
2365 size_t mac_size,
2366 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002367{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002368 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2369 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002370
Steven Cooreman72f736a2021-05-07 14:14:37 +02002371 /* Set the output length and content to a safe default, such that in
2372 * case the caller misses an error check, the output would be an
2373 * unachievable MAC. */
2374 *mac_length = mac_size;
2375
Steven Cooremana5b860a2021-03-19 19:04:39 +01002376 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002377 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002378
Steven Cooreman72f736a2021-05-07 14:14:37 +02002379 if( ! operation->is_sign )
2380 return( PSA_ERROR_BAD_STATE );
2381
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002382 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2383 * once all the error checks are done. */
2384 if( operation->mac_size == 0 )
2385 return( PSA_ERROR_BAD_STATE );
2386
2387 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002388 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002389
Steven Cooremana5b860a2021-03-19 19:04:39 +01002390 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002391 mac, operation->mac_size,
2392 mac_length );
2393
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002394 /* In case of success, set the potential excess room in the output buffer
2395 * to an invalid value, to avoid potentially leaking a longer MAC.
2396 * In case of error, set the output length and content to a safe default,
2397 * such that in case the caller misses an error check, the output would be
2398 * an unachievable MAC.
2399 */
2400 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002401 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002402 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002403 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002404 }
mohammad16036df908f2018-04-02 08:34:15 -07002405
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002406 if( mac_size > operation->mac_size )
2407 memset( &mac[operation->mac_size], '!',
2408 mac_size - operation->mac_size );
2409
Steven Cooremana5b860a2021-03-19 19:04:39 +01002410 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002411
Steven Cooremana5b860a2021-03-19 19:04:39 +01002412 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002413}
2414
Steven Cooremana5b860a2021-03-19 19:04:39 +01002415psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002416 const uint8_t *mac,
2417 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002418{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2420 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002421
Steven Cooremana5b860a2021-03-19 19:04:39 +01002422 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002423 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002424
Steven Cooreman72f736a2021-05-07 14:14:37 +02002425 if( operation->is_sign )
2426 return( PSA_ERROR_BAD_STATE );
2427
2428 if( operation->mac_size != mac_length )
2429 {
2430 status = PSA_ERROR_INVALID_SIGNATURE;
2431 goto cleanup;
2432 }
2433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 status = psa_driver_wrapper_mac_verify_finish( operation,
2435 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002436
2437cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002438 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002439
Steven Cooremana5b860a2021-03-19 19:04:39 +01002440 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441}
2442
Ronald Croncd989b52021-06-18 14:23:33 +02002443static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2444 psa_algorithm_t alg,
2445 const uint8_t *input,
2446 size_t input_length,
2447 uint8_t *mac,
2448 size_t mac_size,
2449 size_t *mac_length,
2450 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002451{
2452 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002453 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2454 psa_key_slot_t *slot;
2455 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002456
Ronald Cron51131b52021-06-17 17:17:20 +02002457 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002458 key, &slot,
2459 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2460 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002461 if( status != PSA_SUCCESS )
2462 goto exit;
2463
Ronald Cron51131b52021-06-17 17:17:20 +02002464 psa_key_attributes_t attributes = {
2465 .core = slot->attr
2466 };
2467
2468 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2469 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002470 if( status != PSA_SUCCESS )
2471 goto exit;
2472
Ronald Cron51131b52021-06-17 17:17:20 +02002473 if( mac_size < operation_mac_size )
2474 {
2475 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002476 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002477 }
2478
2479 status = psa_driver_wrapper_mac_compute(
2480 &attributes,
2481 slot->key.data, slot->key.bytes,
2482 alg,
2483 input, input_length,
2484 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002485
2486exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002487 /* In case of success, set the potential excess room in the output buffer
2488 * to an invalid value, to avoid potentially leaking a longer MAC.
2489 * In case of error, set the output length and content to a safe default,
2490 * such that in case the caller misses an error check, the output would be
2491 * an unachievable MAC.
2492 */
2493 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002494 {
Ronald Cron51131b52021-06-17 17:17:20 +02002495 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002496 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002497 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002498 if( mac_size > operation_mac_size )
2499 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002500
Ronald Cron51131b52021-06-17 17:17:20 +02002501 unlock_status = psa_unlock_key_slot( slot );
2502
2503 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002504}
2505
Ronald Croncd989b52021-06-18 14:23:33 +02002506psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2507 psa_algorithm_t alg,
2508 const uint8_t *input,
2509 size_t input_length,
2510 uint8_t *mac,
2511 size_t mac_size,
2512 size_t *mac_length)
2513{
2514 return( psa_mac_compute_internal( key, alg,
2515 input, input_length,
2516 mac, mac_size, mac_length, 1 ) );
2517}
2518
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002519psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2520 psa_algorithm_t alg,
2521 const uint8_t *input,
2522 size_t input_length,
2523 const uint8_t *mac,
2524 size_t mac_length)
2525{
2526 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002527 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2528 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002529
Ronald Crona587cbc2021-06-18 14:51:29 +02002530 status = psa_mac_compute_internal( key, alg,
2531 input, input_length,
2532 actual_mac, sizeof( actual_mac ),
2533 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002534 if( status != PSA_SUCCESS )
2535 goto exit;
2536
Ronald Crona587cbc2021-06-18 14:51:29 +02002537 if( mac_length != actual_mac_length )
2538 {
2539 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002540 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002541 }
2542 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2543 {
2544 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002545 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002546 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002547
2548exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002549 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002550
2551 return ( status );
2552}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002553
Gilles Peskinee59236f2018-01-27 23:32:46 +01002554/****************************************************************/
2555/* Asymmetric cryptography */
2556/****************************************************************/
2557
gabor-mezei-armf0486182021-05-12 11:03:09 +02002558static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002559 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002560{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002561 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002562 {
2563 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2564 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002565
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002566 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2567 {
2568 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2569 return( PSA_ERROR_INVALID_ARGUMENT );
2570 }
2571 }
2572 else
2573 {
2574 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2575 return( PSA_ERROR_INVALID_ARGUMENT );
2576 }
2577
2578 return( PSA_SUCCESS );
2579}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002580
2581static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002582 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002583 psa_algorithm_t alg,
2584 const uint8_t * input,
2585 size_t input_length,
2586 uint8_t * signature,
2587 size_t signature_size,
2588 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002589{
2590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2591 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2592 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002593
2594 *signature_length = 0;
2595
gabor-mezei-armf0486182021-05-12 11:03:09 +02002596 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002597 if( status != PSA_SUCCESS )
2598 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002599
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002600 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002601 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002602 * buffer can in principle be empty since it doesn't actually have
2603 * to be a hash.) */
2604 if( signature_size == 0 )
2605 return( PSA_ERROR_BUFFER_TOO_SMALL );
2606
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002607 status = psa_get_and_lock_key_slot_with_policy(
2608 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002609 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2610 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002611 alg );
2612
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002613 if( status != PSA_SUCCESS )
2614 goto exit;
2615
2616 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2617 {
2618 status = PSA_ERROR_INVALID_ARGUMENT;
2619 goto exit;
2620 }
2621
2622 psa_key_attributes_t attributes = {
2623 .core = slot->attr
2624 };
2625
gabor-mezei-armf0486182021-05-12 11:03:09 +02002626 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002627 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002628 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002629 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002630 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002631 signature, signature_size, signature_length );
2632 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002633 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002634 {
2635
2636 status = psa_driver_wrapper_sign_hash(
2637 &attributes, slot->key.data, slot->key.bytes,
2638 alg, input, input_length,
2639 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002640 }
2641
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002642
2643exit:
2644 /* Fill the unused part of the output buffer (the whole buffer on error,
2645 * the trailing part on success) with something that isn't a valid signature
2646 * (barring an attack on the signature and deliberately-crafted input),
2647 * in case the caller doesn't check the return status properly. */
2648 if( status == PSA_SUCCESS )
2649 memset( signature + *signature_length, '!',
2650 signature_size - *signature_length );
2651 else
2652 memset( signature, '!', signature_size );
2653 /* If signature_size is 0 then we have nothing to do. We must not call
2654 * memset because signature may be NULL in this case. */
2655
2656 unlock_status = psa_unlock_key_slot( slot );
2657
2658 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2659}
2660
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002661static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002662 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002663 psa_algorithm_t alg,
2664 const uint8_t * input,
2665 size_t input_length,
2666 const uint8_t * signature,
2667 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002668{
2669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2670 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2671 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002672
gabor-mezei-armf0486182021-05-12 11:03:09 +02002673 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002674 if( status != PSA_SUCCESS )
2675 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002676
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002677 status = psa_get_and_lock_key_slot_with_policy(
2678 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002679 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2680 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002681 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002682
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002683 if( status != PSA_SUCCESS )
2684 return( status );
2685
2686 psa_key_attributes_t attributes = {
2687 .core = slot->attr
2688 };
2689
gabor-mezei-armf0486182021-05-12 11:03:09 +02002690 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002691 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002692 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002693 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002694 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002695 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002696 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002697 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002698 {
2699 status = psa_driver_wrapper_verify_hash(
2700 &attributes, slot->key.data, slot->key.bytes,
2701 alg, input, input_length,
2702 signature, signature_length );
2703 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002704
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002705 unlock_status = psa_unlock_key_slot( slot );
2706
2707 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002708
2709}
2710
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002711psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002712 const psa_key_attributes_t *attributes,
2713 const uint8_t *key_buffer,
2714 size_t key_buffer_size,
2715 psa_algorithm_t alg,
2716 const uint8_t *input,
2717 size_t input_length,
2718 uint8_t *signature,
2719 size_t signature_size,
2720 size_t *signature_length )
2721{
2722 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002723
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002724 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2725 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002726 size_t hash_length;
2727 uint8_t hash[PSA_HASH_MAX_SIZE];
2728
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002729 status = psa_driver_wrapper_hash_compute(
2730 PSA_ALG_SIGN_GET_HASH( alg ),
2731 input, input_length,
2732 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002733
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002734 if( status != PSA_SUCCESS )
2735 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002736
2737 return psa_driver_wrapper_sign_hash(
2738 attributes, key_buffer, key_buffer_size,
2739 alg, hash, hash_length,
2740 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002741 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002742
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002743 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002744}
2745
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002746psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2747 psa_algorithm_t alg,
2748 const uint8_t * input,
2749 size_t input_length,
2750 uint8_t * signature,
2751 size_t signature_size,
2752 size_t * signature_length )
2753{
2754 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002755 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002756 signature, signature_size, signature_length );
2757}
2758
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002759psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002760 const psa_key_attributes_t *attributes,
2761 const uint8_t *key_buffer,
2762 size_t key_buffer_size,
2763 psa_algorithm_t alg,
2764 const uint8_t *input,
2765 size_t input_length,
2766 const uint8_t *signature,
2767 size_t signature_length )
2768{
2769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002770
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002771 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2772 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002773 size_t hash_length;
2774 uint8_t hash[PSA_HASH_MAX_SIZE];
2775
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002776 status = psa_driver_wrapper_hash_compute(
2777 PSA_ALG_SIGN_GET_HASH( alg ),
2778 input, input_length,
2779 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002780
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002781 if( status != PSA_SUCCESS )
2782 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002783
2784 return psa_driver_wrapper_verify_hash(
2785 attributes, key_buffer, key_buffer_size,
2786 alg, hash, hash_length,
2787 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002788 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002789
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002790 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002791}
2792
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002793psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2794 psa_algorithm_t alg,
2795 const uint8_t * input,
2796 size_t input_length,
2797 const uint8_t * signature,
2798 size_t signature_length )
2799{
2800 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002801 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002802 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002803}
2804
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002805psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002806 const psa_key_attributes_t *attributes,
2807 const uint8_t *key_buffer, size_t key_buffer_size,
2808 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2809 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002810{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002811 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002812 {
Ronald Cron4501c982021-03-19 20:09:32 +01002813 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2814 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002815 {
Ronald Cron4501c982021-03-19 20:09:32 +01002816#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2817 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2818 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002819 attributes,
2820 key_buffer, key_buffer_size,
2821 alg, hash, hash_length,
2822 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002823#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2824 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002825 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002826 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002827 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002828 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002829 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002830 }
2831 else
Ronald Cron4501c982021-03-19 20:09:32 +01002832 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2833 {
2834 if( PSA_ALG_IS_ECDSA( alg ) )
2835 {
2836#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2837 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2838 return( mbedtls_psa_ecdsa_sign_hash(
2839 attributes,
2840 key_buffer, key_buffer_size,
2841 alg, hash, hash_length,
2842 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002843#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2844 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002845 }
2846 else
2847 {
2848 return( PSA_ERROR_INVALID_ARGUMENT );
2849 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002850 }
Ronald Cron4501c982021-03-19 20:09:32 +01002851
2852 (void)key_buffer;
2853 (void)key_buffer_size;
2854 (void)hash;
2855 (void)hash_length;
2856 (void)signature;
2857 (void)signature_size;
2858 (void)signature_length;
2859
2860 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002861}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002862
2863psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2864 psa_algorithm_t alg,
2865 const uint8_t *hash,
2866 size_t hash_length,
2867 uint8_t *signature,
2868 size_t signature_size,
2869 size_t *signature_length )
2870{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002871 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002872 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002873 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002874}
2875
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002876psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002877 const psa_key_attributes_t *attributes,
2878 const uint8_t *key_buffer, size_t key_buffer_size,
2879 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2880 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002881{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002882 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002883 {
Ronald Cron4501c982021-03-19 20:09:32 +01002884 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2885 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002886 {
Ronald Cron4501c982021-03-19 20:09:32 +01002887#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2888 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2889 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002890 attributes,
2891 key_buffer, key_buffer_size,
2892 alg, hash, hash_length,
2893 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002894#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2895 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002896 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002897 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002898 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002899 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002900 }
itayzafrir5c753392018-05-08 11:18:38 +03002901 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002902 else
Ronald Cron4501c982021-03-19 20:09:32 +01002903 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002904 {
Ronald Cron4501c982021-03-19 20:09:32 +01002905 if( PSA_ALG_IS_ECDSA( alg ) )
2906 {
2907#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2908 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2909 return( mbedtls_psa_ecdsa_verify_hash(
2910 attributes,
2911 key_buffer, key_buffer_size,
2912 alg, hash, hash_length,
2913 signature, signature_length ) );
2914#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2915 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2916 }
2917 else
2918 {
2919 return( PSA_ERROR_INVALID_ARGUMENT );
2920 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002921 }
Ronald Cron4501c982021-03-19 20:09:32 +01002922
2923 (void)key_buffer;
2924 (void)key_buffer_size;
2925 (void)hash;
2926 (void)hash_length;
2927 (void)signature;
2928 (void)signature_length;
2929
2930 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002931}
2932
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002933psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2934 psa_algorithm_t alg,
2935 const uint8_t *hash,
2936 size_t hash_length,
2937 const uint8_t *signature,
2938 size_t signature_length )
2939{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002940 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002941 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002942 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002943}
2944
John Durkop0e005192020-10-31 22:06:54 -07002945#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002946static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2947 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002948{
2949 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2950 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2951 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002952
2953 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002954}
John Durkop0e005192020-10-31 22:06:54 -07002955#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002956
Ronald Croncf56a0a2020-08-04 09:51:30 +02002957psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002958 psa_algorithm_t alg,
2959 const uint8_t *input,
2960 size_t input_length,
2961 const uint8_t *salt,
2962 size_t salt_length,
2963 uint8_t *output,
2964 size_t output_size,
2965 size_t *output_length )
2966{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002967 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002968 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002969 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002970
Darryl Green5cc689a2018-07-24 15:34:10 +01002971 (void) input;
2972 (void) input_length;
2973 (void) salt;
2974 (void) output;
2975 (void) output_size;
2976
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002977 *output_length = 0;
2978
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002979 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2980 return( PSA_ERROR_INVALID_ARGUMENT );
2981
Ronald Cron5c522922020-11-14 16:35:34 +01002982 status = psa_get_and_lock_transparent_key_slot_with_policy(
2983 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002984 if( status != PSA_SUCCESS )
2985 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002986 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2987 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002988 {
2989 status = PSA_ERROR_INVALID_ARGUMENT;
2990 goto exit;
2991 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002992
John Durkop6ba40d12020-11-10 08:50:04 -08002993#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2994 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002995 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002996 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002997 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002998 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2999 slot->key.data,
3000 slot->key.bytes,
3001 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003002 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003003 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003004
3005 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003006 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003007 status = PSA_ERROR_BUFFER_TOO_SMALL;
3008 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003009 }
John Durkop0e005192020-10-31 22:06:54 -07003010#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003011 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3012 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003013 status = mbedtls_to_psa_error(
3014 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003015 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003016 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003017 input_length,
3018 input,
3019 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003020 }
3021 else
John Durkop0e005192020-10-31 22:06:54 -07003022#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3023#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003024 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3025 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003026 status = mbedtls_to_psa_error(
3027 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3028 if( status != PSA_SUCCESS )
3029 goto rsa_exit;
3030
Steven Cooreman4fed4552020-08-03 14:46:03 +02003031 status = mbedtls_to_psa_error(
3032 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003033 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003034 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003035 salt, salt_length,
3036 input_length,
3037 input,
3038 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003039 }
3040 else
John Durkop0e005192020-10-31 22:06:54 -07003041#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003042 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003043 status = PSA_ERROR_INVALID_ARGUMENT;
3044 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003045 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003046rsa_exit:
3047 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003048 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003049
Steven Cooremana2371e52020-07-28 14:30:39 +02003050 mbedtls_rsa_free( rsa );
3051 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003052 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003053 else
John Durkop9814fa22020-11-04 12:28:15 -08003054#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003055 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003057 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003058 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003059
3060exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003061 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003062
Ronald Cron5c522922020-11-14 16:35:34 +01003063 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003064}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003065
Ronald Croncf56a0a2020-08-04 09:51:30 +02003066psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003067 psa_algorithm_t alg,
3068 const uint8_t *input,
3069 size_t input_length,
3070 const uint8_t *salt,
3071 size_t salt_length,
3072 uint8_t *output,
3073 size_t output_size,
3074 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003076 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003077 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003078 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003079
Darryl Green5cc689a2018-07-24 15:34:10 +01003080 (void) input;
3081 (void) input_length;
3082 (void) salt;
3083 (void) output;
3084 (void) output_size;
3085
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003086 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003087
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003088 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3089 return( PSA_ERROR_INVALID_ARGUMENT );
3090
Ronald Cron5c522922020-11-14 16:35:34 +01003091 status = psa_get_and_lock_transparent_key_slot_with_policy(
3092 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003093 if( status != PSA_SUCCESS )
3094 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003095 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003096 {
3097 status = PSA_ERROR_INVALID_ARGUMENT;
3098 goto exit;
3099 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100
John Durkop6ba40d12020-11-10 08:50:04 -08003101#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3102 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003103 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003105 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003106 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3107 slot->key.data,
3108 slot->key.bytes,
3109 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003110 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003111 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003112
Steven Cooremana2371e52020-07-28 14:30:39 +02003113 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003114 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003115 status = PSA_ERROR_INVALID_ARGUMENT;
3116 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003117 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003118
John Durkop0e005192020-10-31 22:06:54 -07003119#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003120 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003122 status = mbedtls_to_psa_error(
3123 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003124 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003125 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003126 output_length,
3127 input,
3128 output,
3129 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003130 }
3131 else
John Durkop0e005192020-10-31 22:06:54 -07003132#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3133#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003134 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003136 status = mbedtls_to_psa_error(
3137 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3138 if( status != PSA_SUCCESS )
3139 goto rsa_exit;
3140
Steven Cooreman4fed4552020-08-03 14:46:03 +02003141 status = mbedtls_to_psa_error(
3142 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003143 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003144 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003145 salt, salt_length,
3146 output_length,
3147 input,
3148 output,
3149 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003150 }
3151 else
John Durkop0e005192020-10-31 22:06:54 -07003152#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003153 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003154 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003156
Steven Cooreman4fed4552020-08-03 14:46:03 +02003157rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003158 mbedtls_rsa_free( rsa );
3159 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003160 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003161 else
John Durkop6ba40d12020-11-10 08:50:04 -08003162#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3163 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003164 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003165 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003167
3168exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003169 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003170
Ronald Cron5c522922020-11-14 16:35:34 +01003171 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003172}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003173
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003174
3175
mohammad1603503973b2018-03-12 15:59:30 +02003176/****************************************************************/
3177/* Symmetric cryptography */
3178/****************************************************************/
3179
Ronald Cronab99ac22020-10-01 16:38:28 +02003180static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3181 mbedtls_svc_key_id_t key,
3182 psa_algorithm_t alg,
3183 mbedtls_operation_t cipher_operation )
3184{
3185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3186 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3187 psa_key_slot_t *slot;
3188 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3189 PSA_KEY_USAGE_ENCRYPT :
3190 PSA_KEY_USAGE_DECRYPT );
3191
3192 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003193 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003194 return( PSA_ERROR_BAD_STATE );
3195
3196 /* The requested algorithm must be one that can be processed by cipher. */
3197 if( ! PSA_ALG_IS_CIPHER( alg ) )
3198 return( PSA_ERROR_INVALID_ARGUMENT );
3199
3200 /* Fetch key material from key storage. */
3201 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3202 if( status != PSA_SUCCESS )
3203 goto exit;
3204
Ronald Cron49fafa92021-03-10 08:34:23 +01003205 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003206 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003207 * so we only set it (in the driver wrapper) after resources have been
3208 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003209 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003210 if( alg == PSA_ALG_ECB_NO_PADDING )
3211 operation->iv_required = 0;
3212 else
3213 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003214 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003215
Ronald Crona4af55f2020-12-14 14:36:06 +01003216 psa_key_attributes_t attributes = {
3217 .core = slot->attr
3218 };
3219
Ronald Cronab99ac22020-10-01 16:38:28 +02003220 /* Try doing the operation through a driver before using software fallback. */
3221 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003222 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3223 &attributes,
3224 slot->key.data,
3225 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003226 alg );
3227 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003228 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3229 &attributes,
3230 slot->key.data,
3231 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003232 alg );
3233
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003234exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003235 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003236 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003237
Ronald Cron5c522922020-11-14 16:35:34 +01003238 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003239
Ronald Cron5c522922020-11-14 16:35:34 +01003240 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003241}
3242
Gilles Peskinefe119512018-07-08 21:39:34 +02003243psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003244 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003245 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003246{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003247 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003248}
3249
Gilles Peskinefe119512018-07-08 21:39:34 +02003250psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003251 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003252 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003253{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003254 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003255}
3256
Gilles Peskinefe119512018-07-08 21:39:34 +02003257psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003258 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003259 size_t iv_size,
3260 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003261{
Ronald Cron6d051732020-10-01 14:10:20 +02003262 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003263
Ronald Cron5618a392021-03-26 09:52:26 +01003264 *iv_length = 0;
3265
Ronald Cron49fafa92021-03-10 08:34:23 +01003266 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003267 {
3268 return( PSA_ERROR_BAD_STATE );
3269 }
3270
Steven Cooreman7df02922020-09-09 15:28:49 +02003271 if( operation->iv_set || ! operation->iv_required )
3272 {
3273 return( PSA_ERROR_BAD_STATE );
3274 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003275
Ronald Cron5618a392021-03-26 09:52:26 +01003276 if( iv_size < operation->default_iv_length )
3277 {
3278 status = PSA_ERROR_BUFFER_TOO_SMALL;
3279 goto exit;
3280 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003281
Ronald Cron5618a392021-03-26 09:52:26 +01003282 status = psa_generate_random( iv, operation->default_iv_length );
3283 if( status != PSA_SUCCESS )
3284 goto exit;
3285
3286 status = psa_driver_wrapper_cipher_set_iv( operation,
3287 iv,
3288 operation->default_iv_length );
3289
3290exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003291 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003292 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003293 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003294 *iv_length = operation->default_iv_length;
3295 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003296 else
Moran Peker395db872018-05-31 14:07:14 +03003297 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003298
itayzafrir534bd7c2018-08-02 13:56:32 +03003299 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003300}
3301
Gilles Peskinefe119512018-07-08 21:39:34 +02003302psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003303 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003304 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003305{
Ronald Cron6d051732020-10-01 14:10:20 +02003306 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003307
Ronald Cron49fafa92021-03-10 08:34:23 +01003308 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003309 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003310
Steven Cooreman7df02922020-09-09 15:28:49 +02003311 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003312 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003313
3314 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3315 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003316
Ronald Crondd24c9b2020-12-15 14:10:01 +01003317 status = psa_driver_wrapper_cipher_set_iv( operation,
3318 iv,
3319 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003320
itayzafrir534bd7c2018-08-02 13:56:32 +03003321 if( status == PSA_SUCCESS )
3322 operation->iv_set = 1;
3323 else
mohammad1603503973b2018-03-12 15:59:30 +02003324 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003325 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003326}
3327
Gilles Peskinee553c652018-06-04 16:22:46 +02003328psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3329 const uint8_t *input,
3330 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003331 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003332 size_t output_size,
3333 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003334{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003335 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003336
Ronald Cron49fafa92021-03-10 08:34:23 +01003337 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003338 {
3339 return( PSA_ERROR_BAD_STATE );
3340 }
3341 if( operation->iv_required && ! operation->iv_set )
3342 {
3343 return( PSA_ERROR_BAD_STATE );
3344 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003345
Ronald Crondd24c9b2020-12-15 14:10:01 +01003346 status = psa_driver_wrapper_cipher_update( operation,
3347 input,
3348 input_length,
3349 output,
3350 output_size,
3351 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003352 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003353 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003354
itayzafrir534bd7c2018-08-02 13:56:32 +03003355 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003356}
3357
Gilles Peskinee553c652018-06-04 16:22:46 +02003358psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3359 uint8_t *output,
3360 size_t output_size,
3361 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003362{
David Saadab4ecc272019-02-14 13:48:10 +02003363 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003364
Ronald Cron49fafa92021-03-10 08:34:23 +01003365 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003366 {
3367 return( PSA_ERROR_BAD_STATE );
3368 }
3369 if( operation->iv_required && ! operation->iv_set )
3370 {
3371 return( PSA_ERROR_BAD_STATE );
3372 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003373
Ronald Crondd24c9b2020-12-15 14:10:01 +01003374 status = psa_driver_wrapper_cipher_finish( operation,
3375 output,
3376 output_size,
3377 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003378 if( status == PSA_SUCCESS )
3379 return( psa_cipher_abort( operation ) );
3380 else
3381 {
3382 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003383 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003384
Steven Cooremanef8575e2020-09-11 11:44:50 +02003385 return( status );
3386 }
mohammad1603503973b2018-03-12 15:59:30 +02003387}
3388
Gilles Peskinee553c652018-06-04 16:22:46 +02003389psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3390{
Ronald Cron49fafa92021-03-10 08:34:23 +01003391 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003392 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003393 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003394 * in use. It's ok to call abort on such an object, and there's
3395 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003396 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003397 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003398
Ronald Crondd24c9b2020-12-15 14:10:01 +01003399 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003400
Ronald Cron49fafa92021-03-10 08:34:23 +01003401 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003402 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003403 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003404
Moran Peker395db872018-05-31 14:07:14 +03003405 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003406}
3407
mohammad16035955c982018-04-26 00:53:03 +03003408/****************************************************************/
3409/* AEAD */
3410/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003411
Ronald Croncf56a0a2020-08-04 09:51:30 +02003412psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003413 psa_algorithm_t alg,
3414 const uint8_t *nonce,
3415 size_t nonce_length,
3416 const uint8_t *additional_data,
3417 size_t additional_data_length,
3418 const uint8_t *plaintext,
3419 size_t plaintext_length,
3420 uint8_t *ciphertext,
3421 size_t ciphertext_size,
3422 size_t *ciphertext_length )
3423{
Ronald Cron215633c2021-03-16 17:15:37 +01003424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3425 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003426
mohammad1603f08a5502018-06-03 15:05:47 +03003427 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003428
Steven Cooremanea7ab132021-03-17 16:28:00 +01003429 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3430 return( PSA_ERROR_NOT_SUPPORTED );
3431
Ronald Cron9a986162021-03-26 12:40:07 +01003432 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003433 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003434 if( status != PSA_SUCCESS )
3435 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003436
Ronald Cron215633c2021-03-16 17:15:37 +01003437 psa_key_attributes_t attributes = {
3438 .core = slot->attr
3439 };
mohammad16035955c982018-04-26 00:53:03 +03003440
Ronald Cronde822812021-03-17 16:08:20 +01003441 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003442 &attributes, slot->key.data, slot->key.bytes,
3443 alg,
3444 nonce, nonce_length,
3445 additional_data, additional_data_length,
3446 plaintext, plaintext_length,
3447 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003448
Gilles Peskineedf9a652018-08-17 18:11:56 +02003449 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3450 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003451
Ronald Cron9f310172021-03-16 16:36:37 +01003452 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003453
mohammad16035955c982018-04-26 00:53:03 +03003454 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003455}
3456
Ronald Croncf56a0a2020-08-04 09:51:30 +02003457psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003458 psa_algorithm_t alg,
3459 const uint8_t *nonce,
3460 size_t nonce_length,
3461 const uint8_t *additional_data,
3462 size_t additional_data_length,
3463 const uint8_t *ciphertext,
3464 size_t ciphertext_length,
3465 uint8_t *plaintext,
3466 size_t plaintext_size,
3467 size_t *plaintext_length )
3468{
Ronald Cron215633c2021-03-16 17:15:37 +01003469 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3470 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003471
Gilles Peskineee652a32018-06-01 19:23:52 +02003472 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003473
Steven Cooremanea7ab132021-03-17 16:28:00 +01003474 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3475 return( PSA_ERROR_NOT_SUPPORTED );
3476
Ronald Cron9a986162021-03-26 12:40:07 +01003477 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003478 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003479 if( status != PSA_SUCCESS )
3480 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003481
Ronald Cron215633c2021-03-16 17:15:37 +01003482 psa_key_attributes_t attributes = {
3483 .core = slot->attr
3484 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003485
Ronald Cronde822812021-03-17 16:08:20 +01003486 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003487 &attributes, slot->key.data, slot->key.bytes,
3488 alg,
3489 nonce, nonce_length,
3490 additional_data, additional_data_length,
3491 ciphertext, ciphertext_length,
3492 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003493
Gilles Peskineedf9a652018-08-17 18:11:56 +02003494 if( status != PSA_SUCCESS && plaintext_size != 0 )
3495 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003496
Ronald Cron215633c2021-03-16 17:15:37 +01003497 psa_unlock_key_slot( slot );
3498
Gilles Peskineedf9a652018-08-17 18:11:56 +02003499 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003500}
3501
Gilles Peskinee59236f2018-01-27 23:32:46 +01003502/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003503/* Generators */
3504/****************************************************************/
3505
John Durkop07cc04a2020-11-16 22:08:34 -08003506#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3507 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3508 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3509#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003510#endif /* At least one builtin KDF */
3511
3512#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3513 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3514 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3515static psa_status_t psa_key_derivation_start_hmac(
3516 psa_mac_operation_t *operation,
3517 psa_algorithm_t hash_alg,
3518 const uint8_t *hmac_key,
3519 size_t hmac_key_length )
3520{
3521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3522 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3523 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3524 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3525 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3526
Steven Cooreman72f736a2021-05-07 14:14:37 +02003527 operation->is_sign = 1;
3528 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3529
Steven Cooreman094a77e2021-05-06 17:58:36 +02003530 status = psa_driver_wrapper_mac_sign_setup( operation,
3531 &attributes,
3532 hmac_key, hmac_key_length,
3533 PSA_ALG_HMAC( hash_alg ) );
3534
3535 psa_reset_key_attributes( &attributes );
3536 return( status );
3537}
3538#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003539
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003540#define HKDF_STATE_INIT 0 /* no input yet */
3541#define HKDF_STATE_STARTED 1 /* got salt */
3542#define HKDF_STATE_KEYED 2 /* got key */
3543#define HKDF_STATE_OUTPUT 3 /* output started */
3544
Gilles Peskinecbe66502019-05-16 16:59:18 +02003545static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003546 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003547{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003548 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3549 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003550 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003551 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003552}
3553
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003554psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003555{
3556 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003557 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003558 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003559 {
3560 /* The object has (apparently) been initialized but it is not
3561 * in use. It's ok to call abort on such an object, and there's
3562 * nothing to do. */
3563 }
3564 else
John Durkopd0321952020-10-29 21:37:36 -07003565#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003566 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003567 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003568 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003569 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003570 }
John Durkop07cc04a2020-11-16 22:08:34 -08003571 else
3572#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3573#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3574 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3575 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003576 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003577 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003578 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003579 if( operation->ctx.tls12_prf.secret != NULL )
3580 {
3581 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3582 operation->ctx.tls12_prf.secret_length );
3583 mbedtls_free( operation->ctx.tls12_prf.secret );
3584 }
3585
Janos Follath6a1d2622019-06-11 10:37:28 +01003586 if( operation->ctx.tls12_prf.seed != NULL )
3587 {
3588 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3589 operation->ctx.tls12_prf.seed_length );
3590 mbedtls_free( operation->ctx.tls12_prf.seed );
3591 }
3592
3593 if( operation->ctx.tls12_prf.label != NULL )
3594 {
3595 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3596 operation->ctx.tls12_prf.label_length );
3597 mbedtls_free( operation->ctx.tls12_prf.label );
3598 }
3599
Steven Cooremana6df6042021-04-29 19:32:25 +02003600 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003601
3602 /* We leave the fields Ai and output_block to be erased safely by the
3603 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003604 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003605 else
John Durkop07cc04a2020-11-16 22:08:34 -08003606#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3607 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003608 {
3609 status = PSA_ERROR_BAD_STATE;
3610 }
Janos Follath083036a2019-06-11 10:22:26 +01003611 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003612 return( status );
3613}
3614
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003615psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003616 size_t *capacity)
3617{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003618 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003619 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003620 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003621 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003622 }
3623
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003624 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003625 return( PSA_SUCCESS );
3626}
3627
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003628psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003629 size_t capacity )
3630{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003631 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003632 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003633 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003634 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003635 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003636 return( PSA_SUCCESS );
3637}
3638
John Durkopd0321952020-10-29 21:37:36 -07003639#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003640/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003641 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003642static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003643 psa_algorithm_t hash_alg,
3644 uint8_t *output,
3645 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003646{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003647 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003648 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003649 psa_status_t status;
3650
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003651 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3652 return( PSA_ERROR_BAD_STATE );
3653 hkdf->state = HKDF_STATE_OUTPUT;
3654
Gilles Peskinebef7f142018-07-12 17:22:21 +02003655 while( output_length != 0 )
3656 {
3657 /* Copy what remains of the current block */
3658 uint8_t n = hash_length - hkdf->offset_in_block;
3659 if( n > output_length )
3660 n = (uint8_t) output_length;
3661 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3662 output += n;
3663 output_length -= n;
3664 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003665 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003666 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003667 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003668 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003669 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003670 * object was corrupted or if this function is called directly
3671 * inside the library. */
3672 if( hkdf->block_number == 0xff )
3673 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003674
3675 /* We need a new block */
3676 ++hkdf->block_number;
3677 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003678
Steven Cooreman094a77e2021-05-06 17:58:36 +02003679 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3680 hash_alg,
3681 hkdf->prk,
3682 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003683 if( status != PSA_SUCCESS )
3684 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003685
Gilles Peskinebef7f142018-07-12 17:22:21 +02003686 if( hkdf->block_number != 1 )
3687 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003688 status = psa_mac_update( &hkdf->hmac,
3689 hkdf->output_block,
3690 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003691 if( status != PSA_SUCCESS )
3692 return( status );
3693 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003694 status = psa_mac_update( &hkdf->hmac,
3695 hkdf->info,
3696 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003697 if( status != PSA_SUCCESS )
3698 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003699 status = psa_mac_update( &hkdf->hmac,
3700 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003701 if( status != PSA_SUCCESS )
3702 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003703 status = psa_mac_sign_finish( &hkdf->hmac,
3704 hkdf->output_block,
3705 sizeof( hkdf->output_block ),
3706 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003707 if( status != PSA_SUCCESS )
3708 return( status );
3709 }
3710
3711 return( PSA_SUCCESS );
3712}
John Durkop07cc04a2020-11-16 22:08:34 -08003713#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003714
John Durkop07cc04a2020-11-16 22:08:34 -08003715#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3716 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003717static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3718 psa_tls12_prf_key_derivation_t *tls12_prf,
3719 psa_algorithm_t alg )
3720{
3721 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003722 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003723 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3724 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003725 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003726
Janos Follath7742fee2019-06-17 12:58:10 +01003727 /* We can't be wanting more output after block 0xff, otherwise
3728 * the capacity check in psa_key_derivation_output_bytes() would have
3729 * prevented this call. It could happen only if the operation
3730 * object was corrupted or if this function is called directly
3731 * inside the library. */
3732 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003733 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003734
3735 /* We need a new block */
3736 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003737 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003738
3739 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3740 *
3741 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3742 *
3743 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3744 * HMAC_hash(secret, A(2) + seed) +
3745 * HMAC_hash(secret, A(3) + seed) + ...
3746 *
3747 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003748 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003749 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003750 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003751 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003752 * is currently extracted as `output_block` and where i is
3753 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003754 */
3755
Steven Cooreman094a77e2021-05-06 17:58:36 +02003756 status = psa_key_derivation_start_hmac( &hmac,
3757 hash_alg,
3758 tls12_prf->secret,
3759 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003760 if( status != PSA_SUCCESS )
3761 goto cleanup;
3762
3763 /* Calculate A(i) where i = tls12_prf->block_number. */
3764 if( tls12_prf->block_number == 1 )
3765 {
3766 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3767 * the variable seed and in this instance means it in the context of the
3768 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003769 status = psa_mac_update( &hmac,
3770 tls12_prf->label,
3771 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003772 if( status != PSA_SUCCESS )
3773 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003774 status = psa_mac_update( &hmac,
3775 tls12_prf->seed,
3776 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003777 if( status != PSA_SUCCESS )
3778 goto cleanup;
3779 }
3780 else
3781 {
3782 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003783 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003784 if( status != PSA_SUCCESS )
3785 goto cleanup;
3786 }
3787
Steven Cooremana6df6042021-04-29 19:32:25 +02003788 status = psa_mac_sign_finish( &hmac,
3789 tls12_prf->Ai, hash_length,
3790 &hmac_output_length );
3791 if( hmac_output_length != hash_length )
3792 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003793 if( status != PSA_SUCCESS )
3794 goto cleanup;
3795
3796 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003797 status = psa_key_derivation_start_hmac( &hmac,
3798 hash_alg,
3799 tls12_prf->secret,
3800 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003801 if( status != PSA_SUCCESS )
3802 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003803 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003804 if( status != PSA_SUCCESS )
3805 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003806 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003807 if( status != PSA_SUCCESS )
3808 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003809 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003810 if( status != PSA_SUCCESS )
3811 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003812 status = psa_mac_sign_finish( &hmac,
3813 tls12_prf->output_block, hash_length,
3814 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003815 if( status != PSA_SUCCESS )
3816 goto cleanup;
3817
Janos Follath7742fee2019-06-17 12:58:10 +01003818
3819cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003820 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003821 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3822 status = cleanup_status;
3823
3824 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003825}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003826
Janos Follath844eb0e2019-06-19 12:10:49 +01003827static psa_status_t psa_key_derivation_tls12_prf_read(
3828 psa_tls12_prf_key_derivation_t *tls12_prf,
3829 psa_algorithm_t alg,
3830 uint8_t *output,
3831 size_t output_length )
3832{
3833 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003834 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003835 psa_status_t status;
3836 uint8_t offset, length;
3837
Gilles Peskineb1edaec2021-06-11 22:41:46 +02003838 switch( tls12_prf->state )
3839 {
3840 case PSA_TLS12_PRF_STATE_LABEL_SET:
3841 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
3842 break;
3843 case PSA_TLS12_PRF_STATE_OUTPUT:
3844 break;
3845 default:
3846 return( PSA_ERROR_BAD_STATE );
3847 }
3848
Janos Follath844eb0e2019-06-19 12:10:49 +01003849 while( output_length != 0 )
3850 {
3851 /* Check if we have fully processed the current block. */
3852 if( tls12_prf->left_in_block == 0 )
3853 {
3854 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3855 alg );
3856 if( status != PSA_SUCCESS )
3857 return( status );
3858
3859 continue;
3860 }
3861
3862 if( tls12_prf->left_in_block > output_length )
3863 length = (uint8_t) output_length;
3864 else
3865 length = tls12_prf->left_in_block;
3866
3867 offset = hash_length - tls12_prf->left_in_block;
3868 memcpy( output, tls12_prf->output_block + offset, length );
3869 output += length;
3870 output_length -= length;
3871 tls12_prf->left_in_block -= length;
3872 }
3873
3874 return( PSA_SUCCESS );
3875}
John Durkop07cc04a2020-11-16 22:08:34 -08003876#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3877 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003878
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003879psa_status_t psa_key_derivation_output_bytes(
3880 psa_key_derivation_operation_t *operation,
3881 uint8_t *output,
3882 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003883{
3884 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003885 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003886
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003887 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003888 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003889 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003890 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003891 }
3892
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003893 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003894 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003895 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003896 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003897 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003898 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003899 goto exit;
3900 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003901 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003902 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003903 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003904 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003905 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3906 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003907 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003908 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003909 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003910 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003911 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003912
John Durkopd0321952020-10-29 21:37:36 -07003913#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003914 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003915 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003916 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003917 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003918 output, output_length );
3919 }
Janos Follathadbec812019-06-14 11:05:39 +01003920 else
John Durkop07cc04a2020-11-16 22:08:34 -08003921#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3922#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3923 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003924 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003925 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003926 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003927 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003928 kdf_alg, output,
3929 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003930 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003931 else
John Durkop07cc04a2020-11-16 22:08:34 -08003932#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3933 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003934 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003935 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003936 return( PSA_ERROR_BAD_STATE );
3937 }
3938
3939exit:
3940 if( status != PSA_SUCCESS )
3941 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003942 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003943 * This allows us to differentiate between exhausted operations and
3944 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3945 * operations. */
3946 psa_algorithm_t alg = operation->alg;
3947 psa_key_derivation_abort( operation );
3948 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003949 memset( output, '!', output_length );
3950 }
3951 return( status );
3952}
3953
David Brown7807bf72021-02-09 16:28:23 -07003954#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003955static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3956{
3957 if( data_size >= 8 )
3958 mbedtls_des_key_set_parity( data );
3959 if( data_size >= 16 )
3960 mbedtls_des_key_set_parity( data + 8 );
3961 if( data_size >= 24 )
3962 mbedtls_des_key_set_parity( data + 16 );
3963}
David Brown7807bf72021-02-09 16:28:23 -07003964#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003965
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003966static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003967 psa_key_slot_t *slot,
3968 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003969 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003970{
3971 uint8_t *data = NULL;
3972 size_t bytes = PSA_BITS_TO_BYTES( bits );
3973 psa_status_t status;
3974
Gilles Peskine8e338702019-07-30 20:06:31 +02003975 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003976 return( PSA_ERROR_INVALID_ARGUMENT );
3977 if( bits % 8 != 0 )
3978 return( PSA_ERROR_INVALID_ARGUMENT );
3979 data = mbedtls_calloc( 1, bytes );
3980 if( data == NULL )
3981 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3982
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003983 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003984 if( status != PSA_SUCCESS )
3985 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003986#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003987 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003988 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003989#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003990
3991 status = psa_allocate_buffer_to_slot( slot, bytes );
3992 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003993 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003994
Ronald Cronbf33c932020-11-28 18:06:53 +01003995 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003996 psa_key_attributes_t attributes = {
3997 .core = slot->attr
3998 };
3999
Ronald Cronbf33c932020-11-28 18:06:53 +01004000 status = psa_driver_wrapper_import_key( &attributes,
4001 data, bytes,
4002 slot->key.data,
4003 slot->key.bytes,
4004 &slot->key.bytes, &bits );
4005 if( bits != slot->attr.bits )
4006 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004007
4008exit:
4009 mbedtls_free( data );
4010 return( status );
4011}
4012
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004013psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004014 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004015 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004016{
4017 psa_status_t status;
4018 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004019 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004020
Ronald Cron81709fc2020-11-14 12:10:32 +01004021 *key = MBEDTLS_SVC_KEY_ID_INIT;
4022
Gilles Peskine0f84d622019-09-12 19:03:13 +02004023 /* Reject any attempt to create a zero-length key so that we don't
4024 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4025 if( psa_get_key_bits( attributes ) == 0 )
4026 return( PSA_ERROR_INVALID_ARGUMENT );
4027
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004028 if( ! operation->can_output_key )
4029 return( PSA_ERROR_NOT_PERMITTED );
4030
Ronald Cron81709fc2020-11-14 12:10:32 +01004031 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4032 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004033#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4034 if( driver != NULL )
4035 {
4036 /* Deriving a key in a secure element is not implemented yet. */
4037 status = PSA_ERROR_NOT_SUPPORTED;
4038 }
4039#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004040 if( status == PSA_SUCCESS )
4041 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004042 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004043 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004044 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004045 }
4046 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004047 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004048 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004049 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004050
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004051 return( status );
4052}
4053
Gilles Peskineeab56e42018-07-12 17:12:33 +02004054
4055
4056/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004057/* Key derivation */
4058/****************************************************************/
4059
Steven Cooreman932ffb72021-02-15 12:14:32 +01004060#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004061static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004062 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004063 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004064{
John Durkop07cc04a2020-11-16 22:08:34 -08004065 int is_kdf_alg_supported;
4066
Janos Follath5fe19732019-06-20 15:09:30 +01004067 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4068 * initialisers for this union leave some bytes unspecified.) */
4069 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4070
Gilles Peskine969c5d62019-01-16 15:53:06 +01004071 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004072#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004073 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4074 is_kdf_alg_supported = 1;
4075 else
4076#endif
4077#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4078 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4079 is_kdf_alg_supported = 1;
4080 else
4081#endif
4082#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4083 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4084 is_kdf_alg_supported = 1;
4085 else
4086#endif
4087 is_kdf_alg_supported = 0;
4088
4089 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004090 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004091 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004092 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004093 if( hash_size == 0 )
4094 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004095 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4096 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004097 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004098 {
4099 return( PSA_ERROR_NOT_SUPPORTED );
4100 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004101 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004102 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004103 }
John Durkop07cc04a2020-11-16 22:08:34 -08004104
4105 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004106}
John Durkop07cc04a2020-11-16 22:08:34 -08004107#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004108
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004109psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004110 psa_algorithm_t alg )
4111{
4112 psa_status_t status;
4113
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004114 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004115 return( PSA_ERROR_BAD_STATE );
4116
Gilles Peskine6843c292019-01-18 16:44:49 +01004117 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4118 return( PSA_ERROR_INVALID_ARGUMENT );
4119 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004120 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004121#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004122 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004123 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004124#else
4125 return( PSA_ERROR_NOT_SUPPORTED );
4126#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004127 }
4128 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4129 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004130#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004131 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004132#else
4133 return( PSA_ERROR_NOT_SUPPORTED );
4134#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004135 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004136 else
4137 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004138
4139 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004140 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004141 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004142}
4143
John Durkopd0321952020-10-29 21:37:36 -07004144#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004145static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004146 psa_algorithm_t hash_alg,
4147 psa_key_derivation_step_t step,
4148 const uint8_t *data,
4149 size_t data_length )
4150{
4151 psa_status_t status;
4152 switch( step )
4153 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004154 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004155 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004156 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004157 else
4158 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004159 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4160 hash_alg,
4161 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004162 if( status != PSA_SUCCESS )
4163 return( status );
4164 hkdf->state = HKDF_STATE_STARTED;
4165 return( PSA_SUCCESS );
4166 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004167 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004168 /* If no salt was provided, use an empty salt. */
4169 if( hkdf->state == HKDF_STATE_INIT )
4170 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004171 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4172 hash_alg,
4173 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004174 if( status != PSA_SUCCESS )
4175 return( status );
4176 hkdf->state = HKDF_STATE_STARTED;
4177 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004178 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004179 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004180 status = psa_mac_update( &hkdf->hmac,
4181 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004182 if( status != PSA_SUCCESS )
4183 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004184 status = psa_mac_sign_finish( &hkdf->hmac,
4185 hkdf->prk,
4186 sizeof( hkdf->prk ),
4187 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004188 if( status != PSA_SUCCESS )
4189 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004190 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004191 hkdf->block_number = 0;
4192 hkdf->state = HKDF_STATE_KEYED;
4193 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004194 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004195 if( hkdf->state == HKDF_STATE_OUTPUT )
4196 return( PSA_ERROR_BAD_STATE );
4197 if( hkdf->info_set )
4198 return( PSA_ERROR_BAD_STATE );
4199 hkdf->info_length = data_length;
4200 if( data_length != 0 )
4201 {
4202 hkdf->info = mbedtls_calloc( 1, data_length );
4203 if( hkdf->info == NULL )
4204 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4205 memcpy( hkdf->info, data, data_length );
4206 }
4207 hkdf->info_set = 1;
4208 return( PSA_SUCCESS );
4209 default:
4210 return( PSA_ERROR_INVALID_ARGUMENT );
4211 }
4212}
John Durkop07cc04a2020-11-16 22:08:34 -08004213#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004214
John Durkop07cc04a2020-11-16 22:08:34 -08004215#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4216 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004217static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4218 const uint8_t *data,
4219 size_t data_length )
4220{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004221 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004222 return( PSA_ERROR_BAD_STATE );
4223
Janos Follathd6dce9f2019-07-04 09:11:38 +01004224 if( data_length != 0 )
4225 {
4226 prf->seed = mbedtls_calloc( 1, data_length );
4227 if( prf->seed == NULL )
4228 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004229
Janos Follathd6dce9f2019-07-04 09:11:38 +01004230 memcpy( prf->seed, data, data_length );
4231 prf->seed_length = data_length;
4232 }
Janos Follathf08e2652019-06-13 09:05:41 +01004233
Gilles Peskine43f958b2020-12-13 14:55:14 +01004234 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004235
4236 return( PSA_SUCCESS );
4237}
4238
Janos Follath81550542019-06-13 14:26:34 +01004239static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004240 const uint8_t *data,
4241 size_t data_length )
4242{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004243 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004244 return( PSA_ERROR_BAD_STATE );
4245
Steven Cooremana6df6042021-04-29 19:32:25 +02004246 if( data_length != 0 )
4247 {
4248 prf->secret = mbedtls_calloc( 1, data_length );
4249 if( prf->secret == NULL )
4250 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4251
4252 memcpy( prf->secret, data, data_length );
4253 prf->secret_length = data_length;
4254 }
Janos Follath81550542019-06-13 14:26:34 +01004255
Gilles Peskine43f958b2020-12-13 14:55:14 +01004256 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004257
4258 return( PSA_SUCCESS );
4259}
4260
Janos Follath63028dd2019-06-13 09:15:47 +01004261static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4262 const uint8_t *data,
4263 size_t data_length )
4264{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004265 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004266 return( PSA_ERROR_BAD_STATE );
4267
Janos Follathd6dce9f2019-07-04 09:11:38 +01004268 if( data_length != 0 )
4269 {
4270 prf->label = mbedtls_calloc( 1, data_length );
4271 if( prf->label == NULL )
4272 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004273
Janos Follathd6dce9f2019-07-04 09:11:38 +01004274 memcpy( prf->label, data, data_length );
4275 prf->label_length = data_length;
4276 }
Janos Follath63028dd2019-06-13 09:15:47 +01004277
Gilles Peskine43f958b2020-12-13 14:55:14 +01004278 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004279
4280 return( PSA_SUCCESS );
4281}
4282
Janos Follathb03233e2019-06-11 15:30:30 +01004283static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004284 psa_key_derivation_step_t step,
4285 const uint8_t *data,
4286 size_t data_length )
4287{
Janos Follathb03233e2019-06-11 15:30:30 +01004288 switch( step )
4289 {
Janos Follathf08e2652019-06-13 09:05:41 +01004290 case PSA_KEY_DERIVATION_INPUT_SEED:
4291 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004292 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004293 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004294 case PSA_KEY_DERIVATION_INPUT_LABEL:
4295 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004296 default:
4297 return( PSA_ERROR_INVALID_ARGUMENT );
4298 }
4299}
John Durkop07cc04a2020-11-16 22:08:34 -08004300#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4301 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4302
4303#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4304static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4305 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004306 const uint8_t *data,
4307 size_t data_length )
4308{
4309 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004310 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004311 uint8_t *cur = pms;
4312
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004313 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004314 return( PSA_ERROR_INVALID_ARGUMENT );
4315
4316 /* Quoting RFC 4279, Section 2:
4317 *
4318 * The premaster secret is formed as follows: if the PSK is N octets
4319 * long, concatenate a uint16 with the value N, N zero octets, a second
4320 * uint16 with the value N, and the PSK itself.
4321 */
4322
4323 *cur++ = ( data_length >> 8 ) & 0xff;
4324 *cur++ = ( data_length >> 0 ) & 0xff;
4325 memset( cur, 0, data_length );
4326 cur += data_length;
4327 *cur++ = pms[0];
4328 *cur++ = pms[1];
4329 memcpy( cur, data, data_length );
4330 cur += data_length;
4331
Steven Cooremana6df6042021-04-29 19:32:25 +02004332 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004333
4334 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4335 return( status );
4336}
Janos Follath6660f0e2019-06-17 08:44:03 +01004337
4338static psa_status_t psa_tls12_prf_psk_to_ms_input(
4339 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004340 psa_key_derivation_step_t step,
4341 const uint8_t *data,
4342 size_t data_length )
4343{
4344 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004345 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004346 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004347 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004348 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004349
Steven Cooremana6df6042021-04-29 19:32:25 +02004350 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004351}
John Durkop07cc04a2020-11-16 22:08:34 -08004352#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004353
Gilles Peskineb8965192019-09-24 16:21:10 +02004354/** Check whether the given key type is acceptable for the given
4355 * input step of a key derivation.
4356 *
4357 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4358 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4359 * Both secret and non-secret inputs can alternatively have the type
4360 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4361 * that the input was passed as a buffer rather than via a key object.
4362 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004363static int psa_key_derivation_check_input_type(
4364 psa_key_derivation_step_t step,
4365 psa_key_type_t key_type )
4366{
4367 switch( step )
4368 {
4369 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004370 if( key_type == PSA_KEY_TYPE_DERIVE )
4371 return( PSA_SUCCESS );
4372 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004373 return( PSA_SUCCESS );
4374 break;
4375 case PSA_KEY_DERIVATION_INPUT_LABEL:
4376 case PSA_KEY_DERIVATION_INPUT_SALT:
4377 case PSA_KEY_DERIVATION_INPUT_INFO:
4378 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004379 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4380 return( PSA_SUCCESS );
4381 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004382 return( PSA_SUCCESS );
4383 break;
4384 }
4385 return( PSA_ERROR_INVALID_ARGUMENT );
4386}
4387
Janos Follathb80a94e2019-06-12 15:54:46 +01004388static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004389 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004390 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004391 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004392 const uint8_t *data,
4393 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004394{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004395 psa_status_t status;
4396 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4397
4398 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004399 if( status != PSA_SUCCESS )
4400 goto exit;
4401
John Durkopd0321952020-10-29 21:37:36 -07004402#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004403 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004404 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004405 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004406 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004407 step, data, data_length );
4408 }
John Durkop07cc04a2020-11-16 22:08:34 -08004409 else
4410#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4411#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4412 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004413 {
Janos Follathb03233e2019-06-11 15:30:30 +01004414 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004415 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004416 }
John Durkop07cc04a2020-11-16 22:08:34 -08004417 else
4418#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4419#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4420 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004421 {
4422 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004423 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004424 }
4425 else
John Durkop07cc04a2020-11-16 22:08:34 -08004426#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004427 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004428 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004429 (void) data;
4430 (void) data_length;
4431 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004432 return( PSA_ERROR_BAD_STATE );
4433 }
4434
Gilles Peskine224b0d62019-09-23 18:13:17 +02004435exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004436 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004437 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004438 return( status );
4439}
4440
Janos Follath51f4a0f2019-06-14 11:35:55 +01004441psa_status_t psa_key_derivation_input_bytes(
4442 psa_key_derivation_operation_t *operation,
4443 psa_key_derivation_step_t step,
4444 const uint8_t *data,
4445 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004446{
Gilles Peskineb8965192019-09-24 16:21:10 +02004447 return( psa_key_derivation_input_internal( operation, step,
4448 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004449 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004450}
4451
Janos Follath51f4a0f2019-06-14 11:35:55 +01004452psa_status_t psa_key_derivation_input_key(
4453 psa_key_derivation_operation_t *operation,
4454 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004455 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004456{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004458 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004459 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004460
Ronald Cron5c522922020-11-14 16:35:34 +01004461 status = psa_get_and_lock_transparent_key_slot_with_policy(
4462 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004463 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004464 {
4465 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004466 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004467 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004468
4469 /* Passing a key object as a SECRET input unlocks the permission
4470 * to output to a key object. */
4471 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4472 operation->can_output_key = 1;
4473
Ronald Cronf95a2b12020-10-22 15:24:49 +02004474 status = psa_key_derivation_input_internal( operation,
4475 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004476 slot->key.data,
4477 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004478
Ronald Cron5c522922020-11-14 16:35:34 +01004479 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004480
Ronald Cron5c522922020-11-14 16:35:34 +01004481 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004482}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004483
4484
4485
4486/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004487/* Key agreement */
4488/****************************************************************/
4489
John Durkop6ba40d12020-11-10 08:50:04 -08004490#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004491static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4492 size_t peer_key_length,
4493 const mbedtls_ecp_keypair *our_key,
4494 uint8_t *shared_secret,
4495 size_t shared_secret_size,
4496 size_t *shared_secret_length )
4497{
Steven Cooremand4867872020-08-05 16:31:39 +02004498 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004499 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004500 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004501 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004502 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004503 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004504
Ronald Cron90857082020-11-25 14:58:33 +01004505 status = mbedtls_psa_ecp_load_representation(
4506 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004507 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004508 peer_key,
4509 peer_key_length,
4510 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004511 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004512 goto exit;
4513
Jaeden Amero97271b32019-01-10 19:38:51 +00004514 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004515 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004516 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004517 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004518 status = mbedtls_to_psa_error(
4519 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4520 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004521 goto exit;
4522
Jaeden Amero97271b32019-01-10 19:38:51 +00004523 status = mbedtls_to_psa_error(
4524 mbedtls_ecdh_calc_secret( &ecdh,
4525 shared_secret_length,
4526 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004527 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004528 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004529 if( status != PSA_SUCCESS )
4530 goto exit;
4531 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4532 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004533
4534exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004535 if( status != PSA_SUCCESS )
4536 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004537 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004538 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004539 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004540
Jaeden Amero97271b32019-01-10 19:38:51 +00004541 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004542}
John Durkop6ba40d12020-11-10 08:50:04 -08004543#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004544
Gilles Peskine01d718c2018-09-18 12:01:02 +02004545#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4546
Gilles Peskine0216fe12019-04-11 21:23:21 +02004547static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4548 psa_key_slot_t *private_key,
4549 const uint8_t *peer_key,
4550 size_t peer_key_length,
4551 uint8_t *shared_secret,
4552 size_t shared_secret_size,
4553 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004554{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004555 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004556 {
John Durkop6ba40d12020-11-10 08:50:04 -08004557#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004558 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004559 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004560 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004561 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004562 psa_status_t status = mbedtls_psa_ecp_load_representation(
4563 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004564 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004565 private_key->key.data,
4566 private_key->key.bytes,
4567 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004568 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004569 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004570 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004571 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004572 shared_secret, shared_secret_size,
4573 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004574 mbedtls_ecp_keypair_free( ecp );
4575 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004576 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004577#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004578 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004579 (void) private_key;
4580 (void) peer_key;
4581 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004582 (void) shared_secret;
4583 (void) shared_secret_size;
4584 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004585 return( PSA_ERROR_NOT_SUPPORTED );
4586 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004587}
4588
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004589/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004590 * to potentially free embedded data structures and wipe confidential data.
4591 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004592static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004593 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004594 psa_key_slot_t *private_key,
4595 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004596 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004597{
4598 psa_status_t status;
4599 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4600 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004601 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004602
4603 /* Step 1: run the secret agreement algorithm to generate the shared
4604 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004605 status = psa_key_agreement_raw_internal( ka_alg,
4606 private_key,
4607 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004608 shared_secret,
4609 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004610 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004611 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004612 goto exit;
4613
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004614 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004615 * the shared secret. A shared secret is permitted wherever a key
4616 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004617 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004618 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004619 shared_secret,
4620 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004621exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004622 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004623 return( status );
4624}
4625
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004626psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004627 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004628 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004629 const uint8_t *peer_key,
4630 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004631{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004632 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004633 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004634 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004635
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004636 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004637 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004638 status = psa_get_and_lock_transparent_key_slot_with_policy(
4639 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004640 if( status != PSA_SUCCESS )
4641 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004642 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004643 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004644 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004645 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004647 else
4648 {
4649 /* If a private key has been added as SECRET, we allow the derived
4650 * key material to be used as a key in PSA Crypto. */
4651 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4652 operation->can_output_key = 1;
4653 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004654
Ronald Cron5c522922020-11-14 16:35:34 +01004655 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004656
Ronald Cron5c522922020-11-14 16:35:34 +01004657 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004658}
4659
Gilles Peskinebe697d82019-05-16 18:00:41 +02004660psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004661 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004662 const uint8_t *peer_key,
4663 size_t peer_key_length,
4664 uint8_t *output,
4665 size_t output_size,
4666 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004667{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004669 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004670 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004671
4672 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4673 {
4674 status = PSA_ERROR_INVALID_ARGUMENT;
4675 goto exit;
4676 }
Ronald Cron5c522922020-11-14 16:35:34 +01004677 status = psa_get_and_lock_transparent_key_slot_with_policy(
4678 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004679 if( status != PSA_SUCCESS )
4680 goto exit;
4681
4682 status = psa_key_agreement_raw_internal( alg, slot,
4683 peer_key, peer_key_length,
4684 output, output_size,
4685 output_length );
4686
4687exit:
4688 if( status != PSA_SUCCESS )
4689 {
4690 /* If an error happens and is not handled properly, the output
4691 * may be used as a key to protect sensitive data. Arrange for such
4692 * a key to be random, which is likely to result in decryption or
4693 * verification errors. This is better than filling the buffer with
4694 * some constant data such as zeros, which would result in the data
4695 * being protected with a reproducible, easily knowable key.
4696 */
4697 psa_generate_random( output, output_size );
4698 *output_length = output_size;
4699 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004700
Ronald Cron5c522922020-11-14 16:35:34 +01004701 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004702
Ronald Cron5c522922020-11-14 16:35:34 +01004703 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004704}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004705
4706
Gilles Peskine30524eb2020-11-13 17:02:26 +01004707
Gilles Peskine86a440b2018-11-12 18:39:40 +01004708/****************************************************************/
4709/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004710/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004711
Gilles Peskine30524eb2020-11-13 17:02:26 +01004712/** Initialize the PSA random generator.
4713 */
4714static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4715{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004716#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4717 memset( rng, 0, sizeof( *rng ) );
4718#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4719
Gilles Peskine30524eb2020-11-13 17:02:26 +01004720 /* Set default configuration if
4721 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4722 if( rng->entropy_init == NULL )
4723 rng->entropy_init = mbedtls_entropy_init;
4724 if( rng->entropy_free == NULL )
4725 rng->entropy_free = mbedtls_entropy_free;
4726
4727 rng->entropy_init( &rng->entropy );
4728#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4729 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4730 /* The PSA entropy injection feature depends on using NV seed as an entropy
4731 * source. Add NV seed as an entropy source for PSA entropy injection. */
4732 mbedtls_entropy_add_source( &rng->entropy,
4733 mbedtls_nv_seed_poll, NULL,
4734 MBEDTLS_ENTROPY_BLOCK_SIZE,
4735 MBEDTLS_ENTROPY_SOURCE_STRONG );
4736#endif
4737
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004738 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004739#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004740}
4741
4742/** Deinitialize the PSA random generator.
4743 */
4744static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4745{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004746#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4747 memset( rng, 0, sizeof( *rng ) );
4748#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004749 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004750 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004751#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004752}
4753
4754/** Seed the PSA random generator.
4755 */
4756static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4757{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004758#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4759 /* Do nothing: the external RNG seeds itself. */
4760 (void) rng;
4761 return( PSA_SUCCESS );
4762#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004763 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004764 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4765 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004766 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004767#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004768}
4769
Gilles Peskinee59236f2018-01-27 23:32:46 +01004770psa_status_t psa_generate_random( uint8_t *output,
4771 size_t output_size )
4772{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004773 GUARD_MODULE_INITIALIZED;
4774
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004775#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4776
4777 size_t output_length = 0;
4778 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4779 output, output_size,
4780 &output_length );
4781 if( status != PSA_SUCCESS )
4782 return( status );
4783 /* Breaking up a request into smaller chunks is currently not supported
4784 * for the extrernal RNG interface. */
4785 if( output_length != output_size )
4786 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4787 return( PSA_SUCCESS );
4788
4789#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4790
Gilles Peskine71ddab92021-01-04 21:01:07 +01004791 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004792 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004793 size_t request_size =
4794 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4795 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4796 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004797 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4798 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004799 if( ret != 0 )
4800 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004801 output_size -= request_size;
4802 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004803 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004804 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004805#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004806}
4807
Gilles Peskine8814fc42020-12-14 15:33:44 +01004808/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004809 *
4810 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4811 * `psa_generate_random(...)`. The state parameter is ignored since the
4812 * PSA API doesn't support passing an explicit state.
4813 *
4814 * In the non-external case, psa_generate_random() calls an
4815 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4816 * and semantics as mbedtls_psa_get_random(). As an optimization,
4817 * instead of doing this back-and-forth between the PSA API and the
4818 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4819 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004820 */
4821#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4822int mbedtls_psa_get_random( void *p_rng,
4823 unsigned char *output,
4824 size_t output_size )
4825{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004826 /* This function takes a pointer to the RNG state because that's what
4827 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4828 * its own state internally and doesn't let the caller access that state.
4829 * So we just ignore the state parameter, and in practice we'll pass
4830 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004831 (void) p_rng;
4832 psa_status_t status = psa_generate_random( output, output_size );
4833 if( status == PSA_SUCCESS )
4834 return( 0 );
4835 else
4836 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4837}
4838#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4839
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004840#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004841#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004842
Gilles Peskine7228da22019-07-15 11:06:15 +02004843psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004844 size_t seed_size )
4845{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004846 if( global_data.initialized )
4847 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004848
4849 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4850 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4851 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4852 return( PSA_ERROR_INVALID_ARGUMENT );
4853
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004854 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004855}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004856#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004857
Ronald Cron3772afe2021-02-08 16:10:05 +01004858/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004859 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004860 * \param type The key type
4861 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004862 *
4863 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004864 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004865 * \retval #PSA_ERROR_INVALID_ARGUMENT
4866 * The size in bits of the key is not valid.
4867 * \retval #PSA_ERROR_NOT_SUPPORTED
4868 * The type and/or the size in bits of the key or the combination of
4869 * the two is not supported.
4870 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004871static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4872 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004873{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004875
Gilles Peskinee59236f2018-01-27 23:32:46 +01004876 if( key_type_is_raw_bytes( type ) )
4877 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004878 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004879 if( status != PSA_SUCCESS )
4880 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004881 }
4882 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004883#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004884 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4885 {
4886 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4887 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004888
Ronald Cron01b2aba2020-10-05 09:42:02 +02004889 /* Accept only byte-aligned keys, for the same reasons as
4890 * in psa_import_rsa_key(). */
4891 if( bits % 8 != 0 )
4892 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004893 }
4894 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004895#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004896
Ronald Cron5c4d3862020-12-07 11:07:24 +01004897#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004898 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4899 {
Ronald Crond81ab562021-02-16 09:01:16 +01004900 /* To avoid empty block, return successfully here. */
4901 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004902 }
4903 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004904#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004905 {
4906 return( PSA_ERROR_NOT_SUPPORTED );
4907 }
4908
4909 return( PSA_SUCCESS );
4910}
4911
Ronald Cron55ed0592020-10-05 10:30:40 +02004912psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004913 const psa_key_attributes_t *attributes,
4914 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004915{
4916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004917 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004918
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004919 if( ( attributes->domain_parameters == NULL ) &&
4920 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004921 return( PSA_ERROR_INVALID_ARGUMENT );
4922
Ronald Cron01b2aba2020-10-05 09:42:02 +02004923 if( key_type_is_raw_bytes( type ) )
4924 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004925 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004926 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004927 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004928
David Brown12ca5032021-02-11 11:02:00 -07004929#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004930 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004931 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004932#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004933 }
4934 else
4935
Jaeden Amero424fa932021-05-14 08:34:32 +01004936#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4937 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004938 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004939 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004940 return( mbedtls_psa_rsa_generate_key( attributes,
4941 key_buffer,
4942 key_buffer_size,
4943 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004944 }
4945 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004946#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4947 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004948
John Durkop9814fa22020-11-04 12:28:15 -08004949#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004950 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004951 {
Ronald Cron7023db52020-11-20 18:17:42 +01004952 return( mbedtls_psa_ecp_generate_key( attributes,
4953 key_buffer,
4954 key_buffer_size,
4955 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004956 }
4957 else
John Durkop9814fa22020-11-04 12:28:15 -08004958#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004959 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004960 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004961 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004962 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004963
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004964 return( PSA_SUCCESS );
4965}
Darryl Green0c6575a2018-11-07 16:05:30 +00004966
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004967psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004968 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004969{
4970 psa_status_t status;
4971 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004972 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004973 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004974
Ronald Cron81709fc2020-11-14 12:10:32 +01004975 *key = MBEDTLS_SVC_KEY_ID_INIT;
4976
Gilles Peskine0f84d622019-09-12 19:03:13 +02004977 /* Reject any attempt to create a zero-length key so that we don't
4978 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4979 if( psa_get_key_bits( attributes ) == 0 )
4980 return( PSA_ERROR_INVALID_ARGUMENT );
4981
Ronald Cron81709fc2020-11-14 12:10:32 +01004982 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4983 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004984 if( status != PSA_SUCCESS )
4985 goto exit;
4986
Ronald Cron977c2472020-10-13 08:32:21 +02004987 /* In the case of a transparent key or an opaque key stored in local
4988 * storage (thus not in the case of generating a key in a secure element
4989 * or cryptoprocessor with storage), we have to allocate a buffer to
4990 * hold the generated key material. */
4991 if( slot->key.data == NULL )
4992 {
4993 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4994 PSA_KEY_LOCATION_LOCAL_STORAGE )
4995 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004996 status = psa_validate_key_type_and_size_for_key_generation(
4997 attributes->core.type, attributes->core.bits );
4998 if( status != PSA_SUCCESS )
4999 goto exit;
5000
5001 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5002 attributes->core.type,
5003 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005004 }
5005 else
5006 {
5007 status = psa_driver_wrapper_get_key_buffer_size(
5008 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005009 if( status != PSA_SUCCESS )
5010 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005011 }
Ronald Cron977c2472020-10-13 08:32:21 +02005012
5013 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5014 if( status != PSA_SUCCESS )
5015 goto exit;
5016 }
5017
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005018 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005019 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005020
Ronald Cron2b56bc82020-10-05 10:02:26 +02005021 if( status != PSA_SUCCESS )
5022 psa_remove_key_data_from_memory( slot );
5023
Gilles Peskine11792082019-08-06 18:36:36 +02005024exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005025 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005026 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005027 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005028 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005029
Darryl Green0c6575a2018-11-07 16:05:30 +00005030 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005031}
5032
Gilles Peskinee59236f2018-01-27 23:32:46 +01005033/****************************************************************/
5034/* Module setup */
5035/****************************************************************/
5036
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005037#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005038psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5039 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5040 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5041{
5042 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5043 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005044 global_data.rng.entropy_init = entropy_init;
5045 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005046 return( PSA_SUCCESS );
5047}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005048#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005049
Gilles Peskinee59236f2018-01-27 23:32:46 +01005050void mbedtls_psa_crypto_free( void )
5051{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005052 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005053 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5054 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005055 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005056 }
5057 /* Wipe all remaining data, including configuration.
5058 * In particular, this sets all state indicator to the value
5059 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005060 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005061#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005062 /* Unregister all secure element drivers, so that we restart from
5063 * a pristine state. */
5064 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005065#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005066}
5067
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005068#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5069/** Recover a transaction that was interrupted by a power failure.
5070 *
5071 * This function is called during initialization, before psa_crypto_init()
5072 * returns. If this function returns a failure status, the initialization
5073 * fails.
5074 */
5075static psa_status_t psa_crypto_recover_transaction(
5076 const psa_crypto_transaction_t *transaction )
5077{
5078 switch( transaction->unknown.type )
5079 {
5080 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5081 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005082 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005083 * is implemented.
5084 * https://github.com/ARMmbed/mbed-crypto/issues/218
5085 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005086 default:
5087 /* We found an unsupported transaction in the storage.
5088 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005089 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005090 }
5091}
5092#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5093
Gilles Peskinee59236f2018-01-27 23:32:46 +01005094psa_status_t psa_crypto_init( void )
5095{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005096 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005097
Gilles Peskinec6b69072018-11-20 21:42:52 +01005098 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005099 if( global_data.initialized != 0 )
5100 return( PSA_SUCCESS );
5101
Gilles Peskine30524eb2020-11-13 17:02:26 +01005102 /* Initialize and seed the random generator. */
5103 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005104 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005105 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005106 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005107 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005108 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005109
Gilles Peskine66fb1262018-12-10 16:29:04 +01005110 status = psa_initialize_key_slots( );
5111 if( status != PSA_SUCCESS )
5112 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005113
Gilles Peskined9348f22019-10-01 15:22:29 +02005114#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5115 status = psa_init_all_se_drivers( );
5116 if( status != PSA_SUCCESS )
5117 goto exit;
5118#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5119
Gilles Peskine4b734222019-07-24 15:56:31 +02005120#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005121 status = psa_crypto_load_transaction( );
5122 if( status == PSA_SUCCESS )
5123 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005124 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5125 if( status != PSA_SUCCESS )
5126 goto exit;
5127 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005128 }
5129 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5130 {
5131 /* There's no transaction to complete. It's all good. */
5132 status = PSA_SUCCESS;
5133 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005134#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005135
Gilles Peskinec6b69072018-11-20 21:42:52 +01005136 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005137 global_data.initialized = 1;
5138
5139exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005140 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005141 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005142 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005143}
5144
5145#endif /* MBEDTLS_PSA_CRYPTO_C */