blob: e962e29cb4edb902a801c655e8575769139cfffa [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200205 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218#endif
219
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
223 return( PSA_ERROR_INVALID_ARGUMENT );
224 case MBEDTLS_ERR_MD_ALLOC_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_MEMORY );
226 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
227 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100228
Gilles Peskinef76aa772018-10-29 19:24:33 +0100229 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
231 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
236 return( PSA_ERROR_BUFFER_TOO_SMALL );
237 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
238 return( PSA_ERROR_INVALID_ARGUMENT );
239 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
245
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100246 case MBEDTLS_ERR_PK_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
249 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100253 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
254 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
257 return( PSA_ERROR_NOT_SUPPORTED );
258 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
259 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
260 return( PSA_ERROR_NOT_PERMITTED );
261 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_INVALID_ALG:
264 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
265 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
268 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200269 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
270 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100271
Gilles Peskineff2d2002019-05-06 15:26:23 +0200272 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
275 return( PSA_ERROR_NOT_SUPPORTED );
276
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_RSA_INVALID_PADDING:
280 return( PSA_ERROR_INVALID_PADDING );
281 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
286 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200287 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
289 return( PSA_ERROR_INVALID_SIGNATURE );
290 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100293 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200294
itayzafrir5c753392018-05-08 11:18:38 +0300295 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300297 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
299 return( PSA_ERROR_BUFFER_TOO_SMALL );
300 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
303 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
304 return( PSA_ERROR_INVALID_SIGNATURE );
305 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309
Janos Follatha13b9052019-11-22 12:48:59 +0000310 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
311 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300312
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 default:
David Saadab4ecc272019-02-14 13:48:10 +0200314 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 }
316}
317
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200319
320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321/****************************************************************/
322/* Key management */
323/****************************************************************/
324
John Durkop07cc04a2020-11-16 22:08:34 -0800325/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
326 * current test driver in key_management.c is using this function
327 * when accelerators are used for ECC key pair and public key.
328 * Once that dependency is resolved these guards can be removed.
329 */
John Durkop9814fa22020-11-04 12:28:15 -0800330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800331 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
332 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
333 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100334mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100335 size_t bits,
336 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200337{
338 switch( curve )
339 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100340 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100341 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100342 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100343#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100344 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100345 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100346#endif
347#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#endif
351#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100352 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100353 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100354#endif
355#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100356 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100357 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100358#endif
359#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100361 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 528:
363 if( bits_is_sloppy )
364 return( MBEDTLS_ECP_DP_SECP521R1 );
365 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100367 }
368 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100369
Paul Elliott8ff510a2020-06-02 17:19:28 +0100370 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100371 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100374 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100376#endif
377#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 }
386 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100387
Paul Elliott8ff510a2020-06-02 17:19:28 +0100388 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100393 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
395 if( bits_is_sloppy )
396 return( MBEDTLS_ECP_DP_CURVE25519 );
397 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#endif
399#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100402#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 }
404 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100405
Paul Elliott8ff510a2020-06-02 17:19:28 +0100406 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100410 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100411 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100412#endif
413#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 }
422 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200423 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100425 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200427}
John Durkop9814fa22020-11-04 12:28:15 -0800428#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800429 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
430 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
431 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200433static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_CAMELLIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_DES:
457 if( bits != 64 && bits != 128 && bits != 192 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200462 case PSA_KEY_TYPE_CHACHA20:
463 if( bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200467 default:
468 return( PSA_ERROR_NOT_SUPPORTED );
469 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200470 if( bits % 8 != 0 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 return( PSA_SUCCESS );
474}
475
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100476/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100477 *
Steven Cooremancd640932021-03-08 12:00:27 +0100478 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
479 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100480 *
481 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 * \param[in] key_type The key type of the key to be used with the
483 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
485 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100491 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493{
Steven Cooremancd640932021-03-08 12:00:27 +0100494 if( PSA_ALG_IS_HMAC( algorithm ) )
495 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 if( key_type == PSA_KEY_TYPE_HMAC )
497 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499
500 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
503 * key. */
504 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
505 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
506 {
507 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
508 * the block length (larger than 1) for block ciphers. */
509 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
510 return( PSA_SUCCESS );
511 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100512 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100513
514 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515}
516
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200517psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
518 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200519{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100520 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200521 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200522
Ronald Cronea0f8a62020-11-25 17:52:23 +0100523 slot->key.data = mbedtls_calloc( 1, buffer_length );
524 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200525 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200526
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529}
530
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200531psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
532 const uint8_t* data,
533 size_t data_length )
534{
535 psa_status_t status = psa_allocate_buffer_to_slot( slot,
536 data_length );
537 if( status != PSA_SUCCESS )
538 return( status );
539
Ronald Cronea0f8a62020-11-25 17:52:23 +0100540 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200541 return( PSA_SUCCESS );
542}
543
Ronald Crona0fe59f2020-11-29 11:14:53 +0100544psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100545 const psa_key_attributes_t *attributes,
546 const uint8_t *data, size_t data_length,
547 uint8_t *key_buffer, size_t key_buffer_size,
548 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100549{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
551 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100552
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553 /* zero-length keys are never supported. */
554 if( data_length == 0 )
555 return( PSA_ERROR_NOT_SUPPORTED );
556
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100559 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560
Steven Cooreman75b74362020-07-28 14:30:13 +0200561 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
562 if( data_length > SIZE_MAX / 8 )
563 return( PSA_ERROR_NOT_SUPPORTED );
564
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200565 /* Enforce a size limit, and in particular ensure that the bit
566 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100567 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200568 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200569
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100570 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200571 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200572 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573
Ronald Crondd04d422020-11-28 15:14:42 +0100574 /* Copy the key material. */
575 memcpy( key_buffer, data, data_length );
576 *key_buffer_length = data_length;
577 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200578
Steven Cooreman40120f62020-10-29 11:42:22 +0100579 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100580 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100581 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200582 {
John Durkop9814fa22020-11-04 12:28:15 -0800583#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
584 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200586 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100587 return( mbedtls_psa_ecp_import_key( attributes,
588 data, data_length,
589 key_buffer, key_buffer_size,
590 key_buffer_length,
591 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100592 }
John Durkop9814fa22020-11-04 12:28:15 -0800593#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
594 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700595#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
596 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200598 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 return( mbedtls_psa_rsa_import_key( attributes,
600 data, data_length,
601 key_buffer, key_buffer_size,
602 key_buffer_length,
603 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200604 }
John Durkop9814fa22020-11-04 12:28:15 -0800605#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
606 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100608
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100609 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100610}
611
Gilles Peskinef603c712019-01-19 13:40:11 +0100612/** Calculate the intersection of two algorithm usage policies.
613 *
614 * Return 0 (which allows no operation) on incompatibility.
615 */
616static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100617 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100618 psa_algorithm_t alg1,
619 psa_algorithm_t alg2 )
620{
Gilles Peskine549ea862019-05-22 11:45:59 +0200621 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100622 if( alg1 == alg2 )
623 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100624 /* If the policies are from the same hash-and-sign family, check
625 * if one is a wildcard. If so the other has the specific algorithm. */
626 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
627 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
628 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100629 {
Steven Cooreman03488022021-02-18 12:07:20 +0100630 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
631 return( alg2 );
632 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
633 return( alg1 );
634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
638 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
639 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
641 {
642 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
643 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100644 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100645
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100646 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100647 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
648 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100649 {
Steven Cooremancd640932021-03-08 12:00:27 +0100650 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
651 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100652 }
653 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100654 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100655 ( alg1_len <= alg2_len ) )
656 {
657 return( alg2 );
658 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100659 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100660 ( alg2_len <= alg1_len ) )
661 {
662 return( alg1 );
663 }
664 }
665 /* If the policies are from the same MAC family, check whether one
666 * of them is a minimum-MAC-length policy. Calculate the most
667 * restrictive tag length. */
668 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
669 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
670 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
671 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100672 /* Validate the combination of key type and algorithm. Since the base
673 * algorithm of alg1 and alg2 are the same, we only need this once. */
674 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100675 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100676
Steven Cooreman31a876d2021-03-03 20:47:40 +0100677 /* Get the (exact or at-least) output lengths for both sides of the
678 * requested intersection. None of the currently supported algorithms
679 * have an output length dependent on the actual key size, so setting it
680 * to a bogus value of 0 is currently OK.
681 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100682 * Note that for at-least-this-length wildcard algorithms, the output
683 * length is set to the shortest allowed length, which allows us to
684 * calculate the most restrictive tag length for the intersection. */
685 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
686 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100687 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100688
Steven Cooremana1d83222021-02-25 10:20:29 +0100689 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100690 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
691 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100692 {
Steven Cooremancd640932021-03-08 12:00:27 +0100693 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100694 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100695
696 /* If only one is an at-least-this-length policy, the intersection would
697 * be the other (fixed-length) policy as long as said fixed length is
698 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100700 {
Steven Cooremancd640932021-03-08 12:00:27 +0100701 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100702 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100703 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100704 {
Steven Cooremancd640932021-03-08 12:00:27 +0100705 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100706 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100707
Steven Cooremancd640932021-03-08 12:00:27 +0100708 /* If none of them are wildcards, check whether they define the same tag
709 * length. This is still possible here when one is default-length and
710 * the other specific-length. Ensure to always return the
711 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100712 if( alg1_len == alg2_len )
713 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100714 }
715 /* If the policies are incompatible, allow nothing. */
716 return( 0 );
717}
718
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100719static int psa_key_algorithm_permits( psa_key_type_t key_type,
720 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200721 psa_algorithm_t requested_alg )
722{
Gilles Peskine549ea862019-05-22 11:45:59 +0200723 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200724 if( requested_alg == policy_alg )
725 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100726 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
727 * and requested_alg is the same hash-and-sign family with any hash,
728 * then requested_alg is compliant with policy_alg. */
729 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
730 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200731 {
Steven Cooreman03488022021-02-18 12:07:20 +0100732 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
733 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
734 }
735 /* If policy_alg is a wildcard AEAD algorithm of the same base as
736 * the requested algorithm, check the requested tag length to be
737 * equal-length or longer than the wildcard-specified length. */
738 if( PSA_ALG_IS_AEAD( policy_alg ) &&
739 PSA_ALG_IS_AEAD( requested_alg ) &&
740 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
741 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100742 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100743 {
744 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
745 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
746 }
Steven Cooremancd640932021-03-08 12:00:27 +0100747 /* If policy_alg is a MAC algorithm of the same base as the requested
748 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100749 if( PSA_ALG_IS_MAC( policy_alg ) &&
750 PSA_ALG_IS_MAC( requested_alg ) &&
751 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100752 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100753 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100754 /* Validate the combination of key type and algorithm. Since the policy
755 * and requested algorithms are the same, we only need this once. */
756 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100757 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100758
Steven Cooreman31a876d2021-03-03 20:47:40 +0100759 /* Get both the requested output length for the algorithm which is to be
760 * verified, and the default output length for the base algorithm.
761 * Note that none of the currently supported algorithms have an output
762 * length dependent on actual key size, so setting it to a bogus value
763 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764 size_t requested_output_length = PSA_MAC_LENGTH(
765 key_type, 0, requested_alg );
766 size_t default_output_length = PSA_MAC_LENGTH(
767 key_type, 0,
768 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100769
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100770 /* If the policy is default-length, only allow an algorithm with
771 * a declared exact-length matching the default. */
772 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774
775 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100776 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
778 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
779 {
780 return( 1 );
781 }
782
Steven Cooremancd640932021-03-08 12:00:27 +0100783 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
784 * check for the requested MAC length to be equal to or longer than the
785 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100786 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
787 {
788 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100789 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200791 }
Steven Cooremance48e852020-10-05 16:02:45 +0200792 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200793 * a key derivation with that key agreement should also be allowed. This
794 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200795 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
796 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
797 {
798 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
799 policy_alg );
800 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100801 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200802 return( 0 );
803}
804
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100805/** Test whether a policy permits an algorithm.
806 *
807 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100808 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100809 * \note This function requires providing the key type for which the policy is
810 * being validated, since some algorithm policy definitions (e.g. MAC)
811 * have different properties depending on what kind of cipher it is
812 * combined with.
813 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 * \retval PSA_SUCCESS When \p alg is a specific algorithm
815 * allowed by the \p policy.
816 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
817 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
818 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100819 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100821 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100822 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823{
Steven Cooremand788fab2021-02-25 11:29:17 +0100824 /* '0' is not a valid algorithm */
825 if( alg == 0 )
826 return( PSA_ERROR_INVALID_ARGUMENT );
827
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828 /* A requested algorithm cannot be a wildcard. */
829 if( PSA_ALG_IS_WILDCARD( alg ) )
830 return( PSA_ERROR_INVALID_ARGUMENT );
831
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100832 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
833 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 return( PSA_SUCCESS );
835 else
836 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837}
838
Gilles Peskinef603c712019-01-19 13:40:11 +0100839/** Restrict a key policy based on a constraint.
840 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100841 * \note This function requires providing the key type for which the policy is
842 * being restricted, since some algorithm policy definitions (e.g. MAC)
843 * have different properties depending on what kind of cipher it is
844 * combined with.
845 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100846 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100847 * \param[in,out] policy The policy to restrict.
848 * \param[in] constraint The policy constraint to apply.
849 *
850 * \retval #PSA_SUCCESS
851 * \c *policy contains the intersection of the original value of
852 * \c *policy and \c *constraint.
853 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100854 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100855 * \c *policy is unchanged.
856 */
857static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100858 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100859 psa_key_policy_t *policy,
860 const psa_key_policy_t *constraint )
861{
862 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100863 psa_key_policy_algorithm_intersection( key_type, policy->alg,
864 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200865 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100866 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
867 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
871 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100872 policy->usage &= constraint->usage;
873 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200874 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 return( PSA_SUCCESS );
876}
877
Ronald Cron5c522922020-11-14 16:35:34 +0100878/** Get the description of a key given its identifier and policy constraints
879 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200880 *
Ronald Cron5c522922020-11-14 16:35:34 +0100881 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100882 * nonzero, the key must allow operations with this algorithm. If \p alg is
883 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100884 *
Ronald Cron5c522922020-11-14 16:35:34 +0100885 * In case of a persistent key, the function loads the description of the key
886 * into a key slot if not already done.
887 *
888 * On success, the returned key slot is locked. It is the responsibility of
889 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200890 */
Ronald Cron5c522922020-11-14 16:35:34 +0100891static psa_status_t psa_get_and_lock_key_slot_with_policy(
892 mbedtls_svc_key_id_t key,
893 psa_key_slot_t **p_slot,
894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100896{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
898 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
Ronald Cron5c522922020-11-14 16:35:34 +0100900 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100901 if( status != PSA_SUCCESS )
902 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100904
905 /* Enforce that usage policy for the key slot contains all the flags
906 * required by the usage parameter. There is one exception: public
907 * keys can always be exported, so we treat public key objects as
908 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200909 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100910 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200911
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 {
914 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200915 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100916 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100917
918 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100919 if( alg != 0 )
920 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100921 status = psa_key_policy_permits( &slot->attr.policy,
922 slot->attr.type,
923 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 if( status != PSA_SUCCESS )
925 goto error;
926 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100927
Darryl Green06fd18d2018-07-16 11:21:11 +0100928 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929
930error:
931 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100932 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200933
934 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100935}
Darryl Green940d72c2018-07-13 13:18:51 +0100936
Ronald Cron5c522922020-11-14 16:35:34 +0100937/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200938 *
939 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * available, as opposed to a key in a secure element and/or to be used
941 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200942 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200943 * This is a temporary function that may be used instead of
944 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
945 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200946 *
Ronald Cron5c522922020-11-14 16:35:34 +0100947 * On success, the returned key slot is locked. It is the responsibility of the
948 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200949 */
Ronald Cron5c522922020-11-14 16:35:34 +0100950static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
951 mbedtls_svc_key_id_t key,
952 psa_key_slot_t **p_slot,
953 psa_key_usage_t usage,
954 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955{
Ronald Cron5c522922020-11-14 16:35:34 +0100956 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
957 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200958 if( status != PSA_SUCCESS )
959 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Ronald Cronddae0f52021-08-24 15:39:44 +0200961 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 {
Ronald Cron5c522922020-11-14 16:35:34 +0100963 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 *p_slot = NULL;
965 return( PSA_ERROR_NOT_SUPPORTED );
966 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 return( PSA_SUCCESS );
969}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200970
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200971psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000972{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100973 /* Data pointer will always be either a valid pointer or NULL in an
974 * initialized slot, so we can just free it. */
975 if( slot->key.data != NULL )
976 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
977
978 mbedtls_free( slot->key.data );
979 slot->key.data = NULL;
980 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000981
982 return( PSA_SUCCESS );
983}
984
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985/** Completely wipe a slot in memory, including its policy.
986 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100987psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100988{
989 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100990
TRodziewicz18cddc02021-07-13 12:19:15 +0200991 /*
992 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200993 * do our best to report an unexpected lock counter. Assert with
994 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
995 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
996 * function is called as part of the execution of a test suite, the
997 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200998 */
Ronald Cron5c522922020-11-14 16:35:34 +0100999 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001001 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001002 status = PSA_ERROR_CORRUPTION_DETECTED;
1003 }
1004
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001005 /* Multipart operations may still be using the key. This is safe
1006 * because all multipart operation objects are independent from
1007 * the key slot: if they need to access the key after the setup
1008 * phase, they have a copy of the key. Note that this means that
1009 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001010 /* At this point, key material and other type-specific content has
1011 * been wiped. Clear remaining metadata. We can call memset and not
1012 * zeroize because the metadata is not particularly sensitive. */
1013 memset( slot, 0, sizeof( *slot ) );
1014 return( status );
1015}
1016
Ronald Croncf56a0a2020-08-04 09:51:30 +02001017psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Ronald Croncf56a0a2020-08-04 09:51:30 +02001026 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001027 return( PSA_SUCCESS );
1028
Ronald Cronf2911112020-10-29 17:51:10 +01001029 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001030 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001031 * key, this will load the key description from persistent memory if not
1032 * done yet. We cannot avoid this loading as without it we don't know if
1033 * the key is operated by an SE or not and this information is needed by
1034 * the current implementation.
1035 */
Ronald Cron5c522922020-11-14 16:35:34 +01001036 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001037 if( status != PSA_SUCCESS )
1038 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001039
Ronald Cronf2911112020-10-29 17:51:10 +01001040 /*
1041 * If the key slot containing the key description is under access by the
1042 * library (apart from the present access), the key cannot be destroyed
1043 * yet. For the time being, just return in error. Eventually (to be
1044 * implemented), the key should be destroyed when all accesses have
1045 * stopped.
1046 */
Ronald Cron5c522922020-11-14 16:35:34 +01001047 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001048 {
Ronald Cron5c522922020-11-14 16:35:34 +01001049 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001050 return( PSA_ERROR_GENERIC_ERROR );
1051 }
1052
Gilles Peskine6687cd02021-04-21 22:32:05 +02001053 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1054 {
1055 /* Refuse the destruction of a read-only key (which may or may not work
1056 * if we attempt it, depending on whether the key is merely read-only
1057 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001058 * Just do the best we can, which is to wipe the copy in memory
1059 * (done in this function's cleanup code). */
1060 overall_status = PSA_ERROR_NOT_PERMITTED;
1061 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001062 }
1063
Gilles Peskine354f7672019-07-12 23:46:38 +02001064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001065 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001066 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001067 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001068 /* For a key in a secure element, we need to do three things:
1069 * remove the key file in internal storage, destroy the
1070 * key inside the secure element, and update the driver's
1071 * persistent data. Start a transaction that will encompass these
1072 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001073 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001074 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001075 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001077 status = psa_crypto_save_transaction( );
1078 if( status != PSA_SUCCESS )
1079 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001080 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001081 /* We should still try to destroy the key in the secure
1082 * element and the key metadata in storage. This is especially
1083 * important if the error is that the storage is full.
1084 * But how to do it exactly without risking an inconsistent
1085 * state after a reset?
1086 * https://github.com/ARMmbed/mbed-crypto/issues/215
1087 */
1088 overall_status = status;
1089 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001090 }
1091
Ronald Cronea0f8a62020-11-25 17:52:23 +01001092 status = psa_destroy_se_key( driver,
1093 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001094 if( overall_status == PSA_SUCCESS )
1095 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001096 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001097#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1098
Darryl Greend49a4992018-06-18 17:27:26 +01001099#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001100 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001101 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 status = psa_destroy_persistent_key( slot->attr.id );
1103 if( overall_status == PSA_SUCCESS )
1104 overall_status = status;
1105
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001106 /* TODO: other slots may have a copy of the same key. We should
1107 * invalidate them.
1108 * https://github.com/ARMmbed/mbed-crypto/issues/214
1109 */
Darryl Greend49a4992018-06-18 17:27:26 +01001110 }
1111#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001112
Gilles Peskinefc762652019-07-22 19:30:34 +02001113#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1114 if( driver != NULL )
1115 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001116 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001117 if( overall_status == PSA_SUCCESS )
1118 overall_status = status;
1119 status = psa_crypto_stop_transaction( );
1120 if( overall_status == PSA_SUCCESS )
1121 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001122 }
1123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1124
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001126 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001128 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 overall_status = status;
1130 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001131}
1132
John Durkop07cc04a2020-11-16 22:08:34 -08001133#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001134 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001135static psa_status_t psa_get_rsa_public_exponent(
1136 const mbedtls_rsa_context *rsa,
1137 psa_key_attributes_t *attributes )
1138{
1139 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001141 uint8_t *buffer = NULL;
1142 size_t buflen;
1143 mbedtls_mpi_init( &mpi );
1144
1145 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1146 if( ret != 0 )
1147 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001148 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1149 {
1150 /* It's the default value, which is reported as an empty string,
1151 * so there's nothing to do. */
1152 goto exit;
1153 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001154
1155 buflen = mbedtls_mpi_size( &mpi );
1156 buffer = mbedtls_calloc( 1, buflen );
1157 if( buffer == NULL )
1158 {
1159 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1160 goto exit;
1161 }
1162 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1163 if( ret != 0 )
1164 goto exit;
1165 attributes->domain_parameters = buffer;
1166 attributes->domain_parameters_size = buflen;
1167
1168exit:
1169 mbedtls_mpi_free( &mpi );
1170 if( ret != 0 )
1171 mbedtls_free( buffer );
1172 return( mbedtls_to_psa_error( ret ) );
1173}
John Durkop07cc04a2020-11-16 22:08:34 -08001174#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001175 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001176
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001177/** Retrieve all the publicly-accessible attributes of a key.
1178 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001179psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001180 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001181{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001183 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001184 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001186 psa_reset_key_attributes( attributes );
1187
Ronald Cron5c522922020-11-14 16:35:34 +01001188 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001189 if( status != PSA_SUCCESS )
1190 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001191
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001192 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001193 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1194 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1195
1196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001197 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001198 psa_set_key_slot_number( attributes,
1199 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001200#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001201
Gilles Peskine8e338702019-07-30 20:06:31 +02001202 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001203 {
John Durkop07cc04a2020-11-16 22:08:34 -08001204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001205 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001206 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001208 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001209 * is not yet implemented.
1210 * https://github.com/ARMmbed/mbed-crypto/issues/216
1211 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001212 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001214 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001215
Ronald Cron90857082020-11-25 14:58:33 +01001216 status = mbedtls_psa_rsa_load_representation(
1217 slot->attr.type,
1218 slot->key.data,
1219 slot->key.bytes,
1220 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001221 if( status != PSA_SUCCESS )
1222 break;
1223
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001226 mbedtls_rsa_free( rsa );
1227 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001230#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001231 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001232 default:
1233 /* Nothing else to do. */
1234 break;
1235 }
1236
1237 if( status != PSA_SUCCESS )
1238 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001241
Ronald Cron5c522922020-11-14 16:35:34 +01001242 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001243}
1244
Gilles Peskinec8000c02019-08-02 20:15:51 +02001245#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1246psa_status_t psa_get_key_slot_number(
1247 const psa_key_attributes_t *attributes,
1248 psa_key_slot_number_t *slot_number )
1249{
1250 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1251 {
1252 *slot_number = attributes->slot_number;
1253 return( PSA_SUCCESS );
1254 }
1255 else
1256 return( PSA_ERROR_INVALID_ARGUMENT );
1257}
1258#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1259
Ronald Crond18b5f82020-11-25 16:46:05 +01001260static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1261 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001262 uint8_t *data,
1263 size_t data_size,
1264 size_t *data_length )
1265{
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001267 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001268 memcpy( data, key_buffer, key_buffer_size );
1269 memset( data + key_buffer_size, 0,
1270 data_size - key_buffer_size );
1271 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001272 return( PSA_SUCCESS );
1273}
1274
Ronald Cron7285cda2020-11-26 14:46:37 +01001275psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 const psa_key_attributes_t *attributes,
1277 const uint8_t *key_buffer, size_t key_buffer_size,
1278 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001279{
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 psa_key_type_t type = attributes->core.type;
1281
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 if( key_type_is_raw_bytes( type ) ||
1283 PSA_KEY_TYPE_IS_RSA( type ) ||
1284 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001285 {
1286 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 key_buffer, key_buffer_size,
1288 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001289 }
1290 else
1291 {
1292 /* This shouldn't happen in the reference implementation, but
1293 it is valid for a special-purpose implementation to omit
1294 support for exporting certain key types. */
1295 return( PSA_ERROR_NOT_SUPPORTED );
1296 }
1297}
1298
1299psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1300 uint8_t *data,
1301 size_t data_size,
1302 size_t *data_length )
1303{
1304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1305 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1306 psa_key_slot_t *slot;
1307
Ronald Crone907e552021-01-18 13:22:38 +01001308 /* Reject a zero-length output buffer now, since this can never be a
1309 * valid key representation. This way we know that data must be a valid
1310 * pointer and we can do things like memset(data, ..., data_size). */
1311 if( data_size == 0 )
1312 return( PSA_ERROR_BUFFER_TOO_SMALL );
1313
Ronald Cron9486f9d2020-11-26 13:36:23 +01001314 /* Set the key to empty now, so that even when there are errors, we always
1315 * set data_length to a value between 0 and data_size. On error, setting
1316 * the key to empty is a good choice because an empty key representation is
1317 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001318 *data_length = 0;
1319
Ronald Cron9486f9d2020-11-26 13:36:23 +01001320 /* Export requires the EXPORT flag. There is an exception for public keys,
1321 * which don't require any flag, but
1322 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1323 */
1324 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1325 PSA_KEY_USAGE_EXPORT, 0 );
1326 if( status != PSA_SUCCESS )
1327 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001328
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 psa_key_attributes_t attributes = {
1330 .core = slot->attr
1331 };
Ronald Cron67227982020-11-26 15:16:05 +01001332 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001333 slot->key.data, slot->key.bytes,
1334 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001335
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 unlock_status = psa_unlock_key_slot( slot );
1337
1338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1339}
1340
Ronald Cron7285cda2020-11-26 14:46:37 +01001341psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 const psa_key_attributes_t *attributes,
1343 const uint8_t *key_buffer,
1344 size_t key_buffer_size,
1345 uint8_t *data,
1346 size_t data_size,
1347 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001348{
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001350
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001352 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001354 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001355 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001356 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 key_buffer, key_buffer_size,
1358 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001359 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001360
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001362 {
John Durkop0e005192020-10-31 22:06:54 -07001363#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1364 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001365 return( mbedtls_psa_rsa_export_public_key( attributes,
1366 key_buffer,
1367 key_buffer_size,
1368 data,
1369 data_size,
1370 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001371#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001372 /* We don't know how to convert a private RSA key to public. */
1373 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001374#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1375 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001376 }
1377 else
Moran Pekera998bc62018-04-16 18:16:20 +03001378 {
John Durkop6ba40d12020-11-10 08:50:04 -08001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001381 return( mbedtls_psa_ecp_export_public_key( attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001387#else
1388 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001389 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001392 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001393 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394 else
1395 {
1396 /* This shouldn't happen in the reference implementation, but
1397 it is valid for a special-purpose implementation to omit
1398 support for exporting certain key types. */
1399 return( PSA_ERROR_NOT_SUPPORTED );
1400 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001401}
Ronald Crond18b5f82020-11-25 16:46:05 +01001402
Ronald Croncf56a0a2020-08-04 09:51:30 +02001403psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001404 uint8_t *data,
1405 size_t data_size,
1406 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001407{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001409 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001410 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001411
Ronald Crone907e552021-01-18 13:22:38 +01001412 /* Reject a zero-length output buffer now, since this can never be a
1413 * valid key representation. This way we know that data must be a valid
1414 * pointer and we can do things like memset(data, ..., data_size). */
1415 if( data_size == 0 )
1416 return( PSA_ERROR_BUFFER_TOO_SMALL );
1417
Darryl Greendd8fb772018-11-07 16:00:44 +00001418 /* Set the key to empty now, so that even when there are errors, we always
1419 * set data_length to a value between 0 and data_size. On error, setting
1420 * the key to empty is a good choice because an empty key representation is
1421 * unlikely to be accepted anywhere. */
1422 *data_length = 0;
1423
1424 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001425 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001426 if( status != PSA_SUCCESS )
1427 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001428
Ronald Cron9486f9d2020-11-26 13:36:23 +01001429 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1430 {
1431 status = PSA_ERROR_INVALID_ARGUMENT;
1432 goto exit;
1433 }
1434
Ronald Crond18b5f82020-11-25 16:46:05 +01001435 psa_key_attributes_t attributes = {
1436 .core = slot->attr
1437 };
Ronald Cron67227982020-11-26 15:16:05 +01001438 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 &attributes, slot->key.data, slot->key.bytes,
1440 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441
1442exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001443 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001444
Ronald Cron5c522922020-11-14 16:35:34 +01001445 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001446}
1447
Gilles Peskine91e8c332019-08-02 19:19:39 +02001448#if defined(static_assert)
1449static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1450 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001452 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001453static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454 "One or more key attribute flag is listed as both internal-only and external-only" );
1455#endif
1456
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001457/** Validate that a key policy is internally well-formed.
1458 *
1459 * This function only rejects invalid policies. It does not validate the
1460 * consistency of the policy with respect to other attributes of the key
1461 * such as the key type.
1462 */
1463static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001464{
1465 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001466 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001467 PSA_KEY_USAGE_ENCRYPT |
1468 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001469 PSA_KEY_USAGE_SIGN_MESSAGE |
1470 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001471 PSA_KEY_USAGE_SIGN_HASH |
1472 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001473 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1475 return( PSA_ERROR_INVALID_ARGUMENT );
1476
Gilles Peskine4747d192019-04-17 15:05:45 +02001477 return( PSA_SUCCESS );
1478}
1479
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001480/** Validate the internal consistency of key attributes.
1481 *
1482 * This function only rejects invalid attribute values. If does not
1483 * validate the consistency of the attributes with any key data that may
1484 * be involved in the creation of the key.
1485 *
1486 * Call this function early in the key creation process.
1487 *
1488 * \param[in] attributes Key attributes for the new key.
1489 * \param[out] p_drv On any return, the driver for the key, if any.
1490 * NULL for a transparent key.
1491 *
1492 */
1493static psa_status_t psa_validate_key_attributes(
1494 const psa_key_attributes_t *attributes,
1495 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001496{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001497 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001498 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001499 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001500
Ronald Cron54b90082020-10-29 15:26:43 +01001501 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001502 if( status != PSA_SUCCESS )
1503 return( status );
1504
Ronald Crond2ed4812020-07-17 16:11:30 +02001505 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001506 if( status != PSA_SUCCESS )
1507 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001508
Ronald Cron65f38a32020-10-23 17:11:13 +02001509 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1510 {
1511 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1512 return( PSA_ERROR_INVALID_ARGUMENT );
1513 }
1514 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001515 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001516 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1517 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001518 }
1519
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001520 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001521 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001522 return( status );
1523
1524 /* Refuse to create overly large keys.
1525 * Note that this doesn't trigger on import if the attributes don't
1526 * explicitly specify a size (so psa_get_key_bits returns 0), so
1527 * psa_import_key() needs its own checks. */
1528 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1529 return( PSA_ERROR_NOT_SUPPORTED );
1530
Gilles Peskine91e8c332019-08-02 19:19:39 +02001531 /* Reject invalid flags. These should not be reachable through the API. */
1532 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1533 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1534 return( PSA_ERROR_INVALID_ARGUMENT );
1535
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 return( PSA_SUCCESS );
1537}
1538
Gilles Peskine4747d192019-04-17 15:05:45 +02001539/** Prepare a key slot to receive key material.
1540 *
1541 * This function allocates a key slot and sets its metadata.
1542 *
1543 * If this function fails, call psa_fail_key_creation().
1544 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001545 * This function is intended to be used as follows:
1546 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001547 * it with the specified attributes, and in case of a volatile key assign it
1548 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001549 * -# Populate the slot with the key material.
1550 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1551 * In case of failure at any step, stop the sequence and call
1552 * psa_fail_key_creation().
1553 *
Ronald Cron5c522922020-11-14 16:35:34 +01001554 * On success, the key slot is locked. It is the responsibility of the caller
1555 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001556 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001557 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001558 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001559 * \param[out] p_slot On success, a pointer to the prepared slot.
1560 * \param[out] p_drv On any return, the driver for the key, if any.
1561 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001562 *
1563 * \retval #PSA_SUCCESS
1564 * The key slot is ready to receive key material.
1565 * \return If this function fails, the key slot is an invalid state.
1566 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001567 */
1568static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001569 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001570 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001571 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001572 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001573{
1574 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001575 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001576 psa_key_slot_t *slot;
1577
Gilles Peskinedf179142019-07-15 22:02:14 +02001578 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001579 *p_drv = NULL;
1580
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001581 status = psa_validate_key_attributes( attributes, p_drv );
1582 if( status != PSA_SUCCESS )
1583 return( status );
1584
Ronald Cronc4d1b512020-07-31 11:26:37 +02001585 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 if( status != PSA_SUCCESS )
1587 return( status );
1588 slot = *p_slot;
1589
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001590 /* We're storing the declared bit-size of the key. It's up to each
1591 * creation mechanism to verify that this information is correct.
1592 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001593 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001594 * is optional (import, copy). In case of a volatile key, assign it the
1595 * volatile key identifier associated to the slot returned to contain its
1596 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001597
1598 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001599 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1600 {
1601#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1602 slot->attr.id = volatile_key_id;
1603#else
1604 slot->attr.id.key_id = volatile_key_id;
1605#endif
1606 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001607
Gilles Peskine91e8c332019-08-02 19:19:39 +02001608 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001609 * external-only flags, query `attributes`. Thanks to the check
1610 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001611 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001612 * may have set. */
1613 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614
Gilles Peskinecbaff462019-07-12 23:46:04 +02001615#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001616 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001617 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001618 * create the key file in internal storage, create the
1619 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001620 * persistent data. This is done by starting a transaction that will
1621 * encompass these three actions.
1622 * For registering a volatile key, we just need to find an appropriate
1623 * slot number inside the SE. Since the key is designated volatile, creating
1624 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 /* The first thing to do is to find a slot number for the new key.
1626 * We save the slot number in persistent storage as part of the
1627 * transaction data. It will be needed to recover if the power
1628 * fails during the key creation process, to clean up on the secure
1629 * element side after restarting. Obtaining a slot number from the
1630 * secure element driver updates its persistent state, but we do not yet
1631 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001632 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001633 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001634 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001636 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001637 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001638 if( status != PSA_SUCCESS )
1639 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640
1641 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001642 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1644 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001645 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 psa_crypto_transaction.key.id = slot->attr.id;
1647 status = psa_crypto_save_transaction( );
1648 if( status != PSA_SUCCESS )
1649 {
1650 (void) psa_crypto_stop_transaction( );
1651 return( status );
1652 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001653 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001654
1655 status = psa_copy_key_material_into_slot(
1656 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001657 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001658
1659 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1660 {
1661 /* Key registration only makes sense with a secure element. */
1662 return( PSA_ERROR_INVALID_ARGUMENT );
1663 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001664#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1665
Ronald Cronc4d1b512020-07-31 11:26:37 +02001666 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001667}
Gilles Peskine4747d192019-04-17 15:05:45 +02001668
1669/** Finalize the creation of a key once its key material has been set.
1670 *
1671 * This entails writing the key to persistent storage.
1672 *
1673 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001674 * See the documentation of psa_start_key_creation() for the intended use
1675 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001676 *
Ronald Cron5c522922020-11-14 16:35:34 +01001677 * If the finalization succeeds, the function unlocks the key slot (it was
1678 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1679 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001680 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001681 * \param[in,out] slot Pointer to the slot with key material.
1682 * \param[in] driver The secure element driver for the key,
1683 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001684 * \param[out] key On success, identifier of the key. Note that the
1685 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001686 *
1687 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001688 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001689 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1690 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1691 * \retval #PSA_ERROR_ALREADY_EXISTS
1692 * \retval #PSA_ERROR_DATA_INVALID
1693 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001694 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001695 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001696 * \return If this function fails, the key slot is an invalid state.
1697 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001698 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001699static psa_status_t psa_finish_key_creation(
1700 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001701 psa_se_drv_table_entry_t *driver,
1702 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001703{
1704 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001705 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001706 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001707
1708#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001709 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001710 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001711#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1712 if( driver != NULL )
1713 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 psa_key_slot_number_t slot_number =
1716 psa_key_slot_get_slot_number( slot ) ;
1717
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720 sizeof( data.slot_number ),
1721 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001722#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001723 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001724 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725 (uint8_t*) &data,
1726 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727 }
1728 else
1729#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1730 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001731 /* Key material is saved in export representation in the slot, so
1732 * just pass the slot buffer for storage. */
1733 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001734 slot->key.data,
1735 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001736 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001737 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001738#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1739
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001741 /* Finish the transaction for a key creation. This does not
1742 * happen when registering an existing key. Detect this case
1743 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001744 * creation of a persistent key in a secure element requires a transaction,
1745 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001746 if( driver != NULL &&
1747 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748 {
1749 status = psa_save_se_persistent_data( driver );
1750 if( status != PSA_SUCCESS )
1751 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001752 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001753 return( status );
1754 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001755 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001756 }
1757#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1758
Ronald Cron50972942020-11-14 11:28:25 +01001759 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001760 {
1761 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001762 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001763 if( status != PSA_SUCCESS )
1764 *key = MBEDTLS_SVC_KEY_ID_INIT;
1765 }
Ronald Cron50972942020-11-14 11:28:25 +01001766
Gilles Peskine4747d192019-04-17 15:05:45 +02001767 return( status );
1768}
1769
1770/** Abort the creation of a key.
1771 *
1772 * You may call this function after calling psa_start_key_creation(),
1773 * or after psa_finish_key_creation() fails. In other circumstances, this
1774 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001775 * See the documentation of psa_start_key_creation() for the intended use
1776 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001778 * \param[in,out] slot Pointer to the slot with key material.
1779 * \param[in] driver The secure element driver for the key,
1780 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001782static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001783 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001784{
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 (void) driver;
1786
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 if( slot == NULL )
1788 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001789
1790#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001791 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 * element, and the failure happened later (when saving metadata
1793 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001794 * element.
1795 * https://github.com/ARMmbed/mbed-crypto/issues/217
1796 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001797
Gilles Peskined7729582019-08-05 15:55:54 +02001798 /* Abort the ongoing transaction if any (there may not be one if
1799 * the creation process failed before starting one, or if the
1800 * key creation is a registration of a key in a secure element).
1801 * Earlier functions must already have done what it takes to undo any
1802 * partial creation. All that's left is to update the transaction data
1803 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001804 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001805#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1806
Gilles Peskine4747d192019-04-17 15:05:45 +02001807 psa_wipe_key_slot( slot );
1808}
1809
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001810/** Validate optional attributes during key creation.
1811 *
1812 * Some key attributes are optional during key creation. If they are
1813 * specified in the attributes structure, check that they are consistent
1814 * with the data in the slot.
1815 *
1816 * This function should be called near the end of key creation, after
1817 * the slot in memory is fully populated but before saving persistent data.
1818 */
1819static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001820 const psa_key_slot_t *slot,
1821 const psa_key_attributes_t *attributes )
1822{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001823 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001825 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 return( PSA_ERROR_INVALID_ARGUMENT );
1827 }
1828
1829 if( attributes->domain_parameters_size != 0 )
1830 {
John Durkop0e005192020-10-31 22:06:54 -07001831#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1832 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001833 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001835 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001836 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001838
Ronald Cron90857082020-11-25 14:58:33 +01001839 psa_status_t status = mbedtls_psa_rsa_load_representation(
1840 slot->attr.type,
1841 slot->key.data,
1842 slot->key.bytes,
1843 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001844 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001845 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001846
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 mbedtls_mpi_init( &actual );
1848 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001851 mbedtls_rsa_free( rsa );
1852 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 if( ret != 0 )
1854 goto rsa_exit;
1855 ret = mbedtls_mpi_read_binary( &required,
1856 attributes->domain_parameters,
1857 attributes->domain_parameters_size );
1858 if( ret != 0 )
1859 goto rsa_exit;
1860 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1861 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1862 rsa_exit:
1863 mbedtls_mpi_free( &actual );
1864 mbedtls_mpi_free( &required );
1865 if( ret != 0)
1866 return( mbedtls_to_psa_error( ret ) );
1867 }
1868 else
John Durkop9814fa22020-11-04 12:28:15 -08001869#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1870 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 {
1872 return( PSA_ERROR_INVALID_ARGUMENT );
1873 }
1874 }
1875
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001876 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001878 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001879 return( PSA_ERROR_INVALID_ARGUMENT );
1880 }
1881
1882 return( PSA_SUCCESS );
1883}
1884
Gilles Peskine4747d192019-04-17 15:05:45 +02001885psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001886 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001887 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001889{
1890 psa_status_t status;
1891 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001892 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001893 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001894
Ronald Cron81709fc2020-11-14 12:10:32 +01001895 *key = MBEDTLS_SVC_KEY_ID_INIT;
1896
Gilles Peskine0f84d622019-09-12 19:03:13 +02001897 /* Reject zero-length symmetric keys (including raw data key objects).
1898 * This also rejects any key which might be encoded as an empty string,
1899 * which is never valid. */
1900 if( data_length == 0 )
1901 return( PSA_ERROR_INVALID_ARGUMENT );
1902
Gilles Peskinedf179142019-07-15 22:02:14 +02001903 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001904 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001905 if( status != PSA_SUCCESS )
1906 goto exit;
1907
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001908 /* In the case of a transparent key or an opaque key stored in local
1909 * storage (thus not in the case of generating a key in a secure element
1910 * or cryptoprocessor with storage), we have to allocate a buffer to
1911 * hold the generated key material. */
1912 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001913 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001914 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001915 if( status != PSA_SUCCESS )
1916 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001917 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001918
1919 bits = slot->attr.bits;
1920 status = psa_driver_wrapper_import_key( attributes,
1921 data, data_length,
1922 slot->key.data,
1923 slot->key.bytes,
1924 &slot->key.bytes, &bits );
1925 if( status != PSA_SUCCESS )
1926 goto exit;
1927
1928 if( slot->attr.bits == 0 )
1929 slot->attr.bits = (psa_key_bits_t) bits;
1930 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001931 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001932 status = PSA_ERROR_INVALID_ARGUMENT;
1933 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001934 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001935
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001936 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001937 if( status != PSA_SUCCESS )
1938 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001939
Ronald Cron81709fc2020-11-14 12:10:32 +01001940 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001941exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001942 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001943 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001944
Gilles Peskine4747d192019-04-17 15:05:45 +02001945 return( status );
1946}
1947
Gilles Peskined7729582019-08-05 15:55:54 +02001948#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1949psa_status_t mbedtls_psa_register_se_key(
1950 const psa_key_attributes_t *attributes )
1951{
1952 psa_status_t status;
1953 psa_key_slot_t *slot = NULL;
1954 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001955 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001956
1957 /* Leaving attributes unspecified is not currently supported.
1958 * It could make sense to query the key type and size from the
1959 * secure element, but not all secure elements support this
1960 * and the driver HAL doesn't currently support it. */
1961 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1962 return( PSA_ERROR_NOT_SUPPORTED );
1963 if( psa_get_key_bits( attributes ) == 0 )
1964 return( PSA_ERROR_NOT_SUPPORTED );
1965
1966 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001967 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001968 if( status != PSA_SUCCESS )
1969 goto exit;
1970
Ronald Cron81709fc2020-11-14 12:10:32 +01001971 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001972
1973exit:
1974 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001975 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001976
Gilles Peskined7729582019-08-05 15:55:54 +02001977 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001978 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001979 return( status );
1980}
1981#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1982
Gilles Peskinef603c712019-01-19 13:40:11 +01001983static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001984 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001985{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001986 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001987 source->key.data,
1988 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001989 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001990 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001991
Steven Cooreman398aee52020-10-13 14:35:45 +02001992 target->attr.type = source->attr.type;
1993 target->attr.bits = source->attr.bits;
1994
1995 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001996}
1997
Ronald Croncf56a0a2020-08-04 09:51:30 +02001998psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001999 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002000 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002001{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002003 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002004 psa_key_slot_t *source_slot = NULL;
2005 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002006 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002007 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002008
Ronald Cron81709fc2020-11-14 12:10:32 +01002009 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2010
Ronald Cron5c522922020-11-14 16:35:34 +01002011 status = psa_get_and_lock_transparent_key_slot_with_policy(
2012 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002013 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002014 goto exit;
2015
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002016 status = psa_validate_optional_attributes( source_slot,
2017 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002018 if( status != PSA_SUCCESS )
2019 goto exit;
2020
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002021 status = psa_restrict_key_policy( source_slot->attr.type,
2022 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002023 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002024 if( status != PSA_SUCCESS )
2025 goto exit;
2026
Ronald Cron81709fc2020-11-14 12:10:32 +01002027 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2028 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002029 if( status != PSA_SUCCESS )
2030 goto exit;
2031
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2033 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002034 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002035 /* Copying to a secure element is not implemented yet. */
2036 status = PSA_ERROR_NOT_SUPPORTED;
2037 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002038 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002039#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002040
Ronald Cron6cc66312021-04-02 12:27:47 +02002041 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2042 {
2043 /*
2044 * Copying through an opaque driver is not implemented yet, consider
2045 * a lifetime with an external location as an invalid parameter for
2046 * now.
2047 */
2048 status = PSA_ERROR_INVALID_ARGUMENT;
2049 goto exit;
2050 }
2051
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002052 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002053 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002054 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002055
Ronald Cron81709fc2020-11-14 12:10:32 +01002056 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002057exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002058 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002059 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002060
Ronald Cron5c522922020-11-14 16:35:34 +01002061 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002062
Ronald Cron5c522922020-11-14 16:35:34 +01002063 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002064}
2065
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002066
2067
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002068/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002069/* Message digests */
2070/****************************************************************/
2071
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002072psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2073{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002074 /* Aborting a non-active operation is allowed */
2075 if( operation->id == 0 )
2076 return( PSA_SUCCESS );
2077
2078 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2079 operation->id = 0;
2080
2081 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002082}
2083
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002084psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002085 psa_algorithm_t alg )
2086{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002087 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002088
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002089 /* A context must be freshly initialized before it can be set up. */
2090 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002091 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002092 status = PSA_ERROR_BAD_STATE;
2093 goto exit;
2094 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002095
2096 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002097 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002098 status = PSA_ERROR_INVALID_ARGUMENT;
2099 goto exit;
2100 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002101
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002102 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2103 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002104 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2105
Dave Rodgman685b6a72021-06-24 11:49:14 +01002106 status = psa_driver_wrapper_hash_setup( operation, alg );
2107
2108exit:
2109 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002110 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002111
2112 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002113}
2114
2115psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2116 const uint8_t *input,
2117 size_t input_length )
2118{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002119 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2120
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002121 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002122 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002123 status = PSA_ERROR_BAD_STATE;
2124 goto exit;
2125 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002126
Steven Cooremanc8288352021-03-04 14:02:19 +01002127 /* Don't require hash implementations to behave correctly on a
2128 * zero-length input, which may have an invalid pointer. */
2129 if( input_length == 0 )
2130 return( PSA_SUCCESS );
2131
Dave Rodgman685b6a72021-06-24 11:49:14 +01002132 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2133
2134exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002135 if( status != PSA_SUCCESS )
2136 psa_hash_abort( operation );
2137
2138 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002139}
2140
2141psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2142 uint8_t *hash,
2143 size_t hash_size,
2144 size_t *hash_length )
2145{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002146 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 if( operation->id == 0 )
2148 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149
Steven Cooreman1e582352021-02-18 17:24:37 +01002150 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002151 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002152 psa_hash_abort( operation );
2153 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002154}
2155
Gilles Peskine2d277862018-06-18 15:41:12 +02002156psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2157 const uint8_t *hash,
2158 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002159{
2160 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2161 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002162 psa_status_t status = psa_hash_finish(
2163 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002164 actual_hash, sizeof( actual_hash ),
2165 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002166
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002168 goto exit;
2169
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002171 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002172 status = PSA_ERROR_INVALID_SIGNATURE;
2173 goto exit;
2174 }
2175
Steven Cooreman36876a02021-04-29 16:37:59 +02002176 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002177 status = PSA_ERROR_INVALID_SIGNATURE;
2178
2179exit:
2180 if( status != PSA_SUCCESS )
2181 psa_hash_abort(operation);
2182
2183 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184}
2185
Gilles Peskine0a749c82019-11-28 19:33:58 +01002186psa_status_t psa_hash_compute( psa_algorithm_t alg,
2187 const uint8_t *input, size_t input_length,
2188 uint8_t *hash, size_t hash_size,
2189 size_t *hash_length )
2190{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002191 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002192 if( !PSA_ALG_IS_HASH( alg ) )
2193 return( PSA_ERROR_INVALID_ARGUMENT );
2194
Steven Cooreman1e582352021-02-18 17:24:37 +01002195 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2196 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002197}
2198
2199psa_status_t psa_hash_compare( psa_algorithm_t alg,
2200 const uint8_t *input, size_t input_length,
2201 const uint8_t *hash, size_t hash_length )
2202{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002203 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2204 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002205
2206 if( !PSA_ALG_IS_HASH( alg ) )
2207 return( PSA_ERROR_INVALID_ARGUMENT );
2208
Steven Cooreman1e582352021-02-18 17:24:37 +01002209 psa_status_t status = psa_driver_wrapper_hash_compute(
2210 alg, input, input_length,
2211 actual_hash, sizeof(actual_hash),
2212 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002213 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002214 return( status );
2215 if( actual_hash_length != hash_length )
2216 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002217 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002218 return( PSA_ERROR_INVALID_SIGNATURE );
2219 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002220}
2221
Gilles Peskineeb35d782019-01-22 17:56:16 +01002222psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2223 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002224{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002225 if( source_operation->id == 0 ||
2226 target_operation->id != 0 )
2227 {
2228 return( PSA_ERROR_BAD_STATE );
2229 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002230
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002231 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2232 target_operation );
2233 if( status != PSA_SUCCESS )
2234 psa_hash_abort( target_operation );
2235
2236 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002237}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002238
2239
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002241/* MAC */
2242/****************************************************************/
2243
Steven Cooremane6804192021-03-19 18:28:56 +01002244psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002245{
Steven Cooremane6804192021-03-19 18:28:56 +01002246 /* Aborting a non-active operation is allowed */
2247 if( operation->id == 0 )
2248 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002249
Steven Cooremane6804192021-03-19 18:28:56 +01002250 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002251 operation->mac_size = 0;
2252 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002253 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002254
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002255 return( status );
2256}
2257
Ronald Cron2dff3b22021-06-17 16:33:22 +02002258static psa_status_t psa_mac_finalize_alg_and_key_validation(
2259 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002260 const psa_key_attributes_t *attributes,
2261 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002262{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002264 psa_key_type_t key_type = psa_get_key_type( attributes );
2265 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002266
Ronald Cron28ea0502021-06-17 16:10:24 +02002267 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002268 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002269
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002270 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002271 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002272 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002273 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002274
Steven Cooremand1a68f12021-05-10 11:13:41 +02002275 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002276 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002277
Ronald Cron79bdd822021-06-17 16:46:44 +02002278 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002279 {
2280 /* A very short MAC is too short for security since it can be
2281 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2282 * so we make this our minimum, even though 32 bits is still
2283 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002284 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002285 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002286
Ronald Cron79bdd822021-06-17 16:46:44 +02002287 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2288 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002289 {
2290 /* It's impossible to "truncate" to a larger length than the full length
2291 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002292 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002293 }
2294
Ronald Cron79bdd822021-06-17 16:46:44 +02002295 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002296}
2297
Gilles Peskinee59236f2018-01-27 23:32:46 +01002298static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2299 mbedtls_svc_key_id_t key,
2300 psa_algorithm_t alg,
2301 int is_sign )
2302{
2303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2304 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002305 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002306
2307 /* A context must be freshly initialized before it can be set up. */
2308 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002309 {
Dave Rodgman54648242021-06-24 11:49:45 +01002310 status = PSA_ERROR_BAD_STATE;
2311 goto exit;
2312 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002313
Gilles Peskine8c9def32018-02-08 10:02:12 +01002314 status = psa_get_and_lock_key_slot_with_policy(
2315 key,
2316 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002317 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002318 alg );
2319 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002320 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321
2322 psa_key_attributes_t attributes = {
2323 .core = slot->attr
2324 };
2325
Ronald Cron79bdd822021-06-17 16:46:44 +02002326 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2327 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328 if( status != PSA_SUCCESS )
2329 goto exit;
2330
2331 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002332 /* Dispatch the MAC setup call with validated input */
2333 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002334 {
Steven Cooremane6804192021-03-19 18:28:56 +01002335 status = psa_driver_wrapper_mac_sign_setup( operation,
2336 &attributes,
2337 slot->key.data,
2338 slot->key.bytes,
2339 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002340 }
2341 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002342 {
Steven Cooremane6804192021-03-19 18:28:56 +01002343 status = psa_driver_wrapper_mac_verify_setup( operation,
2344 &attributes,
2345 slot->key.data,
2346 slot->key.bytes,
2347 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002348 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002349
Gilles Peskinefbfac682018-07-08 20:51:54 +02002350exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002351 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002352 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002353
Ronald Cron5c522922020-11-14 16:35:34 +01002354 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002355
Ronald Cron5c522922020-11-14 16:35:34 +01002356 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002357}
2358
Gilles Peskine89167cb2018-07-08 20:12:23 +02002359psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002360 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002361 psa_algorithm_t alg )
2362{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002363 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002364}
2365
2366psa_status_t psa_mac_verify_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, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002371}
2372
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002373psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002374 const uint8_t *input,
2375 size_t input_length )
2376{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002377 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002378 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002379
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002380 /* Don't require hash implementations to behave correctly on a
2381 * zero-length input, which may have an invalid pointer. */
2382 if( input_length == 0 )
2383 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002384
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002385 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2386 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002387 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002388 psa_mac_abort( operation );
2389
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002390 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002391}
2392
Steven Cooremana5b860a2021-03-19 19:04:39 +01002393psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002394 uint8_t *mac,
2395 size_t mac_size,
2396 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002397{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2399 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002400
Steven Cooremana5b860a2021-03-19 19:04:39 +01002401 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002402 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002403 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002404 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002405 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002406
Steven Cooreman72f736a2021-05-07 14:14:37 +02002407 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002408 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002409 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002410 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002411 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002412
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002413 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2414 * once all the error checks are done. */
2415 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002416 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002417 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002418 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002419 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002420
2421 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002422 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002423 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002424 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002425 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002426
Steven Cooremana5b860a2021-03-19 19:04:39 +01002427 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002428 mac, operation->mac_size,
2429 mac_length );
2430
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002431exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002432 /* In case of success, set the potential excess room in the output buffer
2433 * to an invalid value, to avoid potentially leaking a longer MAC.
2434 * In case of error, set the output length and content to a safe default,
2435 * such that in case the caller misses an error check, the output would be
2436 * an unachievable MAC.
2437 */
2438 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002439 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002440 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002441 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002442 }
mohammad16036df908f2018-04-02 08:34:15 -07002443
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002444 if( mac_size > operation->mac_size )
2445 memset( &mac[operation->mac_size], '!',
2446 mac_size - operation->mac_size );
2447
Steven Cooremana5b860a2021-03-19 19:04:39 +01002448 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002449
Steven Cooremana5b860a2021-03-19 19:04:39 +01002450 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002451}
2452
Steven Cooremana5b860a2021-03-19 19:04:39 +01002453psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002454 const uint8_t *mac,
2455 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002456{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2458 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002459
Steven Cooremana5b860a2021-03-19 19:04:39 +01002460 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002461 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002462 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002463 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002464 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002465
Steven Cooreman72f736a2021-05-07 14:14:37 +02002466 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002467 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002468 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002469 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002470 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002471
2472 if( operation->mac_size != mac_length )
2473 {
2474 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002475 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002476 }
2477
Steven Cooremana5b860a2021-03-19 19:04:39 +01002478 status = psa_driver_wrapper_mac_verify_finish( operation,
2479 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002480
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002481exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002482 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002483
Steven Cooremana5b860a2021-03-19 19:04:39 +01002484 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485}
2486
Ronald Croncd989b52021-06-18 14:23:33 +02002487static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2488 psa_algorithm_t alg,
2489 const uint8_t *input,
2490 size_t input_length,
2491 uint8_t *mac,
2492 size_t mac_size,
2493 size_t *mac_length,
2494 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002495{
2496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002497 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2498 psa_key_slot_t *slot;
2499 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002500
Ronald Cron51131b52021-06-17 17:17:20 +02002501 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002502 key,
2503 &slot,
2504 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002505 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002506 if( status != PSA_SUCCESS )
2507 goto exit;
2508
Ronald Cron51131b52021-06-17 17:17:20 +02002509 psa_key_attributes_t attributes = {
2510 .core = slot->attr
2511 };
2512
2513 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2514 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002515 if( status != PSA_SUCCESS )
2516 goto exit;
2517
Ronald Cron51131b52021-06-17 17:17:20 +02002518 if( mac_size < operation_mac_size )
2519 {
2520 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002521 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002522 }
2523
2524 status = psa_driver_wrapper_mac_compute(
2525 &attributes,
2526 slot->key.data, slot->key.bytes,
2527 alg,
2528 input, input_length,
2529 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002530
2531exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002532 /* In case of success, set the potential excess room in the output buffer
2533 * to an invalid value, to avoid potentially leaking a longer MAC.
2534 * In case of error, set the output length and content to a safe default,
2535 * such that in case the caller misses an error check, the output would be
2536 * an unachievable MAC.
2537 */
2538 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002539 {
Ronald Cron51131b52021-06-17 17:17:20 +02002540 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002541 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002542 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002543 if( mac_size > operation_mac_size )
2544 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002545
Ronald Cron51131b52021-06-17 17:17:20 +02002546 unlock_status = psa_unlock_key_slot( slot );
2547
2548 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002549}
2550
Ronald Croncd989b52021-06-18 14:23:33 +02002551psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2552 psa_algorithm_t alg,
2553 const uint8_t *input,
2554 size_t input_length,
2555 uint8_t *mac,
2556 size_t mac_size,
2557 size_t *mac_length)
2558{
2559 return( psa_mac_compute_internal( key, alg,
2560 input, input_length,
2561 mac, mac_size, mac_length, 1 ) );
2562}
2563
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002564psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2565 psa_algorithm_t alg,
2566 const uint8_t *input,
2567 size_t input_length,
2568 const uint8_t *mac,
2569 size_t mac_length)
2570{
2571 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002572 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2573 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002574
Ronald Crona587cbc2021-06-18 14:51:29 +02002575 status = psa_mac_compute_internal( key, alg,
2576 input, input_length,
2577 actual_mac, sizeof( actual_mac ),
2578 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002579 if( status != PSA_SUCCESS )
2580 goto exit;
2581
Ronald Crona587cbc2021-06-18 14:51:29 +02002582 if( mac_length != actual_mac_length )
2583 {
2584 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002585 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002586 }
2587 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2588 {
2589 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002590 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002591 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002592
2593exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002594 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002595
2596 return ( status );
2597}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002598
Gilles Peskinee59236f2018-01-27 23:32:46 +01002599/****************************************************************/
2600/* Asymmetric cryptography */
2601/****************************************************************/
2602
gabor-mezei-armf0486182021-05-12 11:03:09 +02002603static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002604 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002605{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002606 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002607 {
2608 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2609 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002610
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002611 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2612 {
2613 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2614 return( PSA_ERROR_INVALID_ARGUMENT );
2615 }
2616 }
2617 else
2618 {
2619 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2620 return( PSA_ERROR_INVALID_ARGUMENT );
2621 }
2622
2623 return( PSA_SUCCESS );
2624}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002625
2626static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002627 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002628 psa_algorithm_t alg,
2629 const uint8_t * input,
2630 size_t input_length,
2631 uint8_t * signature,
2632 size_t signature_size,
2633 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002634{
2635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2636 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2637 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002638
2639 *signature_length = 0;
2640
gabor-mezei-armf0486182021-05-12 11:03:09 +02002641 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002642 if( status != PSA_SUCCESS )
2643 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002644
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002645 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002646 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002647 * buffer can in principle be empty since it doesn't actually have
2648 * to be a hash.) */
2649 if( signature_size == 0 )
2650 return( PSA_ERROR_BUFFER_TOO_SMALL );
2651
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002652 status = psa_get_and_lock_key_slot_with_policy(
2653 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002654 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2655 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002656 alg );
2657
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002658 if( status != PSA_SUCCESS )
2659 goto exit;
2660
2661 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2662 {
2663 status = PSA_ERROR_INVALID_ARGUMENT;
2664 goto exit;
2665 }
2666
2667 psa_key_attributes_t attributes = {
2668 .core = slot->attr
2669 };
2670
gabor-mezei-armf0486182021-05-12 11:03:09 +02002671 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002672 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002673 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002674 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002675 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002676 signature, signature_size, signature_length );
2677 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002678 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002679 {
2680
2681 status = psa_driver_wrapper_sign_hash(
2682 &attributes, slot->key.data, slot->key.bytes,
2683 alg, input, input_length,
2684 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002685 }
2686
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002687
2688exit:
2689 /* Fill the unused part of the output buffer (the whole buffer on error,
2690 * the trailing part on success) with something that isn't a valid signature
2691 * (barring an attack on the signature and deliberately-crafted input),
2692 * in case the caller doesn't check the return status properly. */
2693 if( status == PSA_SUCCESS )
2694 memset( signature + *signature_length, '!',
2695 signature_size - *signature_length );
2696 else
2697 memset( signature, '!', signature_size );
2698 /* If signature_size is 0 then we have nothing to do. We must not call
2699 * memset because signature may be NULL in this case. */
2700
2701 unlock_status = psa_unlock_key_slot( slot );
2702
2703 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2704}
2705
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002706static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002707 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002708 psa_algorithm_t alg,
2709 const uint8_t * input,
2710 size_t input_length,
2711 const uint8_t * signature,
2712 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002713{
2714 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2715 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2716 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002717
gabor-mezei-armf0486182021-05-12 11:03:09 +02002718 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002719 if( status != PSA_SUCCESS )
2720 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002721
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002722 status = psa_get_and_lock_key_slot_with_policy(
2723 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002724 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2725 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002726 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002728 if( status != PSA_SUCCESS )
2729 return( status );
2730
2731 psa_key_attributes_t attributes = {
2732 .core = slot->attr
2733 };
2734
gabor-mezei-armf0486182021-05-12 11:03:09 +02002735 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002736 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002737 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002738 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002739 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002740 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002742 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002743 {
2744 status = psa_driver_wrapper_verify_hash(
2745 &attributes, slot->key.data, slot->key.bytes,
2746 alg, input, input_length,
2747 signature, signature_length );
2748 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002749
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002750 unlock_status = psa_unlock_key_slot( slot );
2751
2752 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002753
2754}
2755
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002756psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002757 const psa_key_attributes_t *attributes,
2758 const uint8_t *key_buffer,
2759 size_t key_buffer_size,
2760 psa_algorithm_t alg,
2761 const uint8_t *input,
2762 size_t input_length,
2763 uint8_t *signature,
2764 size_t signature_size,
2765 size_t *signature_length )
2766{
2767 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002768
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002769 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2770 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002771 size_t hash_length;
2772 uint8_t hash[PSA_HASH_MAX_SIZE];
2773
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002774 status = psa_driver_wrapper_hash_compute(
2775 PSA_ALG_SIGN_GET_HASH( alg ),
2776 input, input_length,
2777 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002778
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002779 if( status != PSA_SUCCESS )
2780 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002781
2782 return psa_driver_wrapper_sign_hash(
2783 attributes, key_buffer, key_buffer_size,
2784 alg, hash, hash_length,
2785 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002786 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002787
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002788 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002789}
2790
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002791psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2792 psa_algorithm_t alg,
2793 const uint8_t * input,
2794 size_t input_length,
2795 uint8_t * signature,
2796 size_t signature_size,
2797 size_t * signature_length )
2798{
2799 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002800 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002801 signature, signature_size, signature_length );
2802}
2803
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002804psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002805 const psa_key_attributes_t *attributes,
2806 const uint8_t *key_buffer,
2807 size_t key_buffer_size,
2808 psa_algorithm_t alg,
2809 const uint8_t *input,
2810 size_t input_length,
2811 const uint8_t *signature,
2812 size_t signature_length )
2813{
2814 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002815
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002816 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2817 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002818 size_t hash_length;
2819 uint8_t hash[PSA_HASH_MAX_SIZE];
2820
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002821 status = psa_driver_wrapper_hash_compute(
2822 PSA_ALG_SIGN_GET_HASH( alg ),
2823 input, input_length,
2824 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002826 if( status != PSA_SUCCESS )
2827 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002828
2829 return psa_driver_wrapper_verify_hash(
2830 attributes, key_buffer, key_buffer_size,
2831 alg, hash, hash_length,
2832 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002833 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002834
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002835 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002836}
2837
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002838psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2839 psa_algorithm_t alg,
2840 const uint8_t * input,
2841 size_t input_length,
2842 const uint8_t * signature,
2843 size_t signature_length )
2844{
2845 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002846 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002847 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002848}
2849
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002850psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002851 const psa_key_attributes_t *attributes,
2852 const uint8_t *key_buffer, size_t key_buffer_size,
2853 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2854 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002855{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002856 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002857 {
Ronald Cron4501c982021-03-19 20:09:32 +01002858 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2859 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002860 {
Ronald Cron4501c982021-03-19 20:09:32 +01002861#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2862 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2863 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002864 attributes,
2865 key_buffer, key_buffer_size,
2866 alg, hash, hash_length,
2867 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002868#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2869 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002870 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002871 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002872 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002873 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002874 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002875 }
2876 else
Ronald Cron4501c982021-03-19 20:09:32 +01002877 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2878 {
2879 if( PSA_ALG_IS_ECDSA( alg ) )
2880 {
2881#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2882 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2883 return( mbedtls_psa_ecdsa_sign_hash(
2884 attributes,
2885 key_buffer, key_buffer_size,
2886 alg, hash, hash_length,
2887 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002888#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2889 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002890 }
2891 else
2892 {
2893 return( PSA_ERROR_INVALID_ARGUMENT );
2894 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002895 }
Ronald Cron4501c982021-03-19 20:09:32 +01002896
2897 (void)key_buffer;
2898 (void)key_buffer_size;
2899 (void)hash;
2900 (void)hash_length;
2901 (void)signature;
2902 (void)signature_size;
2903 (void)signature_length;
2904
2905 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002906}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002907
2908psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2909 psa_algorithm_t alg,
2910 const uint8_t *hash,
2911 size_t hash_length,
2912 uint8_t *signature,
2913 size_t signature_size,
2914 size_t *signature_length )
2915{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002916 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002917 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002918 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002919}
2920
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002921psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002922 const psa_key_attributes_t *attributes,
2923 const uint8_t *key_buffer, size_t key_buffer_size,
2924 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2925 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002926{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002927 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002928 {
Ronald Cron4501c982021-03-19 20:09:32 +01002929 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2930 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002931 {
Ronald Cron4501c982021-03-19 20:09:32 +01002932#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2933 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2934 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002935 attributes,
2936 key_buffer, key_buffer_size,
2937 alg, hash, hash_length,
2938 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002939#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2940 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002941 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002942 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002943 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002944 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002945 }
itayzafrir5c753392018-05-08 11:18:38 +03002946 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002947 else
Ronald Cron4501c982021-03-19 20:09:32 +01002948 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002949 {
Ronald Cron4501c982021-03-19 20:09:32 +01002950 if( PSA_ALG_IS_ECDSA( alg ) )
2951 {
2952#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2953 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2954 return( mbedtls_psa_ecdsa_verify_hash(
2955 attributes,
2956 key_buffer, key_buffer_size,
2957 alg, hash, hash_length,
2958 signature, signature_length ) );
2959#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2960 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2961 }
2962 else
2963 {
2964 return( PSA_ERROR_INVALID_ARGUMENT );
2965 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002966 }
Ronald Cron4501c982021-03-19 20:09:32 +01002967
2968 (void)key_buffer;
2969 (void)key_buffer_size;
2970 (void)hash;
2971 (void)hash_length;
2972 (void)signature;
2973 (void)signature_length;
2974
2975 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002976}
2977
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002978psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2979 psa_algorithm_t alg,
2980 const uint8_t *hash,
2981 size_t hash_length,
2982 const uint8_t *signature,
2983 size_t signature_length )
2984{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002985 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002986 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002987 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002988}
2989
John Durkop0e005192020-10-31 22:06:54 -07002990#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002991static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2992 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002993{
2994 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2995 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2996 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002997
2998 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002999}
John Durkop0e005192020-10-31 22:06:54 -07003000#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003001
Ronald Croncf56a0a2020-08-04 09:51:30 +02003002psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003003 psa_algorithm_t alg,
3004 const uint8_t *input,
3005 size_t input_length,
3006 const uint8_t *salt,
3007 size_t salt_length,
3008 uint8_t *output,
3009 size_t output_size,
3010 size_t *output_length )
3011{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003013 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003014 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003015
Darryl Green5cc689a2018-07-24 15:34:10 +01003016 (void) input;
3017 (void) input_length;
3018 (void) salt;
3019 (void) output;
3020 (void) output_size;
3021
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003022 *output_length = 0;
3023
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003024 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3025 return( PSA_ERROR_INVALID_ARGUMENT );
3026
Ronald Cron5c522922020-11-14 16:35:34 +01003027 status = psa_get_and_lock_transparent_key_slot_with_policy(
3028 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003029 if( status != PSA_SUCCESS )
3030 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003031 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3032 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003033 {
3034 status = PSA_ERROR_INVALID_ARGUMENT;
3035 goto exit;
3036 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003037
John Durkop6ba40d12020-11-10 08:50:04 -08003038#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3039 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003040 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003042 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003043 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3044 slot->key.data,
3045 slot->key.bytes,
3046 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003047 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003048 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003049
3050 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003051 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003052 status = PSA_ERROR_BUFFER_TOO_SMALL;
3053 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003054 }
John Durkop0e005192020-10-31 22:06:54 -07003055#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3057 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003058 status = mbedtls_to_psa_error(
3059 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003060 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003061 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003062 input_length,
3063 input,
3064 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003065 }
3066 else
John Durkop0e005192020-10-31 22:06:54 -07003067#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3068#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003069 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3070 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003071 status = mbedtls_to_psa_error(
3072 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3073 if( status != PSA_SUCCESS )
3074 goto rsa_exit;
3075
Steven Cooreman4fed4552020-08-03 14:46:03 +02003076 status = mbedtls_to_psa_error(
3077 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003078 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003079 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003080 salt, salt_length,
3081 input_length,
3082 input,
3083 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003084 }
3085 else
John Durkop0e005192020-10-31 22:06:54 -07003086#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003087 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003088 status = PSA_ERROR_INVALID_ARGUMENT;
3089 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003091rsa_exit:
3092 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003093 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003094
Steven Cooremana2371e52020-07-28 14:30:39 +02003095 mbedtls_rsa_free( rsa );
3096 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003098 else
John Durkop9814fa22020-11-04 12:28:15 -08003099#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003100 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003102 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003104
3105exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003106 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003107
Ronald Cron5c522922020-11-14 16:35:34 +01003108 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003109}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110
Ronald Croncf56a0a2020-08-04 09:51:30 +02003111psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003112 psa_algorithm_t alg,
3113 const uint8_t *input,
3114 size_t input_length,
3115 const uint8_t *salt,
3116 size_t salt_length,
3117 uint8_t *output,
3118 size_t output_size,
3119 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003122 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003123 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003124
Darryl Green5cc689a2018-07-24 15:34:10 +01003125 (void) input;
3126 (void) input_length;
3127 (void) salt;
3128 (void) output;
3129 (void) output_size;
3130
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003131 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003132
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003133 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3134 return( PSA_ERROR_INVALID_ARGUMENT );
3135
Ronald Cron5c522922020-11-14 16:35:34 +01003136 status = psa_get_and_lock_transparent_key_slot_with_policy(
3137 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003138 if( status != PSA_SUCCESS )
3139 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003140 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003141 {
3142 status = PSA_ERROR_INVALID_ARGUMENT;
3143 goto exit;
3144 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003145
John Durkop6ba40d12020-11-10 08:50:04 -08003146#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3147 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003148 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003149 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003150 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003151 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3152 slot->key.data,
3153 slot->key.bytes,
3154 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003155 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003156 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003157
Steven Cooremana2371e52020-07-28 14:30:39 +02003158 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003159 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160 status = PSA_ERROR_INVALID_ARGUMENT;
3161 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003162 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003163
John Durkop0e005192020-10-31 22:06:54 -07003164#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003165 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003167 status = mbedtls_to_psa_error(
3168 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003169 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003170 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003171 output_length,
3172 input,
3173 output,
3174 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003175 }
3176 else
John Durkop0e005192020-10-31 22:06:54 -07003177#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3178#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003179 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003181 status = mbedtls_to_psa_error(
3182 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3183 if( status != PSA_SUCCESS )
3184 goto rsa_exit;
3185
Steven Cooreman4fed4552020-08-03 14:46:03 +02003186 status = mbedtls_to_psa_error(
3187 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003188 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003189 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003190 salt, salt_length,
3191 output_length,
3192 input,
3193 output,
3194 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195 }
3196 else
John Durkop0e005192020-10-31 22:06:54 -07003197#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003198 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003199 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003200 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003201
Steven Cooreman4fed4552020-08-03 14:46:03 +02003202rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003203 mbedtls_rsa_free( rsa );
3204 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003206 else
John Durkop6ba40d12020-11-10 08:50:04 -08003207#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3208 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003209 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003210 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003212
3213exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003214 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003215
Ronald Cron5c522922020-11-14 16:35:34 +01003216 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003217}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003218
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003219
3220
mohammad1603503973b2018-03-12 15:59:30 +02003221/****************************************************************/
3222/* Symmetric cryptography */
3223/****************************************************************/
3224
Ronald Cronab99ac22020-10-01 16:38:28 +02003225static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3226 mbedtls_svc_key_id_t key,
3227 psa_algorithm_t alg,
3228 mbedtls_operation_t cipher_operation )
3229{
3230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3231 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003232 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003233 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3234 PSA_KEY_USAGE_ENCRYPT :
3235 PSA_KEY_USAGE_DECRYPT );
3236
3237 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003238 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003239 {
Dave Rodgman54648242021-06-24 11:49:45 +01003240 status = PSA_ERROR_BAD_STATE;
3241 goto exit;
3242 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003243
Ronald Cronab99ac22020-10-01 16:38:28 +02003244 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003245 {
Dave Rodgman54648242021-06-24 11:49:45 +01003246 status = PSA_ERROR_INVALID_ARGUMENT;
3247 goto exit;
3248 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003249
Ronald Cronab99ac22020-10-01 16:38:28 +02003250 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3251 if( status != PSA_SUCCESS )
3252 goto exit;
3253
Ronald Cron49fafa92021-03-10 08:34:23 +01003254 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003255 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003256 * so we only set it (in the driver wrapper) after resources have been
3257 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003258 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003259 if( alg == PSA_ALG_ECB_NO_PADDING )
3260 operation->iv_required = 0;
3261 else
3262 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003263 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003264
Ronald Crona4af55f2020-12-14 14:36:06 +01003265 psa_key_attributes_t attributes = {
3266 .core = slot->attr
3267 };
3268
Ronald Cronab99ac22020-10-01 16:38:28 +02003269 /* Try doing the operation through a driver before using software fallback. */
3270 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003271 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3272 &attributes,
3273 slot->key.data,
3274 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003275 alg );
3276 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003277 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3278 &attributes,
3279 slot->key.data,
3280 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003281 alg );
3282
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003283exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003284 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003285 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003286
Ronald Cron5c522922020-11-14 16:35:34 +01003287 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003288
Ronald Cron5c522922020-11-14 16:35:34 +01003289 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003290}
3291
Gilles Peskinefe119512018-07-08 21:39:34 +02003292psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003293 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003294 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003295{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003296 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003297}
3298
Gilles Peskinefe119512018-07-08 21:39:34 +02003299psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003300 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003301 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003302{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003303 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003304}
3305
Gilles Peskinefe119512018-07-08 21:39:34 +02003306psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003307 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003308 size_t iv_size,
3309 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003310{
Ronald Cron6d051732020-10-01 14:10:20 +02003311 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003312
Ronald Cron5618a392021-03-26 09:52:26 +01003313 *iv_length = 0;
3314
Ronald Cron49fafa92021-03-10 08:34:23 +01003315 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003316 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003317 status = PSA_ERROR_BAD_STATE;
3318 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003319 }
3320
Steven Cooreman7df02922020-09-09 15:28:49 +02003321 if( operation->iv_set || ! operation->iv_required )
3322 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003323 status = PSA_ERROR_BAD_STATE;
3324 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003325 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003326
Ronald Cron5618a392021-03-26 09:52:26 +01003327 if( iv_size < operation->default_iv_length )
3328 {
3329 status = PSA_ERROR_BUFFER_TOO_SMALL;
3330 goto exit;
3331 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003332
Ronald Cron5618a392021-03-26 09:52:26 +01003333 status = psa_generate_random( iv, operation->default_iv_length );
3334 if( status != PSA_SUCCESS )
3335 goto exit;
3336
3337 status = psa_driver_wrapper_cipher_set_iv( operation,
3338 iv,
3339 operation->default_iv_length );
3340
3341exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003342 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003343 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003344 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003345 *iv_length = operation->default_iv_length;
3346 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003347 else
Moran Peker395db872018-05-31 14:07:14 +03003348 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003349
itayzafrir534bd7c2018-08-02 13:56:32 +03003350 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003351}
3352
Gilles Peskinefe119512018-07-08 21:39:34 +02003353psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003354 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003355 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003356{
Ronald Cron6d051732020-10-01 14:10:20 +02003357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003358
Ronald Cron49fafa92021-03-10 08:34:23 +01003359 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003360 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003361 status = PSA_ERROR_BAD_STATE;
3362 goto exit;
3363 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003364
Steven Cooreman7df02922020-09-09 15:28:49 +02003365 if( operation->iv_set || ! operation->iv_required )
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 Crona0d68172021-03-26 10:15:08 +01003370
3371 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003372 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003373 status = PSA_ERROR_INVALID_ARGUMENT;
3374 goto exit;
3375 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003376
Ronald Crondd24c9b2020-12-15 14:10:01 +01003377 status = psa_driver_wrapper_cipher_set_iv( operation,
3378 iv,
3379 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003380
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003381exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003382 if( status == PSA_SUCCESS )
3383 operation->iv_set = 1;
3384 else
mohammad1603503973b2018-03-12 15:59:30 +02003385 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003386 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003387}
3388
Gilles Peskinee553c652018-06-04 16:22:46 +02003389psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3390 const uint8_t *input,
3391 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003392 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003393 size_t output_size,
3394 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003395{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003397
Ronald Cron49fafa92021-03-10 08:34:23 +01003398 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003399 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003400 status = PSA_ERROR_BAD_STATE;
3401 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003402 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003403
Steven Cooreman7df02922020-09-09 15:28:49 +02003404 if( operation->iv_required && ! operation->iv_set )
3405 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003406 status = PSA_ERROR_BAD_STATE;
3407 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003408 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003409
Ronald Crondd24c9b2020-12-15 14:10:01 +01003410 status = psa_driver_wrapper_cipher_update( operation,
3411 input,
3412 input_length,
3413 output,
3414 output_size,
3415 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003416
3417exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003418 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003419 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003420
itayzafrir534bd7c2018-08-02 13:56:32 +03003421 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003422}
3423
Gilles Peskinee553c652018-06-04 16:22:46 +02003424psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3425 uint8_t *output,
3426 size_t output_size,
3427 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003428{
David Saadab4ecc272019-02-14 13:48:10 +02003429 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003430
Ronald Cron49fafa92021-03-10 08:34:23 +01003431 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003432 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003433 status = PSA_ERROR_BAD_STATE;
3434 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003435 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003436
Steven Cooreman7df02922020-09-09 15:28:49 +02003437 if( operation->iv_required && ! operation->iv_set )
3438 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003439 status = PSA_ERROR_BAD_STATE;
3440 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003441 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003442
Ronald Crondd24c9b2020-12-15 14:10:01 +01003443 status = psa_driver_wrapper_cipher_finish( operation,
3444 output,
3445 output_size,
3446 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003447
3448exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003449 if( status == PSA_SUCCESS )
3450 return( psa_cipher_abort( operation ) );
3451 else
3452 {
3453 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003454 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003455
Steven Cooremanef8575e2020-09-11 11:44:50 +02003456 return( status );
3457 }
mohammad1603503973b2018-03-12 15:59:30 +02003458}
3459
Gilles Peskinee553c652018-06-04 16:22:46 +02003460psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3461{
Ronald Cron49fafa92021-03-10 08:34:23 +01003462 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003463 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003464 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003465 * in use. It's ok to call abort on such an object, and there's
3466 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003467 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003468 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003469
Ronald Crondd24c9b2020-12-15 14:10:01 +01003470 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003471
Ronald Cron49fafa92021-03-10 08:34:23 +01003472 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003473 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003474 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003475
Moran Peker395db872018-05-31 14:07:14 +03003476 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003477}
3478
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003479psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3480 psa_algorithm_t alg,
3481 const uint8_t *input,
3482 size_t input_length,
3483 uint8_t *output,
3484 size_t output_size,
3485 size_t *output_length )
3486{
3487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003488 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3489 psa_key_slot_t *slot;
3490 psa_key_type_t key_type;
3491 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003492
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003493 *output_length = 0;
3494
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003495 if( ! PSA_ALG_IS_CIPHER( alg ) )
3496 return( PSA_ERROR_INVALID_ARGUMENT );
3497
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003498 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3499 PSA_KEY_USAGE_ENCRYPT,
3500 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003501 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003502 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003503
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003504 psa_key_attributes_t attributes = {
3505 .core = slot->attr
3506 };
3507
3508 key_type = slot->attr.type;
3509 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3510
3511 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003512 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003513 if( output_size < iv_length )
3514 {
3515 status = PSA_ERROR_BUFFER_TOO_SMALL;
3516 goto exit;
3517 }
3518
3519 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003520 if( status != PSA_SUCCESS )
3521 goto exit;
3522 }
3523
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003524 status = psa_driver_wrapper_cipher_encrypt(
3525 &attributes, slot->key.data, slot->key.bytes,
3526 alg, input, input_length,
3527 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003528
3529exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003530 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003531
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003532 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003533}
3534
3535psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3536 psa_algorithm_t alg,
3537 const uint8_t *input,
3538 size_t input_length,
3539 uint8_t *output,
3540 size_t output_size,
3541 size_t *output_length )
3542{
3543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003544 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3545 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003546
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003547 *output_length = 0;
3548
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003549 if( ! PSA_ALG_IS_CIPHER( alg ) )
3550 return( PSA_ERROR_INVALID_ARGUMENT );
3551
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003552 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3553 PSA_KEY_USAGE_DECRYPT,
3554 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003555 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003556 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003557
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003558 psa_key_attributes_t attributes = {
3559 .core = slot->attr
3560 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003561
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003562 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3563 {
3564 status = PSA_ERROR_INVALID_ARGUMENT;
3565 goto exit;
3566 }
3567
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 status = psa_driver_wrapper_cipher_decrypt(
3569 &attributes, slot->key.data, slot->key.bytes,
3570 alg, input, input_length,
3571 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003572
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003573exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003574 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003575
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003576 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003577}
3578
3579
mohammad16035955c982018-04-26 00:53:03 +03003580/****************************************************************/
3581/* AEAD */
3582/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003583
Ronald Croncf56a0a2020-08-04 09:51:30 +02003584psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003585 psa_algorithm_t alg,
3586 const uint8_t *nonce,
3587 size_t nonce_length,
3588 const uint8_t *additional_data,
3589 size_t additional_data_length,
3590 const uint8_t *plaintext,
3591 size_t plaintext_length,
3592 uint8_t *ciphertext,
3593 size_t ciphertext_size,
3594 size_t *ciphertext_length )
3595{
Ronald Cron215633c2021-03-16 17:15:37 +01003596 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3597 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003598
mohammad1603f08a5502018-06-03 15:05:47 +03003599 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003600
Steven Cooremanea7ab132021-03-17 16:28:00 +01003601 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3602 return( PSA_ERROR_NOT_SUPPORTED );
3603
Ronald Cron9a986162021-03-26 12:40:07 +01003604 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003605 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003606 if( status != PSA_SUCCESS )
3607 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003608
Ronald Cron215633c2021-03-16 17:15:37 +01003609 psa_key_attributes_t attributes = {
3610 .core = slot->attr
3611 };
mohammad16035955c982018-04-26 00:53:03 +03003612
Ronald Cronde822812021-03-17 16:08:20 +01003613 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003614 &attributes, slot->key.data, slot->key.bytes,
3615 alg,
3616 nonce, nonce_length,
3617 additional_data, additional_data_length,
3618 plaintext, plaintext_length,
3619 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003620
Gilles Peskineedf9a652018-08-17 18:11:56 +02003621 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3622 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003623
Ronald Cron9f310172021-03-16 16:36:37 +01003624 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003625
mohammad16035955c982018-04-26 00:53:03 +03003626 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003627}
3628
Ronald Croncf56a0a2020-08-04 09:51:30 +02003629psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003630 psa_algorithm_t alg,
3631 const uint8_t *nonce,
3632 size_t nonce_length,
3633 const uint8_t *additional_data,
3634 size_t additional_data_length,
3635 const uint8_t *ciphertext,
3636 size_t ciphertext_length,
3637 uint8_t *plaintext,
3638 size_t plaintext_size,
3639 size_t *plaintext_length )
3640{
Ronald Cron215633c2021-03-16 17:15:37 +01003641 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3642 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003643
Gilles Peskineee652a32018-06-01 19:23:52 +02003644 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003645
Steven Cooremanea7ab132021-03-17 16:28:00 +01003646 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3647 return( PSA_ERROR_NOT_SUPPORTED );
3648
Ronald Cron9a986162021-03-26 12:40:07 +01003649 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003650 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003651 if( status != PSA_SUCCESS )
3652 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003653
Ronald Cron215633c2021-03-16 17:15:37 +01003654 psa_key_attributes_t attributes = {
3655 .core = slot->attr
3656 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003657
Ronald Cronde822812021-03-17 16:08:20 +01003658 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003659 &attributes, slot->key.data, slot->key.bytes,
3660 alg,
3661 nonce, nonce_length,
3662 additional_data, additional_data_length,
3663 ciphertext, ciphertext_length,
3664 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003665
Gilles Peskineedf9a652018-08-17 18:11:56 +02003666 if( status != PSA_SUCCESS && plaintext_size != 0 )
3667 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003668
Ronald Cron215633c2021-03-16 17:15:37 +01003669 psa_unlock_key_slot( slot );
3670
Gilles Peskineedf9a652018-08-17 18:11:56 +02003671 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003672}
3673
Gilles Peskinee59236f2018-01-27 23:32:46 +01003674/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003675/* Generators */
3676/****************************************************************/
3677
John Durkop07cc04a2020-11-16 22:08:34 -08003678#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3679 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3680 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3681#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003682#endif /* At least one builtin KDF */
3683
3684#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)
3687static psa_status_t psa_key_derivation_start_hmac(
3688 psa_mac_operation_t *operation,
3689 psa_algorithm_t hash_alg,
3690 const uint8_t *hmac_key,
3691 size_t hmac_key_length )
3692{
3693 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3694 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3695 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3696 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3697 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3698
Steven Cooreman72f736a2021-05-07 14:14:37 +02003699 operation->is_sign = 1;
3700 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3701
Steven Cooreman094a77e2021-05-06 17:58:36 +02003702 status = psa_driver_wrapper_mac_sign_setup( operation,
3703 &attributes,
3704 hmac_key, hmac_key_length,
3705 PSA_ALG_HMAC( hash_alg ) );
3706
3707 psa_reset_key_attributes( &attributes );
3708 return( status );
3709}
3710#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003711
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003712#define HKDF_STATE_INIT 0 /* no input yet */
3713#define HKDF_STATE_STARTED 1 /* got salt */
3714#define HKDF_STATE_KEYED 2 /* got key */
3715#define HKDF_STATE_OUTPUT 3 /* output started */
3716
Gilles Peskinecbe66502019-05-16 16:59:18 +02003717static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003718 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003719{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003720 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3721 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003722 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003723 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003724}
3725
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003726psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003727{
3728 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003729 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003730 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003731 {
3732 /* The object has (apparently) been initialized but it is not
3733 * in use. It's ok to call abort on such an object, and there's
3734 * nothing to do. */
3735 }
3736 else
John Durkopd0321952020-10-29 21:37:36 -07003737#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003738 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003739 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003740 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003741 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003742 }
John Durkop07cc04a2020-11-16 22:08:34 -08003743 else
3744#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3745#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3746 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3747 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003748 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003749 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003750 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003751 if( operation->ctx.tls12_prf.secret != NULL )
3752 {
3753 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3754 operation->ctx.tls12_prf.secret_length );
3755 mbedtls_free( operation->ctx.tls12_prf.secret );
3756 }
3757
Janos Follath6a1d2622019-06-11 10:37:28 +01003758 if( operation->ctx.tls12_prf.seed != NULL )
3759 {
3760 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3761 operation->ctx.tls12_prf.seed_length );
3762 mbedtls_free( operation->ctx.tls12_prf.seed );
3763 }
3764
3765 if( operation->ctx.tls12_prf.label != NULL )
3766 {
3767 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3768 operation->ctx.tls12_prf.label_length );
3769 mbedtls_free( operation->ctx.tls12_prf.label );
3770 }
3771
Steven Cooremana6df6042021-04-29 19:32:25 +02003772 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003773
3774 /* We leave the fields Ai and output_block to be erased safely by the
3775 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003776 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003777 else
John Durkop07cc04a2020-11-16 22:08:34 -08003778#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3779 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003780 {
3781 status = PSA_ERROR_BAD_STATE;
3782 }
Janos Follath083036a2019-06-11 10:22:26 +01003783 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003784 return( status );
3785}
3786
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003787psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003788 size_t *capacity)
3789{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003790 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003791 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003792 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003793 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003794 }
3795
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003796 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003797 return( PSA_SUCCESS );
3798}
3799
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003800psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003801 size_t capacity )
3802{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003803 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003804 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003805 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003806 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003807 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003808 return( PSA_SUCCESS );
3809}
3810
John Durkopd0321952020-10-29 21:37:36 -07003811#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003812/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003813 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003814static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003815 psa_algorithm_t hash_alg,
3816 uint8_t *output,
3817 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003818{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003819 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003820 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003821 psa_status_t status;
3822
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003823 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3824 return( PSA_ERROR_BAD_STATE );
3825 hkdf->state = HKDF_STATE_OUTPUT;
3826
Gilles Peskinebef7f142018-07-12 17:22:21 +02003827 while( output_length != 0 )
3828 {
3829 /* Copy what remains of the current block */
3830 uint8_t n = hash_length - hkdf->offset_in_block;
3831 if( n > output_length )
3832 n = (uint8_t) output_length;
3833 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3834 output += n;
3835 output_length -= n;
3836 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003837 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003838 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003839 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003840 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003841 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003842 * object was corrupted or if this function is called directly
3843 * inside the library. */
3844 if( hkdf->block_number == 0xff )
3845 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003846
3847 /* We need a new block */
3848 ++hkdf->block_number;
3849 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003850
Steven Cooreman094a77e2021-05-06 17:58:36 +02003851 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3852 hash_alg,
3853 hkdf->prk,
3854 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003855 if( status != PSA_SUCCESS )
3856 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003857
Gilles Peskinebef7f142018-07-12 17:22:21 +02003858 if( hkdf->block_number != 1 )
3859 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003860 status = psa_mac_update( &hkdf->hmac,
3861 hkdf->output_block,
3862 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003863 if( status != PSA_SUCCESS )
3864 return( status );
3865 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003866 status = psa_mac_update( &hkdf->hmac,
3867 hkdf->info,
3868 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003869 if( status != PSA_SUCCESS )
3870 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003871 status = psa_mac_update( &hkdf->hmac,
3872 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003873 if( status != PSA_SUCCESS )
3874 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003875 status = psa_mac_sign_finish( &hkdf->hmac,
3876 hkdf->output_block,
3877 sizeof( hkdf->output_block ),
3878 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003879 if( status != PSA_SUCCESS )
3880 return( status );
3881 }
3882
3883 return( PSA_SUCCESS );
3884}
John Durkop07cc04a2020-11-16 22:08:34 -08003885#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003886
John Durkop07cc04a2020-11-16 22:08:34 -08003887#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3888 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003889static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3890 psa_tls12_prf_key_derivation_t *tls12_prf,
3891 psa_algorithm_t alg )
3892{
3893 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003894 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003895 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3896 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003897 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003898
Janos Follath7742fee2019-06-17 12:58:10 +01003899 /* We can't be wanting more output after block 0xff, otherwise
3900 * the capacity check in psa_key_derivation_output_bytes() would have
3901 * prevented this call. It could happen only if the operation
3902 * object was corrupted or if this function is called directly
3903 * inside the library. */
3904 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003905 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003906
3907 /* We need a new block */
3908 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003909 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003910
3911 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3912 *
3913 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3914 *
3915 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3916 * HMAC_hash(secret, A(2) + seed) +
3917 * HMAC_hash(secret, A(3) + seed) + ...
3918 *
3919 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003920 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003921 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003922 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003923 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003924 * is currently extracted as `output_block` and where i is
3925 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003926 */
3927
Steven Cooreman094a77e2021-05-06 17:58:36 +02003928 status = psa_key_derivation_start_hmac( &hmac,
3929 hash_alg,
3930 tls12_prf->secret,
3931 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003932 if( status != PSA_SUCCESS )
3933 goto cleanup;
3934
3935 /* Calculate A(i) where i = tls12_prf->block_number. */
3936 if( tls12_prf->block_number == 1 )
3937 {
3938 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3939 * the variable seed and in this instance means it in the context of the
3940 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003941 status = psa_mac_update( &hmac,
3942 tls12_prf->label,
3943 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003944 if( status != PSA_SUCCESS )
3945 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003946 status = psa_mac_update( &hmac,
3947 tls12_prf->seed,
3948 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003949 if( status != PSA_SUCCESS )
3950 goto cleanup;
3951 }
3952 else
3953 {
3954 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003955 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003956 if( status != PSA_SUCCESS )
3957 goto cleanup;
3958 }
3959
Steven Cooremana6df6042021-04-29 19:32:25 +02003960 status = psa_mac_sign_finish( &hmac,
3961 tls12_prf->Ai, hash_length,
3962 &hmac_output_length );
3963 if( hmac_output_length != hash_length )
3964 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003965 if( status != PSA_SUCCESS )
3966 goto cleanup;
3967
3968 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003969 status = psa_key_derivation_start_hmac( &hmac,
3970 hash_alg,
3971 tls12_prf->secret,
3972 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003973 if( status != PSA_SUCCESS )
3974 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003975 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003976 if( status != PSA_SUCCESS )
3977 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003978 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_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->seed, tls12_prf->seed_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_sign_finish( &hmac,
3985 tls12_prf->output_block, hash_length,
3986 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003987 if( status != PSA_SUCCESS )
3988 goto cleanup;
3989
Janos Follath7742fee2019-06-17 12:58:10 +01003990
3991cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003992 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003993 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3994 status = cleanup_status;
3995
3996 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003997}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003998
Janos Follath844eb0e2019-06-19 12:10:49 +01003999static psa_status_t psa_key_derivation_tls12_prf_read(
4000 psa_tls12_prf_key_derivation_t *tls12_prf,
4001 psa_algorithm_t alg,
4002 uint8_t *output,
4003 size_t output_length )
4004{
4005 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004006 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004007 psa_status_t status;
4008 uint8_t offset, length;
4009
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004010 switch( tls12_prf->state )
4011 {
4012 case PSA_TLS12_PRF_STATE_LABEL_SET:
4013 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4014 break;
4015 case PSA_TLS12_PRF_STATE_OUTPUT:
4016 break;
4017 default:
4018 return( PSA_ERROR_BAD_STATE );
4019 }
4020
Janos Follath844eb0e2019-06-19 12:10:49 +01004021 while( output_length != 0 )
4022 {
4023 /* Check if we have fully processed the current block. */
4024 if( tls12_prf->left_in_block == 0 )
4025 {
4026 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4027 alg );
4028 if( status != PSA_SUCCESS )
4029 return( status );
4030
4031 continue;
4032 }
4033
4034 if( tls12_prf->left_in_block > output_length )
4035 length = (uint8_t) output_length;
4036 else
4037 length = tls12_prf->left_in_block;
4038
4039 offset = hash_length - tls12_prf->left_in_block;
4040 memcpy( output, tls12_prf->output_block + offset, length );
4041 output += length;
4042 output_length -= length;
4043 tls12_prf->left_in_block -= length;
4044 }
4045
4046 return( PSA_SUCCESS );
4047}
John Durkop07cc04a2020-11-16 22:08:34 -08004048#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4049 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004050
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004051psa_status_t psa_key_derivation_output_bytes(
4052 psa_key_derivation_operation_t *operation,
4053 uint8_t *output,
4054 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004055{
4056 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004057 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004058
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004059 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004060 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004061 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004062 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004063 }
4064
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004065 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004066 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004067 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004068 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004069 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004070 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004071 goto exit;
4072 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004073 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004074 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004075 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004076 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004077 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4078 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004079 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004080 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004081 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004082 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004083 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004084
John Durkopd0321952020-10-29 21:37:36 -07004085#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004086 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004087 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004088 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004089 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004090 output, output_length );
4091 }
Janos Follathadbec812019-06-14 11:05:39 +01004092 else
John Durkop07cc04a2020-11-16 22:08:34 -08004093#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4094#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4095 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004096 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004097 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004098 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004099 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004100 kdf_alg, output,
4101 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004102 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004103 else
John Durkop07cc04a2020-11-16 22:08:34 -08004104#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4105 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004106 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004107 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004108 return( PSA_ERROR_BAD_STATE );
4109 }
4110
4111exit:
4112 if( status != PSA_SUCCESS )
4113 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004114 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004115 * This allows us to differentiate between exhausted operations and
4116 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4117 * operations. */
4118 psa_algorithm_t alg = operation->alg;
4119 psa_key_derivation_abort( operation );
4120 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004121 memset( output, '!', output_length );
4122 }
4123 return( status );
4124}
4125
David Brown7807bf72021-02-09 16:28:23 -07004126#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004127static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4128{
4129 if( data_size >= 8 )
4130 mbedtls_des_key_set_parity( data );
4131 if( data_size >= 16 )
4132 mbedtls_des_key_set_parity( data + 8 );
4133 if( data_size >= 24 )
4134 mbedtls_des_key_set_parity( data + 16 );
4135}
David Brown7807bf72021-02-09 16:28:23 -07004136#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004137
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004138static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004139 psa_key_slot_t *slot,
4140 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004141 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004142{
4143 uint8_t *data = NULL;
4144 size_t bytes = PSA_BITS_TO_BYTES( bits );
4145 psa_status_t status;
4146
Gilles Peskine8e338702019-07-30 20:06:31 +02004147 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004148 return( PSA_ERROR_INVALID_ARGUMENT );
4149 if( bits % 8 != 0 )
4150 return( PSA_ERROR_INVALID_ARGUMENT );
4151 data = mbedtls_calloc( 1, bytes );
4152 if( data == NULL )
4153 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4154
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004155 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004156 if( status != PSA_SUCCESS )
4157 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004158#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004159 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004160 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004161#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004162
4163 status = psa_allocate_buffer_to_slot( slot, bytes );
4164 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004165 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004166
Ronald Cronbf33c932020-11-28 18:06:53 +01004167 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004168 psa_key_attributes_t attributes = {
4169 .core = slot->attr
4170 };
4171
Ronald Cronbf33c932020-11-28 18:06:53 +01004172 status = psa_driver_wrapper_import_key( &attributes,
4173 data, bytes,
4174 slot->key.data,
4175 slot->key.bytes,
4176 &slot->key.bytes, &bits );
4177 if( bits != slot->attr.bits )
4178 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004179
4180exit:
4181 mbedtls_free( data );
4182 return( status );
4183}
4184
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004185psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004186 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004187 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004188{
4189 psa_status_t status;
4190 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004191 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004192
Ronald Cron81709fc2020-11-14 12:10:32 +01004193 *key = MBEDTLS_SVC_KEY_ID_INIT;
4194
Gilles Peskine0f84d622019-09-12 19:03:13 +02004195 /* Reject any attempt to create a zero-length key so that we don't
4196 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4197 if( psa_get_key_bits( attributes ) == 0 )
4198 return( PSA_ERROR_INVALID_ARGUMENT );
4199
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004200 if( ! operation->can_output_key )
4201 return( PSA_ERROR_NOT_PERMITTED );
4202
Ronald Cron81709fc2020-11-14 12:10:32 +01004203 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4204 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004205#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4206 if( driver != NULL )
4207 {
4208 /* Deriving a key in a secure element is not implemented yet. */
4209 status = PSA_ERROR_NOT_SUPPORTED;
4210 }
4211#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004212 if( status == PSA_SUCCESS )
4213 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004214 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004215 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004216 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004217 }
4218 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004219 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004220 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004221 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004222
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004223 return( status );
4224}
4225
Gilles Peskineeab56e42018-07-12 17:12:33 +02004226
4227
4228/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004229/* Key derivation */
4230/****************************************************************/
4231
Steven Cooreman932ffb72021-02-15 12:14:32 +01004232#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004233static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004234 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004235 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004236{
John Durkop07cc04a2020-11-16 22:08:34 -08004237 int is_kdf_alg_supported;
4238
Janos Follath5fe19732019-06-20 15:09:30 +01004239 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4240 * initialisers for this union leave some bytes unspecified.) */
4241 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4242
Gilles Peskine969c5d62019-01-16 15:53:06 +01004243 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004244#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004245 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4246 is_kdf_alg_supported = 1;
4247 else
4248#endif
4249#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4250 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4251 is_kdf_alg_supported = 1;
4252 else
4253#endif
4254#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4255 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4256 is_kdf_alg_supported = 1;
4257 else
4258#endif
4259 is_kdf_alg_supported = 0;
4260
4261 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004262 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004263 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004264 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004265 if( hash_size == 0 )
4266 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004267 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4268 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004269 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004270 {
4271 return( PSA_ERROR_NOT_SUPPORTED );
4272 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004273 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004274 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004275 }
John Durkop07cc04a2020-11-16 22:08:34 -08004276
4277 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004278}
John Durkop07cc04a2020-11-16 22:08:34 -08004279#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004280
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004281psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004282 psa_algorithm_t alg )
4283{
4284 psa_status_t status;
4285
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004286 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004287 return( PSA_ERROR_BAD_STATE );
4288
Gilles Peskine6843c292019-01-18 16:44:49 +01004289 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4290 return( PSA_ERROR_INVALID_ARGUMENT );
4291 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004292 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004293#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004294 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004295 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004296#else
4297 return( PSA_ERROR_NOT_SUPPORTED );
4298#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004299 }
4300 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4301 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004302#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004303 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004304#else
4305 return( PSA_ERROR_NOT_SUPPORTED );
4306#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004307 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004308 else
4309 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004310
4311 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004313 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004314}
4315
John Durkopd0321952020-10-29 21:37:36 -07004316#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004317static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004318 psa_algorithm_t hash_alg,
4319 psa_key_derivation_step_t step,
4320 const uint8_t *data,
4321 size_t data_length )
4322{
4323 psa_status_t status;
4324 switch( step )
4325 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004326 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004327 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004328 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004329 else
4330 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004331 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4332 hash_alg,
4333 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004334 if( status != PSA_SUCCESS )
4335 return( status );
4336 hkdf->state = HKDF_STATE_STARTED;
4337 return( PSA_SUCCESS );
4338 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004339 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004340 /* If no salt was provided, use an empty salt. */
4341 if( hkdf->state == HKDF_STATE_INIT )
4342 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004343 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4344 hash_alg,
4345 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004346 if( status != PSA_SUCCESS )
4347 return( status );
4348 hkdf->state = HKDF_STATE_STARTED;
4349 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004350 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004351 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004352 status = psa_mac_update( &hkdf->hmac,
4353 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004354 if( status != PSA_SUCCESS )
4355 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004356 status = psa_mac_sign_finish( &hkdf->hmac,
4357 hkdf->prk,
4358 sizeof( hkdf->prk ),
4359 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004360 if( status != PSA_SUCCESS )
4361 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004362 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004363 hkdf->block_number = 0;
4364 hkdf->state = HKDF_STATE_KEYED;
4365 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004366 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004367 if( hkdf->state == HKDF_STATE_OUTPUT )
4368 return( PSA_ERROR_BAD_STATE );
4369 if( hkdf->info_set )
4370 return( PSA_ERROR_BAD_STATE );
4371 hkdf->info_length = data_length;
4372 if( data_length != 0 )
4373 {
4374 hkdf->info = mbedtls_calloc( 1, data_length );
4375 if( hkdf->info == NULL )
4376 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4377 memcpy( hkdf->info, data, data_length );
4378 }
4379 hkdf->info_set = 1;
4380 return( PSA_SUCCESS );
4381 default:
4382 return( PSA_ERROR_INVALID_ARGUMENT );
4383 }
4384}
John Durkop07cc04a2020-11-16 22:08:34 -08004385#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004386
John Durkop07cc04a2020-11-16 22:08:34 -08004387#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4388 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004389static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4390 const uint8_t *data,
4391 size_t data_length )
4392{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004393 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004394 return( PSA_ERROR_BAD_STATE );
4395
Janos Follathd6dce9f2019-07-04 09:11:38 +01004396 if( data_length != 0 )
4397 {
4398 prf->seed = mbedtls_calloc( 1, data_length );
4399 if( prf->seed == NULL )
4400 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004401
Janos Follathd6dce9f2019-07-04 09:11:38 +01004402 memcpy( prf->seed, data, data_length );
4403 prf->seed_length = data_length;
4404 }
Janos Follathf08e2652019-06-13 09:05:41 +01004405
Gilles Peskine43f958b2020-12-13 14:55:14 +01004406 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004407
4408 return( PSA_SUCCESS );
4409}
4410
Janos Follath81550542019-06-13 14:26:34 +01004411static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004412 const uint8_t *data,
4413 size_t data_length )
4414{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004415 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004416 return( PSA_ERROR_BAD_STATE );
4417
Steven Cooremana6df6042021-04-29 19:32:25 +02004418 if( data_length != 0 )
4419 {
4420 prf->secret = mbedtls_calloc( 1, data_length );
4421 if( prf->secret == NULL )
4422 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4423
4424 memcpy( prf->secret, data, data_length );
4425 prf->secret_length = data_length;
4426 }
Janos Follath81550542019-06-13 14:26:34 +01004427
Gilles Peskine43f958b2020-12-13 14:55:14 +01004428 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004429
4430 return( PSA_SUCCESS );
4431}
4432
Janos Follath63028dd2019-06-13 09:15:47 +01004433static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4434 const uint8_t *data,
4435 size_t data_length )
4436{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004437 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004438 return( PSA_ERROR_BAD_STATE );
4439
Janos Follathd6dce9f2019-07-04 09:11:38 +01004440 if( data_length != 0 )
4441 {
4442 prf->label = mbedtls_calloc( 1, data_length );
4443 if( prf->label == NULL )
4444 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004445
Janos Follathd6dce9f2019-07-04 09:11:38 +01004446 memcpy( prf->label, data, data_length );
4447 prf->label_length = data_length;
4448 }
Janos Follath63028dd2019-06-13 09:15:47 +01004449
Gilles Peskine43f958b2020-12-13 14:55:14 +01004450 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004451
4452 return( PSA_SUCCESS );
4453}
4454
Janos Follathb03233e2019-06-11 15:30:30 +01004455static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004456 psa_key_derivation_step_t step,
4457 const uint8_t *data,
4458 size_t data_length )
4459{
Janos Follathb03233e2019-06-11 15:30:30 +01004460 switch( step )
4461 {
Janos Follathf08e2652019-06-13 09:05:41 +01004462 case PSA_KEY_DERIVATION_INPUT_SEED:
4463 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004464 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004465 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004466 case PSA_KEY_DERIVATION_INPUT_LABEL:
4467 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004468 default:
4469 return( PSA_ERROR_INVALID_ARGUMENT );
4470 }
4471}
John Durkop07cc04a2020-11-16 22:08:34 -08004472#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4473 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4474
4475#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4476static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4477 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004478 const uint8_t *data,
4479 size_t data_length )
4480{
4481 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004482 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004483 uint8_t *cur = pms;
4484
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004485 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004486 return( PSA_ERROR_INVALID_ARGUMENT );
4487
4488 /* Quoting RFC 4279, Section 2:
4489 *
4490 * The premaster secret is formed as follows: if the PSK is N octets
4491 * long, concatenate a uint16 with the value N, N zero octets, a second
4492 * uint16 with the value N, and the PSK itself.
4493 */
4494
Joe Subbiani5ecac212021-06-24 13:00:03 +01004495 *cur++ = MBEDTLS_BYTE_1( data_length );
4496 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004497 memset( cur, 0, data_length );
4498 cur += data_length;
4499 *cur++ = pms[0];
4500 *cur++ = pms[1];
4501 memcpy( cur, data, data_length );
4502 cur += data_length;
4503
Steven Cooremana6df6042021-04-29 19:32:25 +02004504 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004505
4506 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4507 return( status );
4508}
Janos Follath6660f0e2019-06-17 08:44:03 +01004509
4510static psa_status_t psa_tls12_prf_psk_to_ms_input(
4511 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004512 psa_key_derivation_step_t step,
4513 const uint8_t *data,
4514 size_t data_length )
4515{
4516 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004517 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004518 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004519 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004520 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004521
Steven Cooremana6df6042021-04-29 19:32:25 +02004522 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004523}
John Durkop07cc04a2020-11-16 22:08:34 -08004524#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004525
Gilles Peskineb8965192019-09-24 16:21:10 +02004526/** Check whether the given key type is acceptable for the given
4527 * input step of a key derivation.
4528 *
4529 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4530 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4531 * Both secret and non-secret inputs can alternatively have the type
4532 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4533 * that the input was passed as a buffer rather than via a key object.
4534 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004535static int psa_key_derivation_check_input_type(
4536 psa_key_derivation_step_t step,
4537 psa_key_type_t key_type )
4538{
4539 switch( step )
4540 {
4541 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004542 if( key_type == PSA_KEY_TYPE_DERIVE )
4543 return( PSA_SUCCESS );
4544 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004545 return( PSA_SUCCESS );
4546 break;
4547 case PSA_KEY_DERIVATION_INPUT_LABEL:
4548 case PSA_KEY_DERIVATION_INPUT_SALT:
4549 case PSA_KEY_DERIVATION_INPUT_INFO:
4550 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004551 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4552 return( PSA_SUCCESS );
4553 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004554 return( PSA_SUCCESS );
4555 break;
4556 }
4557 return( PSA_ERROR_INVALID_ARGUMENT );
4558}
4559
Janos Follathb80a94e2019-06-12 15:54:46 +01004560static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004561 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004562 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004563 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004564 const uint8_t *data,
4565 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004566{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004567 psa_status_t status;
4568 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4569
4570 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004571 if( status != PSA_SUCCESS )
4572 goto exit;
4573
John Durkopd0321952020-10-29 21:37:36 -07004574#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004575 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004576 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004577 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004578 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004579 step, data, data_length );
4580 }
John Durkop07cc04a2020-11-16 22:08:34 -08004581 else
4582#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4583#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4584 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004585 {
Janos Follathb03233e2019-06-11 15:30:30 +01004586 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004587 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004588 }
John Durkop07cc04a2020-11-16 22:08:34 -08004589 else
4590#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4591#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4592 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004593 {
4594 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004595 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004596 }
4597 else
John Durkop07cc04a2020-11-16 22:08:34 -08004598#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004599 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004600 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004601 (void) data;
4602 (void) data_length;
4603 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004604 return( PSA_ERROR_BAD_STATE );
4605 }
4606
Gilles Peskine224b0d62019-09-23 18:13:17 +02004607exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004608 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004609 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004610 return( status );
4611}
4612
Janos Follath51f4a0f2019-06-14 11:35:55 +01004613psa_status_t psa_key_derivation_input_bytes(
4614 psa_key_derivation_operation_t *operation,
4615 psa_key_derivation_step_t step,
4616 const uint8_t *data,
4617 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004618{
Gilles Peskineb8965192019-09-24 16:21:10 +02004619 return( psa_key_derivation_input_internal( operation, step,
4620 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004621 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004622}
4623
Janos Follath51f4a0f2019-06-14 11:35:55 +01004624psa_status_t psa_key_derivation_input_key(
4625 psa_key_derivation_operation_t *operation,
4626 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004627 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004628{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004629 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004630 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004631 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004632
Ronald Cron5c522922020-11-14 16:35:34 +01004633 status = psa_get_and_lock_transparent_key_slot_with_policy(
4634 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004635 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004636 {
4637 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004638 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004639 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004640
4641 /* Passing a key object as a SECRET input unlocks the permission
4642 * to output to a key object. */
4643 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4644 operation->can_output_key = 1;
4645
Ronald Cronf95a2b12020-10-22 15:24:49 +02004646 status = psa_key_derivation_input_internal( operation,
4647 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004648 slot->key.data,
4649 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004650
Ronald Cron5c522922020-11-14 16:35:34 +01004651 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004652
Ronald Cron5c522922020-11-14 16:35:34 +01004653 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004654}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004655
4656
4657
4658/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004659/* Key agreement */
4660/****************************************************************/
4661
John Durkop6ba40d12020-11-10 08:50:04 -08004662#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004663static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4664 size_t peer_key_length,
4665 const mbedtls_ecp_keypair *our_key,
4666 uint8_t *shared_secret,
4667 size_t shared_secret_size,
4668 size_t *shared_secret_length )
4669{
Steven Cooremand4867872020-08-05 16:31:39 +02004670 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004671 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004672 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004673 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004674 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004675 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004676
Ronald Cron90857082020-11-25 14:58:33 +01004677 status = mbedtls_psa_ecp_load_representation(
4678 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004679 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004680 peer_key,
4681 peer_key_length,
4682 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004683 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004684 goto exit;
4685
Jaeden Amero97271b32019-01-10 19:38:51 +00004686 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004687 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004688 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004689 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004690 status = mbedtls_to_psa_error(
4691 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4692 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004693 goto exit;
4694
Jaeden Amero97271b32019-01-10 19:38:51 +00004695 status = mbedtls_to_psa_error(
4696 mbedtls_ecdh_calc_secret( &ecdh,
4697 shared_secret_length,
4698 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004699 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004700 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004701 if( status != PSA_SUCCESS )
4702 goto exit;
4703 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4704 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004705
4706exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004707 if( status != PSA_SUCCESS )
4708 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004709 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004710 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004711 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004712
Jaeden Amero97271b32019-01-10 19:38:51 +00004713 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004714}
John Durkop6ba40d12020-11-10 08:50:04 -08004715#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004716
Gilles Peskine01d718c2018-09-18 12:01:02 +02004717#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4718
Gilles Peskine0216fe12019-04-11 21:23:21 +02004719static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4720 psa_key_slot_t *private_key,
4721 const uint8_t *peer_key,
4722 size_t peer_key_length,
4723 uint8_t *shared_secret,
4724 size_t shared_secret_size,
4725 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004726{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004727 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004728 {
John Durkop6ba40d12020-11-10 08:50:04 -08004729#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004730 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004731 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004732 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004733 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004734 psa_status_t status = mbedtls_psa_ecp_load_representation(
4735 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004736 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004737 private_key->key.data,
4738 private_key->key.bytes,
4739 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004740 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004741 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004742 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004743 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004744 shared_secret, shared_secret_size,
4745 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004746 mbedtls_ecp_keypair_free( ecp );
4747 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004748 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004749#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004750 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004751 (void) private_key;
4752 (void) peer_key;
4753 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004754 (void) shared_secret;
4755 (void) shared_secret_size;
4756 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004757 return( PSA_ERROR_NOT_SUPPORTED );
4758 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004759}
4760
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004761/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004762 * to potentially free embedded data structures and wipe confidential data.
4763 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004764static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004765 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004766 psa_key_slot_t *private_key,
4767 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004768 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004769{
4770 psa_status_t status;
4771 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4772 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004773 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004774
4775 /* Step 1: run the secret agreement algorithm to generate the shared
4776 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004777 status = psa_key_agreement_raw_internal( ka_alg,
4778 private_key,
4779 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004780 shared_secret,
4781 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004782 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004783 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004784 goto exit;
4785
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004786 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004787 * the shared secret. A shared secret is permitted wherever a key
4788 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004789 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004790 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004791 shared_secret,
4792 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004793exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004794 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004795 return( status );
4796}
4797
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004798psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004799 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004800 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004801 const uint8_t *peer_key,
4802 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004803{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004805 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004806 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004807
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004808 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004809 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004810 status = psa_get_and_lock_transparent_key_slot_with_policy(
4811 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004812 if( status != PSA_SUCCESS )
4813 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004814 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004815 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004816 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004817 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004818 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004819 else
4820 {
4821 /* If a private key has been added as SECRET, we allow the derived
4822 * key material to be used as a key in PSA Crypto. */
4823 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4824 operation->can_output_key = 1;
4825 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004826
Ronald Cron5c522922020-11-14 16:35:34 +01004827 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004828
Ronald Cron5c522922020-11-14 16:35:34 +01004829 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004830}
4831
Gilles Peskinebe697d82019-05-16 18:00:41 +02004832psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004833 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004834 const uint8_t *peer_key,
4835 size_t peer_key_length,
4836 uint8_t *output,
4837 size_t output_size,
4838 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004839{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004841 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004842 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004843
4844 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4845 {
4846 status = PSA_ERROR_INVALID_ARGUMENT;
4847 goto exit;
4848 }
Ronald Cron5c522922020-11-14 16:35:34 +01004849 status = psa_get_and_lock_transparent_key_slot_with_policy(
4850 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004851 if( status != PSA_SUCCESS )
4852 goto exit;
4853
4854 status = psa_key_agreement_raw_internal( alg, slot,
4855 peer_key, peer_key_length,
4856 output, output_size,
4857 output_length );
4858
4859exit:
4860 if( status != PSA_SUCCESS )
4861 {
4862 /* If an error happens and is not handled properly, the output
4863 * may be used as a key to protect sensitive data. Arrange for such
4864 * a key to be random, which is likely to result in decryption or
4865 * verification errors. This is better than filling the buffer with
4866 * some constant data such as zeros, which would result in the data
4867 * being protected with a reproducible, easily knowable key.
4868 */
4869 psa_generate_random( output, output_size );
4870 *output_length = output_size;
4871 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004872
Ronald Cron5c522922020-11-14 16:35:34 +01004873 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004874
Ronald Cron5c522922020-11-14 16:35:34 +01004875 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004876}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004877
4878
Gilles Peskine30524eb2020-11-13 17:02:26 +01004879
Gilles Peskine86a440b2018-11-12 18:39:40 +01004880/****************************************************************/
4881/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004882/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004883
Gilles Peskine30524eb2020-11-13 17:02:26 +01004884/** Initialize the PSA random generator.
4885 */
4886static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4887{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004888#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4889 memset( rng, 0, sizeof( *rng ) );
4890#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4891
Gilles Peskine30524eb2020-11-13 17:02:26 +01004892 /* Set default configuration if
4893 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4894 if( rng->entropy_init == NULL )
4895 rng->entropy_init = mbedtls_entropy_init;
4896 if( rng->entropy_free == NULL )
4897 rng->entropy_free = mbedtls_entropy_free;
4898
4899 rng->entropy_init( &rng->entropy );
4900#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4901 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4902 /* The PSA entropy injection feature depends on using NV seed as an entropy
4903 * source. Add NV seed as an entropy source for PSA entropy injection. */
4904 mbedtls_entropy_add_source( &rng->entropy,
4905 mbedtls_nv_seed_poll, NULL,
4906 MBEDTLS_ENTROPY_BLOCK_SIZE,
4907 MBEDTLS_ENTROPY_SOURCE_STRONG );
4908#endif
4909
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004910 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004911#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004912}
4913
4914/** Deinitialize the PSA random generator.
4915 */
4916static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4917{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004918#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4919 memset( rng, 0, sizeof( *rng ) );
4920#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004921 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004922 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004923#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004924}
4925
4926/** Seed the PSA random generator.
4927 */
4928static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4929{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004930#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4931 /* Do nothing: the external RNG seeds itself. */
4932 (void) rng;
4933 return( PSA_SUCCESS );
4934#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004935 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004936 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4937 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004938 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004939#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004940}
4941
Gilles Peskinee59236f2018-01-27 23:32:46 +01004942psa_status_t psa_generate_random( uint8_t *output,
4943 size_t output_size )
4944{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004945 GUARD_MODULE_INITIALIZED;
4946
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004947#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4948
4949 size_t output_length = 0;
4950 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4951 output, output_size,
4952 &output_length );
4953 if( status != PSA_SUCCESS )
4954 return( status );
4955 /* Breaking up a request into smaller chunks is currently not supported
4956 * for the extrernal RNG interface. */
4957 if( output_length != output_size )
4958 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4959 return( PSA_SUCCESS );
4960
4961#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4962
Gilles Peskine71ddab92021-01-04 21:01:07 +01004963 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004964 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004965 size_t request_size =
4966 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4967 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4968 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004969 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4970 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004971 if( ret != 0 )
4972 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004973 output_size -= request_size;
4974 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004975 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004976 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004977#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004978}
4979
Gilles Peskine8814fc42020-12-14 15:33:44 +01004980/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004981 *
4982 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4983 * `psa_generate_random(...)`. The state parameter is ignored since the
4984 * PSA API doesn't support passing an explicit state.
4985 *
4986 * In the non-external case, psa_generate_random() calls an
4987 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4988 * and semantics as mbedtls_psa_get_random(). As an optimization,
4989 * instead of doing this back-and-forth between the PSA API and the
4990 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4991 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004992 */
4993#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4994int mbedtls_psa_get_random( void *p_rng,
4995 unsigned char *output,
4996 size_t output_size )
4997{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004998 /* This function takes a pointer to the RNG state because that's what
4999 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5000 * its own state internally and doesn't let the caller access that state.
5001 * So we just ignore the state parameter, and in practice we'll pass
5002 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005003 (void) p_rng;
5004 psa_status_t status = psa_generate_random( output, output_size );
5005 if( status == PSA_SUCCESS )
5006 return( 0 );
5007 else
5008 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5009}
5010#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5011
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005012#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005013#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005014
Gilles Peskine7228da22019-07-15 11:06:15 +02005015psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005016 size_t seed_size )
5017{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005018 if( global_data.initialized )
5019 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005020
5021 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5022 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5023 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5024 return( PSA_ERROR_INVALID_ARGUMENT );
5025
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005026 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005027}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005028#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005029
Ronald Cron3772afe2021-02-08 16:10:05 +01005030/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005031 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005032 * \param type The key type
5033 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005034 *
5035 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005036 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005037 * \retval #PSA_ERROR_INVALID_ARGUMENT
5038 * The size in bits of the key is not valid.
5039 * \retval #PSA_ERROR_NOT_SUPPORTED
5040 * The type and/or the size in bits of the key or the combination of
5041 * the two is not supported.
5042 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005043static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5044 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005045{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005046 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005047
Gilles Peskinee59236f2018-01-27 23:32:46 +01005048 if( key_type_is_raw_bytes( type ) )
5049 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005050 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005051 if( status != PSA_SUCCESS )
5052 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005053 }
5054 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005055#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005056 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5057 {
5058 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5059 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005060
Ronald Cron01b2aba2020-10-05 09:42:02 +02005061 /* Accept only byte-aligned keys, for the same reasons as
5062 * in psa_import_rsa_key(). */
5063 if( bits % 8 != 0 )
5064 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005065 }
5066 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005067#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005068
Ronald Cron5c4d3862020-12-07 11:07:24 +01005069#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005070 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5071 {
Ronald Crond81ab562021-02-16 09:01:16 +01005072 /* To avoid empty block, return successfully here. */
5073 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005074 }
5075 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005076#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005077 {
5078 return( PSA_ERROR_NOT_SUPPORTED );
5079 }
5080
5081 return( PSA_SUCCESS );
5082}
5083
Ronald Cron55ed0592020-10-05 10:30:40 +02005084psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005085 const psa_key_attributes_t *attributes,
5086 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005087{
5088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005089 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005090
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005091 if( ( attributes->domain_parameters == NULL ) &&
5092 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005093 return( PSA_ERROR_INVALID_ARGUMENT );
5094
Ronald Cron01b2aba2020-10-05 09:42:02 +02005095 if( key_type_is_raw_bytes( type ) )
5096 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005097 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005098 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005099 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005100
David Brown12ca5032021-02-11 11:02:00 -07005101#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005102 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005103 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005104#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005105 }
5106 else
5107
Jaeden Amero424fa932021-05-14 08:34:32 +01005108#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5109 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005110 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005111 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005112 return( mbedtls_psa_rsa_generate_key( attributes,
5113 key_buffer,
5114 key_buffer_size,
5115 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005116 }
5117 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005118#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5119 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005120
John Durkop9814fa22020-11-04 12:28:15 -08005121#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005122 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005123 {
Ronald Cron7023db52020-11-20 18:17:42 +01005124 return( mbedtls_psa_ecp_generate_key( attributes,
5125 key_buffer,
5126 key_buffer_size,
5127 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005128 }
5129 else
John Durkop9814fa22020-11-04 12:28:15 -08005130#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005131 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005132 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005133 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005134 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005135
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005136 return( PSA_SUCCESS );
5137}
Darryl Green0c6575a2018-11-07 16:05:30 +00005138
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005139psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005140 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005141{
5142 psa_status_t status;
5143 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005144 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005145 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005146
Ronald Cron81709fc2020-11-14 12:10:32 +01005147 *key = MBEDTLS_SVC_KEY_ID_INIT;
5148
Gilles Peskine0f84d622019-09-12 19:03:13 +02005149 /* Reject any attempt to create a zero-length key so that we don't
5150 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5151 if( psa_get_key_bits( attributes ) == 0 )
5152 return( PSA_ERROR_INVALID_ARGUMENT );
5153
Ronald Cron81709fc2020-11-14 12:10:32 +01005154 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5155 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005156 if( status != PSA_SUCCESS )
5157 goto exit;
5158
Ronald Cron977c2472020-10-13 08:32:21 +02005159 /* In the case of a transparent key or an opaque key stored in local
5160 * storage (thus not in the case of generating a key in a secure element
5161 * or cryptoprocessor with storage), we have to allocate a buffer to
5162 * hold the generated key material. */
5163 if( slot->key.data == NULL )
5164 {
5165 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5166 PSA_KEY_LOCATION_LOCAL_STORAGE )
5167 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005168 status = psa_validate_key_type_and_size_for_key_generation(
5169 attributes->core.type, attributes->core.bits );
5170 if( status != PSA_SUCCESS )
5171 goto exit;
5172
5173 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5174 attributes->core.type,
5175 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005176 }
5177 else
5178 {
5179 status = psa_driver_wrapper_get_key_buffer_size(
5180 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005181 if( status != PSA_SUCCESS )
5182 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005183 }
Ronald Cron977c2472020-10-13 08:32:21 +02005184
5185 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5186 if( status != PSA_SUCCESS )
5187 goto exit;
5188 }
5189
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005190 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005191 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005192
Ronald Cron2b56bc82020-10-05 10:02:26 +02005193 if( status != PSA_SUCCESS )
5194 psa_remove_key_data_from_memory( slot );
5195
Gilles Peskine11792082019-08-06 18:36:36 +02005196exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005197 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005198 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005199 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005200 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005201
Darryl Green0c6575a2018-11-07 16:05:30 +00005202 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005203}
5204
Gilles Peskinee59236f2018-01-27 23:32:46 +01005205/****************************************************************/
5206/* Module setup */
5207/****************************************************************/
5208
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005209#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005210psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5211 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5212 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5213{
5214 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5215 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005216 global_data.rng.entropy_init = entropy_init;
5217 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005218 return( PSA_SUCCESS );
5219}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005220#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005221
Gilles Peskinee59236f2018-01-27 23:32:46 +01005222void mbedtls_psa_crypto_free( void )
5223{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005224 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005225 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5226 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005227 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005228 }
5229 /* Wipe all remaining data, including configuration.
5230 * In particular, this sets all state indicator to the value
5231 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005232 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005233#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005234 /* Unregister all secure element drivers, so that we restart from
5235 * a pristine state. */
5236 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005237#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005238}
5239
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005240#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5241/** Recover a transaction that was interrupted by a power failure.
5242 *
5243 * This function is called during initialization, before psa_crypto_init()
5244 * returns. If this function returns a failure status, the initialization
5245 * fails.
5246 */
5247static psa_status_t psa_crypto_recover_transaction(
5248 const psa_crypto_transaction_t *transaction )
5249{
5250 switch( transaction->unknown.type )
5251 {
5252 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5253 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005254 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005255 * is implemented.
5256 * https://github.com/ARMmbed/mbed-crypto/issues/218
5257 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005258 default:
5259 /* We found an unsupported transaction in the storage.
5260 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005261 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005262 }
5263}
5264#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5265
Gilles Peskinee59236f2018-01-27 23:32:46 +01005266psa_status_t psa_crypto_init( void )
5267{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005268 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005269
Gilles Peskinec6b69072018-11-20 21:42:52 +01005270 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005271 if( global_data.initialized != 0 )
5272 return( PSA_SUCCESS );
5273
Gilles Peskine30524eb2020-11-13 17:02:26 +01005274 /* Initialize and seed the random generator. */
5275 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005276 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005277 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005278 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005279 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005280 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005281
Gilles Peskine66fb1262018-12-10 16:29:04 +01005282 status = psa_initialize_key_slots( );
5283 if( status != PSA_SUCCESS )
5284 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005285
Gilles Peskined9348f22019-10-01 15:22:29 +02005286#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5287 status = psa_init_all_se_drivers( );
5288 if( status != PSA_SUCCESS )
5289 goto exit;
5290#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5291
Gilles Peskine4b734222019-07-24 15:56:31 +02005292#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005293 status = psa_crypto_load_transaction( );
5294 if( status == PSA_SUCCESS )
5295 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005296 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5297 if( status != PSA_SUCCESS )
5298 goto exit;
5299 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005300 }
5301 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5302 {
5303 /* There's no transaction to complete. It's all good. */
5304 status = PSA_SUCCESS;
5305 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005306#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005307
Gilles Peskinec6b69072018-11-20 21:42:52 +01005308 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005309 global_data.initialized = 1;
5310
5311exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005312 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005313 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005314 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005315}
5316
5317#endif /* MBEDTLS_PSA_CRYPTO_C */