blob: 906e9b4579bc18f322be8a59d0b5365843a98680 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200205 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218#endif
219
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
223 return( PSA_ERROR_INVALID_ARGUMENT );
224 case MBEDTLS_ERR_MD_ALLOC_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_MEMORY );
226 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
227 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100228
Gilles Peskinef76aa772018-10-29 19:24:33 +0100229 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
231 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
236 return( PSA_ERROR_BUFFER_TOO_SMALL );
237 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
238 return( PSA_ERROR_INVALID_ARGUMENT );
239 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
245
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100246 case MBEDTLS_ERR_PK_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
249 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100253 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
254 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
257 return( PSA_ERROR_NOT_SUPPORTED );
258 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
259 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
260 return( PSA_ERROR_NOT_PERMITTED );
261 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_INVALID_ALG:
264 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
265 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
268 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200269 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
270 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100271
Gilles Peskineff2d2002019-05-06 15:26:23 +0200272 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
275 return( PSA_ERROR_NOT_SUPPORTED );
276
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_RSA_INVALID_PADDING:
280 return( PSA_ERROR_INVALID_PADDING );
281 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
286 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200287 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
289 return( PSA_ERROR_INVALID_SIGNATURE );
290 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100293 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200294
itayzafrir5c753392018-05-08 11:18:38 +0300295 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300297 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
299 return( PSA_ERROR_BUFFER_TOO_SMALL );
300 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
303 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
304 return( PSA_ERROR_INVALID_SIGNATURE );
305 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309
Janos Follatha13b9052019-11-22 12:48:59 +0000310 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
311 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300312
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 default:
David Saadab4ecc272019-02-14 13:48:10 +0200314 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 }
316}
317
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200319
320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321/****************************************************************/
322/* Key management */
323/****************************************************************/
324
John Durkop07cc04a2020-11-16 22:08:34 -0800325/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
326 * current test driver in key_management.c is using this function
327 * when accelerators are used for ECC key pair and public key.
328 * Once that dependency is resolved these guards can be removed.
329 */
John Durkop9814fa22020-11-04 12:28:15 -0800330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800331 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
332 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
333 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100334mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100335 size_t bits,
336 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200337{
338 switch( curve )
339 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100340 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100341 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100342 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100343#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100344 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100345 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100346#endif
347#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#endif
351#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100352 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100353 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100354#endif
355#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100356 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100357 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100358#endif
359#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100361 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 528:
363 if( bits_is_sloppy )
364 return( MBEDTLS_ECP_DP_SECP521R1 );
365 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100367 }
368 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100369
Paul Elliott8ff510a2020-06-02 17:19:28 +0100370 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100371 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100374 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100376#endif
377#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 }
386 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100387
Paul Elliott8ff510a2020-06-02 17:19:28 +0100388 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100393 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
395 if( bits_is_sloppy )
396 return( MBEDTLS_ECP_DP_CURVE25519 );
397 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#endif
399#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100402#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 }
404 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100405
Paul Elliott8ff510a2020-06-02 17:19:28 +0100406 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100410 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100411 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100412#endif
413#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 }
422 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200423 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100425 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200427}
John Durkop9814fa22020-11-04 12:28:15 -0800428#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800429 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
430 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
431 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Archana4d7ae1d2021-07-07 02:50:22 +0530433psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_CAMELLIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_DES:
457 if( bits != 64 && bits != 128 && bits != 192 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200462 case PSA_KEY_TYPE_CHACHA20:
463 if( bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200467 default:
468 return( PSA_ERROR_NOT_SUPPORTED );
469 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200470 if( bits % 8 != 0 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 return( PSA_SUCCESS );
474}
475
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100476/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100477 *
Steven Cooremancd640932021-03-08 12:00:27 +0100478 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
479 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100480 *
481 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 * \param[in] key_type The key type of the key to be used with the
483 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
485 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100491 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493{
Steven Cooremancd640932021-03-08 12:00:27 +0100494 if( PSA_ALG_IS_HMAC( algorithm ) )
495 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 if( key_type == PSA_KEY_TYPE_HMAC )
497 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499
500 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
503 * key. */
504 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
505 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
506 {
507 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
508 * the block length (larger than 1) for block ciphers. */
509 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
510 return( PSA_SUCCESS );
511 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100512 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100513
514 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515}
516
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200517psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
518 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200519{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100520 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200521 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200522
Ronald Cronea0f8a62020-11-25 17:52:23 +0100523 slot->key.data = mbedtls_calloc( 1, buffer_length );
524 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200525 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200526
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529}
530
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200531psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
532 const uint8_t* data,
533 size_t data_length )
534{
535 psa_status_t status = psa_allocate_buffer_to_slot( slot,
536 data_length );
537 if( status != PSA_SUCCESS )
538 return( status );
539
Ronald Cronea0f8a62020-11-25 17:52:23 +0100540 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200541 return( PSA_SUCCESS );
542}
543
Ronald Crona0fe59f2020-11-29 11:14:53 +0100544psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100545 const psa_key_attributes_t *attributes,
546 const uint8_t *data, size_t data_length,
547 uint8_t *key_buffer, size_t key_buffer_size,
548 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100549{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
551 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100552
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553 /* zero-length keys are never supported. */
554 if( data_length == 0 )
555 return( PSA_ERROR_NOT_SUPPORTED );
556
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100559 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560
Archana449608b2021-09-08 15:36:05 +0530561 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
562 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200563 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200564 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200565
Ronald Crondd04d422020-11-28 15:14:42 +0100566 /* Copy the key material. */
567 memcpy( key_buffer, data, data_length );
568 *key_buffer_length = data_length;
569 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200570
Steven Cooreman40120f62020-10-29 11:42:22 +0100571 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100573 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200574 {
John Durkop9814fa22020-11-04 12:28:15 -0800575#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
576 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100577 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200578 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100579 return( mbedtls_psa_ecp_import_key( attributes,
580 data, data_length,
581 key_buffer, key_buffer_size,
582 key_buffer_length,
583 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100584 }
John Durkop9814fa22020-11-04 12:28:15 -0800585#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
586 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700587#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
588 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100589 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200590 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100591 return( mbedtls_psa_rsa_import_key( attributes,
592 data, data_length,
593 key_buffer, key_buffer_size,
594 key_buffer_length,
595 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200596 }
John Durkop9814fa22020-11-04 12:28:15 -0800597#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
598 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100600
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100601 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100602}
603
Gilles Peskinef603c712019-01-19 13:40:11 +0100604/** Calculate the intersection of two algorithm usage policies.
605 *
606 * Return 0 (which allows no operation) on incompatibility.
607 */
608static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100609 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100610 psa_algorithm_t alg1,
611 psa_algorithm_t alg2 )
612{
Gilles Peskine549ea862019-05-22 11:45:59 +0200613 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100614 if( alg1 == alg2 )
615 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100616 /* If the policies are from the same hash-and-sign family, check
617 * if one is a wildcard. If so the other has the specific algorithm. */
618 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
619 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
620 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100621 {
Steven Cooreman03488022021-02-18 12:07:20 +0100622 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
623 return( alg2 );
624 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
625 return( alg1 );
626 }
627 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100628 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100629 * restrictive tag length. */
630 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
631 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
632 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
633 {
634 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
635 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100636 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100637
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100638 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100639 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
640 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100641 {
Steven Cooremancd640932021-03-08 12:00:27 +0100642 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
643 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100644 }
645 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100646 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100647 ( alg1_len <= alg2_len ) )
648 {
649 return( alg2 );
650 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100651 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100652 ( alg2_len <= alg1_len ) )
653 {
654 return( alg1 );
655 }
656 }
657 /* If the policies are from the same MAC family, check whether one
658 * of them is a minimum-MAC-length policy. Calculate the most
659 * restrictive tag length. */
660 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
661 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
662 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
663 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100664 /* Validate the combination of key type and algorithm. Since the base
665 * algorithm of alg1 and alg2 are the same, we only need this once. */
666 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100667 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100668
Steven Cooreman31a876d2021-03-03 20:47:40 +0100669 /* Get the (exact or at-least) output lengths for both sides of the
670 * requested intersection. None of the currently supported algorithms
671 * have an output length dependent on the actual key size, so setting it
672 * to a bogus value of 0 is currently OK.
673 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100674 * Note that for at-least-this-length wildcard algorithms, the output
675 * length is set to the shortest allowed length, which allows us to
676 * calculate the most restrictive tag length for the intersection. */
677 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
678 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100679 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100680
Steven Cooremana1d83222021-02-25 10:20:29 +0100681 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100682 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
683 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100684 {
Steven Cooremancd640932021-03-08 12:00:27 +0100685 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100687
688 /* If only one is an at-least-this-length policy, the intersection would
689 * be the other (fixed-length) policy as long as said fixed length is
690 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100691 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100692 {
Steven Cooremancd640932021-03-08 12:00:27 +0100693 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100694 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100695 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100696 {
Steven Cooremancd640932021-03-08 12:00:27 +0100697 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100698 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100699
Steven Cooremancd640932021-03-08 12:00:27 +0100700 /* If none of them are wildcards, check whether they define the same tag
701 * length. This is still possible here when one is default-length and
702 * the other specific-length. Ensure to always return the
703 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100704 if( alg1_len == alg2_len )
705 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100706 }
707 /* If the policies are incompatible, allow nothing. */
708 return( 0 );
709}
710
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100711static int psa_key_algorithm_permits( psa_key_type_t key_type,
712 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200713 psa_algorithm_t requested_alg )
714{
Gilles Peskine549ea862019-05-22 11:45:59 +0200715 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716 if( requested_alg == policy_alg )
717 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100718 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
719 * and requested_alg is the same hash-and-sign family with any hash,
720 * then requested_alg is compliant with policy_alg. */
721 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
722 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200723 {
Steven Cooreman03488022021-02-18 12:07:20 +0100724 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
725 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
726 }
727 /* If policy_alg is a wildcard AEAD algorithm of the same base as
728 * the requested algorithm, check the requested tag length to be
729 * equal-length or longer than the wildcard-specified length. */
730 if( PSA_ALG_IS_AEAD( policy_alg ) &&
731 PSA_ALG_IS_AEAD( requested_alg ) &&
732 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
733 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100734 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100735 {
736 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
737 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
738 }
Steven Cooremancd640932021-03-08 12:00:27 +0100739 /* If policy_alg is a MAC algorithm of the same base as the requested
740 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100741 if( PSA_ALG_IS_MAC( policy_alg ) &&
742 PSA_ALG_IS_MAC( requested_alg ) &&
743 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100744 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100745 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100746 /* Validate the combination of key type and algorithm. Since the policy
747 * and requested algorithms are the same, we only need this once. */
748 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100749 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100750
Steven Cooreman31a876d2021-03-03 20:47:40 +0100751 /* Get both the requested output length for the algorithm which is to be
752 * verified, and the default output length for the base algorithm.
753 * Note that none of the currently supported algorithms have an output
754 * length dependent on actual key size, so setting it to a bogus value
755 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756 size_t requested_output_length = PSA_MAC_LENGTH(
757 key_type, 0, requested_alg );
758 size_t default_output_length = PSA_MAC_LENGTH(
759 key_type, 0,
760 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100761
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100762 /* If the policy is default-length, only allow an algorithm with
763 * a declared exact-length matching the default. */
764 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100765 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100766
767 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100768 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100769 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
770 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
771 {
772 return( 1 );
773 }
774
Steven Cooremancd640932021-03-08 12:00:27 +0100775 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
776 * check for the requested MAC length to be equal to or longer than the
777 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100778 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
779 {
780 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100781 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 }
Steven Cooremance48e852020-10-05 16:02:45 +0200784 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200785 * a key derivation with that key agreement should also be allowed. This
786 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200787 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
788 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
789 {
790 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
791 policy_alg );
792 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100793 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200794 return( 0 );
795}
796
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100797/** Test whether a policy permits an algorithm.
798 *
799 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100800 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100801 * \note This function requires providing the key type for which the policy is
802 * being validated, since some algorithm policy definitions (e.g. MAC)
803 * have different properties depending on what kind of cipher it is
804 * combined with.
805 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100806 * \retval PSA_SUCCESS When \p alg is a specific algorithm
807 * allowed by the \p policy.
808 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
809 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
810 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100811 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100812static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100813 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100815{
Steven Cooremand788fab2021-02-25 11:29:17 +0100816 /* '0' is not a valid algorithm */
817 if( alg == 0 )
818 return( PSA_ERROR_INVALID_ARGUMENT );
819
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 /* A requested algorithm cannot be a wildcard. */
821 if( PSA_ALG_IS_WILDCARD( alg ) )
822 return( PSA_ERROR_INVALID_ARGUMENT );
823
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100824 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
825 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 return( PSA_SUCCESS );
827 else
828 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100829}
830
Gilles Peskinef603c712019-01-19 13:40:11 +0100831/** Restrict a key policy based on a constraint.
832 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100833 * \note This function requires providing the key type for which the policy is
834 * being restricted, since some algorithm policy definitions (e.g. MAC)
835 * have different properties depending on what kind of cipher it is
836 * combined with.
837 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100838 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100839 * \param[in,out] policy The policy to restrict.
840 * \param[in] constraint The policy constraint to apply.
841 *
842 * \retval #PSA_SUCCESS
843 * \c *policy contains the intersection of the original value of
844 * \c *policy and \c *constraint.
845 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100846 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100847 * \c *policy is unchanged.
848 */
849static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100850 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100851 psa_key_policy_t *policy,
852 const psa_key_policy_t *constraint )
853{
854 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100855 psa_key_policy_algorithm_intersection( key_type, policy->alg,
856 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200857 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100858 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
859 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100860 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
861 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200862 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
863 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100864 policy->usage &= constraint->usage;
865 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200866 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100867 return( PSA_SUCCESS );
868}
869
Ronald Cron5c522922020-11-14 16:35:34 +0100870/** Get the description of a key given its identifier and policy constraints
871 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200872 *
Ronald Cron5c522922020-11-14 16:35:34 +0100873 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100874 * nonzero, the key must allow operations with this algorithm. If \p alg is
875 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100876 *
Ronald Cron5c522922020-11-14 16:35:34 +0100877 * In case of a persistent key, the function loads the description of the key
878 * into a key slot if not already done.
879 *
880 * On success, the returned key slot is locked. It is the responsibility of
881 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200882 */
Ronald Cron5c522922020-11-14 16:35:34 +0100883static psa_status_t psa_get_and_lock_key_slot_with_policy(
884 mbedtls_svc_key_id_t key,
885 psa_key_slot_t **p_slot,
886 psa_key_usage_t usage,
887 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100888{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200889 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
890 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100891
Ronald Cron5c522922020-11-14 16:35:34 +0100892 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100893 if( status != PSA_SUCCESS )
894 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
897 /* Enforce that usage policy for the key slot contains all the flags
898 * required by the usage parameter. There is one exception: public
899 * keys can always be exported, so we treat public key objects as
900 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200901 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100902 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903
Gilles Peskine8e338702019-07-30 20:06:31 +0200904 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100905 {
906 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200907 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100908 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100909
910 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100911 if( alg != 0 )
912 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100913 status = psa_key_policy_permits( &slot->attr.policy,
914 slot->attr.type,
915 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 if( status != PSA_SUCCESS )
917 goto error;
918 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100919
Darryl Green06fd18d2018-07-16 11:21:11 +0100920 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921
922error:
923 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100924 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200925
926 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100927}
Darryl Green940d72c2018-07-13 13:18:51 +0100928
Ronald Cron5c522922020-11-14 16:35:34 +0100929/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 *
931 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200932 * available, as opposed to a key in a secure element and/or to be used
933 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200934 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200935 * This is a temporary function that may be used instead of
936 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
937 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200938 *
Ronald Cron5c522922020-11-14 16:35:34 +0100939 * On success, the returned key slot is locked. It is the responsibility of the
940 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 */
Ronald Cron5c522922020-11-14 16:35:34 +0100942static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
943 mbedtls_svc_key_id_t key,
944 psa_key_slot_t **p_slot,
945 psa_key_usage_t usage,
946 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200947{
Ronald Cron5c522922020-11-14 16:35:34 +0100948 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
949 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200950 if( status != PSA_SUCCESS )
951 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952
Ronald Cronddae0f52021-08-24 15:39:44 +0200953 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200954 {
Ronald Cron5c522922020-11-14 16:35:34 +0100955 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 *p_slot = NULL;
957 return( PSA_ERROR_NOT_SUPPORTED );
958 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960 return( PSA_SUCCESS );
961}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200963psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000964{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100965 /* Data pointer will always be either a valid pointer or NULL in an
966 * initialized slot, so we can just free it. */
967 if( slot->key.data != NULL )
968 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
969
970 mbedtls_free( slot->key.data );
971 slot->key.data = NULL;
972 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000973
974 return( PSA_SUCCESS );
975}
976
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100977/** Completely wipe a slot in memory, including its policy.
978 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100979psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100980{
981 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100982
TRodziewicz18cddc02021-07-13 12:19:15 +0200983 /*
984 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200985 * do our best to report an unexpected lock counter. Assert with
986 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
987 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
988 * function is called as part of the execution of a test suite, the
989 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200990 */
Ronald Cron5c522922020-11-14 16:35:34 +0100991 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100992 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200993 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100994 status = PSA_ERROR_CORRUPTION_DETECTED;
995 }
996
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200997 /* Multipart operations may still be using the key. This is safe
998 * because all multipart operation objects are independent from
999 * the key slot: if they need to access the key after the setup
1000 * phase, they have a copy of the key. Note that this means that
1001 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001002 /* At this point, key material and other type-specific content has
1003 * been wiped. Clear remaining metadata. We can call memset and not
1004 * zeroize because the metadata is not particularly sensitive. */
1005 memset( slot, 0, sizeof( *slot ) );
1006 return( status );
1007}
1008
Ronald Croncf56a0a2020-08-04 09:51:30 +02001009psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001010{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001011 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001012 psa_status_t status; /* status of the last operation */
1013 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001014#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1015 psa_se_drv_table_entry_t *driver;
1016#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017
Ronald Croncf56a0a2020-08-04 09:51:30 +02001018 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001019 return( PSA_SUCCESS );
1020
Ronald Cronf2911112020-10-29 17:51:10 +01001021 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001022 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001023 * key, this will load the key description from persistent memory if not
1024 * done yet. We cannot avoid this loading as without it we don't know if
1025 * the key is operated by an SE or not and this information is needed by
1026 * the current implementation.
1027 */
Ronald Cron5c522922020-11-14 16:35:34 +01001028 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001029 if( status != PSA_SUCCESS )
1030 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001031
Ronald Cronf2911112020-10-29 17:51:10 +01001032 /*
1033 * If the key slot containing the key description is under access by the
1034 * library (apart from the present access), the key cannot be destroyed
1035 * yet. For the time being, just return in error. Eventually (to be
1036 * implemented), the key should be destroyed when all accesses have
1037 * stopped.
1038 */
Ronald Cron5c522922020-11-14 16:35:34 +01001039 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001040 {
Ronald Cron5c522922020-11-14 16:35:34 +01001041 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001042 return( PSA_ERROR_GENERIC_ERROR );
1043 }
1044
Gilles Peskine6687cd02021-04-21 22:32:05 +02001045 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1046 {
1047 /* Refuse the destruction of a read-only key (which may or may not work
1048 * if we attempt it, depending on whether the key is merely read-only
1049 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001050 * Just do the best we can, which is to wipe the copy in memory
1051 * (done in this function's cleanup code). */
1052 overall_status = PSA_ERROR_NOT_PERMITTED;
1053 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001054 }
1055
Gilles Peskine354f7672019-07-12 23:46:38 +02001056#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001057 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001058 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001059 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001060 /* For a key in a secure element, we need to do three things:
1061 * remove the key file in internal storage, destroy the
1062 * key inside the secure element, and update the driver's
1063 * persistent data. Start a transaction that will encompass these
1064 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001065 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001066 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001067 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001068 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001069 status = psa_crypto_save_transaction( );
1070 if( status != PSA_SUCCESS )
1071 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001072 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001073 /* We should still try to destroy the key in the secure
1074 * element and the key metadata in storage. This is especially
1075 * important if the error is that the storage is full.
1076 * But how to do it exactly without risking an inconsistent
1077 * state after a reset?
1078 * https://github.com/ARMmbed/mbed-crypto/issues/215
1079 */
1080 overall_status = status;
1081 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001082 }
1083
Ronald Cronea0f8a62020-11-25 17:52:23 +01001084 status = psa_destroy_se_key( driver,
1085 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001086 if( overall_status == PSA_SUCCESS )
1087 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001089#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1090
Darryl Greend49a4992018-06-18 17:27:26 +01001091#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001092 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001093 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001094 status = psa_destroy_persistent_key( slot->attr.id );
1095 if( overall_status == PSA_SUCCESS )
1096 overall_status = status;
1097
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001098 /* TODO: other slots may have a copy of the same key. We should
1099 * invalidate them.
1100 * https://github.com/ARMmbed/mbed-crypto/issues/214
1101 */
Darryl Greend49a4992018-06-18 17:27:26 +01001102 }
1103#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001104
Gilles Peskinefc762652019-07-22 19:30:34 +02001105#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1106 if( driver != NULL )
1107 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001108 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001109 if( overall_status == PSA_SUCCESS )
1110 overall_status = status;
1111 status = psa_crypto_stop_transaction( );
1112 if( overall_status == PSA_SUCCESS )
1113 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001114 }
1115#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1116
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001117exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001118 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001119 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001120 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001121 overall_status = status;
1122 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001123}
1124
John Durkop07cc04a2020-11-16 22:08:34 -08001125#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001126 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001127static psa_status_t psa_get_rsa_public_exponent(
1128 const mbedtls_rsa_context *rsa,
1129 psa_key_attributes_t *attributes )
1130{
1131 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001133 uint8_t *buffer = NULL;
1134 size_t buflen;
1135 mbedtls_mpi_init( &mpi );
1136
1137 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1138 if( ret != 0 )
1139 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001140 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1141 {
1142 /* It's the default value, which is reported as an empty string,
1143 * so there's nothing to do. */
1144 goto exit;
1145 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001146
1147 buflen = mbedtls_mpi_size( &mpi );
1148 buffer = mbedtls_calloc( 1, buflen );
1149 if( buffer == NULL )
1150 {
1151 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1152 goto exit;
1153 }
1154 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1155 if( ret != 0 )
1156 goto exit;
1157 attributes->domain_parameters = buffer;
1158 attributes->domain_parameters_size = buflen;
1159
1160exit:
1161 mbedtls_mpi_free( &mpi );
1162 if( ret != 0 )
1163 mbedtls_free( buffer );
1164 return( mbedtls_to_psa_error( ret ) );
1165}
John Durkop07cc04a2020-11-16 22:08:34 -08001166#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001167 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001168
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001169/** Retrieve all the publicly-accessible attributes of a key.
1170 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001171psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001172 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001173{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001175 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001176 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001177
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001178 psa_reset_key_attributes( attributes );
1179
Ronald Cron5c522922020-11-14 16:35:34 +01001180 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001181 if( status != PSA_SUCCESS )
1182 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001183
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001184 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001185 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1186 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1187
1188#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001189 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001190 psa_set_key_slot_number( attributes,
1191 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001192#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001193
Gilles Peskine8e338702019-07-30 20:06:31 +02001194 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001195 {
John Durkop07cc04a2020-11-16 22:08:34 -08001196#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001197 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001198 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001199 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001200 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001201 * is not yet implemented.
1202 * https://github.com/ARMmbed/mbed-crypto/issues/216
1203 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001204 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001205 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001206 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001207
Ronald Cron90857082020-11-25 14:58:33 +01001208 status = mbedtls_psa_rsa_load_representation(
1209 slot->attr.type,
1210 slot->key.data,
1211 slot->key.bytes,
1212 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 if( status != PSA_SUCCESS )
1214 break;
1215
Steven Cooremana2371e52020-07-28 14:30:39 +02001216 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001217 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001218 mbedtls_rsa_free( rsa );
1219 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001221 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001222#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001223 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001224 default:
1225 /* Nothing else to do. */
1226 break;
1227 }
1228
1229 if( status != PSA_SUCCESS )
1230 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001231
Ronald Cron5c522922020-11-14 16:35:34 +01001232 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001233
Ronald Cron5c522922020-11-14 16:35:34 +01001234 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001235}
1236
Gilles Peskinec8000c02019-08-02 20:15:51 +02001237#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1238psa_status_t psa_get_key_slot_number(
1239 const psa_key_attributes_t *attributes,
1240 psa_key_slot_number_t *slot_number )
1241{
1242 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1243 {
1244 *slot_number = attributes->slot_number;
1245 return( PSA_SUCCESS );
1246 }
1247 else
1248 return( PSA_ERROR_INVALID_ARGUMENT );
1249}
1250#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1251
Ronald Crond18b5f82020-11-25 16:46:05 +01001252static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1253 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001254 uint8_t *data,
1255 size_t data_size,
1256 size_t *data_length )
1257{
Ronald Crond18b5f82020-11-25 16:46:05 +01001258 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001259 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001260 memcpy( data, key_buffer, key_buffer_size );
1261 memset( data + key_buffer_size, 0,
1262 data_size - key_buffer_size );
1263 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001264 return( PSA_SUCCESS );
1265}
1266
Ronald Cron7285cda2020-11-26 14:46:37 +01001267psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001268 const psa_key_attributes_t *attributes,
1269 const uint8_t *key_buffer, size_t key_buffer_size,
1270 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001271{
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 psa_key_type_t type = attributes->core.type;
1273
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 if( key_type_is_raw_bytes( type ) ||
1275 PSA_KEY_TYPE_IS_RSA( type ) ||
1276 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001277 {
1278 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001279 key_buffer, key_buffer_size,
1280 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001281 }
1282 else
1283 {
1284 /* This shouldn't happen in the reference implementation, but
1285 it is valid for a special-purpose implementation to omit
1286 support for exporting certain key types. */
1287 return( PSA_ERROR_NOT_SUPPORTED );
1288 }
1289}
1290
1291psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1292 uint8_t *data,
1293 size_t data_size,
1294 size_t *data_length )
1295{
1296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1297 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1298 psa_key_slot_t *slot;
1299
Ronald Crone907e552021-01-18 13:22:38 +01001300 /* Reject a zero-length output buffer now, since this can never be a
1301 * valid key representation. This way we know that data must be a valid
1302 * pointer and we can do things like memset(data, ..., data_size). */
1303 if( data_size == 0 )
1304 return( PSA_ERROR_BUFFER_TOO_SMALL );
1305
Ronald Cron9486f9d2020-11-26 13:36:23 +01001306 /* Set the key to empty now, so that even when there are errors, we always
1307 * set data_length to a value between 0 and data_size. On error, setting
1308 * the key to empty is a good choice because an empty key representation is
1309 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001310 *data_length = 0;
1311
Ronald Cron9486f9d2020-11-26 13:36:23 +01001312 /* Export requires the EXPORT flag. There is an exception for public keys,
1313 * which don't require any flag, but
1314 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1315 */
1316 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1317 PSA_KEY_USAGE_EXPORT, 0 );
1318 if( status != PSA_SUCCESS )
1319 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001320
Ronald Crond18b5f82020-11-25 16:46:05 +01001321 psa_key_attributes_t attributes = {
1322 .core = slot->attr
1323 };
Ronald Cron67227982020-11-26 15:16:05 +01001324 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001325 slot->key.data, slot->key.bytes,
1326 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327
Ronald Cron9486f9d2020-11-26 13:36:23 +01001328 unlock_status = psa_unlock_key_slot( slot );
1329
1330 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1331}
1332
Ronald Cron7285cda2020-11-26 14:46:37 +01001333psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001334 const psa_key_attributes_t *attributes,
1335 const uint8_t *key_buffer,
1336 size_t key_buffer_size,
1337 uint8_t *data,
1338 size_t data_size,
1339 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001340{
Ronald Crond18b5f82020-11-25 16:46:05 +01001341 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001342
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001344 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001346 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001347 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001348 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 key_buffer, key_buffer_size,
1350 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001351 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001352
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001354 {
John Durkop0e005192020-10-31 22:06:54 -07001355#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1356 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001357 return( mbedtls_psa_rsa_export_public_key( attributes,
1358 key_buffer,
1359 key_buffer_size,
1360 data,
1361 data_size,
1362 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001363#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001364 /* We don't know how to convert a private RSA key to public. */
1365 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001366#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1367 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001368 }
1369 else
Moran Pekera998bc62018-04-16 18:16:20 +03001370 {
John Durkop6ba40d12020-11-10 08:50:04 -08001371#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1372 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001373 return( mbedtls_psa_ecp_export_public_key( attributes,
1374 key_buffer,
1375 key_buffer_size,
1376 data,
1377 data_size,
1378 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001379#else
1380 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001381 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001382#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1383 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001384 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001385 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001386 else
1387 {
1388 /* This shouldn't happen in the reference implementation, but
1389 it is valid for a special-purpose implementation to omit
1390 support for exporting certain key types. */
1391 return( PSA_ERROR_NOT_SUPPORTED );
1392 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001393}
Ronald Crond18b5f82020-11-25 16:46:05 +01001394
Ronald Croncf56a0a2020-08-04 09:51:30 +02001395psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001396 uint8_t *data,
1397 size_t data_size,
1398 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001399{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001401 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001402 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001403
Ronald Crone907e552021-01-18 13:22:38 +01001404 /* Reject a zero-length output buffer now, since this can never be a
1405 * valid key representation. This way we know that data must be a valid
1406 * pointer and we can do things like memset(data, ..., data_size). */
1407 if( data_size == 0 )
1408 return( PSA_ERROR_BUFFER_TOO_SMALL );
1409
Darryl Greendd8fb772018-11-07 16:00:44 +00001410 /* Set the key to empty now, so that even when there are errors, we always
1411 * set data_length to a value between 0 and data_size. On error, setting
1412 * the key to empty is a good choice because an empty key representation is
1413 * unlikely to be accepted anywhere. */
1414 *data_length = 0;
1415
1416 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001417 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001418 if( status != PSA_SUCCESS )
1419 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001420
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1422 {
1423 status = PSA_ERROR_INVALID_ARGUMENT;
1424 goto exit;
1425 }
1426
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 psa_key_attributes_t attributes = {
1428 .core = slot->attr
1429 };
Ronald Cron67227982020-11-26 15:16:05 +01001430 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 &attributes, slot->key.data, slot->key.bytes,
1432 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433
1434exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001435 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001436
Ronald Cron5c522922020-11-14 16:35:34 +01001437 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001438}
1439
Gilles Peskine91e8c332019-08-02 19:19:39 +02001440#if defined(static_assert)
1441static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1442 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001443static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001444 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001445static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446 "One or more key attribute flag is listed as both internal-only and external-only" );
1447#endif
1448
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001449/** Validate that a key policy is internally well-formed.
1450 *
1451 * This function only rejects invalid policies. It does not validate the
1452 * consistency of the policy with respect to other attributes of the key
1453 * such as the key type.
1454 */
1455static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001456{
1457 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001458 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001459 PSA_KEY_USAGE_ENCRYPT |
1460 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001461 PSA_KEY_USAGE_SIGN_MESSAGE |
1462 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001463 PSA_KEY_USAGE_SIGN_HASH |
1464 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001465 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001466 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1467 return( PSA_ERROR_INVALID_ARGUMENT );
1468
Gilles Peskine4747d192019-04-17 15:05:45 +02001469 return( PSA_SUCCESS );
1470}
1471
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001472/** Validate the internal consistency of key attributes.
1473 *
1474 * This function only rejects invalid attribute values. If does not
1475 * validate the consistency of the attributes with any key data that may
1476 * be involved in the creation of the key.
1477 *
1478 * Call this function early in the key creation process.
1479 *
1480 * \param[in] attributes Key attributes for the new key.
1481 * \param[out] p_drv On any return, the driver for the key, if any.
1482 * NULL for a transparent key.
1483 *
1484 */
1485static psa_status_t psa_validate_key_attributes(
1486 const psa_key_attributes_t *attributes,
1487 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001488{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001489 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001490 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001491 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001492
Ronald Cron54b90082020-10-29 15:26:43 +01001493 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001494 if( status != PSA_SUCCESS )
1495 return( status );
1496
Ronald Crond2ed4812020-07-17 16:11:30 +02001497 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001498 if( status != PSA_SUCCESS )
1499 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001500
Ronald Cron65f38a32020-10-23 17:11:13 +02001501 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1502 {
1503 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1504 return( PSA_ERROR_INVALID_ARGUMENT );
1505 }
1506 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001507 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001508 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1509 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001510 }
1511
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001512 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001513 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514 return( status );
1515
1516 /* Refuse to create overly large keys.
1517 * Note that this doesn't trigger on import if the attributes don't
1518 * explicitly specify a size (so psa_get_key_bits returns 0), so
1519 * psa_import_key() needs its own checks. */
1520 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1521 return( PSA_ERROR_NOT_SUPPORTED );
1522
Gilles Peskine91e8c332019-08-02 19:19:39 +02001523 /* Reject invalid flags. These should not be reachable through the API. */
1524 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1525 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1526 return( PSA_ERROR_INVALID_ARGUMENT );
1527
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001528 return( PSA_SUCCESS );
1529}
1530
Gilles Peskine4747d192019-04-17 15:05:45 +02001531/** Prepare a key slot to receive key material.
1532 *
1533 * This function allocates a key slot and sets its metadata.
1534 *
1535 * If this function fails, call psa_fail_key_creation().
1536 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001537 * This function is intended to be used as follows:
1538 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001539 * it with the specified attributes, and in case of a volatile key assign it
1540 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001541 * -# Populate the slot with the key material.
1542 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1543 * In case of failure at any step, stop the sequence and call
1544 * psa_fail_key_creation().
1545 *
Ronald Cron5c522922020-11-14 16:35:34 +01001546 * On success, the key slot is locked. It is the responsibility of the caller
1547 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001548 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001549 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001550 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001551 * \param[out] p_slot On success, a pointer to the prepared slot.
1552 * \param[out] p_drv On any return, the driver for the key, if any.
1553 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001554 *
1555 * \retval #PSA_SUCCESS
1556 * The key slot is ready to receive key material.
1557 * \return If this function fails, the key slot is an invalid state.
1558 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001559 */
1560static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001561 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001562 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001563 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001564 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001565{
1566 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001567 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 psa_key_slot_t *slot;
1569
Gilles Peskinedf179142019-07-15 22:02:14 +02001570 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001571 *p_drv = NULL;
1572
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001573 status = psa_validate_key_attributes( attributes, p_drv );
1574 if( status != PSA_SUCCESS )
1575 return( status );
1576
Ronald Cronc4d1b512020-07-31 11:26:37 +02001577 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001578 if( status != PSA_SUCCESS )
1579 return( status );
1580 slot = *p_slot;
1581
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001582 /* We're storing the declared bit-size of the key. It's up to each
1583 * creation mechanism to verify that this information is correct.
1584 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001585 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001586 * is optional (import, copy). In case of a volatile key, assign it the
1587 * volatile key identifier associated to the slot returned to contain its
1588 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001589
1590 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001591 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1592 {
1593#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1594 slot->attr.id = volatile_key_id;
1595#else
1596 slot->attr.id.key_id = volatile_key_id;
1597#endif
1598 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001599
Gilles Peskine91e8c332019-08-02 19:19:39 +02001600 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001601 * external-only flags, query `attributes`. Thanks to the check
1602 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001603 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001604 * may have set. */
1605 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606
Gilles Peskinecbaff462019-07-12 23:46:04 +02001607#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001608 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001609 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001610 * create the key file in internal storage, create the
1611 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001612 * persistent data. This is done by starting a transaction that will
1613 * encompass these three actions.
1614 * For registering a volatile key, we just need to find an appropriate
1615 * slot number inside the SE. Since the key is designated volatile, creating
1616 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001617 /* The first thing to do is to find a slot number for the new key.
1618 * We save the slot number in persistent storage as part of the
1619 * transaction data. It will be needed to recover if the power
1620 * fails during the key creation process, to clean up on the secure
1621 * element side after restarting. Obtaining a slot number from the
1622 * secure element driver updates its persistent state, but we do not yet
1623 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001624 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001625 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001626 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001627 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001628 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001629 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001630 if( status != PSA_SUCCESS )
1631 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001632
1633 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001634 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001635 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1636 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001637 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001638 psa_crypto_transaction.key.id = slot->attr.id;
1639 status = psa_crypto_save_transaction( );
1640 if( status != PSA_SUCCESS )
1641 {
1642 (void) psa_crypto_stop_transaction( );
1643 return( status );
1644 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001645 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001646
1647 status = psa_copy_key_material_into_slot(
1648 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001649 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001650
1651 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1652 {
1653 /* Key registration only makes sense with a secure element. */
1654 return( PSA_ERROR_INVALID_ARGUMENT );
1655 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001656#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1657
Ronald Cronc4d1b512020-07-31 11:26:37 +02001658 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001659}
Gilles Peskine4747d192019-04-17 15:05:45 +02001660
1661/** Finalize the creation of a key once its key material has been set.
1662 *
1663 * This entails writing the key to persistent storage.
1664 *
1665 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001666 * See the documentation of psa_start_key_creation() for the intended use
1667 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001668 *
Ronald Cron5c522922020-11-14 16:35:34 +01001669 * If the finalization succeeds, the function unlocks the key slot (it was
1670 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1671 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001672 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001673 * \param[in,out] slot Pointer to the slot with key material.
1674 * \param[in] driver The secure element driver for the key,
1675 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001676 * \param[out] key On success, identifier of the key. Note that the
1677 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001678 *
1679 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001680 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001681 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1682 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1683 * \retval #PSA_ERROR_ALREADY_EXISTS
1684 * \retval #PSA_ERROR_DATA_INVALID
1685 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001686 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001687 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001688 * \return If this function fails, the key slot is an invalid state.
1689 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001690 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001691static psa_status_t psa_finish_key_creation(
1692 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001693 psa_se_drv_table_entry_t *driver,
1694 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001695{
1696 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001697 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001698 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001699
1700#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001701 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001703#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1704 if( driver != NULL )
1705 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001706 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001707 psa_key_slot_number_t slot_number =
1708 psa_key_slot_get_slot_number( slot ) ;
1709
Gilles Peskineb46bef22019-07-30 21:32:04 +02001710#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001711 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001712 sizeof( data.slot_number ),
1713 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001716 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001717 (uint8_t*) &data,
1718 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001719 }
1720 else
1721#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1722 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001723 /* Key material is saved in export representation in the slot, so
1724 * just pass the slot buffer for storage. */
1725 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001726 slot->key.data,
1727 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001728 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001729 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001730#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1731
Gilles Peskinecbaff462019-07-12 23:46:04 +02001732#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001733 /* Finish the transaction for a key creation. This does not
1734 * happen when registering an existing key. Detect this case
1735 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001736 * creation of a persistent key in a secure element requires a transaction,
1737 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001738 if( driver != NULL &&
1739 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740 {
1741 status = psa_save_se_persistent_data( driver );
1742 if( status != PSA_SUCCESS )
1743 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001744 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001745 return( status );
1746 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001747 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748 }
1749#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1750
Ronald Cron50972942020-11-14 11:28:25 +01001751 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001752 {
1753 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001754 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001755 if( status != PSA_SUCCESS )
1756 *key = MBEDTLS_SVC_KEY_ID_INIT;
1757 }
Ronald Cron50972942020-11-14 11:28:25 +01001758
Gilles Peskine4747d192019-04-17 15:05:45 +02001759 return( status );
1760}
1761
1762/** Abort the creation of a key.
1763 *
1764 * You may call this function after calling psa_start_key_creation(),
1765 * or after psa_finish_key_creation() fails. In other circumstances, this
1766 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001767 * See the documentation of psa_start_key_creation() for the intended use
1768 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001769 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001770 * \param[in,out] slot Pointer to the slot with key material.
1771 * \param[in] driver The secure element driver for the key,
1772 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001774static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001775 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001776{
Gilles Peskine011e4282019-06-26 18:34:38 +02001777 (void) driver;
1778
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 if( slot == NULL )
1780 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781
1782#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001783 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001784 * element, and the failure happened later (when saving metadata
1785 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001786 * element.
1787 * https://github.com/ARMmbed/mbed-crypto/issues/217
1788 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001789
Gilles Peskined7729582019-08-05 15:55:54 +02001790 /* Abort the ongoing transaction if any (there may not be one if
1791 * the creation process failed before starting one, or if the
1792 * key creation is a registration of a key in a secure element).
1793 * Earlier functions must already have done what it takes to undo any
1794 * partial creation. All that's left is to update the transaction data
1795 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001796 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001797#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1798
Gilles Peskine4747d192019-04-17 15:05:45 +02001799 psa_wipe_key_slot( slot );
1800}
1801
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001802/** Validate optional attributes during key creation.
1803 *
1804 * Some key attributes are optional during key creation. If they are
1805 * specified in the attributes structure, check that they are consistent
1806 * with the data in the slot.
1807 *
1808 * This function should be called near the end of key creation, after
1809 * the slot in memory is fully populated but before saving persistent data.
1810 */
1811static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001812 const psa_key_slot_t *slot,
1813 const psa_key_attributes_t *attributes )
1814{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001815 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001816 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001817 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001818 return( PSA_ERROR_INVALID_ARGUMENT );
1819 }
1820
1821 if( attributes->domain_parameters_size != 0 )
1822 {
John Durkop0e005192020-10-31 22:06:54 -07001823#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1824 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001825 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001827 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001828 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001830
Ronald Cron90857082020-11-25 14:58:33 +01001831 psa_status_t status = mbedtls_psa_rsa_load_representation(
1832 slot->attr.type,
1833 slot->key.data,
1834 slot->key.bytes,
1835 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001836 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001837 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001838
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001839 mbedtls_mpi_init( &actual );
1840 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001841 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001843 mbedtls_rsa_free( rsa );
1844 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001845 if( ret != 0 )
1846 goto rsa_exit;
1847 ret = mbedtls_mpi_read_binary( &required,
1848 attributes->domain_parameters,
1849 attributes->domain_parameters_size );
1850 if( ret != 0 )
1851 goto rsa_exit;
1852 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1853 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1854 rsa_exit:
1855 mbedtls_mpi_free( &actual );
1856 mbedtls_mpi_free( &required );
1857 if( ret != 0)
1858 return( mbedtls_to_psa_error( ret ) );
1859 }
1860 else
John Durkop9814fa22020-11-04 12:28:15 -08001861#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1862 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 {
1864 return( PSA_ERROR_INVALID_ARGUMENT );
1865 }
1866 }
1867
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001868 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001870 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 return( PSA_ERROR_INVALID_ARGUMENT );
1872 }
1873
1874 return( PSA_SUCCESS );
1875}
1876
Gilles Peskine4747d192019-04-17 15:05:45 +02001877psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001878 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001879 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001880 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001881{
1882 psa_status_t status;
1883 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001884 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001885 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301886 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887
Ronald Cron81709fc2020-11-14 12:10:32 +01001888 *key = MBEDTLS_SVC_KEY_ID_INIT;
1889
Gilles Peskine0f84d622019-09-12 19:03:13 +02001890 /* Reject zero-length symmetric keys (including raw data key objects).
1891 * This also rejects any key which might be encoded as an empty string,
1892 * which is never valid. */
1893 if( data_length == 0 )
1894 return( PSA_ERROR_INVALID_ARGUMENT );
1895
Archana449608b2021-09-08 15:36:05 +05301896 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301897 if( data_length > SIZE_MAX / 8 )
1898 return( PSA_ERROR_NOT_SUPPORTED );
1899
Gilles Peskinedf179142019-07-15 22:02:14 +02001900 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001901 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001902 if( status != PSA_SUCCESS )
1903 goto exit;
1904
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001905 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301906 * storage ( thus not in the case of importing a key in a secure element
1907 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1908 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001909 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001910 {
Archanad8a83dc2021-06-14 10:04:16 +05301911 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1912 {
Archana449608b2021-09-08 15:36:05 +05301913 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1914 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301915 if( status != PSA_SUCCESS )
1916 goto exit;
1917 }
1918 status = psa_allocate_buffer_to_slot( slot, storage_size );
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
Archana6ed4bda2021-08-04 10:47:15 +05301940 /* Enforce a size limit, and in particular ensure that the bit
1941 * size fits in its representation type.*/
1942 if( bits > PSA_MAX_KEY_BITS )
1943 {
1944 status = PSA_ERROR_NOT_SUPPORTED;
1945 goto exit;
1946 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001947 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001948 if( status != PSA_SUCCESS )
1949 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001950
Ronald Cron81709fc2020-11-14 12:10:32 +01001951 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001953 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001954 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001955
Gilles Peskine4747d192019-04-17 15:05:45 +02001956 return( status );
1957}
1958
Gilles Peskined7729582019-08-05 15:55:54 +02001959#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1960psa_status_t mbedtls_psa_register_se_key(
1961 const psa_key_attributes_t *attributes )
1962{
1963 psa_status_t status;
1964 psa_key_slot_t *slot = NULL;
1965 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001966 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001967
1968 /* Leaving attributes unspecified is not currently supported.
1969 * It could make sense to query the key type and size from the
1970 * secure element, but not all secure elements support this
1971 * and the driver HAL doesn't currently support it. */
1972 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1973 return( PSA_ERROR_NOT_SUPPORTED );
1974 if( psa_get_key_bits( attributes ) == 0 )
1975 return( PSA_ERROR_NOT_SUPPORTED );
1976
1977 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001979 if( status != PSA_SUCCESS )
1980 goto exit;
1981
Ronald Cron81709fc2020-11-14 12:10:32 +01001982 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001983
1984exit:
1985 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001986 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001987
Gilles Peskined7729582019-08-05 15:55:54 +02001988 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001989 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001990 return( status );
1991}
1992#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1993
Gilles Peskinef603c712019-01-19 13:40:11 +01001994static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001995 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001996{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001997 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001998 source->key.data,
1999 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002000 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002001 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002002
Steven Cooreman398aee52020-10-13 14:35:45 +02002003 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002004}
2005
Ronald Croncf56a0a2020-08-04 09:51:30 +02002006psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002007 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002008 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002009{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002010 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002011 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002012 psa_key_slot_t *source_slot = NULL;
2013 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002014 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002015 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302016 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002017
Ronald Cron81709fc2020-11-14 12:10:32 +01002018 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2019
Archana8a180362021-07-05 02:18:48 +05302020 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002021 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002022 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002023 goto exit;
2024
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002025 status = psa_validate_optional_attributes( source_slot,
2026 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002027 if( status != PSA_SUCCESS )
2028 goto exit;
2029
Archana374fe5b2021-09-08 15:50:28 +05302030 /* The actual attributes that we received from the user could have
2031 * zero values for key bits and type.These optional attributes
2032 * have been validated and so it is safe to inherit these
2033 * from the source key.
2034 * */
2035 actual_attributes.core.bits = source_slot->attr.bits;
2036 actual_attributes.core.type = source_slot->attr.type;
2037
2038
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002039 status = psa_restrict_key_policy( source_slot->attr.type,
2040 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002041 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002042 if( status != PSA_SUCCESS )
2043 goto exit;
2044
Ronald Cron81709fc2020-11-14 12:10:32 +01002045 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2046 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002047 if( status != PSA_SUCCESS )
2048 goto exit;
Archana8a180362021-07-05 02:18:48 +05302049 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2050 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002051 {
Archana8a180362021-07-05 02:18:48 +05302052 /*
2053 * If the source and target keys are stored across different locations,
2054 * the source key would need to be exported as plaintext and re-imported
2055 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302056 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302057 * appropriate API invocations from the application, if needed.
2058 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002059 status = PSA_ERROR_NOT_SUPPORTED;
2060 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002061 }
Archana8a180362021-07-05 02:18:48 +05302062 /*
2063 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302064 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302065 * - For opaque keys this translates to an invocation of the drivers'
2066 * copy_key entry point through the dispatch layer.
2067 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002068 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2069 {
Archana8a180362021-07-05 02:18:48 +05302070 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302071 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302072 if( status != PSA_SUCCESS )
2073 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302074
Archana8a180362021-07-05 02:18:48 +05302075 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2076 if( status != PSA_SUCCESS )
2077 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302078
Archana8a180362021-07-05 02:18:48 +05302079 status = psa_driver_wrapper_copy_key( &actual_attributes,
2080 source_slot->key.data,
2081 source_slot->key.bytes,
2082 target_slot->key.data,
2083 target_slot->key.bytes,
2084 &target_slot->key.bytes );
2085 if( status != PSA_SUCCESS )
2086 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002087 }
Archana8a180362021-07-05 02:18:48 +05302088 else
2089 {
2090 status = psa_copy_key_material( source_slot, target_slot );
2091 if( status != PSA_SUCCESS )
2092 goto exit;
2093 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002094 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002095exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002096 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002097 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002098
Ronald Cron5c522922020-11-14 16:35:34 +01002099 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002100
Ronald Cron5c522922020-11-14 16:35:34 +01002101 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002102}
2103
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002104
2105
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002106/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002107/* Message digests */
2108/****************************************************************/
2109
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002110psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2111{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002112 /* Aborting a non-active operation is allowed */
2113 if( operation->id == 0 )
2114 return( PSA_SUCCESS );
2115
2116 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2117 operation->id = 0;
2118
2119 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002120}
2121
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002122psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002123 psa_algorithm_t alg )
2124{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002125 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002126
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002127 /* A context must be freshly initialized before it can be set up. */
2128 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002129 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002130 status = PSA_ERROR_BAD_STATE;
2131 goto exit;
2132 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002133
2134 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002135 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002136 status = PSA_ERROR_INVALID_ARGUMENT;
2137 goto exit;
2138 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002139
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002140 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2141 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002142 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2143
Dave Rodgman685b6a72021-06-24 11:49:14 +01002144 status = psa_driver_wrapper_hash_setup( operation, alg );
2145
2146exit:
2147 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002148 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002149
2150 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002151}
2152
2153psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2154 const uint8_t *input,
2155 size_t input_length )
2156{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002157 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2158
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002159 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002160 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002161 status = PSA_ERROR_BAD_STATE;
2162 goto exit;
2163 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002164
Steven Cooremanc8288352021-03-04 14:02:19 +01002165 /* Don't require hash implementations to behave correctly on a
2166 * zero-length input, which may have an invalid pointer. */
2167 if( input_length == 0 )
2168 return( PSA_SUCCESS );
2169
Dave Rodgman685b6a72021-06-24 11:49:14 +01002170 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2171
2172exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002173 if( status != PSA_SUCCESS )
2174 psa_hash_abort( operation );
2175
2176 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177}
2178
2179psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2180 uint8_t *hash,
2181 size_t hash_size,
2182 size_t *hash_length )
2183{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002184 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002185 if( operation->id == 0 )
2186 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187
Steven Cooreman1e582352021-02-18 17:24:37 +01002188 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002189 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002190 psa_hash_abort( operation );
2191 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192}
2193
Gilles Peskine2d277862018-06-18 15:41:12 +02002194psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2195 const uint8_t *hash,
2196 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197{
2198 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2199 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002200 psa_status_t status = psa_hash_finish(
2201 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002202 actual_hash, sizeof( actual_hash ),
2203 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002204
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002205 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206 goto exit;
2207
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002208 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002209 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002210 status = PSA_ERROR_INVALID_SIGNATURE;
2211 goto exit;
2212 }
2213
Steven Cooreman36876a02021-04-29 16:37:59 +02002214 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002215 status = PSA_ERROR_INVALID_SIGNATURE;
2216
2217exit:
2218 if( status != PSA_SUCCESS )
2219 psa_hash_abort(operation);
2220
2221 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002222}
2223
Gilles Peskine0a749c82019-11-28 19:33:58 +01002224psa_status_t psa_hash_compute( psa_algorithm_t alg,
2225 const uint8_t *input, size_t input_length,
2226 uint8_t *hash, size_t hash_size,
2227 size_t *hash_length )
2228{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002229 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002230 if( !PSA_ALG_IS_HASH( alg ) )
2231 return( PSA_ERROR_INVALID_ARGUMENT );
2232
Steven Cooreman1e582352021-02-18 17:24:37 +01002233 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2234 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002235}
2236
2237psa_status_t psa_hash_compare( psa_algorithm_t alg,
2238 const uint8_t *input, size_t input_length,
2239 const uint8_t *hash, size_t hash_length )
2240{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002241 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2242 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002243
2244 if( !PSA_ALG_IS_HASH( alg ) )
2245 return( PSA_ERROR_INVALID_ARGUMENT );
2246
Steven Cooreman1e582352021-02-18 17:24:37 +01002247 psa_status_t status = psa_driver_wrapper_hash_compute(
2248 alg, input, input_length,
2249 actual_hash, sizeof(actual_hash),
2250 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002251 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002252 return( status );
2253 if( actual_hash_length != hash_length )
2254 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002255 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002256 return( PSA_ERROR_INVALID_SIGNATURE );
2257 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002258}
2259
Gilles Peskineeb35d782019-01-22 17:56:16 +01002260psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2261 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002262{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002263 if( source_operation->id == 0 ||
2264 target_operation->id != 0 )
2265 {
2266 return( PSA_ERROR_BAD_STATE );
2267 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002268
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002269 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2270 target_operation );
2271 if( status != PSA_SUCCESS )
2272 psa_hash_abort( target_operation );
2273
2274 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002275}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276
2277
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002279/* MAC */
2280/****************************************************************/
2281
Steven Cooremane6804192021-03-19 18:28:56 +01002282psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002283{
Steven Cooremane6804192021-03-19 18:28:56 +01002284 /* Aborting a non-active operation is allowed */
2285 if( operation->id == 0 )
2286 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002287
Steven Cooremane6804192021-03-19 18:28:56 +01002288 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002289 operation->mac_size = 0;
2290 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002291 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002292
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002293 return( status );
2294}
2295
Ronald Cron2dff3b22021-06-17 16:33:22 +02002296static psa_status_t psa_mac_finalize_alg_and_key_validation(
2297 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002298 const psa_key_attributes_t *attributes,
2299 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002300{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 psa_key_type_t key_type = psa_get_key_type( attributes );
2303 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002304
Ronald Cron28ea0502021-06-17 16:10:24 +02002305 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002306 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002307
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002308 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002310 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002311 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002312
Steven Cooremand1a68f12021-05-10 11:13:41 +02002313 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002314 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002315
Ronald Cron79bdd822021-06-17 16:46:44 +02002316 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002317 {
2318 /* A very short MAC is too short for security since it can be
2319 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2320 * so we make this our minimum, even though 32 bits is still
2321 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002322 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002323 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002324
Ronald Cron79bdd822021-06-17 16:46:44 +02002325 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2326 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002327 {
2328 /* It's impossible to "truncate" to a larger length than the full length
2329 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002330 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002331 }
2332
Ronald Cron79bdd822021-06-17 16:46:44 +02002333 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002334}
2335
Gilles Peskinee59236f2018-01-27 23:32:46 +01002336static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2337 mbedtls_svc_key_id_t key,
2338 psa_algorithm_t alg,
2339 int is_sign )
2340{
2341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2342 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002343 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002344
2345 /* A context must be freshly initialized before it can be set up. */
2346 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002347 {
Dave Rodgman54648242021-06-24 11:49:45 +01002348 status = PSA_ERROR_BAD_STATE;
2349 goto exit;
2350 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351
Gilles Peskine8c9def32018-02-08 10:02:12 +01002352 status = psa_get_and_lock_key_slot_with_policy(
2353 key,
2354 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002355 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356 alg );
2357 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002358 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359
2360 psa_key_attributes_t attributes = {
2361 .core = slot->attr
2362 };
2363
Ronald Cron79bdd822021-06-17 16:46:44 +02002364 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2365 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002366 if( status != PSA_SUCCESS )
2367 goto exit;
2368
2369 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002370 /* Dispatch the MAC setup call with validated input */
2371 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002372 {
Steven Cooremane6804192021-03-19 18:28:56 +01002373 status = psa_driver_wrapper_mac_sign_setup( operation,
2374 &attributes,
2375 slot->key.data,
2376 slot->key.bytes,
2377 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002378 }
2379 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002380 {
Steven Cooremane6804192021-03-19 18:28:56 +01002381 status = psa_driver_wrapper_mac_verify_setup( operation,
2382 &attributes,
2383 slot->key.data,
2384 slot->key.bytes,
2385 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002386 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002387
Gilles Peskinefbfac682018-07-08 20:51:54 +02002388exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002389 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002390 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002391
Ronald Cron5c522922020-11-14 16:35:34 +01002392 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002393
Ronald Cron5c522922020-11-14 16:35:34 +01002394 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002395}
2396
Gilles Peskine89167cb2018-07-08 20:12:23 +02002397psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002398 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002399 psa_algorithm_t alg )
2400{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002401 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002402}
2403
2404psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002405 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002406 psa_algorithm_t alg )
2407{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002408 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002409}
2410
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002411psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412 const uint8_t *input,
2413 size_t input_length )
2414{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002415 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002416 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002417
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002418 /* Don't require hash implementations to behave correctly on a
2419 * zero-length input, which may have an invalid pointer. */
2420 if( input_length == 0 )
2421 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002422
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002423 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2424 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002425 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002426 psa_mac_abort( operation );
2427
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002428 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002429}
2430
Steven Cooremana5b860a2021-03-19 19:04:39 +01002431psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002432 uint8_t *mac,
2433 size_t mac_size,
2434 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002435{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2437 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002438
Steven Cooremana5b860a2021-03-19 19:04:39 +01002439 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002440 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002441 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002442 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002443 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002444
Steven Cooreman72f736a2021-05-07 14:14:37 +02002445 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002446 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002447 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002448 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002449 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002450
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002451 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2452 * once all the error checks are done. */
2453 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002454 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002455 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002456 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002457 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002458
2459 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002460 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002461 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002462 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002463 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002464
Steven Cooremana5b860a2021-03-19 19:04:39 +01002465 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002466 mac, operation->mac_size,
2467 mac_length );
2468
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002469exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002470 /* In case of success, set the potential excess room in the output buffer
2471 * to an invalid value, to avoid potentially leaking a longer MAC.
2472 * In case of error, set the output length and content to a safe default,
2473 * such that in case the caller misses an error check, the output would be
2474 * an unachievable MAC.
2475 */
2476 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002477 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002478 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002479 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002480 }
mohammad16036df908f2018-04-02 08:34:15 -07002481
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002482 if( mac_size > operation->mac_size )
2483 memset( &mac[operation->mac_size], '!',
2484 mac_size - operation->mac_size );
2485
Steven Cooremana5b860a2021-03-19 19:04:39 +01002486 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002487
Steven Cooremana5b860a2021-03-19 19:04:39 +01002488 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002489}
2490
Steven Cooremana5b860a2021-03-19 19:04:39 +01002491psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002492 const uint8_t *mac,
2493 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002494{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002495 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2496 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002497
Steven Cooremana5b860a2021-03-19 19:04:39 +01002498 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002499 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002500 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002501 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002502 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002503
Steven Cooreman72f736a2021-05-07 14:14:37 +02002504 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002505 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002506 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002507 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002508 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002509
2510 if( operation->mac_size != mac_length )
2511 {
2512 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002513 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002514 }
2515
Steven Cooremana5b860a2021-03-19 19:04:39 +01002516 status = psa_driver_wrapper_mac_verify_finish( operation,
2517 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002518
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002519exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002520 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002521
Steven Cooremana5b860a2021-03-19 19:04:39 +01002522 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002523}
2524
Ronald Croncd989b52021-06-18 14:23:33 +02002525static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2526 psa_algorithm_t alg,
2527 const uint8_t *input,
2528 size_t input_length,
2529 uint8_t *mac,
2530 size_t mac_size,
2531 size_t *mac_length,
2532 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002533{
2534 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002535 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2536 psa_key_slot_t *slot;
2537 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002538
Ronald Cron51131b52021-06-17 17:17:20 +02002539 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002540 key,
2541 &slot,
2542 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002543 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002544 if( status != PSA_SUCCESS )
2545 goto exit;
2546
Ronald Cron51131b52021-06-17 17:17:20 +02002547 psa_key_attributes_t attributes = {
2548 .core = slot->attr
2549 };
2550
2551 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2552 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002553 if( status != PSA_SUCCESS )
2554 goto exit;
2555
Ronald Cron51131b52021-06-17 17:17:20 +02002556 if( mac_size < operation_mac_size )
2557 {
2558 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002559 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002560 }
2561
2562 status = psa_driver_wrapper_mac_compute(
2563 &attributes,
2564 slot->key.data, slot->key.bytes,
2565 alg,
2566 input, input_length,
2567 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002568
2569exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002570 /* In case of success, set the potential excess room in the output buffer
2571 * to an invalid value, to avoid potentially leaking a longer MAC.
2572 * In case of error, set the output length and content to a safe default,
2573 * such that in case the caller misses an error check, the output would be
2574 * an unachievable MAC.
2575 */
2576 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002577 {
Ronald Cron51131b52021-06-17 17:17:20 +02002578 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002579 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002580 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002581 if( mac_size > operation_mac_size )
2582 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002583
Ronald Cron51131b52021-06-17 17:17:20 +02002584 unlock_status = psa_unlock_key_slot( slot );
2585
2586 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002587}
2588
Ronald Croncd989b52021-06-18 14:23:33 +02002589psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2590 psa_algorithm_t alg,
2591 const uint8_t *input,
2592 size_t input_length,
2593 uint8_t *mac,
2594 size_t mac_size,
2595 size_t *mac_length)
2596{
2597 return( psa_mac_compute_internal( key, alg,
2598 input, input_length,
2599 mac, mac_size, mac_length, 1 ) );
2600}
2601
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2603 psa_algorithm_t alg,
2604 const uint8_t *input,
2605 size_t input_length,
2606 const uint8_t *mac,
2607 size_t mac_length)
2608{
2609 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002610 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2611 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612
Ronald Crona587cbc2021-06-18 14:51:29 +02002613 status = psa_mac_compute_internal( key, alg,
2614 input, input_length,
2615 actual_mac, sizeof( actual_mac ),
2616 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002617 if( status != PSA_SUCCESS )
2618 goto exit;
2619
Ronald Crona587cbc2021-06-18 14:51:29 +02002620 if( mac_length != actual_mac_length )
2621 {
2622 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002623 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002624 }
2625 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2626 {
2627 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002628 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002629 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002630
2631exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002632 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002633
2634 return ( status );
2635}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002636
Gilles Peskinee59236f2018-01-27 23:32:46 +01002637/****************************************************************/
2638/* Asymmetric cryptography */
2639/****************************************************************/
2640
gabor-mezei-armf0486182021-05-12 11:03:09 +02002641static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002642 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002643{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002644 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002645 {
2646 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2647 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002648
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002649 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2650 {
2651 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2652 return( PSA_ERROR_INVALID_ARGUMENT );
2653 }
2654 }
2655 else
2656 {
2657 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2658 return( PSA_ERROR_INVALID_ARGUMENT );
2659 }
2660
2661 return( PSA_SUCCESS );
2662}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002663
2664static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002665 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666 psa_algorithm_t alg,
2667 const uint8_t * input,
2668 size_t input_length,
2669 uint8_t * signature,
2670 size_t signature_size,
2671 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002672{
2673 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2674 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2675 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002676
2677 *signature_length = 0;
2678
gabor-mezei-armf0486182021-05-12 11:03:09 +02002679 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002680 if( status != PSA_SUCCESS )
2681 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002682
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002683 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002684 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002685 * buffer can in principle be empty since it doesn't actually have
2686 * to be a hash.) */
2687 if( signature_size == 0 )
2688 return( PSA_ERROR_BUFFER_TOO_SMALL );
2689
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002690 status = psa_get_and_lock_key_slot_with_policy(
2691 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002692 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2693 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002694 alg );
2695
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002696 if( status != PSA_SUCCESS )
2697 goto exit;
2698
2699 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2700 {
2701 status = PSA_ERROR_INVALID_ARGUMENT;
2702 goto exit;
2703 }
2704
2705 psa_key_attributes_t attributes = {
2706 .core = slot->attr
2707 };
2708
gabor-mezei-armf0486182021-05-12 11:03:09 +02002709 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002710 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002711 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002713 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002714 signature, signature_size, signature_length );
2715 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002716 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002717 {
2718
2719 status = psa_driver_wrapper_sign_hash(
2720 &attributes, slot->key.data, slot->key.bytes,
2721 alg, input, input_length,
2722 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002723 }
2724
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002725
2726exit:
2727 /* Fill the unused part of the output buffer (the whole buffer on error,
2728 * the trailing part on success) with something that isn't a valid signature
2729 * (barring an attack on the signature and deliberately-crafted input),
2730 * in case the caller doesn't check the return status properly. */
2731 if( status == PSA_SUCCESS )
2732 memset( signature + *signature_length, '!',
2733 signature_size - *signature_length );
2734 else
2735 memset( signature, '!', signature_size );
2736 /* If signature_size is 0 then we have nothing to do. We must not call
2737 * memset because signature may be NULL in this case. */
2738
2739 unlock_status = psa_unlock_key_slot( slot );
2740
2741 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2742}
2743
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002744static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002745 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002746 psa_algorithm_t alg,
2747 const uint8_t * input,
2748 size_t input_length,
2749 const uint8_t * signature,
2750 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002751{
2752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2753 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2754 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755
gabor-mezei-armf0486182021-05-12 11:03:09 +02002756 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002757 if( status != PSA_SUCCESS )
2758 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002760 status = psa_get_and_lock_key_slot_with_policy(
2761 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002762 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2763 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002764 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002765
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002766 if( status != PSA_SUCCESS )
2767 return( status );
2768
2769 psa_key_attributes_t attributes = {
2770 .core = slot->attr
2771 };
2772
gabor-mezei-armf0486182021-05-12 11:03:09 +02002773 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002774 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002775 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002776 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002777 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002778 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002779 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002780 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002781 {
2782 status = psa_driver_wrapper_verify_hash(
2783 &attributes, slot->key.data, slot->key.bytes,
2784 alg, input, input_length,
2785 signature, signature_length );
2786 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002787
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002788 unlock_status = psa_unlock_key_slot( slot );
2789
2790 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002791
2792}
2793
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002794psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002795 const psa_key_attributes_t *attributes,
2796 const uint8_t *key_buffer,
2797 size_t key_buffer_size,
2798 psa_algorithm_t alg,
2799 const uint8_t *input,
2800 size_t input_length,
2801 uint8_t *signature,
2802 size_t signature_size,
2803 size_t *signature_length )
2804{
2805 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002806
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002807 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2808 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002809 size_t hash_length;
2810 uint8_t hash[PSA_HASH_MAX_SIZE];
2811
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002812 status = psa_driver_wrapper_hash_compute(
2813 PSA_ALG_SIGN_GET_HASH( alg ),
2814 input, input_length,
2815 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002816
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002817 if( status != PSA_SUCCESS )
2818 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002819
2820 return psa_driver_wrapper_sign_hash(
2821 attributes, key_buffer, key_buffer_size,
2822 alg, hash, hash_length,
2823 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002824 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002826 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002827}
2828
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002829psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2830 psa_algorithm_t alg,
2831 const uint8_t * input,
2832 size_t input_length,
2833 uint8_t * signature,
2834 size_t signature_size,
2835 size_t * signature_length )
2836{
2837 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002838 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002839 signature, signature_size, signature_length );
2840}
2841
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002842psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002843 const psa_key_attributes_t *attributes,
2844 const uint8_t *key_buffer,
2845 size_t key_buffer_size,
2846 psa_algorithm_t alg,
2847 const uint8_t *input,
2848 size_t input_length,
2849 const uint8_t *signature,
2850 size_t signature_length )
2851{
2852 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002853
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002854 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2855 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002856 size_t hash_length;
2857 uint8_t hash[PSA_HASH_MAX_SIZE];
2858
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002859 status = psa_driver_wrapper_hash_compute(
2860 PSA_ALG_SIGN_GET_HASH( alg ),
2861 input, input_length,
2862 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002863
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002864 if( status != PSA_SUCCESS )
2865 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002866
2867 return psa_driver_wrapper_verify_hash(
2868 attributes, key_buffer, key_buffer_size,
2869 alg, hash, hash_length,
2870 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002871 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002872
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002873 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002874}
2875
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002876psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2877 psa_algorithm_t alg,
2878 const uint8_t * input,
2879 size_t input_length,
2880 const uint8_t * signature,
2881 size_t signature_length )
2882{
2883 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002884 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002885 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002886}
2887
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002888psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002889 const psa_key_attributes_t *attributes,
2890 const uint8_t *key_buffer, size_t key_buffer_size,
2891 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2892 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002893{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002894 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002895 {
Ronald Cron4501c982021-03-19 20:09:32 +01002896 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2897 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002898 {
Ronald Cron4501c982021-03-19 20:09:32 +01002899#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2900 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2901 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002902 attributes,
2903 key_buffer, key_buffer_size,
2904 alg, hash, hash_length,
2905 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002906#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2907 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002908 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002909 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002910 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002911 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002912 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002913 }
2914 else
Ronald Cron4501c982021-03-19 20:09:32 +01002915 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2916 {
2917 if( PSA_ALG_IS_ECDSA( alg ) )
2918 {
2919#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2920 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2921 return( mbedtls_psa_ecdsa_sign_hash(
2922 attributes,
2923 key_buffer, key_buffer_size,
2924 alg, hash, hash_length,
2925 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002926#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2927 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002928 }
2929 else
2930 {
2931 return( PSA_ERROR_INVALID_ARGUMENT );
2932 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002933 }
Ronald Cron4501c982021-03-19 20:09:32 +01002934
2935 (void)key_buffer;
2936 (void)key_buffer_size;
2937 (void)hash;
2938 (void)hash_length;
2939 (void)signature;
2940 (void)signature_size;
2941 (void)signature_length;
2942
2943 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002944}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002945
2946psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2947 psa_algorithm_t alg,
2948 const uint8_t *hash,
2949 size_t hash_length,
2950 uint8_t *signature,
2951 size_t signature_size,
2952 size_t *signature_length )
2953{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002954 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002955 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002956 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002957}
2958
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002959psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002960 const psa_key_attributes_t *attributes,
2961 const uint8_t *key_buffer, size_t key_buffer_size,
2962 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2963 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002964{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002965 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002966 {
Ronald Cron4501c982021-03-19 20:09:32 +01002967 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2968 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002969 {
Ronald Cron4501c982021-03-19 20:09:32 +01002970#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2971 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2972 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002973 attributes,
2974 key_buffer, key_buffer_size,
2975 alg, hash, hash_length,
2976 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002977#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2978 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002979 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002980 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002981 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002982 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002983 }
itayzafrir5c753392018-05-08 11:18:38 +03002984 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002985 else
Ronald Cron4501c982021-03-19 20:09:32 +01002986 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002987 {
Ronald Cron4501c982021-03-19 20:09:32 +01002988 if( PSA_ALG_IS_ECDSA( alg ) )
2989 {
2990#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2991 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2992 return( mbedtls_psa_ecdsa_verify_hash(
2993 attributes,
2994 key_buffer, key_buffer_size,
2995 alg, hash, hash_length,
2996 signature, signature_length ) );
2997#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2998 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2999 }
3000 else
3001 {
3002 return( PSA_ERROR_INVALID_ARGUMENT );
3003 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003004 }
Ronald Cron4501c982021-03-19 20:09:32 +01003005
3006 (void)key_buffer;
3007 (void)key_buffer_size;
3008 (void)hash;
3009 (void)hash_length;
3010 (void)signature;
3011 (void)signature_length;
3012
3013 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003014}
3015
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003016psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3017 psa_algorithm_t alg,
3018 const uint8_t *hash,
3019 size_t hash_length,
3020 const uint8_t *signature,
3021 size_t signature_length )
3022{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003023 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003024 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003025 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003026}
3027
John Durkop0e005192020-10-31 22:06:54 -07003028#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003029static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3030 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003031{
3032 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3033 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3034 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003035
3036 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003037}
John Durkop0e005192020-10-31 22:06:54 -07003038#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003039
Ronald Croncf56a0a2020-08-04 09:51:30 +02003040psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041 psa_algorithm_t alg,
3042 const uint8_t *input,
3043 size_t input_length,
3044 const uint8_t *salt,
3045 size_t salt_length,
3046 uint8_t *output,
3047 size_t output_size,
3048 size_t *output_length )
3049{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003051 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003052 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003053
Darryl Green5cc689a2018-07-24 15:34:10 +01003054 (void) input;
3055 (void) input_length;
3056 (void) salt;
3057 (void) output;
3058 (void) output_size;
3059
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003060 *output_length = 0;
3061
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003062 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3063 return( PSA_ERROR_INVALID_ARGUMENT );
3064
Ronald Cron5c522922020-11-14 16:35:34 +01003065 status = psa_get_and_lock_transparent_key_slot_with_policy(
3066 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003067 if( status != PSA_SUCCESS )
3068 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003069 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3070 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003071 {
3072 status = PSA_ERROR_INVALID_ARGUMENT;
3073 goto exit;
3074 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075
John Durkop6ba40d12020-11-10 08:50:04 -08003076#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3077 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003078 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003079 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003080 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003081 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3082 slot->key.data,
3083 slot->key.bytes,
3084 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003085 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003087
3088 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003089 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003090 status = PSA_ERROR_BUFFER_TOO_SMALL;
3091 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003092 }
John Durkop0e005192020-10-31 22:06:54 -07003093#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003094 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3095 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003096 status = mbedtls_to_psa_error(
3097 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003098 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003099 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003100 input_length,
3101 input,
3102 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 }
3104 else
John Durkop0e005192020-10-31 22:06:54 -07003105#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3106#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3108 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003109 status = mbedtls_to_psa_error(
3110 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3111 if( status != PSA_SUCCESS )
3112 goto rsa_exit;
3113
Steven Cooreman4fed4552020-08-03 14:46:03 +02003114 status = mbedtls_to_psa_error(
3115 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003116 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003117 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003118 salt, salt_length,
3119 input_length,
3120 input,
3121 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122 }
3123 else
John Durkop0e005192020-10-31 22:06:54 -07003124#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003126 status = PSA_ERROR_INVALID_ARGUMENT;
3127 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003128 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003129rsa_exit:
3130 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003131 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003132
Steven Cooremana2371e52020-07-28 14:30:39 +02003133 mbedtls_rsa_free( rsa );
3134 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003136 else
John Durkop9814fa22020-11-04 12:28:15 -08003137#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003138 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003140 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003141 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003142
3143exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003144 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003145
Ronald Cron5c522922020-11-14 16:35:34 +01003146 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003147}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003148
Ronald Croncf56a0a2020-08-04 09:51:30 +02003149psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003150 psa_algorithm_t alg,
3151 const uint8_t *input,
3152 size_t input_length,
3153 const uint8_t *salt,
3154 size_t salt_length,
3155 uint8_t *output,
3156 size_t output_size,
3157 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003158{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003160 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003161 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003162
Darryl Green5cc689a2018-07-24 15:34:10 +01003163 (void) input;
3164 (void) input_length;
3165 (void) salt;
3166 (void) output;
3167 (void) output_size;
3168
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003169 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003171 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3172 return( PSA_ERROR_INVALID_ARGUMENT );
3173
Ronald Cron5c522922020-11-14 16:35:34 +01003174 status = psa_get_and_lock_transparent_key_slot_with_policy(
3175 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003176 if( status != PSA_SUCCESS )
3177 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003178 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179 {
3180 status = PSA_ERROR_INVALID_ARGUMENT;
3181 goto exit;
3182 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003183
John Durkop6ba40d12020-11-10 08:50:04 -08003184#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3185 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003186 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003187 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003188 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003189 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3190 slot->key.data,
3191 slot->key.bytes,
3192 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003193 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003194 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195
Steven Cooremana2371e52020-07-28 14:30:39 +02003196 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003197 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003198 status = PSA_ERROR_INVALID_ARGUMENT;
3199 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003200 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003201
John Durkop0e005192020-10-31 22:06:54 -07003202#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003203 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003204 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003205 status = mbedtls_to_psa_error(
3206 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003207 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003208 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003209 output_length,
3210 input,
3211 output,
3212 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213 }
3214 else
John Durkop0e005192020-10-31 22:06:54 -07003215#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3216#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003217 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003218 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003219 status = mbedtls_to_psa_error(
3220 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3221 if( status != PSA_SUCCESS )
3222 goto rsa_exit;
3223
Steven Cooreman4fed4552020-08-03 14:46:03 +02003224 status = mbedtls_to_psa_error(
3225 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003226 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003227 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003228 salt, salt_length,
3229 output_length,
3230 input,
3231 output,
3232 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233 }
3234 else
John Durkop0e005192020-10-31 22:06:54 -07003235#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003236 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003237 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003238 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003239
Steven Cooreman4fed4552020-08-03 14:46:03 +02003240rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003241 mbedtls_rsa_free( rsa );
3242 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003243 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003244 else
John Durkop6ba40d12020-11-10 08:50:04 -08003245#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3246 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003247 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003248 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003249 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003250
3251exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003252 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003253
Ronald Cron5c522922020-11-14 16:35:34 +01003254 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003255}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003256
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003257
3258
mohammad1603503973b2018-03-12 15:59:30 +02003259/****************************************************************/
3260/* Symmetric cryptography */
3261/****************************************************************/
3262
Ronald Cronab99ac22020-10-01 16:38:28 +02003263static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3264 mbedtls_svc_key_id_t key,
3265 psa_algorithm_t alg,
3266 mbedtls_operation_t cipher_operation )
3267{
3268 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3269 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003270 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003271 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3272 PSA_KEY_USAGE_ENCRYPT :
3273 PSA_KEY_USAGE_DECRYPT );
3274
3275 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003276 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003277 {
Dave Rodgman54648242021-06-24 11:49:45 +01003278 status = PSA_ERROR_BAD_STATE;
3279 goto exit;
3280 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003281
Ronald Cronab99ac22020-10-01 16:38:28 +02003282 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003283 {
Dave Rodgman54648242021-06-24 11:49:45 +01003284 status = PSA_ERROR_INVALID_ARGUMENT;
3285 goto exit;
3286 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003287
Ronald Cronab99ac22020-10-01 16:38:28 +02003288 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3289 if( status != PSA_SUCCESS )
3290 goto exit;
3291
Ronald Cron49fafa92021-03-10 08:34:23 +01003292 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003293 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003294 * so we only set it (in the driver wrapper) after resources have been
3295 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003296 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003297 if( alg == PSA_ALG_ECB_NO_PADDING )
3298 operation->iv_required = 0;
3299 else
3300 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003301 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003302
Ronald Crona4af55f2020-12-14 14:36:06 +01003303 psa_key_attributes_t attributes = {
3304 .core = slot->attr
3305 };
3306
Ronald Cronab99ac22020-10-01 16:38:28 +02003307 /* Try doing the operation through a driver before using software fallback. */
3308 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003309 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3310 &attributes,
3311 slot->key.data,
3312 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003313 alg );
3314 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003315 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3316 &attributes,
3317 slot->key.data,
3318 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003319 alg );
3320
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003321exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003322 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003323 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003324
Ronald Cron5c522922020-11-14 16:35:34 +01003325 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003326
Ronald Cron5c522922020-11-14 16:35:34 +01003327 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003328}
3329
Gilles Peskinefe119512018-07-08 21:39:34 +02003330psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003331 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003332 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003333{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003334 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003335}
3336
Gilles Peskinefe119512018-07-08 21:39:34 +02003337psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003338 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003339 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003340{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003341 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003342}
3343
Gilles Peskinefe119512018-07-08 21:39:34 +02003344psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003345 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003346 size_t iv_size,
3347 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003348{
Ronald Cron6d051732020-10-01 14:10:20 +02003349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003350
Ronald Cron5618a392021-03-26 09:52:26 +01003351 *iv_length = 0;
3352
Ronald Cron49fafa92021-03-10 08:34:23 +01003353 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003354 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003355 status = PSA_ERROR_BAD_STATE;
3356 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003357 }
3358
Steven Cooreman7df02922020-09-09 15:28:49 +02003359 if( operation->iv_set || ! operation->iv_required )
3360 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003361 status = PSA_ERROR_BAD_STATE;
3362 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003363 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003364
Ronald Cron5618a392021-03-26 09:52:26 +01003365 if( iv_size < operation->default_iv_length )
3366 {
3367 status = PSA_ERROR_BUFFER_TOO_SMALL;
3368 goto exit;
3369 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003370
Ronald Cron5618a392021-03-26 09:52:26 +01003371 status = psa_generate_random( iv, operation->default_iv_length );
3372 if( status != PSA_SUCCESS )
3373 goto exit;
3374
3375 status = psa_driver_wrapper_cipher_set_iv( operation,
3376 iv,
3377 operation->default_iv_length );
3378
3379exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003380 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003381 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003382 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003383 *iv_length = operation->default_iv_length;
3384 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003385 else
Moran Peker395db872018-05-31 14:07:14 +03003386 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003387
itayzafrir534bd7c2018-08-02 13:56:32 +03003388 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003389}
3390
Gilles Peskinefe119512018-07-08 21:39:34 +02003391psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003392 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003393 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003394{
Ronald Cron6d051732020-10-01 14:10:20 +02003395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003396
Ronald Cron49fafa92021-03-10 08:34:23 +01003397 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003398 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003399 status = PSA_ERROR_BAD_STATE;
3400 goto exit;
3401 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003402
Steven Cooreman7df02922020-09-09 15:28:49 +02003403 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003404 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003405 status = PSA_ERROR_BAD_STATE;
3406 goto exit;
3407 }
Ronald Crona0d68172021-03-26 10:15:08 +01003408
3409 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003410 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003411 status = PSA_ERROR_INVALID_ARGUMENT;
3412 goto exit;
3413 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003414
Ronald Crondd24c9b2020-12-15 14:10:01 +01003415 status = psa_driver_wrapper_cipher_set_iv( operation,
3416 iv,
3417 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003418
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003419exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003420 if( status == PSA_SUCCESS )
3421 operation->iv_set = 1;
3422 else
mohammad1603503973b2018-03-12 15:59:30 +02003423 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003424 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003425}
3426
Gilles Peskinee553c652018-06-04 16:22:46 +02003427psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3428 const uint8_t *input,
3429 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003430 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003431 size_t output_size,
3432 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003433{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003435
Ronald Cron49fafa92021-03-10 08:34:23 +01003436 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003437 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003438 status = PSA_ERROR_BAD_STATE;
3439 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003440 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003441
Steven Cooreman7df02922020-09-09 15:28:49 +02003442 if( operation->iv_required && ! operation->iv_set )
3443 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003444 status = PSA_ERROR_BAD_STATE;
3445 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003446 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003447
Ronald Crondd24c9b2020-12-15 14:10:01 +01003448 status = psa_driver_wrapper_cipher_update( operation,
3449 input,
3450 input_length,
3451 output,
3452 output_size,
3453 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003454
3455exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003456 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003457 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003458
itayzafrir534bd7c2018-08-02 13:56:32 +03003459 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003460}
3461
Gilles Peskinee553c652018-06-04 16:22:46 +02003462psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3463 uint8_t *output,
3464 size_t output_size,
3465 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003466{
David Saadab4ecc272019-02-14 13:48:10 +02003467 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003468
Ronald Cron49fafa92021-03-10 08:34:23 +01003469 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003470 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003471 status = PSA_ERROR_BAD_STATE;
3472 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003473 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003474
Steven Cooreman7df02922020-09-09 15:28:49 +02003475 if( operation->iv_required && ! operation->iv_set )
3476 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003477 status = PSA_ERROR_BAD_STATE;
3478 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003479 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003480
Ronald Crondd24c9b2020-12-15 14:10:01 +01003481 status = psa_driver_wrapper_cipher_finish( operation,
3482 output,
3483 output_size,
3484 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003485
3486exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003487 if( status == PSA_SUCCESS )
3488 return( psa_cipher_abort( operation ) );
3489 else
3490 {
3491 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003492 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003493
Steven Cooremanef8575e2020-09-11 11:44:50 +02003494 return( status );
3495 }
mohammad1603503973b2018-03-12 15:59:30 +02003496}
3497
Gilles Peskinee553c652018-06-04 16:22:46 +02003498psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3499{
Ronald Cron49fafa92021-03-10 08:34:23 +01003500 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003501 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003502 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003503 * in use. It's ok to call abort on such an object, and there's
3504 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003505 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003506 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003507
Ronald Crondd24c9b2020-12-15 14:10:01 +01003508 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003509
Ronald Cron49fafa92021-03-10 08:34:23 +01003510 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003511 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003512 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003513
Moran Peker395db872018-05-31 14:07:14 +03003514 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003515}
3516
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003517psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3518 psa_algorithm_t alg,
3519 const uint8_t *input,
3520 size_t input_length,
3521 uint8_t *output,
3522 size_t output_size,
3523 size_t *output_length )
3524{
3525 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003526 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3527 psa_key_slot_t *slot;
3528 psa_key_type_t key_type;
3529 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003530
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003531 *output_length = 0;
3532
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003533 if( ! PSA_ALG_IS_CIPHER( alg ) )
3534 return( PSA_ERROR_INVALID_ARGUMENT );
3535
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003536 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3537 PSA_KEY_USAGE_ENCRYPT,
3538 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003539 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003540 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003541
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003542 psa_key_attributes_t attributes = {
3543 .core = slot->attr
3544 };
3545
3546 key_type = slot->attr.type;
3547 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3548
3549 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003550 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003551 if( output_size < iv_length )
3552 {
3553 status = PSA_ERROR_BUFFER_TOO_SMALL;
3554 goto exit;
3555 }
3556
3557 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003558 if( status != PSA_SUCCESS )
3559 goto exit;
3560 }
3561
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 status = psa_driver_wrapper_cipher_encrypt(
3563 &attributes, slot->key.data, slot->key.bytes,
3564 alg, input, input_length,
3565 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003566
3567exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003569
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003570 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003571}
3572
3573psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3574 psa_algorithm_t alg,
3575 const uint8_t *input,
3576 size_t input_length,
3577 uint8_t *output,
3578 size_t output_size,
3579 size_t *output_length )
3580{
3581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003582 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3583 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003584
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003585 *output_length = 0;
3586
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003587 if( ! PSA_ALG_IS_CIPHER( alg ) )
3588 return( PSA_ERROR_INVALID_ARGUMENT );
3589
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003590 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3591 PSA_KEY_USAGE_DECRYPT,
3592 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003593 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003594 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003595
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003596 psa_key_attributes_t attributes = {
3597 .core = slot->attr
3598 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003599
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003600 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3601 {
3602 status = PSA_ERROR_INVALID_ARGUMENT;
3603 goto exit;
3604 }
3605
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003606 status = psa_driver_wrapper_cipher_decrypt(
3607 &attributes, slot->key.data, slot->key.bytes,
3608 alg, input, input_length,
3609 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003610
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003611exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003612 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003613
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003614 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003615}
3616
3617
mohammad16035955c982018-04-26 00:53:03 +03003618/****************************************************************/
3619/* AEAD */
3620/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003621
Ronald Croncf56a0a2020-08-04 09:51:30 +02003622psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003623 psa_algorithm_t alg,
3624 const uint8_t *nonce,
3625 size_t nonce_length,
3626 const uint8_t *additional_data,
3627 size_t additional_data_length,
3628 const uint8_t *plaintext,
3629 size_t plaintext_length,
3630 uint8_t *ciphertext,
3631 size_t ciphertext_size,
3632 size_t *ciphertext_length )
3633{
Ronald Cron215633c2021-03-16 17:15:37 +01003634 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3635 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003636
mohammad1603f08a5502018-06-03 15:05:47 +03003637 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003638
Steven Cooremanea7ab132021-03-17 16:28:00 +01003639 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3640 return( PSA_ERROR_NOT_SUPPORTED );
3641
Ronald Cron9a986162021-03-26 12:40:07 +01003642 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003643 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003644 if( status != PSA_SUCCESS )
3645 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003646
Ronald Cron215633c2021-03-16 17:15:37 +01003647 psa_key_attributes_t attributes = {
3648 .core = slot->attr
3649 };
mohammad16035955c982018-04-26 00:53:03 +03003650
Ronald Cronde822812021-03-17 16:08:20 +01003651 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003652 &attributes, slot->key.data, slot->key.bytes,
3653 alg,
3654 nonce, nonce_length,
3655 additional_data, additional_data_length,
3656 plaintext, plaintext_length,
3657 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003658
Gilles Peskineedf9a652018-08-17 18:11:56 +02003659 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3660 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003661
Ronald Cron9f310172021-03-16 16:36:37 +01003662 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003663
mohammad16035955c982018-04-26 00:53:03 +03003664 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003665}
3666
Ronald Croncf56a0a2020-08-04 09:51:30 +02003667psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003668 psa_algorithm_t alg,
3669 const uint8_t *nonce,
3670 size_t nonce_length,
3671 const uint8_t *additional_data,
3672 size_t additional_data_length,
3673 const uint8_t *ciphertext,
3674 size_t ciphertext_length,
3675 uint8_t *plaintext,
3676 size_t plaintext_size,
3677 size_t *plaintext_length )
3678{
Ronald Cron215633c2021-03-16 17:15:37 +01003679 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3680 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003681
Gilles Peskineee652a32018-06-01 19:23:52 +02003682 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003683
Steven Cooremanea7ab132021-03-17 16:28:00 +01003684 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3685 return( PSA_ERROR_NOT_SUPPORTED );
3686
Ronald Cron9a986162021-03-26 12:40:07 +01003687 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003688 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003689 if( status != PSA_SUCCESS )
3690 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003691
Ronald Cron215633c2021-03-16 17:15:37 +01003692 psa_key_attributes_t attributes = {
3693 .core = slot->attr
3694 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003695
Ronald Cronde822812021-03-17 16:08:20 +01003696 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003697 &attributes, slot->key.data, slot->key.bytes,
3698 alg,
3699 nonce, nonce_length,
3700 additional_data, additional_data_length,
3701 ciphertext, ciphertext_length,
3702 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003703
Gilles Peskineedf9a652018-08-17 18:11:56 +02003704 if( status != PSA_SUCCESS && plaintext_size != 0 )
3705 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003706
Ronald Cron215633c2021-03-16 17:15:37 +01003707 psa_unlock_key_slot( slot );
3708
Gilles Peskineedf9a652018-08-17 18:11:56 +02003709 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003710}
3711
Gilles Peskinee59236f2018-01-27 23:32:46 +01003712/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003713/* Generators */
3714/****************************************************************/
3715
John Durkop07cc04a2020-11-16 22:08:34 -08003716#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3717 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3718 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3719#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003720#endif /* At least one builtin KDF */
3721
3722#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3723 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3724 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3725static psa_status_t psa_key_derivation_start_hmac(
3726 psa_mac_operation_t *operation,
3727 psa_algorithm_t hash_alg,
3728 const uint8_t *hmac_key,
3729 size_t hmac_key_length )
3730{
3731 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3732 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3733 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3734 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3735 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3736
Steven Cooreman72f736a2021-05-07 14:14:37 +02003737 operation->is_sign = 1;
3738 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3739
Steven Cooreman094a77e2021-05-06 17:58:36 +02003740 status = psa_driver_wrapper_mac_sign_setup( operation,
3741 &attributes,
3742 hmac_key, hmac_key_length,
3743 PSA_ALG_HMAC( hash_alg ) );
3744
3745 psa_reset_key_attributes( &attributes );
3746 return( status );
3747}
3748#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003749
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003750#define HKDF_STATE_INIT 0 /* no input yet */
3751#define HKDF_STATE_STARTED 1 /* got salt */
3752#define HKDF_STATE_KEYED 2 /* got key */
3753#define HKDF_STATE_OUTPUT 3 /* output started */
3754
Gilles Peskinecbe66502019-05-16 16:59:18 +02003755static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003756 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003757{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003758 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3759 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003760 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003761 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003762}
3763
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003764psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003765{
3766 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003767 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003768 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003769 {
3770 /* The object has (apparently) been initialized but it is not
3771 * in use. It's ok to call abort on such an object, and there's
3772 * nothing to do. */
3773 }
3774 else
John Durkopd0321952020-10-29 21:37:36 -07003775#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003776 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003777 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003778 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003779 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003780 }
John Durkop07cc04a2020-11-16 22:08:34 -08003781 else
3782#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3783#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3784 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3785 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003786 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003787 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003788 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003789 if( operation->ctx.tls12_prf.secret != NULL )
3790 {
3791 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3792 operation->ctx.tls12_prf.secret_length );
3793 mbedtls_free( operation->ctx.tls12_prf.secret );
3794 }
3795
Janos Follath6a1d2622019-06-11 10:37:28 +01003796 if( operation->ctx.tls12_prf.seed != NULL )
3797 {
3798 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3799 operation->ctx.tls12_prf.seed_length );
3800 mbedtls_free( operation->ctx.tls12_prf.seed );
3801 }
3802
3803 if( operation->ctx.tls12_prf.label != NULL )
3804 {
3805 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3806 operation->ctx.tls12_prf.label_length );
3807 mbedtls_free( operation->ctx.tls12_prf.label );
3808 }
3809
Steven Cooremana6df6042021-04-29 19:32:25 +02003810 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003811
3812 /* We leave the fields Ai and output_block to be erased safely by the
3813 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003814 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003815 else
John Durkop07cc04a2020-11-16 22:08:34 -08003816#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3817 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003818 {
3819 status = PSA_ERROR_BAD_STATE;
3820 }
Janos Follath083036a2019-06-11 10:22:26 +01003821 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003822 return( status );
3823}
3824
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003825psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003826 size_t *capacity)
3827{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003828 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003829 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003830 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003831 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003832 }
3833
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003834 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003835 return( PSA_SUCCESS );
3836}
3837
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003838psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003839 size_t capacity )
3840{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003841 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003842 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003843 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003844 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003845 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003846 return( PSA_SUCCESS );
3847}
3848
John Durkopd0321952020-10-29 21:37:36 -07003849#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003850/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003851 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003852static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003853 psa_algorithm_t hash_alg,
3854 uint8_t *output,
3855 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003856{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003857 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003858 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003859 psa_status_t status;
3860
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003861 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3862 return( PSA_ERROR_BAD_STATE );
3863 hkdf->state = HKDF_STATE_OUTPUT;
3864
Gilles Peskinebef7f142018-07-12 17:22:21 +02003865 while( output_length != 0 )
3866 {
3867 /* Copy what remains of the current block */
3868 uint8_t n = hash_length - hkdf->offset_in_block;
3869 if( n > output_length )
3870 n = (uint8_t) output_length;
3871 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3872 output += n;
3873 output_length -= n;
3874 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003875 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003876 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003877 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003878 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003879 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003880 * object was corrupted or if this function is called directly
3881 * inside the library. */
3882 if( hkdf->block_number == 0xff )
3883 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003884
3885 /* We need a new block */
3886 ++hkdf->block_number;
3887 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003888
Steven Cooreman094a77e2021-05-06 17:58:36 +02003889 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3890 hash_alg,
3891 hkdf->prk,
3892 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003893 if( status != PSA_SUCCESS )
3894 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003895
Gilles Peskinebef7f142018-07-12 17:22:21 +02003896 if( hkdf->block_number != 1 )
3897 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003898 status = psa_mac_update( &hkdf->hmac,
3899 hkdf->output_block,
3900 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003901 if( status != PSA_SUCCESS )
3902 return( status );
3903 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003904 status = psa_mac_update( &hkdf->hmac,
3905 hkdf->info,
3906 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003907 if( status != PSA_SUCCESS )
3908 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003909 status = psa_mac_update( &hkdf->hmac,
3910 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003911 if( status != PSA_SUCCESS )
3912 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003913 status = psa_mac_sign_finish( &hkdf->hmac,
3914 hkdf->output_block,
3915 sizeof( hkdf->output_block ),
3916 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003917 if( status != PSA_SUCCESS )
3918 return( status );
3919 }
3920
3921 return( PSA_SUCCESS );
3922}
John Durkop07cc04a2020-11-16 22:08:34 -08003923#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003924
John Durkop07cc04a2020-11-16 22:08:34 -08003925#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3926 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003927static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3928 psa_tls12_prf_key_derivation_t *tls12_prf,
3929 psa_algorithm_t alg )
3930{
3931 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003932 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003933 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3934 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003935 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003936
Janos Follath7742fee2019-06-17 12:58:10 +01003937 /* We can't be wanting more output after block 0xff, otherwise
3938 * the capacity check in psa_key_derivation_output_bytes() would have
3939 * prevented this call. It could happen only if the operation
3940 * object was corrupted or if this function is called directly
3941 * inside the library. */
3942 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003943 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003944
3945 /* We need a new block */
3946 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003947 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003948
3949 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3950 *
3951 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3952 *
3953 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3954 * HMAC_hash(secret, A(2) + seed) +
3955 * HMAC_hash(secret, A(3) + seed) + ...
3956 *
3957 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003958 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003959 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003960 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003961 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003962 * is currently extracted as `output_block` and where i is
3963 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003964 */
3965
Steven Cooreman094a77e2021-05-06 17:58:36 +02003966 status = psa_key_derivation_start_hmac( &hmac,
3967 hash_alg,
3968 tls12_prf->secret,
3969 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003970 if( status != PSA_SUCCESS )
3971 goto cleanup;
3972
3973 /* Calculate A(i) where i = tls12_prf->block_number. */
3974 if( tls12_prf->block_number == 1 )
3975 {
3976 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3977 * the variable seed and in this instance means it in the context of the
3978 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003979 status = psa_mac_update( &hmac,
3980 tls12_prf->label,
3981 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003982 if( status != PSA_SUCCESS )
3983 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003984 status = psa_mac_update( &hmac,
3985 tls12_prf->seed,
3986 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003987 if( status != PSA_SUCCESS )
3988 goto cleanup;
3989 }
3990 else
3991 {
3992 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003993 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003994 if( status != PSA_SUCCESS )
3995 goto cleanup;
3996 }
3997
Steven Cooremana6df6042021-04-29 19:32:25 +02003998 status = psa_mac_sign_finish( &hmac,
3999 tls12_prf->Ai, hash_length,
4000 &hmac_output_length );
4001 if( hmac_output_length != hash_length )
4002 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004003 if( status != PSA_SUCCESS )
4004 goto cleanup;
4005
4006 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004007 status = psa_key_derivation_start_hmac( &hmac,
4008 hash_alg,
4009 tls12_prf->secret,
4010 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004011 if( status != PSA_SUCCESS )
4012 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004013 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004014 if( status != PSA_SUCCESS )
4015 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004016 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004017 if( status != PSA_SUCCESS )
4018 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004019 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004020 if( status != PSA_SUCCESS )
4021 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004022 status = psa_mac_sign_finish( &hmac,
4023 tls12_prf->output_block, hash_length,
4024 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004025 if( status != PSA_SUCCESS )
4026 goto cleanup;
4027
Janos Follath7742fee2019-06-17 12:58:10 +01004028
4029cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004030 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004031 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4032 status = cleanup_status;
4033
4034 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004035}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004036
Janos Follath844eb0e2019-06-19 12:10:49 +01004037static psa_status_t psa_key_derivation_tls12_prf_read(
4038 psa_tls12_prf_key_derivation_t *tls12_prf,
4039 psa_algorithm_t alg,
4040 uint8_t *output,
4041 size_t output_length )
4042{
4043 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004044 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004045 psa_status_t status;
4046 uint8_t offset, length;
4047
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004048 switch( tls12_prf->state )
4049 {
4050 case PSA_TLS12_PRF_STATE_LABEL_SET:
4051 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4052 break;
4053 case PSA_TLS12_PRF_STATE_OUTPUT:
4054 break;
4055 default:
4056 return( PSA_ERROR_BAD_STATE );
4057 }
4058
Janos Follath844eb0e2019-06-19 12:10:49 +01004059 while( output_length != 0 )
4060 {
4061 /* Check if we have fully processed the current block. */
4062 if( tls12_prf->left_in_block == 0 )
4063 {
4064 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4065 alg );
4066 if( status != PSA_SUCCESS )
4067 return( status );
4068
4069 continue;
4070 }
4071
4072 if( tls12_prf->left_in_block > output_length )
4073 length = (uint8_t) output_length;
4074 else
4075 length = tls12_prf->left_in_block;
4076
4077 offset = hash_length - tls12_prf->left_in_block;
4078 memcpy( output, tls12_prf->output_block + offset, length );
4079 output += length;
4080 output_length -= length;
4081 tls12_prf->left_in_block -= length;
4082 }
4083
4084 return( PSA_SUCCESS );
4085}
John Durkop07cc04a2020-11-16 22:08:34 -08004086#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4087 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004088
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004089psa_status_t psa_key_derivation_output_bytes(
4090 psa_key_derivation_operation_t *operation,
4091 uint8_t *output,
4092 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004093{
4094 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004095 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004096
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004097 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004098 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004099 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004100 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004101 }
4102
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004103 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004104 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004105 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004106 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004107 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004108 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004109 goto exit;
4110 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004111 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004112 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004113 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004114 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004115 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4116 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004117 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004118 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004119 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004120 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004121 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004122
John Durkopd0321952020-10-29 21:37:36 -07004123#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004124 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004125 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004126 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004127 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004128 output, output_length );
4129 }
Janos Follathadbec812019-06-14 11:05:39 +01004130 else
John Durkop07cc04a2020-11-16 22:08:34 -08004131#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4132#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4133 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004134 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004135 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004136 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004137 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004138 kdf_alg, output,
4139 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004140 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004141 else
John Durkop07cc04a2020-11-16 22:08:34 -08004142#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4143 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004144 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004145 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004146 return( PSA_ERROR_BAD_STATE );
4147 }
4148
4149exit:
4150 if( status != PSA_SUCCESS )
4151 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004152 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004153 * This allows us to differentiate between exhausted operations and
4154 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4155 * operations. */
4156 psa_algorithm_t alg = operation->alg;
4157 psa_key_derivation_abort( operation );
4158 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004159 memset( output, '!', output_length );
4160 }
4161 return( status );
4162}
4163
David Brown7807bf72021-02-09 16:28:23 -07004164#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004165static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4166{
4167 if( data_size >= 8 )
4168 mbedtls_des_key_set_parity( data );
4169 if( data_size >= 16 )
4170 mbedtls_des_key_set_parity( data + 8 );
4171 if( data_size >= 24 )
4172 mbedtls_des_key_set_parity( data + 16 );
4173}
David Brown7807bf72021-02-09 16:28:23 -07004174#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004175
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004176static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004177 psa_key_slot_t *slot,
4178 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004179 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004180{
4181 uint8_t *data = NULL;
4182 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304183 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004184 psa_status_t status;
4185
Gilles Peskine8e338702019-07-30 20:06:31 +02004186 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004187 return( PSA_ERROR_INVALID_ARGUMENT );
4188 if( bits % 8 != 0 )
4189 return( PSA_ERROR_INVALID_ARGUMENT );
4190 data = mbedtls_calloc( 1, bytes );
4191 if( data == NULL )
4192 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4193
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004194 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004195 if( status != PSA_SUCCESS )
4196 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004197#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004198 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004199 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004200#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004201
Ronald Cronbf33c932020-11-28 18:06:53 +01004202 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004203 psa_key_attributes_t attributes = {
4204 .core = slot->attr
4205 };
4206
Archanad8a83dc2021-06-14 10:04:16 +05304207 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4208 {
Archana449608b2021-09-08 15:36:05 +05304209 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4210 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304211 if( status != PSA_SUCCESS )
4212 goto exit;
4213 }
4214 status = psa_allocate_buffer_to_slot( slot, storage_size );
4215 if( status != PSA_SUCCESS )
4216 goto exit;
4217
Ronald Cronbf33c932020-11-28 18:06:53 +01004218 status = psa_driver_wrapper_import_key( &attributes,
4219 data, bytes,
4220 slot->key.data,
4221 slot->key.bytes,
4222 &slot->key.bytes, &bits );
4223 if( bits != slot->attr.bits )
4224 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004225
4226exit:
4227 mbedtls_free( data );
4228 return( status );
4229}
4230
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004231psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004232 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004233 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004234{
4235 psa_status_t status;
4236 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004237 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004238
Ronald Cron81709fc2020-11-14 12:10:32 +01004239 *key = MBEDTLS_SVC_KEY_ID_INIT;
4240
Gilles Peskine0f84d622019-09-12 19:03:13 +02004241 /* Reject any attempt to create a zero-length key so that we don't
4242 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4243 if( psa_get_key_bits( attributes ) == 0 )
4244 return( PSA_ERROR_INVALID_ARGUMENT );
4245
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004246 if( ! operation->can_output_key )
4247 return( PSA_ERROR_NOT_PERMITTED );
4248
Ronald Cron81709fc2020-11-14 12:10:32 +01004249 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4250 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004251#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4252 if( driver != NULL )
4253 {
4254 /* Deriving a key in a secure element is not implemented yet. */
4255 status = PSA_ERROR_NOT_SUPPORTED;
4256 }
4257#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004258 if( status == PSA_SUCCESS )
4259 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004260 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004261 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004262 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004263 }
4264 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004265 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004266 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004267 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004268
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004269 return( status );
4270}
4271
Gilles Peskineeab56e42018-07-12 17:12:33 +02004272
4273
4274/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004275/* Key derivation */
4276/****************************************************************/
4277
Steven Cooreman932ffb72021-02-15 12:14:32 +01004278#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004279static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004280 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004281 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004282{
John Durkop07cc04a2020-11-16 22:08:34 -08004283 int is_kdf_alg_supported;
4284
Janos Follath5fe19732019-06-20 15:09:30 +01004285 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4286 * initialisers for this union leave some bytes unspecified.) */
4287 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4288
Gilles Peskine969c5d62019-01-16 15:53:06 +01004289 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004291 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4292 is_kdf_alg_supported = 1;
4293 else
4294#endif
4295#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4296 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4297 is_kdf_alg_supported = 1;
4298 else
4299#endif
4300#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4301 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4302 is_kdf_alg_supported = 1;
4303 else
4304#endif
4305 is_kdf_alg_supported = 0;
4306
4307 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004308 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004310 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004311 if( hash_size == 0 )
4312 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004313 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4314 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004315 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004316 {
4317 return( PSA_ERROR_NOT_SUPPORTED );
4318 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004319 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004320 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004321 }
John Durkop07cc04a2020-11-16 22:08:34 -08004322
4323 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004324}
John Durkop07cc04a2020-11-16 22:08:34 -08004325#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004326
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004327psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004328 psa_algorithm_t alg )
4329{
4330 psa_status_t status;
4331
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004332 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004333 return( PSA_ERROR_BAD_STATE );
4334
Gilles Peskine6843c292019-01-18 16:44:49 +01004335 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4336 return( PSA_ERROR_INVALID_ARGUMENT );
4337 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004338 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004339#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004340 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004341 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004342#else
4343 return( PSA_ERROR_NOT_SUPPORTED );
4344#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004345 }
4346 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4347 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004348#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004349 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004350#else
4351 return( PSA_ERROR_NOT_SUPPORTED );
4352#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004353 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004354 else
4355 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004356
4357 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004358 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004359 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004360}
4361
John Durkopd0321952020-10-29 21:37:36 -07004362#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004363static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004364 psa_algorithm_t hash_alg,
4365 psa_key_derivation_step_t step,
4366 const uint8_t *data,
4367 size_t data_length )
4368{
4369 psa_status_t status;
4370 switch( step )
4371 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004372 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004373 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004374 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004375 else
4376 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004377 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4378 hash_alg,
4379 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004380 if( status != PSA_SUCCESS )
4381 return( status );
4382 hkdf->state = HKDF_STATE_STARTED;
4383 return( PSA_SUCCESS );
4384 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004385 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004386 /* If no salt was provided, use an empty salt. */
4387 if( hkdf->state == HKDF_STATE_INIT )
4388 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004389 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4390 hash_alg,
4391 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004392 if( status != PSA_SUCCESS )
4393 return( status );
4394 hkdf->state = HKDF_STATE_STARTED;
4395 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004396 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004397 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004398 status = psa_mac_update( &hkdf->hmac,
4399 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004400 if( status != PSA_SUCCESS )
4401 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004402 status = psa_mac_sign_finish( &hkdf->hmac,
4403 hkdf->prk,
4404 sizeof( hkdf->prk ),
4405 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004406 if( status != PSA_SUCCESS )
4407 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004408 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004409 hkdf->block_number = 0;
4410 hkdf->state = HKDF_STATE_KEYED;
4411 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004412 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004413 if( hkdf->state == HKDF_STATE_OUTPUT )
4414 return( PSA_ERROR_BAD_STATE );
4415 if( hkdf->info_set )
4416 return( PSA_ERROR_BAD_STATE );
4417 hkdf->info_length = data_length;
4418 if( data_length != 0 )
4419 {
4420 hkdf->info = mbedtls_calloc( 1, data_length );
4421 if( hkdf->info == NULL )
4422 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4423 memcpy( hkdf->info, data, data_length );
4424 }
4425 hkdf->info_set = 1;
4426 return( PSA_SUCCESS );
4427 default:
4428 return( PSA_ERROR_INVALID_ARGUMENT );
4429 }
4430}
John Durkop07cc04a2020-11-16 22:08:34 -08004431#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004432
John Durkop07cc04a2020-11-16 22:08:34 -08004433#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4434 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004435static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4436 const uint8_t *data,
4437 size_t data_length )
4438{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004439 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004440 return( PSA_ERROR_BAD_STATE );
4441
Janos Follathd6dce9f2019-07-04 09:11:38 +01004442 if( data_length != 0 )
4443 {
4444 prf->seed = mbedtls_calloc( 1, data_length );
4445 if( prf->seed == NULL )
4446 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004447
Janos Follathd6dce9f2019-07-04 09:11:38 +01004448 memcpy( prf->seed, data, data_length );
4449 prf->seed_length = data_length;
4450 }
Janos Follathf08e2652019-06-13 09:05:41 +01004451
Gilles Peskine43f958b2020-12-13 14:55:14 +01004452 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004453
4454 return( PSA_SUCCESS );
4455}
4456
Janos Follath81550542019-06-13 14:26:34 +01004457static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004458 const uint8_t *data,
4459 size_t data_length )
4460{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004461 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004462 return( PSA_ERROR_BAD_STATE );
4463
Steven Cooremana6df6042021-04-29 19:32:25 +02004464 if( data_length != 0 )
4465 {
4466 prf->secret = mbedtls_calloc( 1, data_length );
4467 if( prf->secret == NULL )
4468 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4469
4470 memcpy( prf->secret, data, data_length );
4471 prf->secret_length = data_length;
4472 }
Janos Follath81550542019-06-13 14:26:34 +01004473
Gilles Peskine43f958b2020-12-13 14:55:14 +01004474 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004475
4476 return( PSA_SUCCESS );
4477}
4478
Janos Follath63028dd2019-06-13 09:15:47 +01004479static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4480 const uint8_t *data,
4481 size_t data_length )
4482{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004483 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004484 return( PSA_ERROR_BAD_STATE );
4485
Janos Follathd6dce9f2019-07-04 09:11:38 +01004486 if( data_length != 0 )
4487 {
4488 prf->label = mbedtls_calloc( 1, data_length );
4489 if( prf->label == NULL )
4490 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004491
Janos Follathd6dce9f2019-07-04 09:11:38 +01004492 memcpy( prf->label, data, data_length );
4493 prf->label_length = data_length;
4494 }
Janos Follath63028dd2019-06-13 09:15:47 +01004495
Gilles Peskine43f958b2020-12-13 14:55:14 +01004496 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004497
4498 return( PSA_SUCCESS );
4499}
4500
Janos Follathb03233e2019-06-11 15:30:30 +01004501static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004502 psa_key_derivation_step_t step,
4503 const uint8_t *data,
4504 size_t data_length )
4505{
Janos Follathb03233e2019-06-11 15:30:30 +01004506 switch( step )
4507 {
Janos Follathf08e2652019-06-13 09:05:41 +01004508 case PSA_KEY_DERIVATION_INPUT_SEED:
4509 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004510 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004511 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004512 case PSA_KEY_DERIVATION_INPUT_LABEL:
4513 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004514 default:
4515 return( PSA_ERROR_INVALID_ARGUMENT );
4516 }
4517}
John Durkop07cc04a2020-11-16 22:08:34 -08004518#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4519 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4520
4521#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4522static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4523 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004524 const uint8_t *data,
4525 size_t data_length )
4526{
4527 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004528 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004529 uint8_t *cur = pms;
4530
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004531 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004532 return( PSA_ERROR_INVALID_ARGUMENT );
4533
4534 /* Quoting RFC 4279, Section 2:
4535 *
4536 * The premaster secret is formed as follows: if the PSK is N octets
4537 * long, concatenate a uint16 with the value N, N zero octets, a second
4538 * uint16 with the value N, and the PSK itself.
4539 */
4540
Joe Subbiani5ecac212021-06-24 13:00:03 +01004541 *cur++ = MBEDTLS_BYTE_1( data_length );
4542 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004543 memset( cur, 0, data_length );
4544 cur += data_length;
4545 *cur++ = pms[0];
4546 *cur++ = pms[1];
4547 memcpy( cur, data, data_length );
4548 cur += data_length;
4549
Steven Cooremana6df6042021-04-29 19:32:25 +02004550 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004551
4552 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4553 return( status );
4554}
Janos Follath6660f0e2019-06-17 08:44:03 +01004555
4556static psa_status_t psa_tls12_prf_psk_to_ms_input(
4557 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004558 psa_key_derivation_step_t step,
4559 const uint8_t *data,
4560 size_t data_length )
4561{
4562 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004563 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004564 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004565 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004566 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004567
Steven Cooremana6df6042021-04-29 19:32:25 +02004568 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004569}
John Durkop07cc04a2020-11-16 22:08:34 -08004570#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004571
Gilles Peskineb8965192019-09-24 16:21:10 +02004572/** Check whether the given key type is acceptable for the given
4573 * input step of a key derivation.
4574 *
4575 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4576 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4577 * Both secret and non-secret inputs can alternatively have the type
4578 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4579 * that the input was passed as a buffer rather than via a key object.
4580 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004581static int psa_key_derivation_check_input_type(
4582 psa_key_derivation_step_t step,
4583 psa_key_type_t key_type )
4584{
4585 switch( step )
4586 {
4587 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004588 if( key_type == PSA_KEY_TYPE_DERIVE )
4589 return( PSA_SUCCESS );
4590 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004591 return( PSA_SUCCESS );
4592 break;
4593 case PSA_KEY_DERIVATION_INPUT_LABEL:
4594 case PSA_KEY_DERIVATION_INPUT_SALT:
4595 case PSA_KEY_DERIVATION_INPUT_INFO:
4596 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004597 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4598 return( PSA_SUCCESS );
4599 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004600 return( PSA_SUCCESS );
4601 break;
4602 }
4603 return( PSA_ERROR_INVALID_ARGUMENT );
4604}
4605
Janos Follathb80a94e2019-06-12 15:54:46 +01004606static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004607 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004608 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004609 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004610 const uint8_t *data,
4611 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004612{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004613 psa_status_t status;
4614 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4615
4616 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004617 if( status != PSA_SUCCESS )
4618 goto exit;
4619
John Durkopd0321952020-10-29 21:37:36 -07004620#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004621 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004622 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004623 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004624 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004625 step, data, data_length );
4626 }
John Durkop07cc04a2020-11-16 22:08:34 -08004627 else
4628#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4629#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4630 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004631 {
Janos Follathb03233e2019-06-11 15:30:30 +01004632 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004633 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004634 }
John Durkop07cc04a2020-11-16 22:08:34 -08004635 else
4636#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4637#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4638 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004639 {
4640 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004641 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004642 }
4643 else
John Durkop07cc04a2020-11-16 22:08:34 -08004644#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004647 (void) data;
4648 (void) data_length;
4649 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004650 return( PSA_ERROR_BAD_STATE );
4651 }
4652
Gilles Peskine224b0d62019-09-23 18:13:17 +02004653exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004654 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004655 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004656 return( status );
4657}
4658
Janos Follath51f4a0f2019-06-14 11:35:55 +01004659psa_status_t psa_key_derivation_input_bytes(
4660 psa_key_derivation_operation_t *operation,
4661 psa_key_derivation_step_t step,
4662 const uint8_t *data,
4663 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004664{
Gilles Peskineb8965192019-09-24 16:21:10 +02004665 return( psa_key_derivation_input_internal( operation, step,
4666 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004667 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004668}
4669
Janos Follath51f4a0f2019-06-14 11:35:55 +01004670psa_status_t psa_key_derivation_input_key(
4671 psa_key_derivation_operation_t *operation,
4672 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004673 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004674{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004676 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004677 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004678
Ronald Cron5c522922020-11-14 16:35:34 +01004679 status = psa_get_and_lock_transparent_key_slot_with_policy(
4680 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004681 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004682 {
4683 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004684 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004685 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004686
4687 /* Passing a key object as a SECRET input unlocks the permission
4688 * to output to a key object. */
4689 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4690 operation->can_output_key = 1;
4691
Ronald Cronf95a2b12020-10-22 15:24:49 +02004692 status = psa_key_derivation_input_internal( operation,
4693 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004694 slot->key.data,
4695 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004696
Ronald Cron5c522922020-11-14 16:35:34 +01004697 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004698
Ronald Cron5c522922020-11-14 16:35:34 +01004699 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004700}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004701
4702
4703
4704/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004705/* Key agreement */
4706/****************************************************************/
4707
John Durkop6ba40d12020-11-10 08:50:04 -08004708#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004709static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4710 size_t peer_key_length,
4711 const mbedtls_ecp_keypair *our_key,
4712 uint8_t *shared_secret,
4713 size_t shared_secret_size,
4714 size_t *shared_secret_length )
4715{
Steven Cooremand4867872020-08-05 16:31:39 +02004716 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004717 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004718 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004719 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004720 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004721 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004722
Ronald Cron90857082020-11-25 14:58:33 +01004723 status = mbedtls_psa_ecp_load_representation(
4724 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004725 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004726 peer_key,
4727 peer_key_length,
4728 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004729 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004730 goto exit;
4731
Jaeden Amero97271b32019-01-10 19:38:51 +00004732 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004733 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004734 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004735 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004736 status = mbedtls_to_psa_error(
4737 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4738 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004739 goto exit;
4740
Jaeden Amero97271b32019-01-10 19:38:51 +00004741 status = mbedtls_to_psa_error(
4742 mbedtls_ecdh_calc_secret( &ecdh,
4743 shared_secret_length,
4744 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004745 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004746 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004747 if( status != PSA_SUCCESS )
4748 goto exit;
4749 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4750 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004751
4752exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004753 if( status != PSA_SUCCESS )
4754 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004755 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004756 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004757 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004758
Jaeden Amero97271b32019-01-10 19:38:51 +00004759 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004760}
John Durkop6ba40d12020-11-10 08:50:04 -08004761#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004762
Gilles Peskine01d718c2018-09-18 12:01:02 +02004763#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4764
Gilles Peskine0216fe12019-04-11 21:23:21 +02004765static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4766 psa_key_slot_t *private_key,
4767 const uint8_t *peer_key,
4768 size_t peer_key_length,
4769 uint8_t *shared_secret,
4770 size_t shared_secret_size,
4771 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004772{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004773 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004774 {
John Durkop6ba40d12020-11-10 08:50:04 -08004775#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004776 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004777 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004778 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004779 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004780 psa_status_t status = mbedtls_psa_ecp_load_representation(
4781 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004782 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004783 private_key->key.data,
4784 private_key->key.bytes,
4785 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004786 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004787 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004788 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004789 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004790 shared_secret, shared_secret_size,
4791 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004792 mbedtls_ecp_keypair_free( ecp );
4793 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004794 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004795#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004796 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004797 (void) private_key;
4798 (void) peer_key;
4799 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004800 (void) shared_secret;
4801 (void) shared_secret_size;
4802 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004803 return( PSA_ERROR_NOT_SUPPORTED );
4804 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004805}
4806
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004807/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004808 * to potentially free embedded data structures and wipe confidential data.
4809 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004810static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004811 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004812 psa_key_slot_t *private_key,
4813 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004814 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004815{
4816 psa_status_t status;
4817 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4818 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004819 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004820
4821 /* Step 1: run the secret agreement algorithm to generate the shared
4822 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004823 status = psa_key_agreement_raw_internal( ka_alg,
4824 private_key,
4825 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004826 shared_secret,
4827 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004828 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004829 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004830 goto exit;
4831
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004832 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004833 * the shared secret. A shared secret is permitted wherever a key
4834 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004835 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004836 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004837 shared_secret,
4838 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004839exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004840 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004841 return( status );
4842}
4843
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004844psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004845 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004846 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004847 const uint8_t *peer_key,
4848 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004849{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004851 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004852 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004853
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004854 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004855 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004856 status = psa_get_and_lock_transparent_key_slot_with_policy(
4857 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004858 if( status != PSA_SUCCESS )
4859 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004860 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004861 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004862 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004863 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004864 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004865 else
4866 {
4867 /* If a private key has been added as SECRET, we allow the derived
4868 * key material to be used as a key in PSA Crypto. */
4869 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4870 operation->can_output_key = 1;
4871 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004872
Ronald Cron5c522922020-11-14 16:35:34 +01004873 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004874
Ronald Cron5c522922020-11-14 16:35:34 +01004875 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004876}
4877
Gilles Peskinebe697d82019-05-16 18:00:41 +02004878psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004879 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004880 const uint8_t *peer_key,
4881 size_t peer_key_length,
4882 uint8_t *output,
4883 size_t output_size,
4884 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004885{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004886 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004887 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004888 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004889
4890 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4891 {
4892 status = PSA_ERROR_INVALID_ARGUMENT;
4893 goto exit;
4894 }
Ronald Cron5c522922020-11-14 16:35:34 +01004895 status = psa_get_and_lock_transparent_key_slot_with_policy(
4896 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004897 if( status != PSA_SUCCESS )
4898 goto exit;
4899
4900 status = psa_key_agreement_raw_internal( alg, slot,
4901 peer_key, peer_key_length,
4902 output, output_size,
4903 output_length );
4904
4905exit:
4906 if( status != PSA_SUCCESS )
4907 {
4908 /* If an error happens and is not handled properly, the output
4909 * may be used as a key to protect sensitive data. Arrange for such
4910 * a key to be random, which is likely to result in decryption or
4911 * verification errors. This is better than filling the buffer with
4912 * some constant data such as zeros, which would result in the data
4913 * being protected with a reproducible, easily knowable key.
4914 */
4915 psa_generate_random( output, output_size );
4916 *output_length = output_size;
4917 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004918
Ronald Cron5c522922020-11-14 16:35:34 +01004919 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004920
Ronald Cron5c522922020-11-14 16:35:34 +01004921 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004922}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004923
4924
Gilles Peskine30524eb2020-11-13 17:02:26 +01004925
Gilles Peskine86a440b2018-11-12 18:39:40 +01004926/****************************************************************/
4927/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004928/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004929
Gilles Peskine30524eb2020-11-13 17:02:26 +01004930/** Initialize the PSA random generator.
4931 */
4932static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4933{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004934#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4935 memset( rng, 0, sizeof( *rng ) );
4936#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4937
Gilles Peskine30524eb2020-11-13 17:02:26 +01004938 /* Set default configuration if
4939 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4940 if( rng->entropy_init == NULL )
4941 rng->entropy_init = mbedtls_entropy_init;
4942 if( rng->entropy_free == NULL )
4943 rng->entropy_free = mbedtls_entropy_free;
4944
4945 rng->entropy_init( &rng->entropy );
4946#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4947 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4948 /* The PSA entropy injection feature depends on using NV seed as an entropy
4949 * source. Add NV seed as an entropy source for PSA entropy injection. */
4950 mbedtls_entropy_add_source( &rng->entropy,
4951 mbedtls_nv_seed_poll, NULL,
4952 MBEDTLS_ENTROPY_BLOCK_SIZE,
4953 MBEDTLS_ENTROPY_SOURCE_STRONG );
4954#endif
4955
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004956 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004957#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004958}
4959
4960/** Deinitialize the PSA random generator.
4961 */
4962static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4963{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004964#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4965 memset( rng, 0, sizeof( *rng ) );
4966#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004967 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004968 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004969#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004970}
4971
4972/** Seed the PSA random generator.
4973 */
4974static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4975{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004976#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4977 /* Do nothing: the external RNG seeds itself. */
4978 (void) rng;
4979 return( PSA_SUCCESS );
4980#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004981 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004982 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4983 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004984 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004985#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004986}
4987
Gilles Peskinee59236f2018-01-27 23:32:46 +01004988psa_status_t psa_generate_random( uint8_t *output,
4989 size_t output_size )
4990{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004991 GUARD_MODULE_INITIALIZED;
4992
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004993#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4994
4995 size_t output_length = 0;
4996 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4997 output, output_size,
4998 &output_length );
4999 if( status != PSA_SUCCESS )
5000 return( status );
5001 /* Breaking up a request into smaller chunks is currently not supported
5002 * for the extrernal RNG interface. */
5003 if( output_length != output_size )
5004 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5005 return( PSA_SUCCESS );
5006
5007#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5008
Gilles Peskine71ddab92021-01-04 21:01:07 +01005009 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005010 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005011 size_t request_size =
5012 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5013 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5014 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005015 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5016 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005017 if( ret != 0 )
5018 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005019 output_size -= request_size;
5020 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005021 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005022 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005023#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005024}
5025
Gilles Peskine8814fc42020-12-14 15:33:44 +01005026/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005027 *
5028 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5029 * `psa_generate_random(...)`. The state parameter is ignored since the
5030 * PSA API doesn't support passing an explicit state.
5031 *
5032 * In the non-external case, psa_generate_random() calls an
5033 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5034 * and semantics as mbedtls_psa_get_random(). As an optimization,
5035 * instead of doing this back-and-forth between the PSA API and the
5036 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5037 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005038 */
5039#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5040int mbedtls_psa_get_random( void *p_rng,
5041 unsigned char *output,
5042 size_t output_size )
5043{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005044 /* This function takes a pointer to the RNG state because that's what
5045 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5046 * its own state internally and doesn't let the caller access that state.
5047 * So we just ignore the state parameter, and in practice we'll pass
5048 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005049 (void) p_rng;
5050 psa_status_t status = psa_generate_random( output, output_size );
5051 if( status == PSA_SUCCESS )
5052 return( 0 );
5053 else
5054 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5055}
5056#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5057
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005058#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005059#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005060
Gilles Peskine7228da22019-07-15 11:06:15 +02005061psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005062 size_t seed_size )
5063{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005064 if( global_data.initialized )
5065 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005066
5067 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5068 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5069 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5070 return( PSA_ERROR_INVALID_ARGUMENT );
5071
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005072 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005073}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005074#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005075
Ronald Cron3772afe2021-02-08 16:10:05 +01005076/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005077 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005078 * \param type The key type
5079 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005080 *
5081 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005082 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005083 * \retval #PSA_ERROR_INVALID_ARGUMENT
5084 * The size in bits of the key is not valid.
5085 * \retval #PSA_ERROR_NOT_SUPPORTED
5086 * The type and/or the size in bits of the key or the combination of
5087 * the two is not supported.
5088 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005089static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5090 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005091{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005092 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005093
Gilles Peskinee59236f2018-01-27 23:32:46 +01005094 if( key_type_is_raw_bytes( type ) )
5095 {
Archana4d7ae1d2021-07-07 02:50:22 +05305096 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005097 if( status != PSA_SUCCESS )
5098 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005099 }
5100 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005101#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005102 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5103 {
5104 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5105 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005106
Ronald Cron01b2aba2020-10-05 09:42:02 +02005107 /* Accept only byte-aligned keys, for the same reasons as
5108 * in psa_import_rsa_key(). */
5109 if( bits % 8 != 0 )
5110 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005111 }
5112 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005113#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005114
Ronald Cron5c4d3862020-12-07 11:07:24 +01005115#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005116 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5117 {
Ronald Crond81ab562021-02-16 09:01:16 +01005118 /* To avoid empty block, return successfully here. */
5119 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005120 }
5121 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005122#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005123 {
5124 return( PSA_ERROR_NOT_SUPPORTED );
5125 }
5126
5127 return( PSA_SUCCESS );
5128}
5129
Ronald Cron55ed0592020-10-05 10:30:40 +02005130psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005131 const psa_key_attributes_t *attributes,
5132 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005133{
5134 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005135 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005136
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005137 if( ( attributes->domain_parameters == NULL ) &&
5138 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005139 return( PSA_ERROR_INVALID_ARGUMENT );
5140
Ronald Cron01b2aba2020-10-05 09:42:02 +02005141 if( key_type_is_raw_bytes( type ) )
5142 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005143 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005144 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005145 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005146
David Brown12ca5032021-02-11 11:02:00 -07005147#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005148 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005149 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005150#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005151 }
5152 else
5153
Jaeden Amero424fa932021-05-14 08:34:32 +01005154#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5155 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005156 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005157 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005158 return( mbedtls_psa_rsa_generate_key( attributes,
5159 key_buffer,
5160 key_buffer_size,
5161 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005162 }
5163 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005164#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5165 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005166
John Durkop9814fa22020-11-04 12:28:15 -08005167#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005168 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005169 {
Ronald Cron7023db52020-11-20 18:17:42 +01005170 return( mbedtls_psa_ecp_generate_key( attributes,
5171 key_buffer,
5172 key_buffer_size,
5173 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005174 }
5175 else
John Durkop9814fa22020-11-04 12:28:15 -08005176#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005177 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005178 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005179 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005180 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005181
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005182 return( PSA_SUCCESS );
5183}
Darryl Green0c6575a2018-11-07 16:05:30 +00005184
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005185psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005186 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005187{
5188 psa_status_t status;
5189 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005190 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005191 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005192
Ronald Cron81709fc2020-11-14 12:10:32 +01005193 *key = MBEDTLS_SVC_KEY_ID_INIT;
5194
Gilles Peskine0f84d622019-09-12 19:03:13 +02005195 /* Reject any attempt to create a zero-length key so that we don't
5196 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5197 if( psa_get_key_bits( attributes ) == 0 )
5198 return( PSA_ERROR_INVALID_ARGUMENT );
5199
Ronald Cron81709fc2020-11-14 12:10:32 +01005200 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5201 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005202 if( status != PSA_SUCCESS )
5203 goto exit;
5204
Ronald Cron977c2472020-10-13 08:32:21 +02005205 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305206 * storage ( thus not in the case of generating a key in a secure element
5207 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5208 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005209 if( slot->key.data == NULL )
5210 {
5211 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5212 PSA_KEY_LOCATION_LOCAL_STORAGE )
5213 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005214 status = psa_validate_key_type_and_size_for_key_generation(
5215 attributes->core.type, attributes->core.bits );
5216 if( status != PSA_SUCCESS )
5217 goto exit;
5218
5219 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5220 attributes->core.type,
5221 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005222 }
5223 else
5224 {
5225 status = psa_driver_wrapper_get_key_buffer_size(
5226 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005227 if( status != PSA_SUCCESS )
5228 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005229 }
Ronald Cron977c2472020-10-13 08:32:21 +02005230
5231 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5232 if( status != PSA_SUCCESS )
5233 goto exit;
5234 }
5235
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005236 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005237 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005238
Ronald Cron2b56bc82020-10-05 10:02:26 +02005239 if( status != PSA_SUCCESS )
5240 psa_remove_key_data_from_memory( slot );
5241
Gilles Peskine11792082019-08-06 18:36:36 +02005242exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005243 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005244 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005245 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005246 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005247
Darryl Green0c6575a2018-11-07 16:05:30 +00005248 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005249}
5250
Gilles Peskinee59236f2018-01-27 23:32:46 +01005251/****************************************************************/
5252/* Module setup */
5253/****************************************************************/
5254
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005255#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005256psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5257 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5258 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5259{
5260 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5261 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005262 global_data.rng.entropy_init = entropy_init;
5263 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005264 return( PSA_SUCCESS );
5265}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005266#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005267
Gilles Peskinee59236f2018-01-27 23:32:46 +01005268void mbedtls_psa_crypto_free( void )
5269{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005270 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005271 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5272 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005273 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005274 }
5275 /* Wipe all remaining data, including configuration.
5276 * In particular, this sets all state indicator to the value
5277 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005278 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005279#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005280 /* Unregister all secure element drivers, so that we restart from
5281 * a pristine state. */
5282 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005283#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005284}
5285
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005286#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5287/** Recover a transaction that was interrupted by a power failure.
5288 *
5289 * This function is called during initialization, before psa_crypto_init()
5290 * returns. If this function returns a failure status, the initialization
5291 * fails.
5292 */
5293static psa_status_t psa_crypto_recover_transaction(
5294 const psa_crypto_transaction_t *transaction )
5295{
5296 switch( transaction->unknown.type )
5297 {
5298 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5299 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005300 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005301 * is implemented.
5302 * https://github.com/ARMmbed/mbed-crypto/issues/218
5303 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005304 default:
5305 /* We found an unsupported transaction in the storage.
5306 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005307 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005308 }
5309}
5310#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5311
Gilles Peskinee59236f2018-01-27 23:32:46 +01005312psa_status_t psa_crypto_init( void )
5313{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005314 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005315
Gilles Peskinec6b69072018-11-20 21:42:52 +01005316 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005317 if( global_data.initialized != 0 )
5318 return( PSA_SUCCESS );
5319
Gilles Peskine30524eb2020-11-13 17:02:26 +01005320 /* Initialize and seed the random generator. */
5321 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005322 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005323 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005324 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005325 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005326 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005327
Gilles Peskine66fb1262018-12-10 16:29:04 +01005328 status = psa_initialize_key_slots( );
5329 if( status != PSA_SUCCESS )
5330 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005331
Gilles Peskined9348f22019-10-01 15:22:29 +02005332#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5333 status = psa_init_all_se_drivers( );
5334 if( status != PSA_SUCCESS )
5335 goto exit;
5336#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5337
Gilles Peskine4b734222019-07-24 15:56:31 +02005338#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005339 status = psa_crypto_load_transaction( );
5340 if( status == PSA_SUCCESS )
5341 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005342 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5343 if( status != PSA_SUCCESS )
5344 goto exit;
5345 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005346 }
5347 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5348 {
5349 /* There's no transaction to complete. It's all good. */
5350 status = PSA_SUCCESS;
5351 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005352#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005353
Gilles Peskinec6b69072018-11-20 21:42:52 +01005354 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005355 global_data.initialized = 1;
5356
5357exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005358 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005359 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005360 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005361}
5362
5363#endif /* MBEDTLS_PSA_CRYPTO_C */