blob: 8312c075004fa1809bb485756c1a450fbf03dfbc [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200205 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218#endif
219
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
223 return( PSA_ERROR_INVALID_ARGUMENT );
224 case MBEDTLS_ERR_MD_ALLOC_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_MEMORY );
226 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
227 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100228
Gilles Peskinef76aa772018-10-29 19:24:33 +0100229 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
231 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
236 return( PSA_ERROR_BUFFER_TOO_SMALL );
237 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
238 return( PSA_ERROR_INVALID_ARGUMENT );
239 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
245
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100246 case MBEDTLS_ERR_PK_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
249 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100253 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
254 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
257 return( PSA_ERROR_NOT_SUPPORTED );
258 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
259 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
260 return( PSA_ERROR_NOT_PERMITTED );
261 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_INVALID_ALG:
264 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
265 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
268 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200269 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
270 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100271
Gilles Peskineff2d2002019-05-06 15:26:23 +0200272 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
275 return( PSA_ERROR_NOT_SUPPORTED );
276
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_RSA_INVALID_PADDING:
280 return( PSA_ERROR_INVALID_PADDING );
281 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
286 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200287 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
289 return( PSA_ERROR_INVALID_SIGNATURE );
290 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100293 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200294
itayzafrir5c753392018-05-08 11:18:38 +0300295 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300297 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
299 return( PSA_ERROR_BUFFER_TOO_SMALL );
300 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
303 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
304 return( PSA_ERROR_INVALID_SIGNATURE );
305 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309
Janos Follatha13b9052019-11-22 12:48:59 +0000310 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
311 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300312
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 default:
David Saadab4ecc272019-02-14 13:48:10 +0200314 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 }
316}
317
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200319
320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321/****************************************************************/
322/* Key management */
323/****************************************************************/
324
Gilles Peskine73167e12019-07-12 23:44:37 +0200325#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
326static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
327{
Gilles Peskine8e338702019-07-30 20:06:31 +0200328 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200329}
330#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
331
John Durkop07cc04a2020-11-16 22:08:34 -0800332/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
333 * current test driver in key_management.c is using this function
334 * when accelerators are used for ECC key pair and public key.
335 * Once that dependency is resolved these guards can be removed.
336 */
John Durkop9814fa22020-11-04 12:28:15 -0800337#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800338 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
339 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
340 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100341mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100342 size_t bits,
343 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200344{
345 switch( curve )
346 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100347 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100351 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100352 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100353#endif
354#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100356 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100357#endif
358#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100359 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100360 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100361#endif
362#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100363 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100364 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100365#endif
366#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100367 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100368 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 case 528:
370 if( bits_is_sloppy )
371 return( MBEDTLS_ECP_DP_SECP521R1 );
372 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 }
375 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100376
Paul Elliott8ff510a2020-06-02 17:19:28 +0100377 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100381 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100382 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100383#endif
384#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100385 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100386 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100387#endif
388#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 }
393 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100394
Paul Elliott8ff510a2020-06-02 17:19:28 +0100395 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100397 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100400 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100401 case 256:
402 if( bits_is_sloppy )
403 return( MBEDTLS_ECP_DP_CURVE25519 );
404 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100405#endif
406#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 }
411 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100412
Paul Elliott8ff510a2020-06-02 17:19:28 +0100413 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100418 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100419#endif
420#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100421 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100422 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100423#endif
424#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100427#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 }
429 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200430 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100432 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200434}
John Durkop9814fa22020-11-04 12:28:15 -0800435#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800436 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
437 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
438 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200439
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200440static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
441 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200442{
443 /* Check that the bit size is acceptable for the key type */
444 switch( type )
445 {
446 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200447 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 case PSA_KEY_TYPE_DERIVE:
449 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100450#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200451 case PSA_KEY_TYPE_AES:
452 if( bits != 128 && bits != 192 && bits != 256 )
453 return( PSA_ERROR_INVALID_ARGUMENT );
454 break;
455#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100456#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200457 case PSA_KEY_TYPE_CAMELLIA:
458 if( bits != 128 && bits != 192 && bits != 256 )
459 return( PSA_ERROR_INVALID_ARGUMENT );
460 break;
461#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100462#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200463 case PSA_KEY_TYPE_DES:
464 if( bits != 64 && bits != 128 && bits != 192 )
465 return( PSA_ERROR_INVALID_ARGUMENT );
466 break;
467#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100468#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200469 case PSA_KEY_TYPE_CHACHA20:
470 if( bits != 256 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
472 break;
473#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200474 default:
475 return( PSA_ERROR_NOT_SUPPORTED );
476 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200477 if( bits % 8 != 0 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480 return( PSA_SUCCESS );
481}
482
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100483/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
Steven Cooremancd640932021-03-08 12:00:27 +0100485 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
486 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100487 *
488 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 * \param[in] key_type The key type of the key to be used with the
490 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100491 *
492 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100493 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100494 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100495 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100496 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100497MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100498 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500{
Steven Cooremancd640932021-03-08 12:00:27 +0100501 if( PSA_ALG_IS_HMAC( algorithm ) )
502 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100503 if( key_type == PSA_KEY_TYPE_HMAC )
504 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506
507 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100508 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100509 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
510 * key. */
511 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
512 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
513 {
514 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
515 * the block length (larger than 1) for block ciphers. */
516 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
517 return( PSA_SUCCESS );
518 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100519 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100520
521 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100522}
523
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200524psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
525 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200526{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529
Ronald Cronea0f8a62020-11-25 17:52:23 +0100530 slot->key.data = mbedtls_calloc( 1, buffer_length );
531 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200532 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200533
Ronald Cronea0f8a62020-11-25 17:52:23 +0100534 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200535 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200536}
537
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200538psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
539 const uint8_t* data,
540 size_t data_length )
541{
542 psa_status_t status = psa_allocate_buffer_to_slot( slot,
543 data_length );
544 if( status != PSA_SUCCESS )
545 return( status );
546
Ronald Cronea0f8a62020-11-25 17:52:23 +0100547 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200548 return( PSA_SUCCESS );
549}
550
Ronald Crona0fe59f2020-11-29 11:14:53 +0100551psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100552 const psa_key_attributes_t *attributes,
553 const uint8_t *data, size_t data_length,
554 uint8_t *key_buffer, size_t key_buffer_size,
555 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100556{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
558 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100559
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560 /* zero-length keys are never supported. */
561 if( data_length == 0 )
562 return( PSA_ERROR_NOT_SUPPORTED );
563
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100565 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100566 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200567
Steven Cooreman75b74362020-07-28 14:30:13 +0200568 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
569 if( data_length > SIZE_MAX / 8 )
570 return( PSA_ERROR_NOT_SUPPORTED );
571
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200572 /* Enforce a size limit, and in particular ensure that the bit
573 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100574 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200575 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100577 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200578 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200579 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Ronald Crondd04d422020-11-28 15:14:42 +0100581 /* Copy the key material. */
582 memcpy( key_buffer, data, data_length );
583 *key_buffer_length = data_length;
584 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200585
Steven Cooreman40120f62020-10-29 11:42:22 +0100586 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100587 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100588 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200589 {
John Durkop9814fa22020-11-04 12:28:15 -0800590#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
591 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100592 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200593 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100594 return( mbedtls_psa_ecp_import_key( attributes,
595 data, data_length,
596 key_buffer, key_buffer_size,
597 key_buffer_length,
598 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100599 }
John Durkop9814fa22020-11-04 12:28:15 -0800600#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
601 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700602#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
603 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100604 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200605 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100606 return( mbedtls_psa_rsa_import_key( attributes,
607 data, data_length,
608 key_buffer, key_buffer_size,
609 key_buffer_length,
610 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200611 }
John Durkop9814fa22020-11-04 12:28:15 -0800612#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
613 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100614 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100615
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100616 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100617}
618
Gilles Peskinef603c712019-01-19 13:40:11 +0100619/** Calculate the intersection of two algorithm usage policies.
620 *
621 * Return 0 (which allows no operation) on incompatibility.
622 */
623static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100624 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100625 psa_algorithm_t alg1,
626 psa_algorithm_t alg2 )
627{
Gilles Peskine549ea862019-05-22 11:45:59 +0200628 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100629 if( alg1 == alg2 )
630 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100631 /* If the policies are from the same hash-and-sign family, check
632 * if one is a wildcard. If so the other has the specific algorithm. */
633 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
634 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
635 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100636 {
Steven Cooreman03488022021-02-18 12:07:20 +0100637 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
638 return( alg2 );
639 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
640 return( alg1 );
641 }
642 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100643 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100644 * restrictive tag length. */
645 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
646 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
647 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
648 {
649 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
650 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100651 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100652
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100653 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100654 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
655 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100656 {
Steven Cooremancd640932021-03-08 12:00:27 +0100657 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
658 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100659 }
660 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100661 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100662 ( alg1_len <= alg2_len ) )
663 {
664 return( alg2 );
665 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100666 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100667 ( alg2_len <= alg1_len ) )
668 {
669 return( alg1 );
670 }
671 }
672 /* If the policies are from the same MAC family, check whether one
673 * of them is a minimum-MAC-length policy. Calculate the most
674 * restrictive tag length. */
675 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
676 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
677 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
678 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100679 /* Validate the combination of key type and algorithm. Since the base
680 * algorithm of alg1 and alg2 are the same, we only need this once. */
681 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100682 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100683
Steven Cooreman31a876d2021-03-03 20:47:40 +0100684 /* Get the (exact or at-least) output lengths for both sides of the
685 * requested intersection. None of the currently supported algorithms
686 * have an output length dependent on the actual key size, so setting it
687 * to a bogus value of 0 is currently OK.
688 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100689 * Note that for at-least-this-length wildcard algorithms, the output
690 * length is set to the shortest allowed length, which allows us to
691 * calculate the most restrictive tag length for the intersection. */
692 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
693 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100694 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100695
Steven Cooremana1d83222021-02-25 10:20:29 +0100696 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100697 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
698 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100699 {
Steven Cooremancd640932021-03-08 12:00:27 +0100700 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100701 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100702
703 /* If only one is an at-least-this-length policy, the intersection would
704 * be the other (fixed-length) policy as long as said fixed length is
705 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100706 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100707 {
Steven Cooremancd640932021-03-08 12:00:27 +0100708 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100709 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100710 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100711 {
Steven Cooremancd640932021-03-08 12:00:27 +0100712 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100713 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100714
Steven Cooremancd640932021-03-08 12:00:27 +0100715 /* If none of them are wildcards, check whether they define the same tag
716 * length. This is still possible here when one is default-length and
717 * the other specific-length. Ensure to always return the
718 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100719 if( alg1_len == alg2_len )
720 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100721 }
722 /* If the policies are incompatible, allow nothing. */
723 return( 0 );
724}
725
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100726static int psa_key_algorithm_permits( psa_key_type_t key_type,
727 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200728 psa_algorithm_t requested_alg )
729{
Gilles Peskine549ea862019-05-22 11:45:59 +0200730 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200731 if( requested_alg == policy_alg )
732 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100733 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
734 * and requested_alg is the same hash-and-sign family with any hash,
735 * then requested_alg is compliant with policy_alg. */
736 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
737 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200738 {
Steven Cooreman03488022021-02-18 12:07:20 +0100739 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
740 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
741 }
742 /* If policy_alg is a wildcard AEAD algorithm of the same base as
743 * the requested algorithm, check the requested tag length to be
744 * equal-length or longer than the wildcard-specified length. */
745 if( PSA_ALG_IS_AEAD( policy_alg ) &&
746 PSA_ALG_IS_AEAD( requested_alg ) &&
747 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
748 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100749 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100750 {
751 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
752 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
753 }
Steven Cooremancd640932021-03-08 12:00:27 +0100754 /* If policy_alg is a MAC algorithm of the same base as the requested
755 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100756 if( PSA_ALG_IS_MAC( policy_alg ) &&
757 PSA_ALG_IS_MAC( requested_alg ) &&
758 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100759 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100760 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100761 /* Validate the combination of key type and algorithm. Since the policy
762 * and requested algorithms are the same, we only need this once. */
763 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100764 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100765
Steven Cooreman31a876d2021-03-03 20:47:40 +0100766 /* Get both the requested output length for the algorithm which is to be
767 * verified, and the default output length for the base algorithm.
768 * Note that none of the currently supported algorithms have an output
769 * length dependent on actual key size, so setting it to a bogus value
770 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771 size_t requested_output_length = PSA_MAC_LENGTH(
772 key_type, 0, requested_alg );
773 size_t default_output_length = PSA_MAC_LENGTH(
774 key_type, 0,
775 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100776
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 /* If the policy is default-length, only allow an algorithm with
778 * a declared exact-length matching the default. */
779 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100781
782 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100783 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
785 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
786 {
787 return( 1 );
788 }
789
Steven Cooremancd640932021-03-08 12:00:27 +0100790 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
791 * check for the requested MAC length to be equal to or longer than the
792 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100793 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
794 {
795 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100796 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100797 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200798 }
Steven Cooremance48e852020-10-05 16:02:45 +0200799 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200800 * a key derivation with that key agreement should also be allowed. This
801 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200802 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
803 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
804 {
805 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
806 policy_alg );
807 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100808 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200809 return( 0 );
810}
811
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100812/** Test whether a policy permits an algorithm.
813 *
814 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100815 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100816 * \note This function requires providing the key type for which the policy is
817 * being validated, since some algorithm policy definitions (e.g. MAC)
818 * have different properties depending on what kind of cipher it is
819 * combined with.
820 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100821 * \retval PSA_SUCCESS When \p alg is a specific algorithm
822 * allowed by the \p policy.
823 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
824 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
825 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100826 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100827static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100828 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100829 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100830{
Steven Cooremand788fab2021-02-25 11:29:17 +0100831 /* '0' is not a valid algorithm */
832 if( alg == 0 )
833 return( PSA_ERROR_INVALID_ARGUMENT );
834
Steven Cooreman7e39f052021-02-23 14:18:32 +0100835 /* A requested algorithm cannot be a wildcard. */
836 if( PSA_ALG_IS_WILDCARD( alg ) )
837 return( PSA_ERROR_INVALID_ARGUMENT );
838
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100839 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
840 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100841 return( PSA_SUCCESS );
842 else
843 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100844}
845
Gilles Peskinef603c712019-01-19 13:40:11 +0100846/** Restrict a key policy based on a constraint.
847 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100848 * \note This function requires providing the key type for which the policy is
849 * being restricted, since some algorithm policy definitions (e.g. MAC)
850 * have different properties depending on what kind of cipher it is
851 * combined with.
852 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100853 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100854 * \param[in,out] policy The policy to restrict.
855 * \param[in] constraint The policy constraint to apply.
856 *
857 * \retval #PSA_SUCCESS
858 * \c *policy contains the intersection of the original value of
859 * \c *policy and \c *constraint.
860 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100862 * \c *policy is unchanged.
863 */
864static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100865 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 psa_key_policy_t *policy,
867 const psa_key_policy_t *constraint )
868{
869 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100870 psa_key_policy_algorithm_intersection( key_type, policy->alg,
871 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100873 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
874 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
876 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
878 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100879 policy->usage &= constraint->usage;
880 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200881 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100882 return( PSA_SUCCESS );
883}
884
Ronald Cron5c522922020-11-14 16:35:34 +0100885/** Get the description of a key given its identifier and policy constraints
886 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200887 *
Ronald Cron5c522922020-11-14 16:35:34 +0100888 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100889 * nonzero, the key must allow operations with this algorithm. If \p alg is
890 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100891 *
Ronald Cron5c522922020-11-14 16:35:34 +0100892 * In case of a persistent key, the function loads the description of the key
893 * into a key slot if not already done.
894 *
895 * On success, the returned key slot is locked. It is the responsibility of
896 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 */
Ronald Cron5c522922020-11-14 16:35:34 +0100898static psa_status_t psa_get_and_lock_key_slot_with_policy(
899 mbedtls_svc_key_id_t key,
900 psa_key_slot_t **p_slot,
901 psa_key_usage_t usage,
902 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100903{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
905 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100906
Ronald Cron5c522922020-11-14 16:35:34 +0100907 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 if( status != PSA_SUCCESS )
909 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200910 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100911
912 /* Enforce that usage policy for the key slot contains all the flags
913 * required by the usage parameter. There is one exception: public
914 * keys can always be exported, so we treat public key objects as
915 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200916 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100917 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200918
Gilles Peskine8e338702019-07-30 20:06:31 +0200919 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100920 {
921 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200922 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100923 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100924
925 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100926 if( alg != 0 )
927 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100928 status = psa_key_policy_permits( &slot->attr.policy,
929 slot->attr.type,
930 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100931 if( status != PSA_SUCCESS )
932 goto error;
933 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100934
Darryl Green06fd18d2018-07-16 11:21:11 +0100935 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200936
937error:
938 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100939 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940
941 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100942}
Darryl Green940d72c2018-07-13 13:18:51 +0100943
Ronald Cron5c522922020-11-14 16:35:34 +0100944/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200945 *
946 * A transparent key is a key for which the key material is directly
947 * available, as opposed to a key in a secure element.
948 *
Ronald Cron5c522922020-11-14 16:35:34 +0100949 * This is a temporary function to use instead of
950 * psa_get_and_lock_key_slot_with_policy() until secure element support is
951 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952 *
Ronald Cron5c522922020-11-14 16:35:34 +0100953 * On success, the returned key slot is locked. It is the responsibility of the
954 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 */
956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100957static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
958 mbedtls_svc_key_id_t key,
959 psa_key_slot_t **p_slot,
960 psa_key_usage_t usage,
961 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962{
Ronald Cron5c522922020-11-14 16:35:34 +0100963 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
964 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200965 if( status != PSA_SUCCESS )
966 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967
Gilles Peskineadad8132019-07-25 11:31:23 +0200968 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200969 {
Ronald Cron5c522922020-11-14 16:35:34 +0100970 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200971 *p_slot = NULL;
972 return( PSA_ERROR_NOT_SUPPORTED );
973 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200974
Gilles Peskine28f8f302019-07-24 13:30:31 +0200975 return( PSA_SUCCESS );
976}
977#else /* MBEDTLS_PSA_CRYPTO_SE_C */
978/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100979#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
980 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
982
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200983psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000984{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100985 /* Data pointer will always be either a valid pointer or NULL in an
986 * initialized slot, so we can just free it. */
987 if( slot->key.data != NULL )
988 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
989
990 mbedtls_free( slot->key.data );
991 slot->key.data = NULL;
992 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000993
994 return( PSA_SUCCESS );
995}
996
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100997/** Completely wipe a slot in memory, including its policy.
998 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100999psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001000{
1001 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001002
Ronald Cron5c522922020-11-14 16:35:34 +01001003 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001004 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001005 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001006 status = PSA_ERROR_CORRUPTION_DETECTED;
1007 }
1008
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001009 /* Multipart operations may still be using the key. This is safe
1010 * because all multipart operation objects are independent from
1011 * the key slot: if they need to access the key after the setup
1012 * phase, they have a copy of the key. Note that this means that
1013 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001014 /* At this point, key material and other type-specific content has
1015 * been wiped. Clear remaining metadata. We can call memset and not
1016 * zeroize because the metadata is not particularly sensitive. */
1017 memset( slot, 0, sizeof( *slot ) );
1018 return( status );
1019}
1020
Ronald Croncf56a0a2020-08-04 09:51:30 +02001021psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001023 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001024 psa_status_t status; /* status of the last operation */
1025 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1027 psa_se_drv_table_entry_t *driver;
1028#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001029
Ronald Croncf56a0a2020-08-04 09:51:30 +02001030 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001031 return( PSA_SUCCESS );
1032
Ronald Cronf2911112020-10-29 17:51:10 +01001033 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001034 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001035 * key, this will load the key description from persistent memory if not
1036 * done yet. We cannot avoid this loading as without it we don't know if
1037 * the key is operated by an SE or not and this information is needed by
1038 * the current implementation.
1039 */
Ronald Cron5c522922020-11-14 16:35:34 +01001040 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001041 if( status != PSA_SUCCESS )
1042 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001043
Ronald Cronf2911112020-10-29 17:51:10 +01001044 /*
1045 * If the key slot containing the key description is under access by the
1046 * library (apart from the present access), the key cannot be destroyed
1047 * yet. For the time being, just return in error. Eventually (to be
1048 * implemented), the key should be destroyed when all accesses have
1049 * stopped.
1050 */
Ronald Cron5c522922020-11-14 16:35:34 +01001051 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001052 {
Ronald Cron5c522922020-11-14 16:35:34 +01001053 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001054 return( PSA_ERROR_GENERIC_ERROR );
1055 }
1056
Gilles Peskine6687cd02021-04-21 22:32:05 +02001057 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1058 {
1059 /* Refuse the destruction of a read-only key (which may or may not work
1060 * if we attempt it, depending on whether the key is merely read-only
1061 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001062 * Just do the best we can, which is to wipe the copy in memory
1063 * (done in this function's cleanup code). */
1064 overall_status = PSA_ERROR_NOT_PERMITTED;
1065 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001066 }
1067
Gilles Peskine354f7672019-07-12 23:46:38 +02001068#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001069 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001070 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001071 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001072 /* For a key in a secure element, we need to do three things:
1073 * remove the key file in internal storage, destroy the
1074 * key inside the secure element, and update the driver's
1075 * persistent data. Start a transaction that will encompass these
1076 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001077 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001078 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001079 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001080 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001081 status = psa_crypto_save_transaction( );
1082 if( status != PSA_SUCCESS )
1083 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001084 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001085 /* We should still try to destroy the key in the secure
1086 * element and the key metadata in storage. This is especially
1087 * important if the error is that the storage is full.
1088 * But how to do it exactly without risking an inconsistent
1089 * state after a reset?
1090 * https://github.com/ARMmbed/mbed-crypto/issues/215
1091 */
1092 overall_status = status;
1093 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001094 }
1095
Ronald Cronea0f8a62020-11-25 17:52:23 +01001096 status = psa_destroy_se_key( driver,
1097 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001098 if( overall_status == PSA_SUCCESS )
1099 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001100 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001101#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1102
Darryl Greend49a4992018-06-18 17:27:26 +01001103#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001104 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001105 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106 status = psa_destroy_persistent_key( slot->attr.id );
1107 if( overall_status == PSA_SUCCESS )
1108 overall_status = status;
1109
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001110 /* TODO: other slots may have a copy of the same key. We should
1111 * invalidate them.
1112 * https://github.com/ARMmbed/mbed-crypto/issues/214
1113 */
Darryl Greend49a4992018-06-18 17:27:26 +01001114 }
1115#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001116
Gilles Peskinefc762652019-07-22 19:30:34 +02001117#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1118 if( driver != NULL )
1119 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001120 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001121 if( overall_status == PSA_SUCCESS )
1122 overall_status = status;
1123 status = psa_crypto_stop_transaction( );
1124 if( overall_status == PSA_SUCCESS )
1125 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001126 }
1127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1128
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001130 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001131 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001132 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001133 overall_status = status;
1134 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001135}
1136
John Durkop07cc04a2020-11-16 22:08:34 -08001137#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001138 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001139static psa_status_t psa_get_rsa_public_exponent(
1140 const mbedtls_rsa_context *rsa,
1141 psa_key_attributes_t *attributes )
1142{
1143 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001144 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001145 uint8_t *buffer = NULL;
1146 size_t buflen;
1147 mbedtls_mpi_init( &mpi );
1148
1149 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1150 if( ret != 0 )
1151 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001152 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1153 {
1154 /* It's the default value, which is reported as an empty string,
1155 * so there's nothing to do. */
1156 goto exit;
1157 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001158
1159 buflen = mbedtls_mpi_size( &mpi );
1160 buffer = mbedtls_calloc( 1, buflen );
1161 if( buffer == NULL )
1162 {
1163 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1164 goto exit;
1165 }
1166 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1167 if( ret != 0 )
1168 goto exit;
1169 attributes->domain_parameters = buffer;
1170 attributes->domain_parameters_size = buflen;
1171
1172exit:
1173 mbedtls_mpi_free( &mpi );
1174 if( ret != 0 )
1175 mbedtls_free( buffer );
1176 return( mbedtls_to_psa_error( ret ) );
1177}
John Durkop07cc04a2020-11-16 22:08:34 -08001178#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001179 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001180
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001181/** Retrieve all the publicly-accessible attributes of a key.
1182 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001183psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001184 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001188 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001189
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001190 psa_reset_key_attributes( attributes );
1191
Ronald Cron5c522922020-11-14 16:35:34 +01001192 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001193 if( status != PSA_SUCCESS )
1194 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001195
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001196 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001197 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1198 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1199
1200#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1201 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001202 psa_set_key_slot_number( attributes,
1203 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001204#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001205
Gilles Peskine8e338702019-07-30 20:06:31 +02001206 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 {
John Durkop07cc04a2020-11-16 22:08:34 -08001208#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001209 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001210 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001211 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001212#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001213 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001214 * is not yet implemented.
1215 * https://github.com/ARMmbed/mbed-crypto/issues/216
1216 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001217 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001218 break;
1219#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001221 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001222
Ronald Cron90857082020-11-25 14:58:33 +01001223 status = mbedtls_psa_rsa_load_representation(
1224 slot->attr.type,
1225 slot->key.data,
1226 slot->key.bytes,
1227 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 if( status != PSA_SUCCESS )
1229 break;
1230
Steven Cooremana2371e52020-07-28 14:30:39 +02001231 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001232 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001233 mbedtls_rsa_free( rsa );
1234 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001237#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001238 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001239 default:
1240 /* Nothing else to do. */
1241 break;
1242 }
1243
1244 if( status != PSA_SUCCESS )
1245 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001248
Ronald Cron5c522922020-11-14 16:35:34 +01001249 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001250}
1251
Gilles Peskinec8000c02019-08-02 20:15:51 +02001252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1253psa_status_t psa_get_key_slot_number(
1254 const psa_key_attributes_t *attributes,
1255 psa_key_slot_number_t *slot_number )
1256{
1257 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1258 {
1259 *slot_number = attributes->slot_number;
1260 return( PSA_SUCCESS );
1261 }
1262 else
1263 return( PSA_ERROR_INVALID_ARGUMENT );
1264}
1265#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1266
Ronald Crond18b5f82020-11-25 16:46:05 +01001267static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1268 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 uint8_t *data,
1270 size_t data_size,
1271 size_t *data_length )
1272{
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001274 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001275 memcpy( data, key_buffer, key_buffer_size );
1276 memset( data + key_buffer_size, 0,
1277 data_size - key_buffer_size );
1278 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001279 return( PSA_SUCCESS );
1280}
1281
Ronald Cron7285cda2020-11-26 14:46:37 +01001282psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 const psa_key_attributes_t *attributes,
1284 const uint8_t *key_buffer, size_t key_buffer_size,
1285 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001286{
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 psa_key_type_t type = attributes->core.type;
1288
Ronald Crond18b5f82020-11-25 16:46:05 +01001289 if( key_type_is_raw_bytes( type ) ||
1290 PSA_KEY_TYPE_IS_RSA( type ) ||
1291 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001292 {
1293 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 key_buffer, key_buffer_size,
1295 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001296 }
1297 else
1298 {
1299 /* This shouldn't happen in the reference implementation, but
1300 it is valid for a special-purpose implementation to omit
1301 support for exporting certain key types. */
1302 return( PSA_ERROR_NOT_SUPPORTED );
1303 }
1304}
1305
1306psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1307 uint8_t *data,
1308 size_t data_size,
1309 size_t *data_length )
1310{
1311 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1312 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1313 psa_key_slot_t *slot;
1314
Ronald Crone907e552021-01-18 13:22:38 +01001315 /* Reject a zero-length output buffer now, since this can never be a
1316 * valid key representation. This way we know that data must be a valid
1317 * pointer and we can do things like memset(data, ..., data_size). */
1318 if( data_size == 0 )
1319 return( PSA_ERROR_BUFFER_TOO_SMALL );
1320
Ronald Cron9486f9d2020-11-26 13:36:23 +01001321 /* Set the key to empty now, so that even when there are errors, we always
1322 * set data_length to a value between 0 and data_size. On error, setting
1323 * the key to empty is a good choice because an empty key representation is
1324 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001325 *data_length = 0;
1326
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 /* Export requires the EXPORT flag. There is an exception for public keys,
1328 * which don't require any flag, but
1329 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1330 */
1331 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1332 PSA_KEY_USAGE_EXPORT, 0 );
1333 if( status != PSA_SUCCESS )
1334 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001335
Ronald Crond18b5f82020-11-25 16:46:05 +01001336 psa_key_attributes_t attributes = {
1337 .core = slot->attr
1338 };
Ronald Cron67227982020-11-26 15:16:05 +01001339 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 slot->key.data, slot->key.bytes,
1341 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342
Ronald Cron9486f9d2020-11-26 13:36:23 +01001343 unlock_status = psa_unlock_key_slot( slot );
1344
1345 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1346}
1347
Ronald Cron7285cda2020-11-26 14:46:37 +01001348psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 const psa_key_attributes_t *attributes,
1350 const uint8_t *key_buffer,
1351 size_t key_buffer_size,
1352 uint8_t *data,
1353 size_t data_size,
1354 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001359 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001360 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001361 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001362 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001363 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001364 key_buffer, key_buffer_size,
1365 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001366 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 {
John Durkop0e005192020-10-31 22:06:54 -07001370#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1371 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001372 return( mbedtls_psa_rsa_export_public_key( attributes,
1373 key_buffer,
1374 key_buffer_size,
1375 data,
1376 data_size,
1377 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001378#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001379 /* We don't know how to convert a private RSA key to public. */
1380 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001381#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1382 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001383 }
1384 else
Moran Pekera998bc62018-04-16 18:16:20 +03001385 {
John Durkop6ba40d12020-11-10 08:50:04 -08001386#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1387 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001388 return( mbedtls_psa_ecp_export_public_key( attributes,
1389 key_buffer,
1390 key_buffer_size,
1391 data,
1392 data_size,
1393 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394#else
1395 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001396 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001397#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1398 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001399 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001400 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001401 else
1402 {
1403 /* This shouldn't happen in the reference implementation, but
1404 it is valid for a special-purpose implementation to omit
1405 support for exporting certain key types. */
1406 return( PSA_ERROR_NOT_SUPPORTED );
1407 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001408}
Ronald Crond18b5f82020-11-25 16:46:05 +01001409
Ronald Croncf56a0a2020-08-04 09:51:30 +02001410psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001411 uint8_t *data,
1412 size_t data_size,
1413 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001414{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001416 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001417 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001418
Ronald Crone907e552021-01-18 13:22:38 +01001419 /* Reject a zero-length output buffer now, since this can never be a
1420 * valid key representation. This way we know that data must be a valid
1421 * pointer and we can do things like memset(data, ..., data_size). */
1422 if( data_size == 0 )
1423 return( PSA_ERROR_BUFFER_TOO_SMALL );
1424
Darryl Greendd8fb772018-11-07 16:00:44 +00001425 /* Set the key to empty now, so that even when there are errors, we always
1426 * set data_length to a value between 0 and data_size. On error, setting
1427 * the key to empty is a good choice because an empty key representation is
1428 * unlikely to be accepted anywhere. */
1429 *data_length = 0;
1430
1431 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001432 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001433 if( status != PSA_SUCCESS )
1434 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001435
Ronald Cron9486f9d2020-11-26 13:36:23 +01001436 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1437 {
1438 status = PSA_ERROR_INVALID_ARGUMENT;
1439 goto exit;
1440 }
1441
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 psa_key_attributes_t attributes = {
1443 .core = slot->attr
1444 };
Ronald Cron67227982020-11-26 15:16:05 +01001445 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 &attributes, slot->key.data, slot->key.bytes,
1447 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001448
1449exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001450 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001451
Ronald Cron5c522922020-11-14 16:35:34 +01001452 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001453}
1454
Gilles Peskine91e8c332019-08-02 19:19:39 +02001455#if defined(static_assert)
1456static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1457 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001458static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001459 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001460static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001461 "One or more key attribute flag is listed as both internal-only and external-only" );
1462#endif
1463
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001464/** Validate that a key policy is internally well-formed.
1465 *
1466 * This function only rejects invalid policies. It does not validate the
1467 * consistency of the policy with respect to other attributes of the key
1468 * such as the key type.
1469 */
1470static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001471{
1472 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001473 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 PSA_KEY_USAGE_ENCRYPT |
1475 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001476 PSA_KEY_USAGE_SIGN_MESSAGE |
1477 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001478 PSA_KEY_USAGE_SIGN_HASH |
1479 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001480 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001481 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1482 return( PSA_ERROR_INVALID_ARGUMENT );
1483
Gilles Peskine4747d192019-04-17 15:05:45 +02001484 return( PSA_SUCCESS );
1485}
1486
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001487/** Validate the internal consistency of key attributes.
1488 *
1489 * This function only rejects invalid attribute values. If does not
1490 * validate the consistency of the attributes with any key data that may
1491 * be involved in the creation of the key.
1492 *
1493 * Call this function early in the key creation process.
1494 *
1495 * \param[in] attributes Key attributes for the new key.
1496 * \param[out] p_drv On any return, the driver for the key, if any.
1497 * NULL for a transparent key.
1498 *
1499 */
1500static psa_status_t psa_validate_key_attributes(
1501 const psa_key_attributes_t *attributes,
1502 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001503{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001504 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001505 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001506 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001507
Ronald Cron54b90082020-10-29 15:26:43 +01001508 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001509 if( status != PSA_SUCCESS )
1510 return( status );
1511
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001513 if( status != PSA_SUCCESS )
1514 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001515
Ronald Cron65f38a32020-10-23 17:11:13 +02001516 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1517 {
1518 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1519 return( PSA_ERROR_INVALID_ARGUMENT );
1520 }
1521 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001522 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001523 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1524 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001525 }
1526
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001527 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001528 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001529 return( status );
1530
1531 /* Refuse to create overly large keys.
1532 * Note that this doesn't trigger on import if the attributes don't
1533 * explicitly specify a size (so psa_get_key_bits returns 0), so
1534 * psa_import_key() needs its own checks. */
1535 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1536 return( PSA_ERROR_NOT_SUPPORTED );
1537
Gilles Peskine91e8c332019-08-02 19:19:39 +02001538 /* Reject invalid flags. These should not be reachable through the API. */
1539 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1540 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1541 return( PSA_ERROR_INVALID_ARGUMENT );
1542
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001543 return( PSA_SUCCESS );
1544}
1545
Gilles Peskine4747d192019-04-17 15:05:45 +02001546/** Prepare a key slot to receive key material.
1547 *
1548 * This function allocates a key slot and sets its metadata.
1549 *
1550 * If this function fails, call psa_fail_key_creation().
1551 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001552 * This function is intended to be used as follows:
1553 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001554 * it with the specified attributes, and in case of a volatile key assign it
1555 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001556 * -# Populate the slot with the key material.
1557 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1558 * In case of failure at any step, stop the sequence and call
1559 * psa_fail_key_creation().
1560 *
Ronald Cron5c522922020-11-14 16:35:34 +01001561 * On success, the key slot is locked. It is the responsibility of the caller
1562 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001563 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001564 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001565 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001566 * \param[out] p_slot On success, a pointer to the prepared slot.
1567 * \param[out] p_drv On any return, the driver for the key, if any.
1568 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001569 *
1570 * \retval #PSA_SUCCESS
1571 * The key slot is ready to receive key material.
1572 * \return If this function fails, the key slot is an invalid state.
1573 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 */
1575static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001578 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001579 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001580{
1581 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001582 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 psa_key_slot_t *slot;
1584
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001586 *p_drv = NULL;
1587
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001588 status = psa_validate_key_attributes( attributes, p_drv );
1589 if( status != PSA_SUCCESS )
1590 return( status );
1591
Ronald Cronc4d1b512020-07-31 11:26:37 +02001592 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001593 if( status != PSA_SUCCESS )
1594 return( status );
1595 slot = *p_slot;
1596
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001597 /* We're storing the declared bit-size of the key. It's up to each
1598 * creation mechanism to verify that this information is correct.
1599 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001600 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001601 * is optional (import, copy). In case of a volatile key, assign it the
1602 * volatile key identifier associated to the slot returned to contain its
1603 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001604
1605 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001606 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1607 {
1608#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1609 slot->attr.id = volatile_key_id;
1610#else
1611 slot->attr.id.key_id = volatile_key_id;
1612#endif
1613 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001614
Gilles Peskine91e8c332019-08-02 19:19:39 +02001615 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001616 * external-only flags, query `attributes`. Thanks to the check
1617 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001618 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001619 * may have set. */
1620 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001621
Gilles Peskinecbaff462019-07-12 23:46:04 +02001622#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001623 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001624 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 * create the key file in internal storage, create the
1626 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001627 * persistent data. This is done by starting a transaction that will
1628 * encompass these three actions.
1629 * For registering a volatile key, we just need to find an appropriate
1630 * slot number inside the SE. Since the key is designated volatile, creating
1631 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001632 /* The first thing to do is to find a slot number for the new key.
1633 * We save the slot number in persistent storage as part of the
1634 * transaction data. It will be needed to recover if the power
1635 * fails during the key creation process, to clean up on the secure
1636 * element side after restarting. Obtaining a slot number from the
1637 * secure element driver updates its persistent state, but we do not yet
1638 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001639 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001640 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001641 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001642 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001643 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001644 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001645 if( status != PSA_SUCCESS )
1646 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001647
1648 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001649 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001650 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1651 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001653 psa_crypto_transaction.key.id = slot->attr.id;
1654 status = psa_crypto_save_transaction( );
1655 if( status != PSA_SUCCESS )
1656 {
1657 (void) psa_crypto_stop_transaction( );
1658 return( status );
1659 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001660 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661
1662 status = psa_copy_key_material_into_slot(
1663 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001664 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001665
1666 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1667 {
1668 /* Key registration only makes sense with a secure element. */
1669 return( PSA_ERROR_INVALID_ARGUMENT );
1670 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001671#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1672
Ronald Cronc4d1b512020-07-31 11:26:37 +02001673 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001674}
Gilles Peskine4747d192019-04-17 15:05:45 +02001675
1676/** Finalize the creation of a key once its key material has been set.
1677 *
1678 * This entails writing the key to persistent storage.
1679 *
1680 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001681 * See the documentation of psa_start_key_creation() for the intended use
1682 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001683 *
Ronald Cron5c522922020-11-14 16:35:34 +01001684 * If the finalization succeeds, the function unlocks the key slot (it was
1685 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1686 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001687 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001688 * \param[in,out] slot Pointer to the slot with key material.
1689 * \param[in] driver The secure element driver for the key,
1690 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001691 * \param[out] key On success, identifier of the key. Note that the
1692 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 *
1694 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001695 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001696 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1697 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1698 * \retval #PSA_ERROR_ALREADY_EXISTS
1699 * \retval #PSA_ERROR_DATA_INVALID
1700 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001701 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001702 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001703 * \return If this function fails, the key slot is an invalid state.
1704 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001705 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001706static psa_status_t psa_finish_key_creation(
1707 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001708 psa_se_drv_table_entry_t *driver,
1709 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001710{
1711 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001712 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001713 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001714
1715#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001716 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001717 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001718#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1719 if( driver != NULL )
1720 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001721 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001722 psa_key_slot_number_t slot_number =
1723 psa_key_slot_get_slot_number( slot ) ;
1724
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001726 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001727 sizeof( data.slot_number ),
1728 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001729#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001731 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001732 (uint8_t*) &data,
1733 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
1735 else
1736#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1737 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001738 /* Key material is saved in export representation in the slot, so
1739 * just pass the slot buffer for storage. */
1740 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 slot->key.data,
1742 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001743 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001744 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001745#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1746
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001748 /* Finish the transaction for a key creation. This does not
1749 * happen when registering an existing key. Detect this case
1750 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001751 * creation of a persistent key in a secure element requires a transaction,
1752 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001753 if( driver != NULL &&
1754 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001755 {
1756 status = psa_save_se_persistent_data( driver );
1757 if( status != PSA_SUCCESS )
1758 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001759 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001760 return( status );
1761 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001762 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763 }
1764#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1765
Ronald Cron50972942020-11-14 11:28:25 +01001766 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 {
1768 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001769 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001770 if( status != PSA_SUCCESS )
1771 *key = MBEDTLS_SVC_KEY_ID_INIT;
1772 }
Ronald Cron50972942020-11-14 11:28:25 +01001773
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 return( status );
1775}
1776
1777/** Abort the creation of a key.
1778 *
1779 * You may call this function after calling psa_start_key_creation(),
1780 * or after psa_finish_key_creation() fails. In other circumstances, this
1781 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001782 * See the documentation of psa_start_key_creation() for the intended use
1783 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 * \param[in,out] slot Pointer to the slot with key material.
1786 * \param[in] driver The secure element driver for the key,
1787 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001789static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001790 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001791{
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 (void) driver;
1793
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 if( slot == NULL )
1795 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001796
1797#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001798 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001799 * element, and the failure happened later (when saving metadata
1800 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001801 * element.
1802 * https://github.com/ARMmbed/mbed-crypto/issues/217
1803 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001804
Gilles Peskined7729582019-08-05 15:55:54 +02001805 /* Abort the ongoing transaction if any (there may not be one if
1806 * the creation process failed before starting one, or if the
1807 * key creation is a registration of a key in a secure element).
1808 * Earlier functions must already have done what it takes to undo any
1809 * partial creation. All that's left is to update the transaction data
1810 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001811 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001812#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1813
Gilles Peskine4747d192019-04-17 15:05:45 +02001814 psa_wipe_key_slot( slot );
1815}
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817/** Validate optional attributes during key creation.
1818 *
1819 * Some key attributes are optional during key creation. If they are
1820 * specified in the attributes structure, check that they are consistent
1821 * with the data in the slot.
1822 *
1823 * This function should be called near the end of key creation, after
1824 * the slot in memory is fully populated but before saving persistent data.
1825 */
1826static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001827 const psa_key_slot_t *slot,
1828 const psa_key_attributes_t *attributes )
1829{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001830 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001832 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001833 return( PSA_ERROR_INVALID_ARGUMENT );
1834 }
1835
1836 if( attributes->domain_parameters_size != 0 )
1837 {
John Durkop0e005192020-10-31 22:06:54 -07001838#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1839 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001840 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001842 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001843 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001845
Ronald Cron90857082020-11-25 14:58:33 +01001846 psa_status_t status = mbedtls_psa_rsa_load_representation(
1847 slot->attr.type,
1848 slot->key.data,
1849 slot->key.bytes,
1850 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001851 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001852 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001853
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854 mbedtls_mpi_init( &actual );
1855 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001856 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001858 mbedtls_rsa_free( rsa );
1859 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 if( ret != 0 )
1861 goto rsa_exit;
1862 ret = mbedtls_mpi_read_binary( &required,
1863 attributes->domain_parameters,
1864 attributes->domain_parameters_size );
1865 if( ret != 0 )
1866 goto rsa_exit;
1867 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1868 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1869 rsa_exit:
1870 mbedtls_mpi_free( &actual );
1871 mbedtls_mpi_free( &required );
1872 if( ret != 0)
1873 return( mbedtls_to_psa_error( ret ) );
1874 }
1875 else
John Durkop9814fa22020-11-04 12:28:15 -08001876#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1877 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001878 {
1879 return( PSA_ERROR_INVALID_ARGUMENT );
1880 }
1881 }
1882
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001883 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001885 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886 return( PSA_ERROR_INVALID_ARGUMENT );
1887 }
1888
1889 return( PSA_SUCCESS );
1890}
1891
Gilles Peskine4747d192019-04-17 15:05:45 +02001892psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001893 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001894 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001895 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001896{
1897 psa_status_t status;
1898 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001899 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001900 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901
Ronald Cron81709fc2020-11-14 12:10:32 +01001902 *key = MBEDTLS_SVC_KEY_ID_INIT;
1903
Gilles Peskine0f84d622019-09-12 19:03:13 +02001904 /* Reject zero-length symmetric keys (including raw data key objects).
1905 * This also rejects any key which might be encoded as an empty string,
1906 * which is never valid. */
1907 if( data_length == 0 )
1908 return( PSA_ERROR_INVALID_ARGUMENT );
1909
Gilles Peskinedf179142019-07-15 22:02:14 +02001910 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001911 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912 if( status != PSA_SUCCESS )
1913 goto exit;
1914
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001915 /* In the case of a transparent key or an opaque key stored in local
1916 * storage (thus not in the case of generating a key in a secure element
1917 * or cryptoprocessor with storage), we have to allocate a buffer to
1918 * hold the generated key material. */
1919 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001920 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001921 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001922 if( status != PSA_SUCCESS )
1923 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001924 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001925
1926 bits = slot->attr.bits;
1927 status = psa_driver_wrapper_import_key( attributes,
1928 data, data_length,
1929 slot->key.data,
1930 slot->key.bytes,
1931 &slot->key.bytes, &bits );
1932 if( status != PSA_SUCCESS )
1933 goto exit;
1934
1935 if( slot->attr.bits == 0 )
1936 slot->attr.bits = (psa_key_bits_t) bits;
1937 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001938 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001939 status = PSA_ERROR_INVALID_ARGUMENT;
1940 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001941 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001942
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001943 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001944 if( status != PSA_SUCCESS )
1945 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001948exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001949 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001950 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001951
Gilles Peskine4747d192019-04-17 15:05:45 +02001952 return( status );
1953}
1954
Gilles Peskined7729582019-08-05 15:55:54 +02001955#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1956psa_status_t mbedtls_psa_register_se_key(
1957 const psa_key_attributes_t *attributes )
1958{
1959 psa_status_t status;
1960 psa_key_slot_t *slot = NULL;
1961 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001962 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001963
1964 /* Leaving attributes unspecified is not currently supported.
1965 * It could make sense to query the key type and size from the
1966 * secure element, but not all secure elements support this
1967 * and the driver HAL doesn't currently support it. */
1968 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1969 return( PSA_ERROR_NOT_SUPPORTED );
1970 if( psa_get_key_bits( attributes ) == 0 )
1971 return( PSA_ERROR_NOT_SUPPORTED );
1972
1973 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001974 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001975 if( status != PSA_SUCCESS )
1976 goto exit;
1977
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001979
1980exit:
1981 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001982 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001983
Gilles Peskined7729582019-08-05 15:55:54 +02001984 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001985 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001986 return( status );
1987}
1988#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1989
Gilles Peskinef603c712019-01-19 13:40:11 +01001990static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001991 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001992{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001993 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001994 source->key.data,
1995 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001996 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001997 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001998
Steven Cooreman398aee52020-10-13 14:35:45 +02001999 target->attr.type = source->attr.type;
2000 target->attr.bits = source->attr.bits;
2001
2002 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002003}
2004
Ronald Croncf56a0a2020-08-04 09:51:30 +02002005psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002006 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002007 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002008{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002010 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011 psa_key_slot_t *source_slot = NULL;
2012 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002013 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002014 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002015
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2017
Ronald Cron5c522922020-11-14 16:35:34 +01002018 status = psa_get_and_lock_transparent_key_slot_with_policy(
2019 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002020 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 goto exit;
2022
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002023 status = psa_validate_optional_attributes( source_slot,
2024 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025 if( status != PSA_SUCCESS )
2026 goto exit;
2027
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002028 status = psa_restrict_key_policy( source_slot->attr.type,
2029 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002030 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002031 if( status != PSA_SUCCESS )
2032 goto exit;
2033
Ronald Cron81709fc2020-11-14 12:10:32 +01002034 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2035 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 if( status != PSA_SUCCESS )
2037 goto exit;
2038
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002039#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2040 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002041 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002042 /* Copying to a secure element is not implemented yet. */
2043 status = PSA_ERROR_NOT_SUPPORTED;
2044 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002045 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002047
Ronald Cron6cc66312021-04-02 12:27:47 +02002048 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2049 {
2050 /*
2051 * Copying through an opaque driver is not implemented yet, consider
2052 * a lifetime with an external location as an invalid parameter for
2053 * now.
2054 */
2055 status = PSA_ERROR_INVALID_ARGUMENT;
2056 goto exit;
2057 }
2058
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002060 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002061 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002062
Ronald Cron81709fc2020-11-14 12:10:32 +01002063 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002064exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002065 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002066 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002067
Ronald Cron5c522922020-11-14 16:35:34 +01002068 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002069
Ronald Cron5c522922020-11-14 16:35:34 +01002070 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002071}
2072
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002073
2074
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002075/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002076/* Message digests */
2077/****************************************************************/
2078
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002079psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2080{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002081 /* Aborting a non-active operation is allowed */
2082 if( operation->id == 0 )
2083 return( PSA_SUCCESS );
2084
2085 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2086 operation->id = 0;
2087
2088 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002089}
2090
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002091psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002092 psa_algorithm_t alg )
2093{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002095
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002096 /* A context must be freshly initialized before it can be set up. */
2097 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002098 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002099 status = PSA_ERROR_BAD_STATE;
2100 goto exit;
2101 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002102
2103 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002104 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002105 status = PSA_ERROR_INVALID_ARGUMENT;
2106 goto exit;
2107 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002108
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002109 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2110 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002111 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2112
Dave Rodgman685b6a72021-06-24 11:49:14 +01002113 status = psa_driver_wrapper_hash_setup( operation, alg );
2114
2115exit:
2116 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002117 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002118
2119 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002120}
2121
2122psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2123 const uint8_t *input,
2124 size_t input_length )
2125{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2127
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002128 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 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002133
Steven Cooremanc8288352021-03-04 14:02:19 +01002134 /* Don't require hash implementations to behave correctly on a
2135 * zero-length input, which may have an invalid pointer. */
2136 if( input_length == 0 )
2137 return( PSA_SUCCESS );
2138
Dave Rodgman685b6a72021-06-24 11:49:14 +01002139 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2140
2141exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002142 if( status != PSA_SUCCESS )
2143 psa_hash_abort( operation );
2144
2145 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146}
2147
2148psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2149 uint8_t *hash,
2150 size_t hash_size,
2151 size_t *hash_length )
2152{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002153 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002154 if( operation->id == 0 )
2155 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156
Steven Cooreman1e582352021-02-18 17:24:37 +01002157 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002159 psa_hash_abort( operation );
2160 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002161}
2162
Gilles Peskine2d277862018-06-18 15:41:12 +02002163psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2164 const uint8_t *hash,
2165 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166{
2167 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2168 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169 psa_status_t status = psa_hash_finish(
2170 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002171 actual_hash, sizeof( actual_hash ),
2172 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002173
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002175 goto exit;
2176
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002178 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002179 status = PSA_ERROR_INVALID_SIGNATURE;
2180 goto exit;
2181 }
2182
Steven Cooreman36876a02021-04-29 16:37:59 +02002183 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002184 status = PSA_ERROR_INVALID_SIGNATURE;
2185
2186exit:
2187 if( status != PSA_SUCCESS )
2188 psa_hash_abort(operation);
2189
2190 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002191}
2192
Gilles Peskine0a749c82019-11-28 19:33:58 +01002193psa_status_t psa_hash_compute( psa_algorithm_t alg,
2194 const uint8_t *input, size_t input_length,
2195 uint8_t *hash, size_t hash_size,
2196 size_t *hash_length )
2197{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002198 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002199 if( !PSA_ALG_IS_HASH( alg ) )
2200 return( PSA_ERROR_INVALID_ARGUMENT );
2201
Steven Cooreman1e582352021-02-18 17:24:37 +01002202 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2203 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002204}
2205
2206psa_status_t psa_hash_compare( psa_algorithm_t alg,
2207 const uint8_t *input, size_t input_length,
2208 const uint8_t *hash, size_t hash_length )
2209{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002210 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2211 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002212
2213 if( !PSA_ALG_IS_HASH( alg ) )
2214 return( PSA_ERROR_INVALID_ARGUMENT );
2215
Steven Cooreman1e582352021-02-18 17:24:37 +01002216 psa_status_t status = psa_driver_wrapper_hash_compute(
2217 alg, input, input_length,
2218 actual_hash, sizeof(actual_hash),
2219 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002220 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002221 return( status );
2222 if( actual_hash_length != hash_length )
2223 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002224 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002225 return( PSA_ERROR_INVALID_SIGNATURE );
2226 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002227}
2228
Gilles Peskineeb35d782019-01-22 17:56:16 +01002229psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2230 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002231{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232 if( source_operation->id == 0 ||
2233 target_operation->id != 0 )
2234 {
2235 return( PSA_ERROR_BAD_STATE );
2236 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002237
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002238 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2239 target_operation );
2240 if( status != PSA_SUCCESS )
2241 psa_hash_abort( target_operation );
2242
2243 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002244}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245
2246
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002248/* MAC */
2249/****************************************************************/
2250
Steven Cooremane6804192021-03-19 18:28:56 +01002251psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002252{
Steven Cooremane6804192021-03-19 18:28:56 +01002253 /* Aborting a non-active operation is allowed */
2254 if( operation->id == 0 )
2255 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002256
Steven Cooremane6804192021-03-19 18:28:56 +01002257 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002258 operation->mac_size = 0;
2259 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002260 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002261
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002262 return( status );
2263}
2264
Ronald Cron2dff3b22021-06-17 16:33:22 +02002265static psa_status_t psa_mac_finalize_alg_and_key_validation(
2266 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002267 const psa_key_attributes_t *attributes,
2268 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002269{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002271 psa_key_type_t key_type = psa_get_key_type( attributes );
2272 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002273
Ronald Cron28ea0502021-06-17 16:10:24 +02002274 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002275 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002276
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002277 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002278 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002279 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002280 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002281
Steven Cooremand1a68f12021-05-10 11:13:41 +02002282 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002283 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002284
Ronald Cron79bdd822021-06-17 16:46:44 +02002285 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002286 {
2287 /* A very short MAC is too short for security since it can be
2288 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2289 * so we make this our minimum, even though 32 bits is still
2290 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002291 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002292 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002293
Ronald Cron79bdd822021-06-17 16:46:44 +02002294 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2295 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002296 {
2297 /* It's impossible to "truncate" to a larger length than the full length
2298 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002299 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002300 }
2301
Ronald Cron79bdd822021-06-17 16:46:44 +02002302 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002303}
2304
Gilles Peskinee59236f2018-01-27 23:32:46 +01002305static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2306 mbedtls_svc_key_id_t key,
2307 psa_algorithm_t alg,
2308 int is_sign )
2309{
2310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002312 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002313
2314 /* A context must be freshly initialized before it can be set up. */
2315 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002316 {
Dave Rodgman54648242021-06-24 11:49:45 +01002317 status = PSA_ERROR_BAD_STATE;
2318 goto exit;
2319 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321 status = psa_get_and_lock_key_slot_with_policy(
2322 key,
2323 &slot,
2324 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2325 alg );
2326 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002327 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328
2329 psa_key_attributes_t attributes = {
2330 .core = slot->attr
2331 };
2332
Ronald Cron79bdd822021-06-17 16:46:44 +02002333 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2334 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002335 if( status != PSA_SUCCESS )
2336 goto exit;
2337
2338 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002339 /* Dispatch the MAC setup call with validated input */
2340 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002341 {
Steven Cooremane6804192021-03-19 18:28:56 +01002342 status = psa_driver_wrapper_mac_sign_setup( operation,
2343 &attributes,
2344 slot->key.data,
2345 slot->key.bytes,
2346 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002347 }
2348 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002349 {
Steven Cooremane6804192021-03-19 18:28:56 +01002350 status = psa_driver_wrapper_mac_verify_setup( operation,
2351 &attributes,
2352 slot->key.data,
2353 slot->key.bytes,
2354 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002355 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002356
Gilles Peskinefbfac682018-07-08 20:51:54 +02002357exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002358 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002359 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002360
Ronald Cron5c522922020-11-14 16:35:34 +01002361 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002362
Ronald Cron5c522922020-11-14 16:35:34 +01002363 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002364}
2365
Gilles Peskine89167cb2018-07-08 20:12:23 +02002366psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002367 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002368 psa_algorithm_t alg )
2369{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002370 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002371}
2372
2373psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002374 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002375 psa_algorithm_t alg )
2376{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002377 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002378}
2379
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002380psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 const uint8_t *input,
2382 size_t input_length )
2383{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002384 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002385 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002386
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002387 /* Don't require hash implementations to behave correctly on a
2388 * zero-length input, which may have an invalid pointer. */
2389 if( input_length == 0 )
2390 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002391
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002392 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2393 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002394 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002395 psa_mac_abort( operation );
2396
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002397 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002398}
2399
Steven Cooremana5b860a2021-03-19 19:04:39 +01002400psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002401 uint8_t *mac,
2402 size_t mac_size,
2403 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002404{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2406 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002407
Steven Cooremana5b860a2021-03-19 19:04:39 +01002408 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002409 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002410 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002411 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002412 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002413
Steven Cooreman72f736a2021-05-07 14:14:37 +02002414 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002415 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002416 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002417 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002418 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002419
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002420 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2421 * once all the error checks are done. */
2422 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002423 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002424 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002425 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002426 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002427
2428 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002429 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002430 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002431 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002432 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002435 mac, operation->mac_size,
2436 mac_length );
2437
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002438exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002439 /* In case of success, set the potential excess room in the output buffer
2440 * to an invalid value, to avoid potentially leaking a longer MAC.
2441 * In case of error, set the output length and content to a safe default,
2442 * such that in case the caller misses an error check, the output would be
2443 * an unachievable MAC.
2444 */
2445 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002446 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002447 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002448 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002449 }
mohammad16036df908f2018-04-02 08:34:15 -07002450
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002451 if( mac_size > operation->mac_size )
2452 memset( &mac[operation->mac_size], '!',
2453 mac_size - operation->mac_size );
2454
Steven Cooremana5b860a2021-03-19 19:04:39 +01002455 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002456
Steven Cooremana5b860a2021-03-19 19:04:39 +01002457 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002458}
2459
Steven Cooremana5b860a2021-03-19 19:04:39 +01002460psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002461 const uint8_t *mac,
2462 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002463{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002464 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2465 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002466
Steven Cooremana5b860a2021-03-19 19:04:39 +01002467 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002468 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002469 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002470 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002471 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002472
Steven Cooreman72f736a2021-05-07 14:14:37 +02002473 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002474 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002475 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002476 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002477 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002478
2479 if( operation->mac_size != mac_length )
2480 {
2481 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002482 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002483 }
2484
Steven Cooremana5b860a2021-03-19 19:04:39 +01002485 status = psa_driver_wrapper_mac_verify_finish( operation,
2486 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002487
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002488exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002489 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002490
Steven Cooremana5b860a2021-03-19 19:04:39 +01002491 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002492}
2493
Ronald Croncd989b52021-06-18 14:23:33 +02002494static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2495 psa_algorithm_t alg,
2496 const uint8_t *input,
2497 size_t input_length,
2498 uint8_t *mac,
2499 size_t mac_size,
2500 size_t *mac_length,
2501 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002502{
2503 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002504 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2505 psa_key_slot_t *slot;
2506 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002507
Ronald Cron51131b52021-06-17 17:17:20 +02002508 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002509 key, &slot,
2510 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2511 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002512 if( status != PSA_SUCCESS )
2513 goto exit;
2514
Ronald Cron51131b52021-06-17 17:17:20 +02002515 psa_key_attributes_t attributes = {
2516 .core = slot->attr
2517 };
2518
2519 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2520 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002521 if( status != PSA_SUCCESS )
2522 goto exit;
2523
Ronald Cron51131b52021-06-17 17:17:20 +02002524 if( mac_size < operation_mac_size )
2525 {
2526 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002527 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002528 }
2529
2530 status = psa_driver_wrapper_mac_compute(
2531 &attributes,
2532 slot->key.data, slot->key.bytes,
2533 alg,
2534 input, input_length,
2535 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002536
2537exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002538 /* In case of success, set the potential excess room in the output buffer
2539 * to an invalid value, to avoid potentially leaking a longer MAC.
2540 * In case of error, set the output length and content to a safe default,
2541 * such that in case the caller misses an error check, the output would be
2542 * an unachievable MAC.
2543 */
2544 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002545 {
Ronald Cron51131b52021-06-17 17:17:20 +02002546 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002547 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002548 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002549 if( mac_size > operation_mac_size )
2550 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002551
Ronald Cron51131b52021-06-17 17:17:20 +02002552 unlock_status = psa_unlock_key_slot( slot );
2553
2554 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002555}
2556
Ronald Croncd989b52021-06-18 14:23:33 +02002557psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2558 psa_algorithm_t alg,
2559 const uint8_t *input,
2560 size_t input_length,
2561 uint8_t *mac,
2562 size_t mac_size,
2563 size_t *mac_length)
2564{
2565 return( psa_mac_compute_internal( key, alg,
2566 input, input_length,
2567 mac, mac_size, mac_length, 1 ) );
2568}
2569
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002570psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2571 psa_algorithm_t alg,
2572 const uint8_t *input,
2573 size_t input_length,
2574 const uint8_t *mac,
2575 size_t mac_length)
2576{
2577 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002578 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2579 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002580
Ronald Crona587cbc2021-06-18 14:51:29 +02002581 status = psa_mac_compute_internal( key, alg,
2582 input, input_length,
2583 actual_mac, sizeof( actual_mac ),
2584 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002585 if( status != PSA_SUCCESS )
2586 goto exit;
2587
Ronald Crona587cbc2021-06-18 14:51:29 +02002588 if( mac_length != actual_mac_length )
2589 {
2590 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002591 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002592 }
2593 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2594 {
2595 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002596 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002597 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002598
2599exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002600 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002601
2602 return ( status );
2603}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002604
Gilles Peskinee59236f2018-01-27 23:32:46 +01002605/****************************************************************/
2606/* Asymmetric cryptography */
2607/****************************************************************/
2608
gabor-mezei-armf0486182021-05-12 11:03:09 +02002609static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002610 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002611{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002612 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002613 {
2614 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2615 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002616
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002617 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2618 {
2619 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2620 return( PSA_ERROR_INVALID_ARGUMENT );
2621 }
2622 }
2623 else
2624 {
2625 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2626 return( PSA_ERROR_INVALID_ARGUMENT );
2627 }
2628
2629 return( PSA_SUCCESS );
2630}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002631
2632static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002633 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002634 psa_algorithm_t alg,
2635 const uint8_t * input,
2636 size_t input_length,
2637 uint8_t * signature,
2638 size_t signature_size,
2639 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002640{
2641 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2642 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2643 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002644
2645 *signature_length = 0;
2646
gabor-mezei-armf0486182021-05-12 11:03:09 +02002647 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002648 if( status != PSA_SUCCESS )
2649 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002650
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002651 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002652 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002653 * buffer can in principle be empty since it doesn't actually have
2654 * to be a hash.) */
2655 if( signature_size == 0 )
2656 return( PSA_ERROR_BUFFER_TOO_SMALL );
2657
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002658 status = psa_get_and_lock_key_slot_with_policy(
2659 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002660 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2661 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002662 alg );
2663
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002664 if( status != PSA_SUCCESS )
2665 goto exit;
2666
2667 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2668 {
2669 status = PSA_ERROR_INVALID_ARGUMENT;
2670 goto exit;
2671 }
2672
2673 psa_key_attributes_t attributes = {
2674 .core = slot->attr
2675 };
2676
gabor-mezei-armf0486182021-05-12 11:03:09 +02002677 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002678 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002679 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002680 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002681 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002682 signature, signature_size, signature_length );
2683 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002684 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002685 {
2686
2687 status = psa_driver_wrapper_sign_hash(
2688 &attributes, slot->key.data, slot->key.bytes,
2689 alg, input, input_length,
2690 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002691 }
2692
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002693
2694exit:
2695 /* Fill the unused part of the output buffer (the whole buffer on error,
2696 * the trailing part on success) with something that isn't a valid signature
2697 * (barring an attack on the signature and deliberately-crafted input),
2698 * in case the caller doesn't check the return status properly. */
2699 if( status == PSA_SUCCESS )
2700 memset( signature + *signature_length, '!',
2701 signature_size - *signature_length );
2702 else
2703 memset( signature, '!', signature_size );
2704 /* If signature_size is 0 then we have nothing to do. We must not call
2705 * memset because signature may be NULL in this case. */
2706
2707 unlock_status = psa_unlock_key_slot( slot );
2708
2709 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2710}
2711
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002713 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002714 psa_algorithm_t alg,
2715 const uint8_t * input,
2716 size_t input_length,
2717 const uint8_t * signature,
2718 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002719{
2720 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2721 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2722 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002723
gabor-mezei-armf0486182021-05-12 11:03:09 +02002724 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002725 if( status != PSA_SUCCESS )
2726 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002727
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002728 status = psa_get_and_lock_key_slot_with_policy(
2729 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002730 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2731 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002732 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002733
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002734 if( status != PSA_SUCCESS )
2735 return( status );
2736
2737 psa_key_attributes_t attributes = {
2738 .core = slot->attr
2739 };
2740
gabor-mezei-armf0486182021-05-12 11:03:09 +02002741 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002742 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002743 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002744 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002745 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002746 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002747 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002748 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002749 {
2750 status = psa_driver_wrapper_verify_hash(
2751 &attributes, slot->key.data, slot->key.bytes,
2752 alg, input, input_length,
2753 signature, signature_length );
2754 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002756 unlock_status = psa_unlock_key_slot( slot );
2757
2758 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759
2760}
2761
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002762psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002763 const psa_key_attributes_t *attributes,
2764 const uint8_t *key_buffer,
2765 size_t key_buffer_size,
2766 psa_algorithm_t alg,
2767 const uint8_t *input,
2768 size_t input_length,
2769 uint8_t *signature,
2770 size_t signature_size,
2771 size_t *signature_length )
2772{
2773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002774
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002775 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2776 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002777 size_t hash_length;
2778 uint8_t hash[PSA_HASH_MAX_SIZE];
2779
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002780 status = psa_driver_wrapper_hash_compute(
2781 PSA_ALG_SIGN_GET_HASH( alg ),
2782 input, input_length,
2783 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002784
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002785 if( status != PSA_SUCCESS )
2786 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002787
2788 return psa_driver_wrapper_sign_hash(
2789 attributes, key_buffer, key_buffer_size,
2790 alg, hash, hash_length,
2791 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002792 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002793
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002794 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002795}
2796
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002797psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
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 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002806 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002807 signature, signature_size, signature_length );
2808}
2809
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002810psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002811 const psa_key_attributes_t *attributes,
2812 const uint8_t *key_buffer,
2813 size_t key_buffer_size,
2814 psa_algorithm_t alg,
2815 const uint8_t *input,
2816 size_t input_length,
2817 const uint8_t *signature,
2818 size_t signature_length )
2819{
2820 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002821
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002822 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2823 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002824 size_t hash_length;
2825 uint8_t hash[PSA_HASH_MAX_SIZE];
2826
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002827 status = psa_driver_wrapper_hash_compute(
2828 PSA_ALG_SIGN_GET_HASH( alg ),
2829 input, input_length,
2830 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002831
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002832 if( status != PSA_SUCCESS )
2833 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002834
2835 return psa_driver_wrapper_verify_hash(
2836 attributes, key_buffer, key_buffer_size,
2837 alg, hash, hash_length,
2838 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002839 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002840
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002841 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002842}
2843
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002844psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2845 psa_algorithm_t alg,
2846 const uint8_t * input,
2847 size_t input_length,
2848 const uint8_t * signature,
2849 size_t signature_length )
2850{
2851 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002852 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002853 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002854}
2855
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002856psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002857 const psa_key_attributes_t *attributes,
2858 const uint8_t *key_buffer, size_t key_buffer_size,
2859 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2860 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002861{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002862 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002863 {
Ronald Cron4501c982021-03-19 20:09:32 +01002864 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2865 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002866 {
Ronald Cron4501c982021-03-19 20:09:32 +01002867#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2868 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2869 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002870 attributes,
2871 key_buffer, key_buffer_size,
2872 alg, hash, hash_length,
2873 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002874#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2875 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002876 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002877 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002878 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002879 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002880 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002881 }
2882 else
Ronald Cron4501c982021-03-19 20:09:32 +01002883 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2884 {
2885 if( PSA_ALG_IS_ECDSA( alg ) )
2886 {
2887#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2888 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2889 return( mbedtls_psa_ecdsa_sign_hash(
2890 attributes,
2891 key_buffer, key_buffer_size,
2892 alg, hash, hash_length,
2893 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002894#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2895 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002896 }
2897 else
2898 {
2899 return( PSA_ERROR_INVALID_ARGUMENT );
2900 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002901 }
Ronald Cron4501c982021-03-19 20:09:32 +01002902
2903 (void)key_buffer;
2904 (void)key_buffer_size;
2905 (void)hash;
2906 (void)hash_length;
2907 (void)signature;
2908 (void)signature_size;
2909 (void)signature_length;
2910
2911 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002912}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002913
2914psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2915 psa_algorithm_t alg,
2916 const uint8_t *hash,
2917 size_t hash_length,
2918 uint8_t *signature,
2919 size_t signature_size,
2920 size_t *signature_length )
2921{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002922 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002923 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002924 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002925}
2926
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002927psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002928 const psa_key_attributes_t *attributes,
2929 const uint8_t *key_buffer, size_t key_buffer_size,
2930 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2931 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002932{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002933 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002934 {
Ronald Cron4501c982021-03-19 20:09:32 +01002935 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2936 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002937 {
Ronald Cron4501c982021-03-19 20:09:32 +01002938#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2939 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2940 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002941 attributes,
2942 key_buffer, key_buffer_size,
2943 alg, hash, hash_length,
2944 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002945#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2946 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002947 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002948 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002949 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002950 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002951 }
itayzafrir5c753392018-05-08 11:18:38 +03002952 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002953 else
Ronald Cron4501c982021-03-19 20:09:32 +01002954 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002955 {
Ronald Cron4501c982021-03-19 20:09:32 +01002956 if( PSA_ALG_IS_ECDSA( alg ) )
2957 {
2958#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2959 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2960 return( mbedtls_psa_ecdsa_verify_hash(
2961 attributes,
2962 key_buffer, key_buffer_size,
2963 alg, hash, hash_length,
2964 signature, signature_length ) );
2965#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2966 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2967 }
2968 else
2969 {
2970 return( PSA_ERROR_INVALID_ARGUMENT );
2971 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002972 }
Ronald Cron4501c982021-03-19 20:09:32 +01002973
2974 (void)key_buffer;
2975 (void)key_buffer_size;
2976 (void)hash;
2977 (void)hash_length;
2978 (void)signature;
2979 (void)signature_length;
2980
2981 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002982}
2983
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002984psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2985 psa_algorithm_t alg,
2986 const uint8_t *hash,
2987 size_t hash_length,
2988 const uint8_t *signature,
2989 size_t signature_length )
2990{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002991 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002992 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002993 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002994}
2995
John Durkop0e005192020-10-31 22:06:54 -07002996#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002997static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2998 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002999{
3000 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3001 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3002 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003003
3004 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003005}
John Durkop0e005192020-10-31 22:06:54 -07003006#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003007
Ronald Croncf56a0a2020-08-04 09:51:30 +02003008psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003009 psa_algorithm_t alg,
3010 const uint8_t *input,
3011 size_t input_length,
3012 const uint8_t *salt,
3013 size_t salt_length,
3014 uint8_t *output,
3015 size_t output_size,
3016 size_t *output_length )
3017{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003019 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003020 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003021
Darryl Green5cc689a2018-07-24 15:34:10 +01003022 (void) input;
3023 (void) input_length;
3024 (void) salt;
3025 (void) output;
3026 (void) output_size;
3027
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003028 *output_length = 0;
3029
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003030 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3031 return( PSA_ERROR_INVALID_ARGUMENT );
3032
Ronald Cron5c522922020-11-14 16:35:34 +01003033 status = psa_get_and_lock_transparent_key_slot_with_policy(
3034 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003035 if( status != PSA_SUCCESS )
3036 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003037 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3038 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003039 {
3040 status = PSA_ERROR_INVALID_ARGUMENT;
3041 goto exit;
3042 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003043
John Durkop6ba40d12020-11-10 08:50:04 -08003044#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3045 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003046 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003047 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003048 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003049 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3050 slot->key.data,
3051 slot->key.bytes,
3052 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003053 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003054 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003055
3056 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003057 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003058 status = PSA_ERROR_BUFFER_TOO_SMALL;
3059 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003060 }
John Durkop0e005192020-10-31 22:06:54 -07003061#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003062 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3063 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003064 status = mbedtls_to_psa_error(
3065 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003066 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003067 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003068 input_length,
3069 input,
3070 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003071 }
3072 else
John Durkop0e005192020-10-31 22:06:54 -07003073#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3074#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3076 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003077 status = mbedtls_to_psa_error(
3078 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3079 if( status != PSA_SUCCESS )
3080 goto rsa_exit;
3081
Steven Cooreman4fed4552020-08-03 14:46:03 +02003082 status = mbedtls_to_psa_error(
3083 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003084 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003085 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 salt, salt_length,
3087 input_length,
3088 input,
3089 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090 }
3091 else
John Durkop0e005192020-10-31 22:06:54 -07003092#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003093 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003094 status = PSA_ERROR_INVALID_ARGUMENT;
3095 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003097rsa_exit:
3098 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003099 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003100
Steven Cooremana2371e52020-07-28 14:30:39 +02003101 mbedtls_rsa_free( rsa );
3102 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003104 else
John Durkop9814fa22020-11-04 12:28:15 -08003105#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003106 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003108 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003109 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003110
3111exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003112 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003113
Ronald Cron5c522922020-11-14 16:35:34 +01003114 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003115}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116
Ronald Croncf56a0a2020-08-04 09:51:30 +02003117psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003118 psa_algorithm_t alg,
3119 const uint8_t *input,
3120 size_t input_length,
3121 const uint8_t *salt,
3122 size_t salt_length,
3123 uint8_t *output,
3124 size_t output_size,
3125 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003128 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003129 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003130
Darryl Green5cc689a2018-07-24 15:34:10 +01003131 (void) input;
3132 (void) input_length;
3133 (void) salt;
3134 (void) output;
3135 (void) output_size;
3136
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003137 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003138
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003139 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3140 return( PSA_ERROR_INVALID_ARGUMENT );
3141
Ronald Cron5c522922020-11-14 16:35:34 +01003142 status = psa_get_and_lock_transparent_key_slot_with_policy(
3143 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003144 if( status != PSA_SUCCESS )
3145 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003146 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003147 {
3148 status = PSA_ERROR_INVALID_ARGUMENT;
3149 goto exit;
3150 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003151
John Durkop6ba40d12020-11-10 08:50:04 -08003152#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3153 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003154 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003156 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003157 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3158 slot->key.data,
3159 slot->key.bytes,
3160 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003161 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003162 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003163
Steven Cooremana2371e52020-07-28 14:30:39 +02003164 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003165 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003166 status = PSA_ERROR_INVALID_ARGUMENT;
3167 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003168 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003169
John Durkop0e005192020-10-31 22:06:54 -07003170#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003171 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003172 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003173 status = mbedtls_to_psa_error(
3174 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003175 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003176 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003177 output_length,
3178 input,
3179 output,
3180 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181 }
3182 else
John Durkop0e005192020-10-31 22:06:54 -07003183#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3184#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003185 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003186 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003187 status = mbedtls_to_psa_error(
3188 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3189 if( status != PSA_SUCCESS )
3190 goto rsa_exit;
3191
Steven Cooreman4fed4552020-08-03 14:46:03 +02003192 status = mbedtls_to_psa_error(
3193 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003194 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003195 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003196 salt, salt_length,
3197 output_length,
3198 input,
3199 output,
3200 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003201 }
3202 else
John Durkop0e005192020-10-31 22:06:54 -07003203#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003204 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003205 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003206 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003207
Steven Cooreman4fed4552020-08-03 14:46:03 +02003208rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003209 mbedtls_rsa_free( rsa );
3210 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003212 else
John Durkop6ba40d12020-11-10 08:50:04 -08003213#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3214 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003215 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003216 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003217 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003218
3219exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003220 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003221
Ronald Cron5c522922020-11-14 16:35:34 +01003222 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003223}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003224
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003225
3226
mohammad1603503973b2018-03-12 15:59:30 +02003227/****************************************************************/
3228/* Symmetric cryptography */
3229/****************************************************************/
3230
Ronald Cronab99ac22020-10-01 16:38:28 +02003231static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3232 mbedtls_svc_key_id_t key,
3233 psa_algorithm_t alg,
3234 mbedtls_operation_t cipher_operation )
3235{
3236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3237 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003238 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003239 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3240 PSA_KEY_USAGE_ENCRYPT :
3241 PSA_KEY_USAGE_DECRYPT );
3242
3243 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003244 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003245 {
Dave Rodgman54648242021-06-24 11:49:45 +01003246 status = PSA_ERROR_BAD_STATE;
3247 goto exit;
3248 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003249
Ronald Cronab99ac22020-10-01 16:38:28 +02003250 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003251 {
Dave Rodgman54648242021-06-24 11:49:45 +01003252 status = PSA_ERROR_INVALID_ARGUMENT;
3253 goto exit;
3254 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003255
Ronald Cronab99ac22020-10-01 16:38:28 +02003256 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3257 if( status != PSA_SUCCESS )
3258 goto exit;
3259
Ronald Cron49fafa92021-03-10 08:34:23 +01003260 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003261 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003262 * so we only set it (in the driver wrapper) after resources have been
3263 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003264 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003265 if( alg == PSA_ALG_ECB_NO_PADDING )
3266 operation->iv_required = 0;
3267 else
3268 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003269 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003270
Ronald Crona4af55f2020-12-14 14:36:06 +01003271 psa_key_attributes_t attributes = {
3272 .core = slot->attr
3273 };
3274
Ronald Cronab99ac22020-10-01 16:38:28 +02003275 /* Try doing the operation through a driver before using software fallback. */
3276 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003277 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3278 &attributes,
3279 slot->key.data,
3280 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003281 alg );
3282 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003283 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3284 &attributes,
3285 slot->key.data,
3286 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003287 alg );
3288
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003289exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003290 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003291 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003292
Ronald Cron5c522922020-11-14 16:35:34 +01003293 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003294
Ronald Cron5c522922020-11-14 16:35:34 +01003295 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003296}
3297
Gilles Peskinefe119512018-07-08 21:39:34 +02003298psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003299 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003300 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003301{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003302 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003303}
3304
Gilles Peskinefe119512018-07-08 21:39:34 +02003305psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003306 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003307 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003308{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003309 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003310}
3311
Gilles Peskinefe119512018-07-08 21:39:34 +02003312psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003313 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003314 size_t iv_size,
3315 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003316{
Ronald Cron6d051732020-10-01 14:10:20 +02003317 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003318
Ronald Cron5618a392021-03-26 09:52:26 +01003319 *iv_length = 0;
3320
Ronald Cron49fafa92021-03-10 08:34:23 +01003321 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003322 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003323 status = PSA_ERROR_BAD_STATE;
3324 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003325 }
3326
Steven Cooreman7df02922020-09-09 15:28:49 +02003327 if( operation->iv_set || ! operation->iv_required )
3328 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003329 status = PSA_ERROR_BAD_STATE;
3330 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003331 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003332
Ronald Cron5618a392021-03-26 09:52:26 +01003333 if( iv_size < operation->default_iv_length )
3334 {
3335 status = PSA_ERROR_BUFFER_TOO_SMALL;
3336 goto exit;
3337 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003338
Ronald Cron5618a392021-03-26 09:52:26 +01003339 status = psa_generate_random( iv, operation->default_iv_length );
3340 if( status != PSA_SUCCESS )
3341 goto exit;
3342
3343 status = psa_driver_wrapper_cipher_set_iv( operation,
3344 iv,
3345 operation->default_iv_length );
3346
3347exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003348 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003349 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003350 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003351 *iv_length = operation->default_iv_length;
3352 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003353 else
Moran Peker395db872018-05-31 14:07:14 +03003354 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003355
itayzafrir534bd7c2018-08-02 13:56:32 +03003356 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003357}
3358
Gilles Peskinefe119512018-07-08 21:39:34 +02003359psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003360 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003361 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003362{
Ronald Cron6d051732020-10-01 14:10:20 +02003363 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003364
Ronald Cron49fafa92021-03-10 08:34:23 +01003365 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003366 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003367 status = PSA_ERROR_BAD_STATE;
3368 goto exit;
3369 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003370
Steven Cooreman7df02922020-09-09 15:28:49 +02003371 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003372 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003373 status = PSA_ERROR_BAD_STATE;
3374 goto exit;
3375 }
Ronald Crona0d68172021-03-26 10:15:08 +01003376
3377 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003378 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003379 status = PSA_ERROR_INVALID_ARGUMENT;
3380 goto exit;
3381 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003382
Ronald Crondd24c9b2020-12-15 14:10:01 +01003383 status = psa_driver_wrapper_cipher_set_iv( operation,
3384 iv,
3385 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003386
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003387exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003388 if( status == PSA_SUCCESS )
3389 operation->iv_set = 1;
3390 else
mohammad1603503973b2018-03-12 15:59:30 +02003391 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003392 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003393}
3394
Gilles Peskinee553c652018-06-04 16:22:46 +02003395psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3396 const uint8_t *input,
3397 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003398 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003399 size_t output_size,
3400 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003401{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003403
Ronald Cron49fafa92021-03-10 08:34:23 +01003404 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003405 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003406 status = PSA_ERROR_BAD_STATE;
3407 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003408 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003409
Steven Cooreman7df02922020-09-09 15:28:49 +02003410 if( operation->iv_required && ! operation->iv_set )
3411 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003412 status = PSA_ERROR_BAD_STATE;
3413 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003414 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003415
Ronald Crondd24c9b2020-12-15 14:10:01 +01003416 status = psa_driver_wrapper_cipher_update( operation,
3417 input,
3418 input_length,
3419 output,
3420 output_size,
3421 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003422
3423exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003424 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003425 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003426
itayzafrir534bd7c2018-08-02 13:56:32 +03003427 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003428}
3429
Gilles Peskinee553c652018-06-04 16:22:46 +02003430psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3431 uint8_t *output,
3432 size_t output_size,
3433 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003434{
David Saadab4ecc272019-02-14 13:48:10 +02003435 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003436
Ronald Cron49fafa92021-03-10 08:34:23 +01003437 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003438 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003439 status = PSA_ERROR_BAD_STATE;
3440 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003441 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003442
Steven Cooreman7df02922020-09-09 15:28:49 +02003443 if( operation->iv_required && ! operation->iv_set )
3444 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003445 status = PSA_ERROR_BAD_STATE;
3446 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003447 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003448
Ronald Crondd24c9b2020-12-15 14:10:01 +01003449 status = psa_driver_wrapper_cipher_finish( operation,
3450 output,
3451 output_size,
3452 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003453
3454exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003455 if( status == PSA_SUCCESS )
3456 return( psa_cipher_abort( operation ) );
3457 else
3458 {
3459 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003460 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003461
Steven Cooremanef8575e2020-09-11 11:44:50 +02003462 return( status );
3463 }
mohammad1603503973b2018-03-12 15:59:30 +02003464}
3465
Gilles Peskinee553c652018-06-04 16:22:46 +02003466psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3467{
Ronald Cron49fafa92021-03-10 08:34:23 +01003468 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003469 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003470 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003471 * in use. It's ok to call abort on such an object, and there's
3472 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003473 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003474 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003475
Ronald Crondd24c9b2020-12-15 14:10:01 +01003476 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003477
Ronald Cron49fafa92021-03-10 08:34:23 +01003478 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003479 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003480 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003481
Moran Peker395db872018-05-31 14:07:14 +03003482 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003483}
3484
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003485psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3486 psa_algorithm_t alg,
3487 const uint8_t *input,
3488 size_t input_length,
3489 uint8_t *output,
3490 size_t output_size,
3491 size_t *output_length )
3492{
3493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003494 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3495 psa_key_slot_t *slot;
3496 psa_key_type_t key_type;
3497 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003498
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003499 *output_length = 0;
3500
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003501 if( ! PSA_ALG_IS_CIPHER( alg ) )
3502 return( PSA_ERROR_INVALID_ARGUMENT );
3503
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003504 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3505 PSA_KEY_USAGE_ENCRYPT,
3506 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003507 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003508 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003509
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003510 psa_key_attributes_t attributes = {
3511 .core = slot->attr
3512 };
3513
3514 key_type = slot->attr.type;
3515 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3516
3517 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003518 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003519 if( output_size < iv_length )
3520 {
3521 status = PSA_ERROR_BUFFER_TOO_SMALL;
3522 goto exit;
3523 }
3524
3525 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003526 if( status != PSA_SUCCESS )
3527 goto exit;
3528 }
3529
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003530 status = psa_driver_wrapper_cipher_encrypt(
3531 &attributes, slot->key.data, slot->key.bytes,
3532 alg, input, input_length,
3533 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003534
3535exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003536 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003537
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003538 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003539}
3540
3541psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3542 psa_algorithm_t alg,
3543 const uint8_t *input,
3544 size_t input_length,
3545 uint8_t *output,
3546 size_t output_size,
3547 size_t *output_length )
3548{
3549 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003550 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3551 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003552
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003553 *output_length = 0;
3554
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003555 if( ! PSA_ALG_IS_CIPHER( alg ) )
3556 return( PSA_ERROR_INVALID_ARGUMENT );
3557
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003558 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3559 PSA_KEY_USAGE_DECRYPT,
3560 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003561 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003563
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003564 psa_key_attributes_t attributes = {
3565 .core = slot->attr
3566 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003568 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3569 {
3570 status = PSA_ERROR_INVALID_ARGUMENT;
3571 goto exit;
3572 }
3573
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003574 status = psa_driver_wrapper_cipher_decrypt(
3575 &attributes, slot->key.data, slot->key.bytes,
3576 alg, input, input_length,
3577 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003578
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003579exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003580 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003581
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003582 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003583}
3584
3585
mohammad16035955c982018-04-26 00:53:03 +03003586/****************************************************************/
3587/* AEAD */
3588/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003589
Ronald Croncf56a0a2020-08-04 09:51:30 +02003590psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003591 psa_algorithm_t alg,
3592 const uint8_t *nonce,
3593 size_t nonce_length,
3594 const uint8_t *additional_data,
3595 size_t additional_data_length,
3596 const uint8_t *plaintext,
3597 size_t plaintext_length,
3598 uint8_t *ciphertext,
3599 size_t ciphertext_size,
3600 size_t *ciphertext_length )
3601{
Ronald Cron215633c2021-03-16 17:15:37 +01003602 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3603 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003604
mohammad1603f08a5502018-06-03 15:05:47 +03003605 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003606
Steven Cooremanea7ab132021-03-17 16:28:00 +01003607 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3608 return( PSA_ERROR_NOT_SUPPORTED );
3609
Ronald Cron9a986162021-03-26 12:40:07 +01003610 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003611 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003612 if( status != PSA_SUCCESS )
3613 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003614
Ronald Cron215633c2021-03-16 17:15:37 +01003615 psa_key_attributes_t attributes = {
3616 .core = slot->attr
3617 };
mohammad16035955c982018-04-26 00:53:03 +03003618
Ronald Cronde822812021-03-17 16:08:20 +01003619 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003620 &attributes, slot->key.data, slot->key.bytes,
3621 alg,
3622 nonce, nonce_length,
3623 additional_data, additional_data_length,
3624 plaintext, plaintext_length,
3625 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003626
Gilles Peskineedf9a652018-08-17 18:11:56 +02003627 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3628 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003629
Ronald Cron9f310172021-03-16 16:36:37 +01003630 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003631
mohammad16035955c982018-04-26 00:53:03 +03003632 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003633}
3634
Ronald Croncf56a0a2020-08-04 09:51:30 +02003635psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003636 psa_algorithm_t alg,
3637 const uint8_t *nonce,
3638 size_t nonce_length,
3639 const uint8_t *additional_data,
3640 size_t additional_data_length,
3641 const uint8_t *ciphertext,
3642 size_t ciphertext_length,
3643 uint8_t *plaintext,
3644 size_t plaintext_size,
3645 size_t *plaintext_length )
3646{
Ronald Cron215633c2021-03-16 17:15:37 +01003647 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3648 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003649
Gilles Peskineee652a32018-06-01 19:23:52 +02003650 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003651
Steven Cooremanea7ab132021-03-17 16:28:00 +01003652 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3653 return( PSA_ERROR_NOT_SUPPORTED );
3654
Ronald Cron9a986162021-03-26 12:40:07 +01003655 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003656 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003657 if( status != PSA_SUCCESS )
3658 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003659
Ronald Cron215633c2021-03-16 17:15:37 +01003660 psa_key_attributes_t attributes = {
3661 .core = slot->attr
3662 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003663
Ronald Cronde822812021-03-17 16:08:20 +01003664 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003665 &attributes, slot->key.data, slot->key.bytes,
3666 alg,
3667 nonce, nonce_length,
3668 additional_data, additional_data_length,
3669 ciphertext, ciphertext_length,
3670 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003671
Gilles Peskineedf9a652018-08-17 18:11:56 +02003672 if( status != PSA_SUCCESS && plaintext_size != 0 )
3673 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003674
Ronald Cron215633c2021-03-16 17:15:37 +01003675 psa_unlock_key_slot( slot );
3676
Gilles Peskineedf9a652018-08-17 18:11:56 +02003677 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003678}
3679
Gilles Peskinee59236f2018-01-27 23:32:46 +01003680/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003681/* Generators */
3682/****************************************************************/
3683
John Durkop07cc04a2020-11-16 22:08:34 -08003684#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3685 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3686 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3687#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003688#endif /* At least one builtin KDF */
3689
3690#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3691 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3692 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3693static psa_status_t psa_key_derivation_start_hmac(
3694 psa_mac_operation_t *operation,
3695 psa_algorithm_t hash_alg,
3696 const uint8_t *hmac_key,
3697 size_t hmac_key_length )
3698{
3699 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3700 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3701 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3702 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3703 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3704
Steven Cooreman72f736a2021-05-07 14:14:37 +02003705 operation->is_sign = 1;
3706 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3707
Steven Cooreman094a77e2021-05-06 17:58:36 +02003708 status = psa_driver_wrapper_mac_sign_setup( operation,
3709 &attributes,
3710 hmac_key, hmac_key_length,
3711 PSA_ALG_HMAC( hash_alg ) );
3712
3713 psa_reset_key_attributes( &attributes );
3714 return( status );
3715}
3716#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003717
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003718#define HKDF_STATE_INIT 0 /* no input yet */
3719#define HKDF_STATE_STARTED 1 /* got salt */
3720#define HKDF_STATE_KEYED 2 /* got key */
3721#define HKDF_STATE_OUTPUT 3 /* output started */
3722
Gilles Peskinecbe66502019-05-16 16:59:18 +02003723static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003724 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003725{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003726 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3727 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003728 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003729 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003730}
3731
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003732psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003733{
3734 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003735 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003736 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003737 {
3738 /* The object has (apparently) been initialized but it is not
3739 * in use. It's ok to call abort on such an object, and there's
3740 * nothing to do. */
3741 }
3742 else
John Durkopd0321952020-10-29 21:37:36 -07003743#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003744 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003745 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003746 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003747 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003748 }
John Durkop07cc04a2020-11-16 22:08:34 -08003749 else
3750#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3751#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3752 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3753 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003754 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003755 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003756 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003757 if( operation->ctx.tls12_prf.secret != NULL )
3758 {
3759 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3760 operation->ctx.tls12_prf.secret_length );
3761 mbedtls_free( operation->ctx.tls12_prf.secret );
3762 }
3763
Janos Follath6a1d2622019-06-11 10:37:28 +01003764 if( operation->ctx.tls12_prf.seed != NULL )
3765 {
3766 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3767 operation->ctx.tls12_prf.seed_length );
3768 mbedtls_free( operation->ctx.tls12_prf.seed );
3769 }
3770
3771 if( operation->ctx.tls12_prf.label != NULL )
3772 {
3773 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3774 operation->ctx.tls12_prf.label_length );
3775 mbedtls_free( operation->ctx.tls12_prf.label );
3776 }
3777
Steven Cooremana6df6042021-04-29 19:32:25 +02003778 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003779
3780 /* We leave the fields Ai and output_block to be erased safely by the
3781 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003782 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003783 else
John Durkop07cc04a2020-11-16 22:08:34 -08003784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3785 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003786 {
3787 status = PSA_ERROR_BAD_STATE;
3788 }
Janos Follath083036a2019-06-11 10:22:26 +01003789 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003790 return( status );
3791}
3792
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003793psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003794 size_t *capacity)
3795{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003796 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003797 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003798 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003799 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003800 }
3801
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003802 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003803 return( PSA_SUCCESS );
3804}
3805
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003806psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003807 size_t capacity )
3808{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003809 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003810 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003811 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003812 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003813 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003814 return( PSA_SUCCESS );
3815}
3816
John Durkopd0321952020-10-29 21:37:36 -07003817#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003818/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003819 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003820static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003821 psa_algorithm_t hash_alg,
3822 uint8_t *output,
3823 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003824{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003825 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003826 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003827 psa_status_t status;
3828
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003829 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3830 return( PSA_ERROR_BAD_STATE );
3831 hkdf->state = HKDF_STATE_OUTPUT;
3832
Gilles Peskinebef7f142018-07-12 17:22:21 +02003833 while( output_length != 0 )
3834 {
3835 /* Copy what remains of the current block */
3836 uint8_t n = hash_length - hkdf->offset_in_block;
3837 if( n > output_length )
3838 n = (uint8_t) output_length;
3839 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3840 output += n;
3841 output_length -= n;
3842 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003843 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003844 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003845 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003846 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003847 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003848 * object was corrupted or if this function is called directly
3849 * inside the library. */
3850 if( hkdf->block_number == 0xff )
3851 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003852
3853 /* We need a new block */
3854 ++hkdf->block_number;
3855 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003856
Steven Cooreman094a77e2021-05-06 17:58:36 +02003857 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3858 hash_alg,
3859 hkdf->prk,
3860 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003861 if( status != PSA_SUCCESS )
3862 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003863
Gilles Peskinebef7f142018-07-12 17:22:21 +02003864 if( hkdf->block_number != 1 )
3865 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003866 status = psa_mac_update( &hkdf->hmac,
3867 hkdf->output_block,
3868 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003869 if( status != PSA_SUCCESS )
3870 return( status );
3871 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003872 status = psa_mac_update( &hkdf->hmac,
3873 hkdf->info,
3874 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003875 if( status != PSA_SUCCESS )
3876 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003877 status = psa_mac_update( &hkdf->hmac,
3878 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003879 if( status != PSA_SUCCESS )
3880 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003881 status = psa_mac_sign_finish( &hkdf->hmac,
3882 hkdf->output_block,
3883 sizeof( hkdf->output_block ),
3884 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003885 if( status != PSA_SUCCESS )
3886 return( status );
3887 }
3888
3889 return( PSA_SUCCESS );
3890}
John Durkop07cc04a2020-11-16 22:08:34 -08003891#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003892
John Durkop07cc04a2020-11-16 22:08:34 -08003893#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3894 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003895static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3896 psa_tls12_prf_key_derivation_t *tls12_prf,
3897 psa_algorithm_t alg )
3898{
3899 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003900 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003901 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3902 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003903 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003904
Janos Follath7742fee2019-06-17 12:58:10 +01003905 /* We can't be wanting more output after block 0xff, otherwise
3906 * the capacity check in psa_key_derivation_output_bytes() would have
3907 * prevented this call. It could happen only if the operation
3908 * object was corrupted or if this function is called directly
3909 * inside the library. */
3910 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003911 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003912
3913 /* We need a new block */
3914 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003915 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003916
3917 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3918 *
3919 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3920 *
3921 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3922 * HMAC_hash(secret, A(2) + seed) +
3923 * HMAC_hash(secret, A(3) + seed) + ...
3924 *
3925 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003926 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003927 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003928 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003929 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003930 * is currently extracted as `output_block` and where i is
3931 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003932 */
3933
Steven Cooreman094a77e2021-05-06 17:58:36 +02003934 status = psa_key_derivation_start_hmac( &hmac,
3935 hash_alg,
3936 tls12_prf->secret,
3937 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003938 if( status != PSA_SUCCESS )
3939 goto cleanup;
3940
3941 /* Calculate A(i) where i = tls12_prf->block_number. */
3942 if( tls12_prf->block_number == 1 )
3943 {
3944 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3945 * the variable seed and in this instance means it in the context of the
3946 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003947 status = psa_mac_update( &hmac,
3948 tls12_prf->label,
3949 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003950 if( status != PSA_SUCCESS )
3951 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003952 status = psa_mac_update( &hmac,
3953 tls12_prf->seed,
3954 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003955 if( status != PSA_SUCCESS )
3956 goto cleanup;
3957 }
3958 else
3959 {
3960 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003961 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003962 if( status != PSA_SUCCESS )
3963 goto cleanup;
3964 }
3965
Steven Cooremana6df6042021-04-29 19:32:25 +02003966 status = psa_mac_sign_finish( &hmac,
3967 tls12_prf->Ai, hash_length,
3968 &hmac_output_length );
3969 if( hmac_output_length != hash_length )
3970 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003971 if( status != PSA_SUCCESS )
3972 goto cleanup;
3973
3974 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003975 status = psa_key_derivation_start_hmac( &hmac,
3976 hash_alg,
3977 tls12_prf->secret,
3978 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003979 if( status != PSA_SUCCESS )
3980 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003981 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_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, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003985 if( status != PSA_SUCCESS )
3986 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003987 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003988 if( status != PSA_SUCCESS )
3989 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003990 status = psa_mac_sign_finish( &hmac,
3991 tls12_prf->output_block, hash_length,
3992 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003993 if( status != PSA_SUCCESS )
3994 goto cleanup;
3995
Janos Follath7742fee2019-06-17 12:58:10 +01003996
3997cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003998 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003999 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4000 status = cleanup_status;
4001
4002 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004003}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004004
Janos Follath844eb0e2019-06-19 12:10:49 +01004005static psa_status_t psa_key_derivation_tls12_prf_read(
4006 psa_tls12_prf_key_derivation_t *tls12_prf,
4007 psa_algorithm_t alg,
4008 uint8_t *output,
4009 size_t output_length )
4010{
4011 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004012 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004013 psa_status_t status;
4014 uint8_t offset, length;
4015
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004016 switch( tls12_prf->state )
4017 {
4018 case PSA_TLS12_PRF_STATE_LABEL_SET:
4019 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4020 break;
4021 case PSA_TLS12_PRF_STATE_OUTPUT:
4022 break;
4023 default:
4024 return( PSA_ERROR_BAD_STATE );
4025 }
4026
Janos Follath844eb0e2019-06-19 12:10:49 +01004027 while( output_length != 0 )
4028 {
4029 /* Check if we have fully processed the current block. */
4030 if( tls12_prf->left_in_block == 0 )
4031 {
4032 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4033 alg );
4034 if( status != PSA_SUCCESS )
4035 return( status );
4036
4037 continue;
4038 }
4039
4040 if( tls12_prf->left_in_block > output_length )
4041 length = (uint8_t) output_length;
4042 else
4043 length = tls12_prf->left_in_block;
4044
4045 offset = hash_length - tls12_prf->left_in_block;
4046 memcpy( output, tls12_prf->output_block + offset, length );
4047 output += length;
4048 output_length -= length;
4049 tls12_prf->left_in_block -= length;
4050 }
4051
4052 return( PSA_SUCCESS );
4053}
John Durkop07cc04a2020-11-16 22:08:34 -08004054#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4055 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004056
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004057psa_status_t psa_key_derivation_output_bytes(
4058 psa_key_derivation_operation_t *operation,
4059 uint8_t *output,
4060 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004061{
4062 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004063 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004064
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004065 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004066 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004067 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004068 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004069 }
4070
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004071 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004072 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004073 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004074 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004075 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004076 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004077 goto exit;
4078 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004079 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004080 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004081 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004082 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004083 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4084 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004085 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004086 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004087 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004088 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004089 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004090
John Durkopd0321952020-10-29 21:37:36 -07004091#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004092 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004093 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004094 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004095 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004096 output, output_length );
4097 }
Janos Follathadbec812019-06-14 11:05:39 +01004098 else
John Durkop07cc04a2020-11-16 22:08:34 -08004099#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4100#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4101 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004102 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004103 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004104 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004105 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004106 kdf_alg, output,
4107 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004108 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004109 else
John Durkop07cc04a2020-11-16 22:08:34 -08004110#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4111 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004112 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004113 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004114 return( PSA_ERROR_BAD_STATE );
4115 }
4116
4117exit:
4118 if( status != PSA_SUCCESS )
4119 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004120 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004121 * This allows us to differentiate between exhausted operations and
4122 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4123 * operations. */
4124 psa_algorithm_t alg = operation->alg;
4125 psa_key_derivation_abort( operation );
4126 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004127 memset( output, '!', output_length );
4128 }
4129 return( status );
4130}
4131
David Brown7807bf72021-02-09 16:28:23 -07004132#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004133static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4134{
4135 if( data_size >= 8 )
4136 mbedtls_des_key_set_parity( data );
4137 if( data_size >= 16 )
4138 mbedtls_des_key_set_parity( data + 8 );
4139 if( data_size >= 24 )
4140 mbedtls_des_key_set_parity( data + 16 );
4141}
David Brown7807bf72021-02-09 16:28:23 -07004142#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004143
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004144static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004145 psa_key_slot_t *slot,
4146 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004147 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004148{
4149 uint8_t *data = NULL;
4150 size_t bytes = PSA_BITS_TO_BYTES( bits );
4151 psa_status_t status;
4152
Gilles Peskine8e338702019-07-30 20:06:31 +02004153 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004154 return( PSA_ERROR_INVALID_ARGUMENT );
4155 if( bits % 8 != 0 )
4156 return( PSA_ERROR_INVALID_ARGUMENT );
4157 data = mbedtls_calloc( 1, bytes );
4158 if( data == NULL )
4159 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4160
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004161 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004162 if( status != PSA_SUCCESS )
4163 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004164#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004165 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004166 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004167#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004168
4169 status = psa_allocate_buffer_to_slot( slot, bytes );
4170 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004171 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004172
Ronald Cronbf33c932020-11-28 18:06:53 +01004173 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004174 psa_key_attributes_t attributes = {
4175 .core = slot->attr
4176 };
4177
Ronald Cronbf33c932020-11-28 18:06:53 +01004178 status = psa_driver_wrapper_import_key( &attributes,
4179 data, bytes,
4180 slot->key.data,
4181 slot->key.bytes,
4182 &slot->key.bytes, &bits );
4183 if( bits != slot->attr.bits )
4184 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004185
4186exit:
4187 mbedtls_free( data );
4188 return( status );
4189}
4190
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004191psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004192 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004193 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004194{
4195 psa_status_t status;
4196 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004197 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004198
Ronald Cron81709fc2020-11-14 12:10:32 +01004199 *key = MBEDTLS_SVC_KEY_ID_INIT;
4200
Gilles Peskine0f84d622019-09-12 19:03:13 +02004201 /* Reject any attempt to create a zero-length key so that we don't
4202 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4203 if( psa_get_key_bits( attributes ) == 0 )
4204 return( PSA_ERROR_INVALID_ARGUMENT );
4205
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004206 if( ! operation->can_output_key )
4207 return( PSA_ERROR_NOT_PERMITTED );
4208
Ronald Cron81709fc2020-11-14 12:10:32 +01004209 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4210 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004211#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4212 if( driver != NULL )
4213 {
4214 /* Deriving a key in a secure element is not implemented yet. */
4215 status = PSA_ERROR_NOT_SUPPORTED;
4216 }
4217#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004218 if( status == PSA_SUCCESS )
4219 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004220 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004221 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004222 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004223 }
4224 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004225 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004226 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004227 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004228
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004229 return( status );
4230}
4231
Gilles Peskineeab56e42018-07-12 17:12:33 +02004232
4233
4234/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004235/* Key derivation */
4236/****************************************************************/
4237
Steven Cooreman932ffb72021-02-15 12:14:32 +01004238#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004239static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004240 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004241 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004242{
John Durkop07cc04a2020-11-16 22:08:34 -08004243 int is_kdf_alg_supported;
4244
Janos Follath5fe19732019-06-20 15:09:30 +01004245 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4246 * initialisers for this union leave some bytes unspecified.) */
4247 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4248
Gilles Peskine969c5d62019-01-16 15:53:06 +01004249 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004250#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004251 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4252 is_kdf_alg_supported = 1;
4253 else
4254#endif
4255#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4256 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4257 is_kdf_alg_supported = 1;
4258 else
4259#endif
4260#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4261 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4262 is_kdf_alg_supported = 1;
4263 else
4264#endif
4265 is_kdf_alg_supported = 0;
4266
4267 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004268 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004269 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004270 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004271 if( hash_size == 0 )
4272 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004273 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4274 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004275 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004276 {
4277 return( PSA_ERROR_NOT_SUPPORTED );
4278 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004279 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004280 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004281 }
John Durkop07cc04a2020-11-16 22:08:34 -08004282
4283 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284}
John Durkop07cc04a2020-11-16 22:08:34 -08004285#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004286
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004287psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004288 psa_algorithm_t alg )
4289{
4290 psa_status_t status;
4291
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004292 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004293 return( PSA_ERROR_BAD_STATE );
4294
Gilles Peskine6843c292019-01-18 16:44:49 +01004295 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4296 return( PSA_ERROR_INVALID_ARGUMENT );
4297 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004298 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004299#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004300 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004301 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004302#else
4303 return( PSA_ERROR_NOT_SUPPORTED );
4304#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004305 }
4306 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4307 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004308#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004309 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004310#else
4311 return( PSA_ERROR_NOT_SUPPORTED );
4312#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004313 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004314 else
4315 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004316
4317 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004318 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004319 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004320}
4321
John Durkopd0321952020-10-29 21:37:36 -07004322#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004323static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004324 psa_algorithm_t hash_alg,
4325 psa_key_derivation_step_t step,
4326 const uint8_t *data,
4327 size_t data_length )
4328{
4329 psa_status_t status;
4330 switch( step )
4331 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004332 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004333 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004334 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004335 else
4336 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004337 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4338 hash_alg,
4339 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004340 if( status != PSA_SUCCESS )
4341 return( status );
4342 hkdf->state = HKDF_STATE_STARTED;
4343 return( PSA_SUCCESS );
4344 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004345 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004346 /* If no salt was provided, use an empty salt. */
4347 if( hkdf->state == HKDF_STATE_INIT )
4348 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004349 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4350 hash_alg,
4351 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004352 if( status != PSA_SUCCESS )
4353 return( status );
4354 hkdf->state = HKDF_STATE_STARTED;
4355 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004356 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004357 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004358 status = psa_mac_update( &hkdf->hmac,
4359 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004360 if( status != PSA_SUCCESS )
4361 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004362 status = psa_mac_sign_finish( &hkdf->hmac,
4363 hkdf->prk,
4364 sizeof( hkdf->prk ),
4365 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004366 if( status != PSA_SUCCESS )
4367 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004368 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004369 hkdf->block_number = 0;
4370 hkdf->state = HKDF_STATE_KEYED;
4371 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004372 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004373 if( hkdf->state == HKDF_STATE_OUTPUT )
4374 return( PSA_ERROR_BAD_STATE );
4375 if( hkdf->info_set )
4376 return( PSA_ERROR_BAD_STATE );
4377 hkdf->info_length = data_length;
4378 if( data_length != 0 )
4379 {
4380 hkdf->info = mbedtls_calloc( 1, data_length );
4381 if( hkdf->info == NULL )
4382 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4383 memcpy( hkdf->info, data, data_length );
4384 }
4385 hkdf->info_set = 1;
4386 return( PSA_SUCCESS );
4387 default:
4388 return( PSA_ERROR_INVALID_ARGUMENT );
4389 }
4390}
John Durkop07cc04a2020-11-16 22:08:34 -08004391#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004392
John Durkop07cc04a2020-11-16 22:08:34 -08004393#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4394 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004395static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4396 const uint8_t *data,
4397 size_t data_length )
4398{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004399 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004400 return( PSA_ERROR_BAD_STATE );
4401
Janos Follathd6dce9f2019-07-04 09:11:38 +01004402 if( data_length != 0 )
4403 {
4404 prf->seed = mbedtls_calloc( 1, data_length );
4405 if( prf->seed == NULL )
4406 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004407
Janos Follathd6dce9f2019-07-04 09:11:38 +01004408 memcpy( prf->seed, data, data_length );
4409 prf->seed_length = data_length;
4410 }
Janos Follathf08e2652019-06-13 09:05:41 +01004411
Gilles Peskine43f958b2020-12-13 14:55:14 +01004412 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004413
4414 return( PSA_SUCCESS );
4415}
4416
Janos Follath81550542019-06-13 14:26:34 +01004417static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004418 const uint8_t *data,
4419 size_t data_length )
4420{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004421 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004422 return( PSA_ERROR_BAD_STATE );
4423
Steven Cooremana6df6042021-04-29 19:32:25 +02004424 if( data_length != 0 )
4425 {
4426 prf->secret = mbedtls_calloc( 1, data_length );
4427 if( prf->secret == NULL )
4428 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4429
4430 memcpy( prf->secret, data, data_length );
4431 prf->secret_length = data_length;
4432 }
Janos Follath81550542019-06-13 14:26:34 +01004433
Gilles Peskine43f958b2020-12-13 14:55:14 +01004434 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004435
4436 return( PSA_SUCCESS );
4437}
4438
Janos Follath63028dd2019-06-13 09:15:47 +01004439static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4440 const uint8_t *data,
4441 size_t data_length )
4442{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004443 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004444 return( PSA_ERROR_BAD_STATE );
4445
Janos Follathd6dce9f2019-07-04 09:11:38 +01004446 if( data_length != 0 )
4447 {
4448 prf->label = mbedtls_calloc( 1, data_length );
4449 if( prf->label == NULL )
4450 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004451
Janos Follathd6dce9f2019-07-04 09:11:38 +01004452 memcpy( prf->label, data, data_length );
4453 prf->label_length = data_length;
4454 }
Janos Follath63028dd2019-06-13 09:15:47 +01004455
Gilles Peskine43f958b2020-12-13 14:55:14 +01004456 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004457
4458 return( PSA_SUCCESS );
4459}
4460
Janos Follathb03233e2019-06-11 15:30:30 +01004461static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004462 psa_key_derivation_step_t step,
4463 const uint8_t *data,
4464 size_t data_length )
4465{
Janos Follathb03233e2019-06-11 15:30:30 +01004466 switch( step )
4467 {
Janos Follathf08e2652019-06-13 09:05:41 +01004468 case PSA_KEY_DERIVATION_INPUT_SEED:
4469 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004470 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004471 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004472 case PSA_KEY_DERIVATION_INPUT_LABEL:
4473 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004474 default:
4475 return( PSA_ERROR_INVALID_ARGUMENT );
4476 }
4477}
John Durkop07cc04a2020-11-16 22:08:34 -08004478#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4479 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4480
4481#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4482static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4483 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004484 const uint8_t *data,
4485 size_t data_length )
4486{
4487 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004488 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004489 uint8_t *cur = pms;
4490
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004491 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004492 return( PSA_ERROR_INVALID_ARGUMENT );
4493
4494 /* Quoting RFC 4279, Section 2:
4495 *
4496 * The premaster secret is formed as follows: if the PSK is N octets
4497 * long, concatenate a uint16 with the value N, N zero octets, a second
4498 * uint16 with the value N, and the PSK itself.
4499 */
4500
4501 *cur++ = ( data_length >> 8 ) & 0xff;
4502 *cur++ = ( data_length >> 0 ) & 0xff;
4503 memset( cur, 0, data_length );
4504 cur += data_length;
4505 *cur++ = pms[0];
4506 *cur++ = pms[1];
4507 memcpy( cur, data, data_length );
4508 cur += data_length;
4509
Steven Cooremana6df6042021-04-29 19:32:25 +02004510 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004511
4512 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4513 return( status );
4514}
Janos Follath6660f0e2019-06-17 08:44:03 +01004515
4516static psa_status_t psa_tls12_prf_psk_to_ms_input(
4517 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004518 psa_key_derivation_step_t step,
4519 const uint8_t *data,
4520 size_t data_length )
4521{
4522 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004523 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004524 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004525 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004526 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004527
Steven Cooremana6df6042021-04-29 19:32:25 +02004528 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004529}
John Durkop07cc04a2020-11-16 22:08:34 -08004530#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004531
Gilles Peskineb8965192019-09-24 16:21:10 +02004532/** Check whether the given key type is acceptable for the given
4533 * input step of a key derivation.
4534 *
4535 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4536 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4537 * Both secret and non-secret inputs can alternatively have the type
4538 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4539 * that the input was passed as a buffer rather than via a key object.
4540 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004541static int psa_key_derivation_check_input_type(
4542 psa_key_derivation_step_t step,
4543 psa_key_type_t key_type )
4544{
4545 switch( step )
4546 {
4547 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004548 if( key_type == PSA_KEY_TYPE_DERIVE )
4549 return( PSA_SUCCESS );
4550 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004551 return( PSA_SUCCESS );
4552 break;
4553 case PSA_KEY_DERIVATION_INPUT_LABEL:
4554 case PSA_KEY_DERIVATION_INPUT_SALT:
4555 case PSA_KEY_DERIVATION_INPUT_INFO:
4556 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004557 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4558 return( PSA_SUCCESS );
4559 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004560 return( PSA_SUCCESS );
4561 break;
4562 }
4563 return( PSA_ERROR_INVALID_ARGUMENT );
4564}
4565
Janos Follathb80a94e2019-06-12 15:54:46 +01004566static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004567 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004568 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004569 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004570 const uint8_t *data,
4571 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004572{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004573 psa_status_t status;
4574 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4575
4576 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004577 if( status != PSA_SUCCESS )
4578 goto exit;
4579
John Durkopd0321952020-10-29 21:37:36 -07004580#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004581 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004582 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004583 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004584 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004585 step, data, data_length );
4586 }
John Durkop07cc04a2020-11-16 22:08:34 -08004587 else
4588#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4589#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4590 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004591 {
Janos Follathb03233e2019-06-11 15:30:30 +01004592 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004593 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004594 }
John Durkop07cc04a2020-11-16 22:08:34 -08004595 else
4596#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4597#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4598 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004599 {
4600 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004601 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004602 }
4603 else
John Durkop07cc04a2020-11-16 22:08:34 -08004604#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004605 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004606 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004607 (void) data;
4608 (void) data_length;
4609 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004610 return( PSA_ERROR_BAD_STATE );
4611 }
4612
Gilles Peskine224b0d62019-09-23 18:13:17 +02004613exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004614 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004615 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004616 return( status );
4617}
4618
Janos Follath51f4a0f2019-06-14 11:35:55 +01004619psa_status_t psa_key_derivation_input_bytes(
4620 psa_key_derivation_operation_t *operation,
4621 psa_key_derivation_step_t step,
4622 const uint8_t *data,
4623 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004624{
Gilles Peskineb8965192019-09-24 16:21:10 +02004625 return( psa_key_derivation_input_internal( operation, step,
4626 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004627 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004628}
4629
Janos Follath51f4a0f2019-06-14 11:35:55 +01004630psa_status_t psa_key_derivation_input_key(
4631 psa_key_derivation_operation_t *operation,
4632 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004633 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004634{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004636 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004637 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004638
Ronald Cron5c522922020-11-14 16:35:34 +01004639 status = psa_get_and_lock_transparent_key_slot_with_policy(
4640 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004641 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004642 {
4643 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004644 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004645 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004646
4647 /* Passing a key object as a SECRET input unlocks the permission
4648 * to output to a key object. */
4649 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4650 operation->can_output_key = 1;
4651
Ronald Cronf95a2b12020-10-22 15:24:49 +02004652 status = psa_key_derivation_input_internal( operation,
4653 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004654 slot->key.data,
4655 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004656
Ronald Cron5c522922020-11-14 16:35:34 +01004657 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004658
Ronald Cron5c522922020-11-14 16:35:34 +01004659 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004660}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004661
4662
4663
4664/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004665/* Key agreement */
4666/****************************************************************/
4667
John Durkop6ba40d12020-11-10 08:50:04 -08004668#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004669static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4670 size_t peer_key_length,
4671 const mbedtls_ecp_keypair *our_key,
4672 uint8_t *shared_secret,
4673 size_t shared_secret_size,
4674 size_t *shared_secret_length )
4675{
Steven Cooremand4867872020-08-05 16:31:39 +02004676 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004677 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004678 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004679 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004680 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004681 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004682
Ronald Cron90857082020-11-25 14:58:33 +01004683 status = mbedtls_psa_ecp_load_representation(
4684 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004685 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004686 peer_key,
4687 peer_key_length,
4688 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004689 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004690 goto exit;
4691
Jaeden Amero97271b32019-01-10 19:38:51 +00004692 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004693 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004694 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004695 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004696 status = mbedtls_to_psa_error(
4697 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4698 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004699 goto exit;
4700
Jaeden Amero97271b32019-01-10 19:38:51 +00004701 status = mbedtls_to_psa_error(
4702 mbedtls_ecdh_calc_secret( &ecdh,
4703 shared_secret_length,
4704 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004705 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004706 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004707 if( status != PSA_SUCCESS )
4708 goto exit;
4709 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4710 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004711
4712exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004713 if( status != PSA_SUCCESS )
4714 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004715 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004716 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004717 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004718
Jaeden Amero97271b32019-01-10 19:38:51 +00004719 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004720}
John Durkop6ba40d12020-11-10 08:50:04 -08004721#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004722
Gilles Peskine01d718c2018-09-18 12:01:02 +02004723#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4724
Gilles Peskine0216fe12019-04-11 21:23:21 +02004725static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4726 psa_key_slot_t *private_key,
4727 const uint8_t *peer_key,
4728 size_t peer_key_length,
4729 uint8_t *shared_secret,
4730 size_t shared_secret_size,
4731 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004732{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004733 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004734 {
John Durkop6ba40d12020-11-10 08:50:04 -08004735#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004736 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004737 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004738 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004739 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004740 psa_status_t status = mbedtls_psa_ecp_load_representation(
4741 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004742 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004743 private_key->key.data,
4744 private_key->key.bytes,
4745 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004746 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004747 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004748 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004749 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004750 shared_secret, shared_secret_size,
4751 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004752 mbedtls_ecp_keypair_free( ecp );
4753 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004754 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004755#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004756 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004757 (void) private_key;
4758 (void) peer_key;
4759 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004760 (void) shared_secret;
4761 (void) shared_secret_size;
4762 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004763 return( PSA_ERROR_NOT_SUPPORTED );
4764 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004765}
4766
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004767/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004768 * to potentially free embedded data structures and wipe confidential data.
4769 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004770static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004771 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004772 psa_key_slot_t *private_key,
4773 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004774 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004775{
4776 psa_status_t status;
4777 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4778 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004779 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004780
4781 /* Step 1: run the secret agreement algorithm to generate the shared
4782 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004783 status = psa_key_agreement_raw_internal( ka_alg,
4784 private_key,
4785 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004786 shared_secret,
4787 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004788 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004789 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004790 goto exit;
4791
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004792 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004793 * the shared secret. A shared secret is permitted wherever a key
4794 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004795 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004796 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004797 shared_secret,
4798 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004799exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004800 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004801 return( status );
4802}
4803
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004804psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004805 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004806 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004807 const uint8_t *peer_key,
4808 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004809{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004811 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004812 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004813
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004814 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004815 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004816 status = psa_get_and_lock_transparent_key_slot_with_policy(
4817 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004818 if( status != PSA_SUCCESS )
4819 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004820 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004821 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004822 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004823 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004824 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004825 else
4826 {
4827 /* If a private key has been added as SECRET, we allow the derived
4828 * key material to be used as a key in PSA Crypto. */
4829 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4830 operation->can_output_key = 1;
4831 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004832
Ronald Cron5c522922020-11-14 16:35:34 +01004833 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004834
Ronald Cron5c522922020-11-14 16:35:34 +01004835 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004836}
4837
Gilles Peskinebe697d82019-05-16 18:00:41 +02004838psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004839 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004840 const uint8_t *peer_key,
4841 size_t peer_key_length,
4842 uint8_t *output,
4843 size_t output_size,
4844 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004845{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004847 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004848 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004849
4850 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4851 {
4852 status = PSA_ERROR_INVALID_ARGUMENT;
4853 goto exit;
4854 }
Ronald Cron5c522922020-11-14 16:35:34 +01004855 status = psa_get_and_lock_transparent_key_slot_with_policy(
4856 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004857 if( status != PSA_SUCCESS )
4858 goto exit;
4859
4860 status = psa_key_agreement_raw_internal( alg, slot,
4861 peer_key, peer_key_length,
4862 output, output_size,
4863 output_length );
4864
4865exit:
4866 if( status != PSA_SUCCESS )
4867 {
4868 /* If an error happens and is not handled properly, the output
4869 * may be used as a key to protect sensitive data. Arrange for such
4870 * a key to be random, which is likely to result in decryption or
4871 * verification errors. This is better than filling the buffer with
4872 * some constant data such as zeros, which would result in the data
4873 * being protected with a reproducible, easily knowable key.
4874 */
4875 psa_generate_random( output, output_size );
4876 *output_length = output_size;
4877 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004878
Ronald Cron5c522922020-11-14 16:35:34 +01004879 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004880
Ronald Cron5c522922020-11-14 16:35:34 +01004881 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004882}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004883
4884
Gilles Peskine30524eb2020-11-13 17:02:26 +01004885
Gilles Peskine86a440b2018-11-12 18:39:40 +01004886/****************************************************************/
4887/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004888/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004889
Gilles Peskine30524eb2020-11-13 17:02:26 +01004890/** Initialize the PSA random generator.
4891 */
4892static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4893{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004894#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4895 memset( rng, 0, sizeof( *rng ) );
4896#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4897
Gilles Peskine30524eb2020-11-13 17:02:26 +01004898 /* Set default configuration if
4899 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4900 if( rng->entropy_init == NULL )
4901 rng->entropy_init = mbedtls_entropy_init;
4902 if( rng->entropy_free == NULL )
4903 rng->entropy_free = mbedtls_entropy_free;
4904
4905 rng->entropy_init( &rng->entropy );
4906#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4907 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4908 /* The PSA entropy injection feature depends on using NV seed as an entropy
4909 * source. Add NV seed as an entropy source for PSA entropy injection. */
4910 mbedtls_entropy_add_source( &rng->entropy,
4911 mbedtls_nv_seed_poll, NULL,
4912 MBEDTLS_ENTROPY_BLOCK_SIZE,
4913 MBEDTLS_ENTROPY_SOURCE_STRONG );
4914#endif
4915
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004916 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004917#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004918}
4919
4920/** Deinitialize the PSA random generator.
4921 */
4922static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4923{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004924#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4925 memset( rng, 0, sizeof( *rng ) );
4926#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004927 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004928 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004929#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004930}
4931
4932/** Seed the PSA random generator.
4933 */
4934static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4935{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004936#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4937 /* Do nothing: the external RNG seeds itself. */
4938 (void) rng;
4939 return( PSA_SUCCESS );
4940#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004941 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004942 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4943 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004944 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004945#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004946}
4947
Gilles Peskinee59236f2018-01-27 23:32:46 +01004948psa_status_t psa_generate_random( uint8_t *output,
4949 size_t output_size )
4950{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004951 GUARD_MODULE_INITIALIZED;
4952
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004953#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4954
4955 size_t output_length = 0;
4956 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4957 output, output_size,
4958 &output_length );
4959 if( status != PSA_SUCCESS )
4960 return( status );
4961 /* Breaking up a request into smaller chunks is currently not supported
4962 * for the extrernal RNG interface. */
4963 if( output_length != output_size )
4964 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4965 return( PSA_SUCCESS );
4966
4967#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4968
Gilles Peskine71ddab92021-01-04 21:01:07 +01004969 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004970 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004971 size_t request_size =
4972 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4973 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4974 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004975 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4976 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004977 if( ret != 0 )
4978 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004979 output_size -= request_size;
4980 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004981 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004982 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004983#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004984}
4985
Gilles Peskine8814fc42020-12-14 15:33:44 +01004986/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004987 *
4988 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4989 * `psa_generate_random(...)`. The state parameter is ignored since the
4990 * PSA API doesn't support passing an explicit state.
4991 *
4992 * In the non-external case, psa_generate_random() calls an
4993 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4994 * and semantics as mbedtls_psa_get_random(). As an optimization,
4995 * instead of doing this back-and-forth between the PSA API and the
4996 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4997 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004998 */
4999#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5000int mbedtls_psa_get_random( void *p_rng,
5001 unsigned char *output,
5002 size_t output_size )
5003{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005004 /* This function takes a pointer to the RNG state because that's what
5005 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5006 * its own state internally and doesn't let the caller access that state.
5007 * So we just ignore the state parameter, and in practice we'll pass
5008 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005009 (void) p_rng;
5010 psa_status_t status = psa_generate_random( output, output_size );
5011 if( status == PSA_SUCCESS )
5012 return( 0 );
5013 else
5014 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5015}
5016#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5017
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005018#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005019#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005020
Gilles Peskine7228da22019-07-15 11:06:15 +02005021psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005022 size_t seed_size )
5023{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005024 if( global_data.initialized )
5025 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005026
5027 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5028 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5029 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5030 return( PSA_ERROR_INVALID_ARGUMENT );
5031
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005032 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005033}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005034#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005035
Ronald Cron3772afe2021-02-08 16:10:05 +01005036/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005037 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005038 * \param type The key type
5039 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005040 *
5041 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005042 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005043 * \retval #PSA_ERROR_INVALID_ARGUMENT
5044 * The size in bits of the key is not valid.
5045 * \retval #PSA_ERROR_NOT_SUPPORTED
5046 * The type and/or the size in bits of the key or the combination of
5047 * the two is not supported.
5048 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005049static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5050 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005051{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005052 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005053
Gilles Peskinee59236f2018-01-27 23:32:46 +01005054 if( key_type_is_raw_bytes( type ) )
5055 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005056 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005057 if( status != PSA_SUCCESS )
5058 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005059 }
5060 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005061#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005062 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5063 {
5064 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5065 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005066
Ronald Cron01b2aba2020-10-05 09:42:02 +02005067 /* Accept only byte-aligned keys, for the same reasons as
5068 * in psa_import_rsa_key(). */
5069 if( bits % 8 != 0 )
5070 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005071 }
5072 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005073#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005074
Ronald Cron5c4d3862020-12-07 11:07:24 +01005075#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005076 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5077 {
Ronald Crond81ab562021-02-16 09:01:16 +01005078 /* To avoid empty block, return successfully here. */
5079 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005080 }
5081 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005082#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005083 {
5084 return( PSA_ERROR_NOT_SUPPORTED );
5085 }
5086
5087 return( PSA_SUCCESS );
5088}
5089
Ronald Cron55ed0592020-10-05 10:30:40 +02005090psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005091 const psa_key_attributes_t *attributes,
5092 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005093{
5094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005095 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005096
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005097 if( ( attributes->domain_parameters == NULL ) &&
5098 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005099 return( PSA_ERROR_INVALID_ARGUMENT );
5100
Ronald Cron01b2aba2020-10-05 09:42:02 +02005101 if( key_type_is_raw_bytes( type ) )
5102 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005103 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005104 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005105 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005106
David Brown12ca5032021-02-11 11:02:00 -07005107#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005108 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005109 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005110#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005111 }
5112 else
5113
Jaeden Amero424fa932021-05-14 08:34:32 +01005114#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5115 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005116 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005117 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005118 return( mbedtls_psa_rsa_generate_key( attributes,
5119 key_buffer,
5120 key_buffer_size,
5121 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005122 }
5123 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005124#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5125 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005126
John Durkop9814fa22020-11-04 12:28:15 -08005127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005128 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005129 {
Ronald Cron7023db52020-11-20 18:17:42 +01005130 return( mbedtls_psa_ecp_generate_key( attributes,
5131 key_buffer,
5132 key_buffer_size,
5133 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005134 }
5135 else
John Durkop9814fa22020-11-04 12:28:15 -08005136#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005137 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005138 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005139 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005140 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005141
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005142 return( PSA_SUCCESS );
5143}
Darryl Green0c6575a2018-11-07 16:05:30 +00005144
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005145psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005146 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005147{
5148 psa_status_t status;
5149 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005150 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005151 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005152
Ronald Cron81709fc2020-11-14 12:10:32 +01005153 *key = MBEDTLS_SVC_KEY_ID_INIT;
5154
Gilles Peskine0f84d622019-09-12 19:03:13 +02005155 /* Reject any attempt to create a zero-length key so that we don't
5156 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5157 if( psa_get_key_bits( attributes ) == 0 )
5158 return( PSA_ERROR_INVALID_ARGUMENT );
5159
Ronald Cron81709fc2020-11-14 12:10:32 +01005160 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5161 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005162 if( status != PSA_SUCCESS )
5163 goto exit;
5164
Ronald Cron977c2472020-10-13 08:32:21 +02005165 /* In the case of a transparent key or an opaque key stored in local
5166 * storage (thus not in the case of generating a key in a secure element
5167 * or cryptoprocessor with storage), we have to allocate a buffer to
5168 * hold the generated key material. */
5169 if( slot->key.data == NULL )
5170 {
5171 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5172 PSA_KEY_LOCATION_LOCAL_STORAGE )
5173 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005174 status = psa_validate_key_type_and_size_for_key_generation(
5175 attributes->core.type, attributes->core.bits );
5176 if( status != PSA_SUCCESS )
5177 goto exit;
5178
5179 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5180 attributes->core.type,
5181 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005182 }
5183 else
5184 {
5185 status = psa_driver_wrapper_get_key_buffer_size(
5186 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005187 if( status != PSA_SUCCESS )
5188 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005189 }
Ronald Cron977c2472020-10-13 08:32:21 +02005190
5191 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5192 if( status != PSA_SUCCESS )
5193 goto exit;
5194 }
5195
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005196 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005197 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005198
Ronald Cron2b56bc82020-10-05 10:02:26 +02005199 if( status != PSA_SUCCESS )
5200 psa_remove_key_data_from_memory( slot );
5201
Gilles Peskine11792082019-08-06 18:36:36 +02005202exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005203 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005204 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005205 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005206 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005207
Darryl Green0c6575a2018-11-07 16:05:30 +00005208 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005209}
5210
Gilles Peskinee59236f2018-01-27 23:32:46 +01005211/****************************************************************/
5212/* Module setup */
5213/****************************************************************/
5214
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005215#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005216psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5217 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5218 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5219{
5220 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5221 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005222 global_data.rng.entropy_init = entropy_init;
5223 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005224 return( PSA_SUCCESS );
5225}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005226#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005227
Gilles Peskinee59236f2018-01-27 23:32:46 +01005228void mbedtls_psa_crypto_free( void )
5229{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005230 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005231 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5232 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005233 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005234 }
5235 /* Wipe all remaining data, including configuration.
5236 * In particular, this sets all state indicator to the value
5237 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005238 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005239#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005240 /* Unregister all secure element drivers, so that we restart from
5241 * a pristine state. */
5242 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005243#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005244}
5245
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005246#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5247/** Recover a transaction that was interrupted by a power failure.
5248 *
5249 * This function is called during initialization, before psa_crypto_init()
5250 * returns. If this function returns a failure status, the initialization
5251 * fails.
5252 */
5253static psa_status_t psa_crypto_recover_transaction(
5254 const psa_crypto_transaction_t *transaction )
5255{
5256 switch( transaction->unknown.type )
5257 {
5258 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5259 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005260 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005261 * is implemented.
5262 * https://github.com/ARMmbed/mbed-crypto/issues/218
5263 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005264 default:
5265 /* We found an unsupported transaction in the storage.
5266 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005267 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005268 }
5269}
5270#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5271
Gilles Peskinee59236f2018-01-27 23:32:46 +01005272psa_status_t psa_crypto_init( void )
5273{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005274 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005275
Gilles Peskinec6b69072018-11-20 21:42:52 +01005276 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005277 if( global_data.initialized != 0 )
5278 return( PSA_SUCCESS );
5279
Gilles Peskine30524eb2020-11-13 17:02:26 +01005280 /* Initialize and seed the random generator. */
5281 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005282 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005283 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005284 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005285 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005286 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005287
Gilles Peskine66fb1262018-12-10 16:29:04 +01005288 status = psa_initialize_key_slots( );
5289 if( status != PSA_SUCCESS )
5290 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005291
Gilles Peskined9348f22019-10-01 15:22:29 +02005292#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5293 status = psa_init_all_se_drivers( );
5294 if( status != PSA_SUCCESS )
5295 goto exit;
5296#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5297
Gilles Peskine4b734222019-07-24 15:56:31 +02005298#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005299 status = psa_crypto_load_transaction( );
5300 if( status == PSA_SUCCESS )
5301 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005302 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5303 if( status != PSA_SUCCESS )
5304 goto exit;
5305 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005306 }
5307 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5308 {
5309 /* There's no transaction to complete. It's all good. */
5310 status = PSA_SUCCESS;
5311 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005312#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005313
Gilles Peskinec6b69072018-11-20 21:42:52 +01005314 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005315 global_data.initialized = 1;
5316
5317exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005318 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005319 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005320 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005321}
5322
5323#endif /* MBEDTLS_PSA_CRYPTO_C */