blob: fd2069b797f068a6d7d58be37438bbc59c985b4a [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200205 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100211 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
218#endif
219
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
221 return( PSA_ERROR_NOT_SUPPORTED );
222 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
223 return( PSA_ERROR_INVALID_ARGUMENT );
224 case MBEDTLS_ERR_MD_ALLOC_FAILED:
225 return( PSA_ERROR_INSUFFICIENT_MEMORY );
226 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
227 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100228
Gilles Peskinef76aa772018-10-29 19:24:33 +0100229 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
231 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
236 return( PSA_ERROR_BUFFER_TOO_SMALL );
237 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
238 return( PSA_ERROR_INVALID_ARGUMENT );
239 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
244 return( PSA_ERROR_INSUFFICIENT_MEMORY );
245
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100246 case MBEDTLS_ERR_PK_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
249 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100253 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
254 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
255 return( PSA_ERROR_INVALID_ARGUMENT );
256 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
257 return( PSA_ERROR_NOT_SUPPORTED );
258 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
259 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
260 return( PSA_ERROR_NOT_PERMITTED );
261 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_INVALID_ALG:
264 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
265 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
268 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200269 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
270 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100271
Gilles Peskineff2d2002019-05-06 15:26:23 +0200272 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
273 return( PSA_ERROR_HARDWARE_FAILURE );
274 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
275 return( PSA_ERROR_NOT_SUPPORTED );
276
Gilles Peskinea5905292018-02-07 20:59:33 +0100277 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_RSA_INVALID_PADDING:
280 return( PSA_ERROR_INVALID_PADDING );
281 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
286 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200287 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
289 return( PSA_ERROR_INVALID_SIGNATURE );
290 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100293 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200294
itayzafrir5c753392018-05-08 11:18:38 +0300295 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300296 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300297 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
299 return( PSA_ERROR_BUFFER_TOO_SMALL );
300 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
303 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
304 return( PSA_ERROR_INVALID_SIGNATURE );
305 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
306 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100307 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309
Janos Follatha13b9052019-11-22 12:48:59 +0000310 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
311 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300312
Gilles Peskinee59236f2018-01-27 23:32:46 +0100313 default:
David Saadab4ecc272019-02-14 13:48:10 +0200314 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 }
316}
317
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200319
320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321/****************************************************************/
322/* Key management */
323/****************************************************************/
324
John Durkop07cc04a2020-11-16 22:08:34 -0800325/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
326 * current test driver in key_management.c is using this function
327 * when accelerators are used for ECC key pair and public key.
328 * Once that dependency is resolved these guards can be removed.
329 */
John Durkop9814fa22020-11-04 12:28:15 -0800330#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800331 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
332 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
333 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100334mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100335 size_t bits,
336 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200337{
338 switch( curve )
339 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100340 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100341 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100342 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100343#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100344 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100345 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100346#endif
347#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100348 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100349 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100350#endif
351#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100352 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100353 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100354#endif
355#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100356 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100357 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100358#endif
359#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100361 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 528:
363 if( bits_is_sloppy )
364 return( MBEDTLS_ECP_DP_SECP521R1 );
365 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100367 }
368 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100369
Paul Elliott8ff510a2020-06-02 17:19:28 +0100370 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100371 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100373#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100374 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100376#endif
377#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 }
386 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100387
Paul Elliott8ff510a2020-06-02 17:19:28 +0100388 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100389 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100391#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100393 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
395 if( bits_is_sloppy )
396 return( MBEDTLS_ECP_DP_CURVE25519 );
397 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100398#endif
399#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100402#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 }
404 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100405
Paul Elliott8ff510a2020-06-02 17:19:28 +0100406 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100410 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100411 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100412#endif
413#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 }
422 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200423 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100425 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200427}
John Durkop9814fa22020-11-04 12:28:15 -0800428#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800429 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
430 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
431 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Archana4d7ae1d2021-07-07 02:50:22 +0530433psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_CAMELLIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_DES:
457 if( bits != 64 && bits != 128 && bits != 192 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200462 case PSA_KEY_TYPE_CHACHA20:
463 if( bits != 256 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200467 default:
468 return( PSA_ERROR_NOT_SUPPORTED );
469 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200470 if( bits % 8 != 0 )
471 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 return( PSA_SUCCESS );
474}
475
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100476/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100477 *
Steven Cooremancd640932021-03-08 12:00:27 +0100478 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
479 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100480 *
481 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 * \param[in] key_type The key type of the key to be used with the
483 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 *
485 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100491 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493{
Steven Cooremancd640932021-03-08 12:00:27 +0100494 if( PSA_ALG_IS_HMAC( algorithm ) )
495 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 if( key_type == PSA_KEY_TYPE_HMAC )
497 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100499
500 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
503 * key. */
504 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
505 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
506 {
507 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
508 * the block length (larger than 1) for block ciphers. */
509 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
510 return( PSA_SUCCESS );
511 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100512 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100513
514 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515}
516
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200517psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
518 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200519{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100520 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200521 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200522
Ronald Cronea0f8a62020-11-25 17:52:23 +0100523 slot->key.data = mbedtls_calloc( 1, buffer_length );
524 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200525 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200526
Ronald Cronea0f8a62020-11-25 17:52:23 +0100527 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200528 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200529}
530
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200531psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
532 const uint8_t* data,
533 size_t data_length )
534{
535 psa_status_t status = psa_allocate_buffer_to_slot( slot,
536 data_length );
537 if( status != PSA_SUCCESS )
538 return( status );
539
Ronald Cronea0f8a62020-11-25 17:52:23 +0100540 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200541 return( PSA_SUCCESS );
542}
543
Ronald Crona0fe59f2020-11-29 11:14:53 +0100544psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100545 const psa_key_attributes_t *attributes,
546 const uint8_t *data, size_t data_length,
547 uint8_t *key_buffer, size_t key_buffer_size,
548 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100549{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
551 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100552
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200553 /* zero-length keys are never supported. */
554 if( data_length == 0 )
555 return( PSA_ERROR_NOT_SUPPORTED );
556
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100557 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100559 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200560
Archana449608b2021-09-08 15:36:05 +0530561 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
562 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200563 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200564 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200565
Ronald Crondd04d422020-11-28 15:14:42 +0100566 /* Copy the key material. */
567 memcpy( key_buffer, data, data_length );
568 *key_buffer_length = data_length;
569 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200570
Steven Cooreman40120f62020-10-29 11:42:22 +0100571 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100573 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200574 {
John Durkop9814fa22020-11-04 12:28:15 -0800575#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
576 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100577 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200578 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100579 return( mbedtls_psa_ecp_import_key( attributes,
580 data, data_length,
581 key_buffer, key_buffer_size,
582 key_buffer_length,
583 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100584 }
John Durkop9814fa22020-11-04 12:28:15 -0800585#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
586 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700587#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
588 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100589 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200590 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100591 return( mbedtls_psa_rsa_import_key( attributes,
592 data, data_length,
593 key_buffer, key_buffer_size,
594 key_buffer_length,
595 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200596 }
John Durkop9814fa22020-11-04 12:28:15 -0800597#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
598 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100600
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100601 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100602}
603
Gilles Peskinef603c712019-01-19 13:40:11 +0100604/** Calculate the intersection of two algorithm usage policies.
605 *
606 * Return 0 (which allows no operation) on incompatibility.
607 */
608static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100609 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100610 psa_algorithm_t alg1,
611 psa_algorithm_t alg2 )
612{
Gilles Peskine549ea862019-05-22 11:45:59 +0200613 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100614 if( alg1 == alg2 )
615 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100616 /* If the policies are from the same hash-and-sign family, check
617 * if one is a wildcard. If so the other has the specific algorithm. */
618 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
619 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
620 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100621 {
Steven Cooreman03488022021-02-18 12:07:20 +0100622 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
623 return( alg2 );
624 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
625 return( alg1 );
626 }
627 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100628 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100629 * restrictive tag length. */
630 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
631 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
632 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
633 {
634 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
635 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100636 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100637
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100638 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100639 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
640 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100641 {
Steven Cooremancd640932021-03-08 12:00:27 +0100642 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
643 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100644 }
645 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100646 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100647 ( alg1_len <= alg2_len ) )
648 {
649 return( alg2 );
650 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100651 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100652 ( alg2_len <= alg1_len ) )
653 {
654 return( alg1 );
655 }
656 }
657 /* If the policies are from the same MAC family, check whether one
658 * of them is a minimum-MAC-length policy. Calculate the most
659 * restrictive tag length. */
660 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
661 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
662 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
663 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100664 /* Validate the combination of key type and algorithm. Since the base
665 * algorithm of alg1 and alg2 are the same, we only need this once. */
666 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100667 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100668
Steven Cooreman31a876d2021-03-03 20:47:40 +0100669 /* Get the (exact or at-least) output lengths for both sides of the
670 * requested intersection. None of the currently supported algorithms
671 * have an output length dependent on the actual key size, so setting it
672 * to a bogus value of 0 is currently OK.
673 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100674 * Note that for at-least-this-length wildcard algorithms, the output
675 * length is set to the shortest allowed length, which allows us to
676 * calculate the most restrictive tag length for the intersection. */
677 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
678 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100679 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100680
Steven Cooremana1d83222021-02-25 10:20:29 +0100681 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100682 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
683 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100684 {
Steven Cooremancd640932021-03-08 12:00:27 +0100685 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100687
688 /* If only one is an at-least-this-length policy, the intersection would
689 * be the other (fixed-length) policy as long as said fixed length is
690 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100691 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100692 {
Steven Cooremancd640932021-03-08 12:00:27 +0100693 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100694 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100695 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100696 {
Steven Cooremancd640932021-03-08 12:00:27 +0100697 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100698 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100699
Steven Cooremancd640932021-03-08 12:00:27 +0100700 /* If none of them are wildcards, check whether they define the same tag
701 * length. This is still possible here when one is default-length and
702 * the other specific-length. Ensure to always return the
703 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100704 if( alg1_len == alg2_len )
705 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100706 }
707 /* If the policies are incompatible, allow nothing. */
708 return( 0 );
709}
710
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100711static int psa_key_algorithm_permits( psa_key_type_t key_type,
712 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200713 psa_algorithm_t requested_alg )
714{
Gilles Peskine549ea862019-05-22 11:45:59 +0200715 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200716 if( requested_alg == policy_alg )
717 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100718 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
719 * and requested_alg is the same hash-and-sign family with any hash,
720 * then requested_alg is compliant with policy_alg. */
721 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
722 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200723 {
Steven Cooreman03488022021-02-18 12:07:20 +0100724 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
725 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
726 }
727 /* If policy_alg is a wildcard AEAD algorithm of the same base as
728 * the requested algorithm, check the requested tag length to be
729 * equal-length or longer than the wildcard-specified length. */
730 if( PSA_ALG_IS_AEAD( policy_alg ) &&
731 PSA_ALG_IS_AEAD( requested_alg ) &&
732 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
733 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100734 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100735 {
736 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
737 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
738 }
Steven Cooremancd640932021-03-08 12:00:27 +0100739 /* If policy_alg is a MAC algorithm of the same base as the requested
740 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100741 if( PSA_ALG_IS_MAC( policy_alg ) &&
742 PSA_ALG_IS_MAC( requested_alg ) &&
743 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100744 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100745 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100746 /* Validate the combination of key type and algorithm. Since the policy
747 * and requested algorithms are the same, we only need this once. */
748 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100749 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100750
Steven Cooreman31a876d2021-03-03 20:47:40 +0100751 /* Get both the requested output length for the algorithm which is to be
752 * verified, and the default output length for the base algorithm.
753 * Note that none of the currently supported algorithms have an output
754 * length dependent on actual key size, so setting it to a bogus value
755 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756 size_t requested_output_length = PSA_MAC_LENGTH(
757 key_type, 0, requested_alg );
758 size_t default_output_length = PSA_MAC_LENGTH(
759 key_type, 0,
760 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100761
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100762 /* If the policy is default-length, only allow an algorithm with
763 * a declared exact-length matching the default. */
764 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100765 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100766
767 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100768 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100769 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
770 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
771 {
772 return( 1 );
773 }
774
Steven Cooremancd640932021-03-08 12:00:27 +0100775 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
776 * check for the requested MAC length to be equal to or longer than the
777 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100778 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
779 {
780 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100781 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200783 }
Steven Cooremance48e852020-10-05 16:02:45 +0200784 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200785 * a key derivation with that key agreement should also be allowed. This
786 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200787 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
788 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
789 {
790 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
791 policy_alg );
792 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100793 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200794 return( 0 );
795}
796
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100797/** Test whether a policy permits an algorithm.
798 *
799 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100800 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100801 * \note This function requires providing the key type for which the policy is
802 * being validated, since some algorithm policy definitions (e.g. MAC)
803 * have different properties depending on what kind of cipher it is
804 * combined with.
805 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100806 * \retval PSA_SUCCESS When \p alg is a specific algorithm
807 * allowed by the \p policy.
808 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
809 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
810 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100811 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100812static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100813 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100815{
Steven Cooremand788fab2021-02-25 11:29:17 +0100816 /* '0' is not a valid algorithm */
817 if( alg == 0 )
818 return( PSA_ERROR_INVALID_ARGUMENT );
819
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 /* A requested algorithm cannot be a wildcard. */
821 if( PSA_ALG_IS_WILDCARD( alg ) )
822 return( PSA_ERROR_INVALID_ARGUMENT );
823
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100824 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
825 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 return( PSA_SUCCESS );
827 else
828 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100829}
830
Gilles Peskinef603c712019-01-19 13:40:11 +0100831/** Restrict a key policy based on a constraint.
832 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100833 * \note This function requires providing the key type for which the policy is
834 * being restricted, since some algorithm policy definitions (e.g. MAC)
835 * have different properties depending on what kind of cipher it is
836 * combined with.
837 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100838 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100839 * \param[in,out] policy The policy to restrict.
840 * \param[in] constraint The policy constraint to apply.
841 *
842 * \retval #PSA_SUCCESS
843 * \c *policy contains the intersection of the original value of
844 * \c *policy and \c *constraint.
845 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100846 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100847 * \c *policy is unchanged.
848 */
849static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100850 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100851 psa_key_policy_t *policy,
852 const psa_key_policy_t *constraint )
853{
854 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100855 psa_key_policy_algorithm_intersection( key_type, policy->alg,
856 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200857 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100858 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
859 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100860 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
861 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200862 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
863 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100864 policy->usage &= constraint->usage;
865 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200866 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100867 return( PSA_SUCCESS );
868}
869
Ronald Cron5c522922020-11-14 16:35:34 +0100870/** Get the description of a key given its identifier and policy constraints
871 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200872 *
Ronald Cron5c522922020-11-14 16:35:34 +0100873 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100874 * nonzero, the key must allow operations with this algorithm. If \p alg is
875 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100876 *
Ronald Cron5c522922020-11-14 16:35:34 +0100877 * In case of a persistent key, the function loads the description of the key
878 * into a key slot if not already done.
879 *
880 * On success, the returned key slot is locked. It is the responsibility of
881 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200882 */
Ronald Cron5c522922020-11-14 16:35:34 +0100883static psa_status_t psa_get_and_lock_key_slot_with_policy(
884 mbedtls_svc_key_id_t key,
885 psa_key_slot_t **p_slot,
886 psa_key_usage_t usage,
887 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100888{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200889 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
890 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100891
Ronald Cron5c522922020-11-14 16:35:34 +0100892 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100893 if( status != PSA_SUCCESS )
894 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
897 /* Enforce that usage policy for the key slot contains all the flags
898 * required by the usage parameter. There is one exception: public
899 * keys can always be exported, so we treat public key objects as
900 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200901 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100902 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903
Gilles Peskine8e338702019-07-30 20:06:31 +0200904 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100905 {
906 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200907 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100908 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100909
910 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100911 if( alg != 0 )
912 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100913 status = psa_key_policy_permits( &slot->attr.policy,
914 slot->attr.type,
915 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 if( status != PSA_SUCCESS )
917 goto error;
918 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100919
Darryl Green06fd18d2018-07-16 11:21:11 +0100920 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921
922error:
923 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100924 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200925
926 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100927}
Darryl Green940d72c2018-07-13 13:18:51 +0100928
Ronald Cron5c522922020-11-14 16:35:34 +0100929/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200930 *
931 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200932 * available, as opposed to a key in a secure element and/or to be used
933 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200934 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200935 * This is a temporary function that may be used instead of
936 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
937 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200938 *
Ronald Cron5c522922020-11-14 16:35:34 +0100939 * On success, the returned key slot is locked. It is the responsibility of the
940 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 */
Ronald Cron5c522922020-11-14 16:35:34 +0100942static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
943 mbedtls_svc_key_id_t key,
944 psa_key_slot_t **p_slot,
945 psa_key_usage_t usage,
946 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200947{
Ronald Cron5c522922020-11-14 16:35:34 +0100948 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
949 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200950 if( status != PSA_SUCCESS )
951 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952
Ronald Cronddae0f52021-08-24 15:39:44 +0200953 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200954 {
Ronald Cron5c522922020-11-14 16:35:34 +0100955 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 *p_slot = NULL;
957 return( PSA_ERROR_NOT_SUPPORTED );
958 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960 return( PSA_SUCCESS );
961}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200963psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000964{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100965 /* Data pointer will always be either a valid pointer or NULL in an
966 * initialized slot, so we can just free it. */
967 if( slot->key.data != NULL )
968 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
969
970 mbedtls_free( slot->key.data );
971 slot->key.data = NULL;
972 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000973
974 return( PSA_SUCCESS );
975}
976
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100977/** Completely wipe a slot in memory, including its policy.
978 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100979psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100980{
981 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100982
TRodziewicz18cddc02021-07-13 12:19:15 +0200983 /*
984 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200985 * do our best to report an unexpected lock counter. Assert with
986 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
987 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
988 * function is called as part of the execution of a test suite, the
989 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200990 */
Ronald Cron5c522922020-11-14 16:35:34 +0100991 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100992 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200993 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100994 status = PSA_ERROR_CORRUPTION_DETECTED;
995 }
996
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200997 /* Multipart operations may still be using the key. This is safe
998 * because all multipart operation objects are independent from
999 * the key slot: if they need to access the key after the setup
1000 * phase, they have a copy of the key. Note that this means that
1001 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001002 /* At this point, key material and other type-specific content has
1003 * been wiped. Clear remaining metadata. We can call memset and not
1004 * zeroize because the metadata is not particularly sensitive. */
1005 memset( slot, 0, sizeof( *slot ) );
1006 return( status );
1007}
1008
Ronald Croncf56a0a2020-08-04 09:51:30 +02001009psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001010{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001011 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001012 psa_status_t status; /* status of the last operation */
1013 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001014#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1015 psa_se_drv_table_entry_t *driver;
1016#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001017
Ronald Croncf56a0a2020-08-04 09:51:30 +02001018 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001019 return( PSA_SUCCESS );
1020
Ronald Cronf2911112020-10-29 17:51:10 +01001021 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001022 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001023 * key, this will load the key description from persistent memory if not
1024 * done yet. We cannot avoid this loading as without it we don't know if
1025 * the key is operated by an SE or not and this information is needed by
1026 * the current implementation.
1027 */
Ronald Cron5c522922020-11-14 16:35:34 +01001028 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001029 if( status != PSA_SUCCESS )
1030 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001031
Ronald Cronf2911112020-10-29 17:51:10 +01001032 /*
1033 * If the key slot containing the key description is under access by the
1034 * library (apart from the present access), the key cannot be destroyed
1035 * yet. For the time being, just return in error. Eventually (to be
1036 * implemented), the key should be destroyed when all accesses have
1037 * stopped.
1038 */
Ronald Cron5c522922020-11-14 16:35:34 +01001039 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001040 {
Ronald Cron5c522922020-11-14 16:35:34 +01001041 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001042 return( PSA_ERROR_GENERIC_ERROR );
1043 }
1044
Gilles Peskine6687cd02021-04-21 22:32:05 +02001045 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1046 {
1047 /* Refuse the destruction of a read-only key (which may or may not work
1048 * if we attempt it, depending on whether the key is merely read-only
1049 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001050 * Just do the best we can, which is to wipe the copy in memory
1051 * (done in this function's cleanup code). */
1052 overall_status = PSA_ERROR_NOT_PERMITTED;
1053 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001054 }
1055
Gilles Peskine354f7672019-07-12 23:46:38 +02001056#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001057 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001058 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001059 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001060 /* For a key in a secure element, we need to do three things:
1061 * remove the key file in internal storage, destroy the
1062 * key inside the secure element, and update the driver's
1063 * persistent data. Start a transaction that will encompass these
1064 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001065 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001066 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001067 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001068 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001069 status = psa_crypto_save_transaction( );
1070 if( status != PSA_SUCCESS )
1071 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001072 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001073 /* We should still try to destroy the key in the secure
1074 * element and the key metadata in storage. This is especially
1075 * important if the error is that the storage is full.
1076 * But how to do it exactly without risking an inconsistent
1077 * state after a reset?
1078 * https://github.com/ARMmbed/mbed-crypto/issues/215
1079 */
1080 overall_status = status;
1081 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001082 }
1083
Ronald Cronea0f8a62020-11-25 17:52:23 +01001084 status = psa_destroy_se_key( driver,
1085 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001086 if( overall_status == PSA_SUCCESS )
1087 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001089#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1090
Darryl Greend49a4992018-06-18 17:27:26 +01001091#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001092 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001093 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001094 status = psa_destroy_persistent_key( slot->attr.id );
1095 if( overall_status == PSA_SUCCESS )
1096 overall_status = status;
1097
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001098 /* TODO: other slots may have a copy of the same key. We should
1099 * invalidate them.
1100 * https://github.com/ARMmbed/mbed-crypto/issues/214
1101 */
Darryl Greend49a4992018-06-18 17:27:26 +01001102 }
1103#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001104
Gilles Peskinefc762652019-07-22 19:30:34 +02001105#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1106 if( driver != NULL )
1107 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001108 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001109 if( overall_status == PSA_SUCCESS )
1110 overall_status = status;
1111 status = psa_crypto_stop_transaction( );
1112 if( overall_status == PSA_SUCCESS )
1113 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001114 }
1115#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1116
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001117exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001118 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001119 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001120 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001121 overall_status = status;
1122 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001123}
1124
John Durkop07cc04a2020-11-16 22:08:34 -08001125#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001126 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001127static psa_status_t psa_get_rsa_public_exponent(
1128 const mbedtls_rsa_context *rsa,
1129 psa_key_attributes_t *attributes )
1130{
1131 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001133 uint8_t *buffer = NULL;
1134 size_t buflen;
1135 mbedtls_mpi_init( &mpi );
1136
1137 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1138 if( ret != 0 )
1139 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001140 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1141 {
1142 /* It's the default value, which is reported as an empty string,
1143 * so there's nothing to do. */
1144 goto exit;
1145 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001146
1147 buflen = mbedtls_mpi_size( &mpi );
1148 buffer = mbedtls_calloc( 1, buflen );
1149 if( buffer == NULL )
1150 {
1151 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1152 goto exit;
1153 }
1154 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1155 if( ret != 0 )
1156 goto exit;
1157 attributes->domain_parameters = buffer;
1158 attributes->domain_parameters_size = buflen;
1159
1160exit:
1161 mbedtls_mpi_free( &mpi );
1162 if( ret != 0 )
1163 mbedtls_free( buffer );
1164 return( mbedtls_to_psa_error( ret ) );
1165}
John Durkop07cc04a2020-11-16 22:08:34 -08001166#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001167 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001168
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001169/** Retrieve all the publicly-accessible attributes of a key.
1170 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001171psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001172 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001173{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001175 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001176 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001177
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001178 psa_reset_key_attributes( attributes );
1179
Ronald Cron5c522922020-11-14 16:35:34 +01001180 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001181 if( status != PSA_SUCCESS )
1182 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001183
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001184 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001185 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1186 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1187
1188#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001189 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001190 psa_set_key_slot_number( attributes,
1191 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001192#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001193
Gilles Peskine8e338702019-07-30 20:06:31 +02001194 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001195 {
John Durkop07cc04a2020-11-16 22:08:34 -08001196#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001197 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001198 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001199 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001200 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001201 * is not yet implemented.
1202 * https://github.com/ARMmbed/mbed-crypto/issues/216
1203 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001204 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001205 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001206 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001207
Ronald Cron90857082020-11-25 14:58:33 +01001208 status = mbedtls_psa_rsa_load_representation(
1209 slot->attr.type,
1210 slot->key.data,
1211 slot->key.bytes,
1212 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 if( status != PSA_SUCCESS )
1214 break;
1215
Steven Cooremana2371e52020-07-28 14:30:39 +02001216 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001217 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001218 mbedtls_rsa_free( rsa );
1219 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001221 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001222#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001223 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001224 default:
1225 /* Nothing else to do. */
1226 break;
1227 }
1228
1229 if( status != PSA_SUCCESS )
1230 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001231
Ronald Cron5c522922020-11-14 16:35:34 +01001232 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001233
Ronald Cron5c522922020-11-14 16:35:34 +01001234 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001235}
1236
Gilles Peskinec8000c02019-08-02 20:15:51 +02001237#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1238psa_status_t psa_get_key_slot_number(
1239 const psa_key_attributes_t *attributes,
1240 psa_key_slot_number_t *slot_number )
1241{
1242 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1243 {
1244 *slot_number = attributes->slot_number;
1245 return( PSA_SUCCESS );
1246 }
1247 else
1248 return( PSA_ERROR_INVALID_ARGUMENT );
1249}
1250#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1251
Ronald Crond18b5f82020-11-25 16:46:05 +01001252static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1253 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001254 uint8_t *data,
1255 size_t data_size,
1256 size_t *data_length )
1257{
Ronald Crond18b5f82020-11-25 16:46:05 +01001258 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001259 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001260 memcpy( data, key_buffer, key_buffer_size );
1261 memset( data + key_buffer_size, 0,
1262 data_size - key_buffer_size );
1263 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001264 return( PSA_SUCCESS );
1265}
1266
Ronald Cron7285cda2020-11-26 14:46:37 +01001267psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001268 const psa_key_attributes_t *attributes,
1269 const uint8_t *key_buffer, size_t key_buffer_size,
1270 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001271{
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 psa_key_type_t type = attributes->core.type;
1273
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 if( key_type_is_raw_bytes( type ) ||
1275 PSA_KEY_TYPE_IS_RSA( type ) ||
1276 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001277 {
1278 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001279 key_buffer, key_buffer_size,
1280 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001281 }
1282 else
1283 {
1284 /* This shouldn't happen in the reference implementation, but
1285 it is valid for a special-purpose implementation to omit
1286 support for exporting certain key types. */
1287 return( PSA_ERROR_NOT_SUPPORTED );
1288 }
1289}
1290
1291psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1292 uint8_t *data,
1293 size_t data_size,
1294 size_t *data_length )
1295{
1296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1297 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1298 psa_key_slot_t *slot;
1299
Ronald Crone907e552021-01-18 13:22:38 +01001300 /* Reject a zero-length output buffer now, since this can never be a
1301 * valid key representation. This way we know that data must be a valid
1302 * pointer and we can do things like memset(data, ..., data_size). */
1303 if( data_size == 0 )
1304 return( PSA_ERROR_BUFFER_TOO_SMALL );
1305
Ronald Cron9486f9d2020-11-26 13:36:23 +01001306 /* Set the key to empty now, so that even when there are errors, we always
1307 * set data_length to a value between 0 and data_size. On error, setting
1308 * the key to empty is a good choice because an empty key representation is
1309 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001310 *data_length = 0;
1311
Ronald Cron9486f9d2020-11-26 13:36:23 +01001312 /* Export requires the EXPORT flag. There is an exception for public keys,
1313 * which don't require any flag, but
1314 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1315 */
1316 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1317 PSA_KEY_USAGE_EXPORT, 0 );
1318 if( status != PSA_SUCCESS )
1319 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001320
Ronald Crond18b5f82020-11-25 16:46:05 +01001321 psa_key_attributes_t attributes = {
1322 .core = slot->attr
1323 };
Ronald Cron67227982020-11-26 15:16:05 +01001324 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001325 slot->key.data, slot->key.bytes,
1326 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327
Ronald Cron9486f9d2020-11-26 13:36:23 +01001328 unlock_status = psa_unlock_key_slot( slot );
1329
1330 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1331}
1332
Ronald Cron7285cda2020-11-26 14:46:37 +01001333psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001334 const psa_key_attributes_t *attributes,
1335 const uint8_t *key_buffer,
1336 size_t key_buffer_size,
1337 uint8_t *data,
1338 size_t data_size,
1339 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001340{
Ronald Crond18b5f82020-11-25 16:46:05 +01001341 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001342
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001344 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001346 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001347 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001348 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 key_buffer, key_buffer_size,
1350 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001351 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001352
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001354 {
John Durkop0e005192020-10-31 22:06:54 -07001355#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1356 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001357 return( mbedtls_psa_rsa_export_public_key( attributes,
1358 key_buffer,
1359 key_buffer_size,
1360 data,
1361 data_size,
1362 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001363#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001364 /* We don't know how to convert a private RSA key to public. */
1365 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001366#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1367 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001368 }
1369 else
Moran Pekera998bc62018-04-16 18:16:20 +03001370 {
John Durkop6ba40d12020-11-10 08:50:04 -08001371#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1372 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001373 return( mbedtls_psa_ecp_export_public_key( attributes,
1374 key_buffer,
1375 key_buffer_size,
1376 data,
1377 data_size,
1378 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001379#else
1380 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001381 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001382#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1383 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001384 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001385 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001386 else
1387 {
1388 /* This shouldn't happen in the reference implementation, but
1389 it is valid for a special-purpose implementation to omit
1390 support for exporting certain key types. */
1391 return( PSA_ERROR_NOT_SUPPORTED );
1392 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001393}
Ronald Crond18b5f82020-11-25 16:46:05 +01001394
Ronald Croncf56a0a2020-08-04 09:51:30 +02001395psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001396 uint8_t *data,
1397 size_t data_size,
1398 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001399{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001401 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001402 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001403
Ronald Crone907e552021-01-18 13:22:38 +01001404 /* Reject a zero-length output buffer now, since this can never be a
1405 * valid key representation. This way we know that data must be a valid
1406 * pointer and we can do things like memset(data, ..., data_size). */
1407 if( data_size == 0 )
1408 return( PSA_ERROR_BUFFER_TOO_SMALL );
1409
Darryl Greendd8fb772018-11-07 16:00:44 +00001410 /* Set the key to empty now, so that even when there are errors, we always
1411 * set data_length to a value between 0 and data_size. On error, setting
1412 * the key to empty is a good choice because an empty key representation is
1413 * unlikely to be accepted anywhere. */
1414 *data_length = 0;
1415
1416 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001417 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001418 if( status != PSA_SUCCESS )
1419 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001420
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1422 {
1423 status = PSA_ERROR_INVALID_ARGUMENT;
1424 goto exit;
1425 }
1426
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 psa_key_attributes_t attributes = {
1428 .core = slot->attr
1429 };
Ronald Cron67227982020-11-26 15:16:05 +01001430 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 &attributes, slot->key.data, slot->key.bytes,
1432 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433
1434exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001435 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001436
Ronald Cron5c522922020-11-14 16:35:34 +01001437 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001438}
1439
Gilles Peskine91e8c332019-08-02 19:19:39 +02001440#if defined(static_assert)
1441static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1442 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001443static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001444 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001445static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446 "One or more key attribute flag is listed as both internal-only and external-only" );
1447#endif
1448
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001449/** Validate that a key policy is internally well-formed.
1450 *
1451 * This function only rejects invalid policies. It does not validate the
1452 * consistency of the policy with respect to other attributes of the key
1453 * such as the key type.
1454 */
1455static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001456{
1457 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001458 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001459 PSA_KEY_USAGE_ENCRYPT |
1460 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001461 PSA_KEY_USAGE_SIGN_MESSAGE |
1462 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001463 PSA_KEY_USAGE_SIGN_HASH |
1464 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001465 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001466 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1467 return( PSA_ERROR_INVALID_ARGUMENT );
1468
Gilles Peskine4747d192019-04-17 15:05:45 +02001469 return( PSA_SUCCESS );
1470}
1471
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001472/** Validate the internal consistency of key attributes.
1473 *
1474 * This function only rejects invalid attribute values. If does not
1475 * validate the consistency of the attributes with any key data that may
1476 * be involved in the creation of the key.
1477 *
1478 * Call this function early in the key creation process.
1479 *
1480 * \param[in] attributes Key attributes for the new key.
1481 * \param[out] p_drv On any return, the driver for the key, if any.
1482 * NULL for a transparent key.
1483 *
1484 */
1485static psa_status_t psa_validate_key_attributes(
1486 const psa_key_attributes_t *attributes,
1487 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001488{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001489 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001490 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001491 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001492
Ronald Cron54b90082020-10-29 15:26:43 +01001493 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001494 if( status != PSA_SUCCESS )
1495 return( status );
1496
Ronald Crond2ed4812020-07-17 16:11:30 +02001497 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001498 if( status != PSA_SUCCESS )
1499 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001500
Ronald Cron65f38a32020-10-23 17:11:13 +02001501 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1502 {
1503 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1504 return( PSA_ERROR_INVALID_ARGUMENT );
1505 }
1506 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001507 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001508 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1509 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001510 }
1511
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001512 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001513 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514 return( status );
1515
1516 /* Refuse to create overly large keys.
1517 * Note that this doesn't trigger on import if the attributes don't
1518 * explicitly specify a size (so psa_get_key_bits returns 0), so
1519 * psa_import_key() needs its own checks. */
1520 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1521 return( PSA_ERROR_NOT_SUPPORTED );
1522
Gilles Peskine91e8c332019-08-02 19:19:39 +02001523 /* Reject invalid flags. These should not be reachable through the API. */
1524 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1525 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1526 return( PSA_ERROR_INVALID_ARGUMENT );
1527
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001528 return( PSA_SUCCESS );
1529}
1530
Gilles Peskine4747d192019-04-17 15:05:45 +02001531/** Prepare a key slot to receive key material.
1532 *
1533 * This function allocates a key slot and sets its metadata.
1534 *
1535 * If this function fails, call psa_fail_key_creation().
1536 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001537 * This function is intended to be used as follows:
1538 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001539 * it with the specified attributes, and in case of a volatile key assign it
1540 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001541 * -# Populate the slot with the key material.
1542 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1543 * In case of failure at any step, stop the sequence and call
1544 * psa_fail_key_creation().
1545 *
Ronald Cron5c522922020-11-14 16:35:34 +01001546 * On success, the key slot is locked. It is the responsibility of the caller
1547 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001548 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001549 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001550 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001551 * \param[out] p_slot On success, a pointer to the prepared slot.
1552 * \param[out] p_drv On any return, the driver for the key, if any.
1553 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001554 *
1555 * \retval #PSA_SUCCESS
1556 * The key slot is ready to receive key material.
1557 * \return If this function fails, the key slot is an invalid state.
1558 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001559 */
1560static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001561 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001562 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001563 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001564 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001565{
1566 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001567 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 psa_key_slot_t *slot;
1569
Gilles Peskinedf179142019-07-15 22:02:14 +02001570 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001571 *p_drv = NULL;
1572
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001573 status = psa_validate_key_attributes( attributes, p_drv );
1574 if( status != PSA_SUCCESS )
1575 return( status );
1576
Ronald Cronc4d1b512020-07-31 11:26:37 +02001577 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001578 if( status != PSA_SUCCESS )
1579 return( status );
1580 slot = *p_slot;
1581
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001582 /* We're storing the declared bit-size of the key. It's up to each
1583 * creation mechanism to verify that this information is correct.
1584 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001585 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001586 * is optional (import, copy). In case of a volatile key, assign it the
1587 * volatile key identifier associated to the slot returned to contain its
1588 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001589
1590 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001591 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1592 {
1593#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1594 slot->attr.id = volatile_key_id;
1595#else
1596 slot->attr.id.key_id = volatile_key_id;
1597#endif
1598 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001599
Gilles Peskine91e8c332019-08-02 19:19:39 +02001600 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001601 * external-only flags, query `attributes`. Thanks to the check
1602 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001603 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001604 * may have set. */
1605 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606
Gilles Peskinecbaff462019-07-12 23:46:04 +02001607#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001608 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001609 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001610 * create the key file in internal storage, create the
1611 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001612 * persistent data. This is done by starting a transaction that will
1613 * encompass these three actions.
1614 * For registering a volatile key, we just need to find an appropriate
1615 * slot number inside the SE. Since the key is designated volatile, creating
1616 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001617 /* The first thing to do is to find a slot number for the new key.
1618 * We save the slot number in persistent storage as part of the
1619 * transaction data. It will be needed to recover if the power
1620 * fails during the key creation process, to clean up on the secure
1621 * element side after restarting. Obtaining a slot number from the
1622 * secure element driver updates its persistent state, but we do not yet
1623 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001624 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001625 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001626 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001627 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001628 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001629 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001630 if( status != PSA_SUCCESS )
1631 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001632
1633 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001634 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001635 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1636 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001637 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001638 psa_crypto_transaction.key.id = slot->attr.id;
1639 status = psa_crypto_save_transaction( );
1640 if( status != PSA_SUCCESS )
1641 {
1642 (void) psa_crypto_stop_transaction( );
1643 return( status );
1644 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001645 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001646
1647 status = psa_copy_key_material_into_slot(
1648 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001649 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001650
1651 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1652 {
1653 /* Key registration only makes sense with a secure element. */
1654 return( PSA_ERROR_INVALID_ARGUMENT );
1655 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001656#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1657
Ronald Cronc4d1b512020-07-31 11:26:37 +02001658 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001659}
Gilles Peskine4747d192019-04-17 15:05:45 +02001660
1661/** Finalize the creation of a key once its key material has been set.
1662 *
1663 * This entails writing the key to persistent storage.
1664 *
1665 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001666 * See the documentation of psa_start_key_creation() for the intended use
1667 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001668 *
Ronald Cron5c522922020-11-14 16:35:34 +01001669 * If the finalization succeeds, the function unlocks the key slot (it was
1670 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1671 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001672 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001673 * \param[in,out] slot Pointer to the slot with key material.
1674 * \param[in] driver The secure element driver for the key,
1675 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001676 * \param[out] key On success, identifier of the key. Note that the
1677 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001678 *
1679 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001680 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001681 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1682 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1683 * \retval #PSA_ERROR_ALREADY_EXISTS
1684 * \retval #PSA_ERROR_DATA_INVALID
1685 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001686 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001687 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001688 * \return If this function fails, the key slot is an invalid state.
1689 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001690 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001691static psa_status_t psa_finish_key_creation(
1692 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001693 psa_se_drv_table_entry_t *driver,
1694 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001695{
1696 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001697 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001698 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001699
1700#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001701 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001703#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1704 if( driver != NULL )
1705 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001706 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001707 psa_key_slot_number_t slot_number =
1708 psa_key_slot_get_slot_number( slot ) ;
1709
Gilles Peskineb46bef22019-07-30 21:32:04 +02001710#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001711 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001712 sizeof( data.slot_number ),
1713 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001716 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001717 (uint8_t*) &data,
1718 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001719 }
1720 else
1721#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1722 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001723 /* Key material is saved in export representation in the slot, so
1724 * just pass the slot buffer for storage. */
1725 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001726 slot->key.data,
1727 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001728 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001729 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001730#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1731
Gilles Peskinecbaff462019-07-12 23:46:04 +02001732#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001733 /* Finish the transaction for a key creation. This does not
1734 * happen when registering an existing key. Detect this case
1735 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001736 * creation of a persistent key in a secure element requires a transaction,
1737 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001738 if( driver != NULL &&
1739 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740 {
1741 status = psa_save_se_persistent_data( driver );
1742 if( status != PSA_SUCCESS )
1743 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001744 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001745 return( status );
1746 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001747 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748 }
1749#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1750
Ronald Cron50972942020-11-14 11:28:25 +01001751 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001752 {
1753 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001754 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001755 if( status != PSA_SUCCESS )
1756 *key = MBEDTLS_SVC_KEY_ID_INIT;
1757 }
Ronald Cron50972942020-11-14 11:28:25 +01001758
Gilles Peskine4747d192019-04-17 15:05:45 +02001759 return( status );
1760}
1761
1762/** Abort the creation of a key.
1763 *
1764 * You may call this function after calling psa_start_key_creation(),
1765 * or after psa_finish_key_creation() fails. In other circumstances, this
1766 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001767 * See the documentation of psa_start_key_creation() for the intended use
1768 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001769 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001770 * \param[in,out] slot Pointer to the slot with key material.
1771 * \param[in] driver The secure element driver for the key,
1772 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001774static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001775 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001776{
Gilles Peskine011e4282019-06-26 18:34:38 +02001777 (void) driver;
1778
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 if( slot == NULL )
1780 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781
1782#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001783 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001784 * element, and the failure happened later (when saving metadata
1785 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001786 * element.
1787 * https://github.com/ARMmbed/mbed-crypto/issues/217
1788 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001789
Gilles Peskined7729582019-08-05 15:55:54 +02001790 /* Abort the ongoing transaction if any (there may not be one if
1791 * the creation process failed before starting one, or if the
1792 * key creation is a registration of a key in a secure element).
1793 * Earlier functions must already have done what it takes to undo any
1794 * partial creation. All that's left is to update the transaction data
1795 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001796 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001797#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1798
Gilles Peskine4747d192019-04-17 15:05:45 +02001799 psa_wipe_key_slot( slot );
1800}
1801
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001802/** Validate optional attributes during key creation.
1803 *
1804 * Some key attributes are optional during key creation. If they are
1805 * specified in the attributes structure, check that they are consistent
1806 * with the data in the slot.
1807 *
1808 * This function should be called near the end of key creation, after
1809 * the slot in memory is fully populated but before saving persistent data.
1810 */
1811static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001812 const psa_key_slot_t *slot,
1813 const psa_key_attributes_t *attributes )
1814{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001815 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001816 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001817 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001818 return( PSA_ERROR_INVALID_ARGUMENT );
1819 }
1820
1821 if( attributes->domain_parameters_size != 0 )
1822 {
John Durkop0e005192020-10-31 22:06:54 -07001823#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1824 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001825 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001827 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001828 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001830
Ronald Cron90857082020-11-25 14:58:33 +01001831 psa_status_t status = mbedtls_psa_rsa_load_representation(
1832 slot->attr.type,
1833 slot->key.data,
1834 slot->key.bytes,
1835 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001836 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001837 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001838
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001839 mbedtls_mpi_init( &actual );
1840 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001841 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001843 mbedtls_rsa_free( rsa );
1844 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001845 if( ret != 0 )
1846 goto rsa_exit;
1847 ret = mbedtls_mpi_read_binary( &required,
1848 attributes->domain_parameters,
1849 attributes->domain_parameters_size );
1850 if( ret != 0 )
1851 goto rsa_exit;
1852 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1853 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1854 rsa_exit:
1855 mbedtls_mpi_free( &actual );
1856 mbedtls_mpi_free( &required );
1857 if( ret != 0)
1858 return( mbedtls_to_psa_error( ret ) );
1859 }
1860 else
John Durkop9814fa22020-11-04 12:28:15 -08001861#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1862 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 {
1864 return( PSA_ERROR_INVALID_ARGUMENT );
1865 }
1866 }
1867
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001868 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001870 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 return( PSA_ERROR_INVALID_ARGUMENT );
1872 }
1873
1874 return( PSA_SUCCESS );
1875}
1876
Gilles Peskine4747d192019-04-17 15:05:45 +02001877psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001878 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001879 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001880 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001881{
1882 psa_status_t status;
1883 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001884 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001885 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301886 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887
Ronald Cron81709fc2020-11-14 12:10:32 +01001888 *key = MBEDTLS_SVC_KEY_ID_INIT;
1889
Gilles Peskine0f84d622019-09-12 19:03:13 +02001890 /* Reject zero-length symmetric keys (including raw data key objects).
1891 * This also rejects any key which might be encoded as an empty string,
1892 * which is never valid. */
1893 if( data_length == 0 )
1894 return( PSA_ERROR_INVALID_ARGUMENT );
1895
Archana449608b2021-09-08 15:36:05 +05301896 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301897 if( data_length > SIZE_MAX / 8 )
1898 return( PSA_ERROR_NOT_SUPPORTED );
1899
Gilles Peskinedf179142019-07-15 22:02:14 +02001900 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001901 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001902 if( status != PSA_SUCCESS )
1903 goto exit;
1904
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001905 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301906 * storage ( thus not in the case of importing a key in a secure element
1907 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1908 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001909 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001910 {
Archanad8a83dc2021-06-14 10:04:16 +05301911 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1912 {
Archana449608b2021-09-08 15:36:05 +05301913 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1914 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301915 if( status != PSA_SUCCESS )
1916 goto exit;
1917 }
1918 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001919 if( status != PSA_SUCCESS )
1920 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001921 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001922
1923 bits = slot->attr.bits;
1924 status = psa_driver_wrapper_import_key( attributes,
1925 data, data_length,
1926 slot->key.data,
1927 slot->key.bytes,
1928 &slot->key.bytes, &bits );
1929 if( status != PSA_SUCCESS )
1930 goto exit;
1931
1932 if( slot->attr.bits == 0 )
1933 slot->attr.bits = (psa_key_bits_t) bits;
1934 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001935 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001936 status = PSA_ERROR_INVALID_ARGUMENT;
1937 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001938 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001939
Archana6ed4bda2021-08-04 10:47:15 +05301940 /* Enforce a size limit, and in particular ensure that the bit
1941 * size fits in its representation type.*/
1942 if( bits > PSA_MAX_KEY_BITS )
1943 {
1944 status = PSA_ERROR_NOT_SUPPORTED;
1945 goto exit;
1946 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001947 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001948 if( status != PSA_SUCCESS )
1949 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001950
Ronald Cron81709fc2020-11-14 12:10:32 +01001951 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001953 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001954 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001955
Gilles Peskine4747d192019-04-17 15:05:45 +02001956 return( status );
1957}
1958
Gilles Peskined7729582019-08-05 15:55:54 +02001959#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1960psa_status_t mbedtls_psa_register_se_key(
1961 const psa_key_attributes_t *attributes )
1962{
1963 psa_status_t status;
1964 psa_key_slot_t *slot = NULL;
1965 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001966 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001967
1968 /* Leaving attributes unspecified is not currently supported.
1969 * It could make sense to query the key type and size from the
1970 * secure element, but not all secure elements support this
1971 * and the driver HAL doesn't currently support it. */
1972 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1973 return( PSA_ERROR_NOT_SUPPORTED );
1974 if( psa_get_key_bits( attributes ) == 0 )
1975 return( PSA_ERROR_NOT_SUPPORTED );
1976
1977 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001979 if( status != PSA_SUCCESS )
1980 goto exit;
1981
Ronald Cron81709fc2020-11-14 12:10:32 +01001982 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001983
1984exit:
1985 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001986 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001987
Gilles Peskined7729582019-08-05 15:55:54 +02001988 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001989 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001990 return( status );
1991}
1992#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1993
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001995 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001996 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001997{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001999 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002000 psa_key_slot_t *source_slot = NULL;
2001 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002002 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002003 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302004 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002005
Ronald Cron81709fc2020-11-14 12:10:32 +01002006 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2007
Archana8a180362021-07-05 02:18:48 +05302008 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002009 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002010 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002011 goto exit;
2012
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002013 status = psa_validate_optional_attributes( source_slot,
2014 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002015 if( status != PSA_SUCCESS )
2016 goto exit;
2017
Archana9d17bf42021-09-10 06:22:44 +05302018 /* The target key type and number of bits have been validated by
2019 * psa_validate_optional_attributes() to be either equal to zero or
2020 * equal to the ones of the source key. So it is safe to inherit
2021 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302022 * */
Archana9d17bf42021-09-10 06:22:44 +05302023 actual_attributes.core.bits = source_slot->attr.bits;
2024 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302025
2026
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002027 status = psa_restrict_key_policy( source_slot->attr.type,
2028 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002029 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 if( status != PSA_SUCCESS )
2031 goto exit;
2032
Ronald Cron81709fc2020-11-14 12:10:32 +01002033 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2034 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002035 if( status != PSA_SUCCESS )
2036 goto exit;
Archana8a180362021-07-05 02:18:48 +05302037 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2038 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002039 {
Archana8a180362021-07-05 02:18:48 +05302040 /*
Archana9d17bf42021-09-10 06:22:44 +05302041 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302042 * the source key would need to be exported as plaintext and re-imported
2043 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302044 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302045 * appropriate API invocations from the application, if needed.
2046 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002047 status = PSA_ERROR_NOT_SUPPORTED;
2048 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002049 }
Archana8a180362021-07-05 02:18:48 +05302050 /*
2051 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302052 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302053 * - For opaque keys this translates to an invocation of the drivers'
2054 * copy_key entry point through the dispatch layer.
2055 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002056 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2057 {
Archana8a180362021-07-05 02:18:48 +05302058 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302059 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302060 if( status != PSA_SUCCESS )
2061 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302062
Archana8a180362021-07-05 02:18:48 +05302063 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2064 if( status != PSA_SUCCESS )
2065 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302066
Archana8a180362021-07-05 02:18:48 +05302067 status = psa_driver_wrapper_copy_key( &actual_attributes,
2068 source_slot->key.data,
2069 source_slot->key.bytes,
2070 target_slot->key.data,
2071 target_slot->key.bytes,
2072 &target_slot->key.bytes );
2073 if( status != PSA_SUCCESS )
2074 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002075 }
Archana8a180362021-07-05 02:18:48 +05302076 else
2077 {
Archana9d17bf42021-09-10 06:22:44 +05302078 status = psa_copy_key_material_into_slot( target_slot,
2079 source_slot->key.data,
2080 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302081 if( status != PSA_SUCCESS )
2082 goto exit;
2083 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002084 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002085exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002086 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002087 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002088
Ronald Cron5c522922020-11-14 16:35:34 +01002089 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002090
Ronald Cron5c522922020-11-14 16:35:34 +01002091 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002092}
2093
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002094
2095
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002096/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002097/* Message digests */
2098/****************************************************************/
2099
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002100psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2101{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002102 /* Aborting a non-active operation is allowed */
2103 if( operation->id == 0 )
2104 return( PSA_SUCCESS );
2105
2106 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2107 operation->id = 0;
2108
2109 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002110}
2111
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002112psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002113 psa_algorithm_t alg )
2114{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002116
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002117 /* A context must be freshly initialized before it can be set up. */
2118 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002119 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002120 status = PSA_ERROR_BAD_STATE;
2121 goto exit;
2122 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002123
2124 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002125 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 status = PSA_ERROR_INVALID_ARGUMENT;
2127 goto exit;
2128 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002129
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002130 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2131 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002132 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2133
Dave Rodgman685b6a72021-06-24 11:49:14 +01002134 status = psa_driver_wrapper_hash_setup( operation, alg );
2135
2136exit:
2137 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002138 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002139
2140 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002141}
2142
2143psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2144 const uint8_t *input,
2145 size_t input_length )
2146{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2148
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002149 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002150 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002151 status = PSA_ERROR_BAD_STATE;
2152 goto exit;
2153 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002154
Steven Cooremanc8288352021-03-04 14:02:19 +01002155 /* Don't require hash implementations to behave correctly on a
2156 * zero-length input, which may have an invalid pointer. */
2157 if( input_length == 0 )
2158 return( PSA_SUCCESS );
2159
Dave Rodgman685b6a72021-06-24 11:49:14 +01002160 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2161
2162exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 if( status != PSA_SUCCESS )
2164 psa_hash_abort( operation );
2165
2166 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167}
2168
2169psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2170 uint8_t *hash,
2171 size_t hash_size,
2172 size_t *hash_length )
2173{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002174 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002175 if( operation->id == 0 )
2176 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177
Steven Cooreman1e582352021-02-18 17:24:37 +01002178 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002179 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002180 psa_hash_abort( operation );
2181 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182}
2183
Gilles Peskine2d277862018-06-18 15:41:12 +02002184psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2185 const uint8_t *hash,
2186 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187{
2188 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2189 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002190 psa_status_t status = psa_hash_finish(
2191 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002192 actual_hash, sizeof( actual_hash ),
2193 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002194
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002196 goto exit;
2197
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002198 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002199 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200 status = PSA_ERROR_INVALID_SIGNATURE;
2201 goto exit;
2202 }
2203
Steven Cooreman36876a02021-04-29 16:37:59 +02002204 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002205 status = PSA_ERROR_INVALID_SIGNATURE;
2206
2207exit:
2208 if( status != PSA_SUCCESS )
2209 psa_hash_abort(operation);
2210
2211 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212}
2213
Gilles Peskine0a749c82019-11-28 19:33:58 +01002214psa_status_t psa_hash_compute( psa_algorithm_t alg,
2215 const uint8_t *input, size_t input_length,
2216 uint8_t *hash, size_t hash_size,
2217 size_t *hash_length )
2218{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002219 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002220 if( !PSA_ALG_IS_HASH( alg ) )
2221 return( PSA_ERROR_INVALID_ARGUMENT );
2222
Steven Cooreman1e582352021-02-18 17:24:37 +01002223 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2224 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002225}
2226
2227psa_status_t psa_hash_compare( psa_algorithm_t alg,
2228 const uint8_t *input, size_t input_length,
2229 const uint8_t *hash, size_t hash_length )
2230{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002231 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2232 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002233
2234 if( !PSA_ALG_IS_HASH( alg ) )
2235 return( PSA_ERROR_INVALID_ARGUMENT );
2236
Steven Cooreman1e582352021-02-18 17:24:37 +01002237 psa_status_t status = psa_driver_wrapper_hash_compute(
2238 alg, input, input_length,
2239 actual_hash, sizeof(actual_hash),
2240 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002241 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002242 return( status );
2243 if( actual_hash_length != hash_length )
2244 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002245 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002246 return( PSA_ERROR_INVALID_SIGNATURE );
2247 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002248}
2249
Gilles Peskineeb35d782019-01-22 17:56:16 +01002250psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2251 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002252{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002253 if( source_operation->id == 0 ||
2254 target_operation->id != 0 )
2255 {
2256 return( PSA_ERROR_BAD_STATE );
2257 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002258
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002259 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2260 target_operation );
2261 if( status != PSA_SUCCESS )
2262 psa_hash_abort( target_operation );
2263
2264 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002265}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002266
2267
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002268/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002269/* MAC */
2270/****************************************************************/
2271
Steven Cooremane6804192021-03-19 18:28:56 +01002272psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002273{
Steven Cooremane6804192021-03-19 18:28:56 +01002274 /* Aborting a non-active operation is allowed */
2275 if( operation->id == 0 )
2276 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002277
Steven Cooremane6804192021-03-19 18:28:56 +01002278 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002279 operation->mac_size = 0;
2280 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002281 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002282
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002283 return( status );
2284}
2285
Ronald Cron2dff3b22021-06-17 16:33:22 +02002286static psa_status_t psa_mac_finalize_alg_and_key_validation(
2287 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002288 const psa_key_attributes_t *attributes,
2289 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002290{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002291 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002292 psa_key_type_t key_type = psa_get_key_type( attributes );
2293 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002294
Ronald Cron28ea0502021-06-17 16:10:24 +02002295 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002296 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002297
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002298 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002299 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002300 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002302
Steven Cooremand1a68f12021-05-10 11:13:41 +02002303 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002304 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002305
Ronald Cron79bdd822021-06-17 16:46:44 +02002306 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002307 {
2308 /* A very short MAC is too short for security since it can be
2309 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2310 * so we make this our minimum, even though 32 bits is still
2311 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002312 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002313 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002314
Ronald Cron79bdd822021-06-17 16:46:44 +02002315 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2316 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002317 {
2318 /* It's impossible to "truncate" to a larger length than the full length
2319 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002320 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002321 }
2322
Ronald Cron79bdd822021-06-17 16:46:44 +02002323 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002324}
2325
Gilles Peskinee59236f2018-01-27 23:32:46 +01002326static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2327 mbedtls_svc_key_id_t key,
2328 psa_algorithm_t alg,
2329 int is_sign )
2330{
2331 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2332 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002333 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002334
2335 /* A context must be freshly initialized before it can be set up. */
2336 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002337 {
Dave Rodgman54648242021-06-24 11:49:45 +01002338 status = PSA_ERROR_BAD_STATE;
2339 goto exit;
2340 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002341
2342 status = psa_get_and_lock_key_slot_with_policy(
2343 key,
2344 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002345 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346 alg );
2347 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002348 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349
2350 psa_key_attributes_t attributes = {
2351 .core = slot->attr
2352 };
2353
Ronald Cron79bdd822021-06-17 16:46:44 +02002354 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2355 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356 if( status != PSA_SUCCESS )
2357 goto exit;
2358
2359 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002360 /* Dispatch the MAC setup call with validated input */
2361 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002362 {
Steven Cooremane6804192021-03-19 18:28:56 +01002363 status = psa_driver_wrapper_mac_sign_setup( operation,
2364 &attributes,
2365 slot->key.data,
2366 slot->key.bytes,
2367 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002368 }
2369 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002370 {
Steven Cooremane6804192021-03-19 18:28:56 +01002371 status = psa_driver_wrapper_mac_verify_setup( operation,
2372 &attributes,
2373 slot->key.data,
2374 slot->key.bytes,
2375 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002376 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002377
Gilles Peskinefbfac682018-07-08 20:51:54 +02002378exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002379 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002380 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002381
Ronald Cron5c522922020-11-14 16:35:34 +01002382 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002383
Ronald Cron5c522922020-11-14 16:35:34 +01002384 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002385}
2386
Gilles Peskine89167cb2018-07-08 20:12:23 +02002387psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002388 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002389 psa_algorithm_t alg )
2390{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002391 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002392}
2393
2394psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002395 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002396 psa_algorithm_t alg )
2397{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002398 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002399}
2400
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002401psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002402 const uint8_t *input,
2403 size_t input_length )
2404{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002405 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002406 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002407
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002408 /* Don't require hash implementations to behave correctly on a
2409 * zero-length input, which may have an invalid pointer. */
2410 if( input_length == 0 )
2411 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002412
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002413 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2414 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002415 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002416 psa_mac_abort( operation );
2417
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002418 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419}
2420
Steven Cooremana5b860a2021-03-19 19:04:39 +01002421psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002422 uint8_t *mac,
2423 size_t mac_size,
2424 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002425{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2427 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002428
Steven Cooremana5b860a2021-03-19 19:04:39 +01002429 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002430 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002431 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002432 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002433 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002434
Steven Cooreman72f736a2021-05-07 14:14:37 +02002435 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002436 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002437 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002438 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002439 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002440
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002441 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2442 * once all the error checks are done. */
2443 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002444 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002445 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002446 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002447 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002448
2449 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002450 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002451 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002452 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002453 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002454
Steven Cooremana5b860a2021-03-19 19:04:39 +01002455 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002456 mac, operation->mac_size,
2457 mac_length );
2458
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002459exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002460 /* In case of success, set the potential excess room in the output buffer
2461 * to an invalid value, to avoid potentially leaking a longer MAC.
2462 * In case of error, set the output length and content to a safe default,
2463 * such that in case the caller misses an error check, the output would be
2464 * an unachievable MAC.
2465 */
2466 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002467 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002468 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002469 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002470 }
mohammad16036df908f2018-04-02 08:34:15 -07002471
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002472 if( mac_size > operation->mac_size )
2473 memset( &mac[operation->mac_size], '!',
2474 mac_size - operation->mac_size );
2475
Steven Cooremana5b860a2021-03-19 19:04:39 +01002476 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002477
Steven Cooremana5b860a2021-03-19 19:04:39 +01002478 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002479}
2480
Steven Cooremana5b860a2021-03-19 19:04:39 +01002481psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002482 const uint8_t *mac,
2483 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2486 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002487
Steven Cooremana5b860a2021-03-19 19:04:39 +01002488 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002489 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002490 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002491 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002492 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002493
Steven Cooreman72f736a2021-05-07 14:14:37 +02002494 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002495 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002496 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002497 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002498 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002499
2500 if( operation->mac_size != mac_length )
2501 {
2502 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002503 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002504 }
2505
Steven Cooremana5b860a2021-03-19 19:04:39 +01002506 status = psa_driver_wrapper_mac_verify_finish( operation,
2507 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002508
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002509exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002510 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002511
Steven Cooremana5b860a2021-03-19 19:04:39 +01002512 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002513}
2514
Ronald Croncd989b52021-06-18 14:23:33 +02002515static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2516 psa_algorithm_t alg,
2517 const uint8_t *input,
2518 size_t input_length,
2519 uint8_t *mac,
2520 size_t mac_size,
2521 size_t *mac_length,
2522 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002523{
2524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002525 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2526 psa_key_slot_t *slot;
2527 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002528
Ronald Cron51131b52021-06-17 17:17:20 +02002529 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002530 key,
2531 &slot,
2532 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002533 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002534 if( status != PSA_SUCCESS )
2535 goto exit;
2536
Ronald Cron51131b52021-06-17 17:17:20 +02002537 psa_key_attributes_t attributes = {
2538 .core = slot->attr
2539 };
2540
2541 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2542 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002543 if( status != PSA_SUCCESS )
2544 goto exit;
2545
Ronald Cron51131b52021-06-17 17:17:20 +02002546 if( mac_size < operation_mac_size )
2547 {
2548 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002549 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002550 }
2551
2552 status = psa_driver_wrapper_mac_compute(
2553 &attributes,
2554 slot->key.data, slot->key.bytes,
2555 alg,
2556 input, input_length,
2557 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002558
2559exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002560 /* In case of success, set the potential excess room in the output buffer
2561 * to an invalid value, to avoid potentially leaking a longer MAC.
2562 * In case of error, set the output length and content to a safe default,
2563 * such that in case the caller misses an error check, the output would be
2564 * an unachievable MAC.
2565 */
2566 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002567 {
Ronald Cron51131b52021-06-17 17:17:20 +02002568 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002569 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002570 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002571 if( mac_size > operation_mac_size )
2572 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002573
Ronald Cron51131b52021-06-17 17:17:20 +02002574 unlock_status = psa_unlock_key_slot( slot );
2575
2576 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002577}
2578
Ronald Croncd989b52021-06-18 14:23:33 +02002579psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2580 psa_algorithm_t alg,
2581 const uint8_t *input,
2582 size_t input_length,
2583 uint8_t *mac,
2584 size_t mac_size,
2585 size_t *mac_length)
2586{
2587 return( psa_mac_compute_internal( key, alg,
2588 input, input_length,
2589 mac, mac_size, mac_length, 1 ) );
2590}
2591
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002592psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2593 psa_algorithm_t alg,
2594 const uint8_t *input,
2595 size_t input_length,
2596 const uint8_t *mac,
2597 size_t mac_length)
2598{
2599 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002600 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2601 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002602
Ronald Crona587cbc2021-06-18 14:51:29 +02002603 status = psa_mac_compute_internal( key, alg,
2604 input, input_length,
2605 actual_mac, sizeof( actual_mac ),
2606 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002607 if( status != PSA_SUCCESS )
2608 goto exit;
2609
Ronald Crona587cbc2021-06-18 14:51:29 +02002610 if( mac_length != actual_mac_length )
2611 {
2612 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002613 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002614 }
2615 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2616 {
2617 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002618 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002619 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002620
2621exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002622 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002623
2624 return ( status );
2625}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002626
Gilles Peskinee59236f2018-01-27 23:32:46 +01002627/****************************************************************/
2628/* Asymmetric cryptography */
2629/****************************************************************/
2630
gabor-mezei-armf0486182021-05-12 11:03:09 +02002631static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002632 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002633{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002634 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002635 {
2636 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2637 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002638
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002639 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2640 {
2641 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2642 return( PSA_ERROR_INVALID_ARGUMENT );
2643 }
2644 }
2645 else
2646 {
2647 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2648 return( PSA_ERROR_INVALID_ARGUMENT );
2649 }
2650
2651 return( PSA_SUCCESS );
2652}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002653
2654static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002655 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002656 psa_algorithm_t alg,
2657 const uint8_t * input,
2658 size_t input_length,
2659 uint8_t * signature,
2660 size_t signature_size,
2661 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002662{
2663 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2664 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2665 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002666
2667 *signature_length = 0;
2668
gabor-mezei-armf0486182021-05-12 11:03:09 +02002669 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002670 if( status != PSA_SUCCESS )
2671 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002672
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002673 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002674 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002675 * buffer can in principle be empty since it doesn't actually have
2676 * to be a hash.) */
2677 if( signature_size == 0 )
2678 return( PSA_ERROR_BUFFER_TOO_SMALL );
2679
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002680 status = psa_get_and_lock_key_slot_with_policy(
2681 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002682 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2683 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684 alg );
2685
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002686 if( status != PSA_SUCCESS )
2687 goto exit;
2688
2689 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2690 {
2691 status = PSA_ERROR_INVALID_ARGUMENT;
2692 goto exit;
2693 }
2694
2695 psa_key_attributes_t attributes = {
2696 .core = slot->attr
2697 };
2698
gabor-mezei-armf0486182021-05-12 11:03:09 +02002699 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002700 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002701 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002702 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002703 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002704 signature, signature_size, signature_length );
2705 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002706 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707 {
2708
2709 status = psa_driver_wrapper_sign_hash(
2710 &attributes, slot->key.data, slot->key.bytes,
2711 alg, input, input_length,
2712 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002713 }
2714
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002715
2716exit:
2717 /* Fill the unused part of the output buffer (the whole buffer on error,
2718 * the trailing part on success) with something that isn't a valid signature
2719 * (barring an attack on the signature and deliberately-crafted input),
2720 * in case the caller doesn't check the return status properly. */
2721 if( status == PSA_SUCCESS )
2722 memset( signature + *signature_length, '!',
2723 signature_size - *signature_length );
2724 else
2725 memset( signature, '!', signature_size );
2726 /* If signature_size is 0 then we have nothing to do. We must not call
2727 * memset because signature may be NULL in this case. */
2728
2729 unlock_status = psa_unlock_key_slot( slot );
2730
2731 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2732}
2733
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002734static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002735 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736 psa_algorithm_t alg,
2737 const uint8_t * input,
2738 size_t input_length,
2739 const uint8_t * signature,
2740 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002741{
2742 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2743 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2744 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002745
gabor-mezei-armf0486182021-05-12 11:03:09 +02002746 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002747 if( status != PSA_SUCCESS )
2748 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002749
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002750 status = psa_get_and_lock_key_slot_with_policy(
2751 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002752 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2753 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002754 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002755
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002756 if( status != PSA_SUCCESS )
2757 return( status );
2758
2759 psa_key_attributes_t attributes = {
2760 .core = slot->attr
2761 };
2762
gabor-mezei-armf0486182021-05-12 11:03:09 +02002763 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002764 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002765 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002766 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002767 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002768 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002769 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002770 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002771 {
2772 status = psa_driver_wrapper_verify_hash(
2773 &attributes, slot->key.data, slot->key.bytes,
2774 alg, input, input_length,
2775 signature, signature_length );
2776 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002777
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002778 unlock_status = psa_unlock_key_slot( slot );
2779
2780 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002781
2782}
2783
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002784psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002785 const psa_key_attributes_t *attributes,
2786 const uint8_t *key_buffer,
2787 size_t key_buffer_size,
2788 psa_algorithm_t alg,
2789 const uint8_t *input,
2790 size_t input_length,
2791 uint8_t *signature,
2792 size_t signature_size,
2793 size_t *signature_length )
2794{
2795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002796
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002797 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2798 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002799 size_t hash_length;
2800 uint8_t hash[PSA_HASH_MAX_SIZE];
2801
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002802 status = psa_driver_wrapper_hash_compute(
2803 PSA_ALG_SIGN_GET_HASH( alg ),
2804 input, input_length,
2805 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002806
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002807 if( status != PSA_SUCCESS )
2808 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002809
2810 return psa_driver_wrapper_sign_hash(
2811 attributes, key_buffer, key_buffer_size,
2812 alg, hash, hash_length,
2813 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002814 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002815
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002816 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002817}
2818
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002819psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2820 psa_algorithm_t alg,
2821 const uint8_t * input,
2822 size_t input_length,
2823 uint8_t * signature,
2824 size_t signature_size,
2825 size_t * signature_length )
2826{
2827 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002828 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002829 signature, signature_size, signature_length );
2830}
2831
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002832psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002833 const psa_key_attributes_t *attributes,
2834 const uint8_t *key_buffer,
2835 size_t key_buffer_size,
2836 psa_algorithm_t alg,
2837 const uint8_t *input,
2838 size_t input_length,
2839 const uint8_t *signature,
2840 size_t signature_length )
2841{
2842 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002843
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002844 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2845 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002846 size_t hash_length;
2847 uint8_t hash[PSA_HASH_MAX_SIZE];
2848
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002849 status = psa_driver_wrapper_hash_compute(
2850 PSA_ALG_SIGN_GET_HASH( alg ),
2851 input, input_length,
2852 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002853
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002854 if( status != PSA_SUCCESS )
2855 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002856
2857 return psa_driver_wrapper_verify_hash(
2858 attributes, key_buffer, key_buffer_size,
2859 alg, hash, hash_length,
2860 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002861 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002862
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002863 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002864}
2865
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002866psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2867 psa_algorithm_t alg,
2868 const uint8_t * input,
2869 size_t input_length,
2870 const uint8_t * signature,
2871 size_t signature_length )
2872{
2873 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002874 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002875 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002876}
2877
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002878psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002879 const psa_key_attributes_t *attributes,
2880 const uint8_t *key_buffer, size_t key_buffer_size,
2881 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2882 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002883{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002884 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002885 {
Ronald Cron4501c982021-03-19 20:09:32 +01002886 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2887 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002888 {
Ronald Cron4501c982021-03-19 20:09:32 +01002889#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2890 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2891 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002892 attributes,
2893 key_buffer, key_buffer_size,
2894 alg, hash, hash_length,
2895 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002896#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2897 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002898 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002899 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002900 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002901 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002902 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002903 }
2904 else
Ronald Cron4501c982021-03-19 20:09:32 +01002905 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2906 {
2907 if( PSA_ALG_IS_ECDSA( alg ) )
2908 {
2909#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2910 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2911 return( mbedtls_psa_ecdsa_sign_hash(
2912 attributes,
2913 key_buffer, key_buffer_size,
2914 alg, hash, hash_length,
2915 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002916#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2917 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002918 }
2919 else
2920 {
2921 return( PSA_ERROR_INVALID_ARGUMENT );
2922 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002923 }
Ronald Cron4501c982021-03-19 20:09:32 +01002924
2925 (void)key_buffer;
2926 (void)key_buffer_size;
2927 (void)hash;
2928 (void)hash_length;
2929 (void)signature;
2930 (void)signature_size;
2931 (void)signature_length;
2932
2933 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002934}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002935
2936psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2937 psa_algorithm_t alg,
2938 const uint8_t *hash,
2939 size_t hash_length,
2940 uint8_t *signature,
2941 size_t signature_size,
2942 size_t *signature_length )
2943{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002944 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002945 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002946 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002947}
2948
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002949psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002950 const psa_key_attributes_t *attributes,
2951 const uint8_t *key_buffer, size_t key_buffer_size,
2952 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2953 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002954{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002955 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002956 {
Ronald Cron4501c982021-03-19 20:09:32 +01002957 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2958 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002959 {
Ronald Cron4501c982021-03-19 20:09:32 +01002960#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2961 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2962 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002963 attributes,
2964 key_buffer, key_buffer_size,
2965 alg, hash, hash_length,
2966 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002967#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2968 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002969 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002970 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002971 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002972 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002973 }
itayzafrir5c753392018-05-08 11:18:38 +03002974 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002975 else
Ronald Cron4501c982021-03-19 20:09:32 +01002976 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002977 {
Ronald Cron4501c982021-03-19 20:09:32 +01002978 if( PSA_ALG_IS_ECDSA( alg ) )
2979 {
2980#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2981 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2982 return( mbedtls_psa_ecdsa_verify_hash(
2983 attributes,
2984 key_buffer, key_buffer_size,
2985 alg, hash, hash_length,
2986 signature, signature_length ) );
2987#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2988 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2989 }
2990 else
2991 {
2992 return( PSA_ERROR_INVALID_ARGUMENT );
2993 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002994 }
Ronald Cron4501c982021-03-19 20:09:32 +01002995
2996 (void)key_buffer;
2997 (void)key_buffer_size;
2998 (void)hash;
2999 (void)hash_length;
3000 (void)signature;
3001 (void)signature_length;
3002
3003 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003004}
3005
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003006psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3007 psa_algorithm_t alg,
3008 const uint8_t *hash,
3009 size_t hash_length,
3010 const uint8_t *signature,
3011 size_t signature_length )
3012{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003013 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003014 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003015 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003016}
3017
John Durkop0e005192020-10-31 22:06:54 -07003018#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003019static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3020 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003021{
3022 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3023 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3024 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003025
3026 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003027}
John Durkop0e005192020-10-31 22:06:54 -07003028#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003029
Ronald Croncf56a0a2020-08-04 09:51:30 +02003030psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003031 psa_algorithm_t alg,
3032 const uint8_t *input,
3033 size_t input_length,
3034 const uint8_t *salt,
3035 size_t salt_length,
3036 uint8_t *output,
3037 size_t output_size,
3038 size_t *output_length )
3039{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003040 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003041 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003042 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003043
Darryl Green5cc689a2018-07-24 15:34:10 +01003044 (void) input;
3045 (void) input_length;
3046 (void) salt;
3047 (void) output;
3048 (void) output_size;
3049
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003050 *output_length = 0;
3051
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003052 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3053 return( PSA_ERROR_INVALID_ARGUMENT );
3054
Ronald Cron5c522922020-11-14 16:35:34 +01003055 status = psa_get_and_lock_transparent_key_slot_with_policy(
3056 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003057 if( status != PSA_SUCCESS )
3058 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003059 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3060 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003061 {
3062 status = PSA_ERROR_INVALID_ARGUMENT;
3063 goto exit;
3064 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003065
John Durkop6ba40d12020-11-10 08:50:04 -08003066#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3067 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003068 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003069 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003070 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003071 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3072 slot->key.data,
3073 slot->key.bytes,
3074 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003075 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003076 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003077
3078 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003079 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003080 status = PSA_ERROR_BUFFER_TOO_SMALL;
3081 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003082 }
John Durkop0e005192020-10-31 22:06:54 -07003083#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003084 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3085 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 status = mbedtls_to_psa_error(
3087 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003088 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003089 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003090 input_length,
3091 input,
3092 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003093 }
3094 else
John Durkop0e005192020-10-31 22:06:54 -07003095#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3096#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003097 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3098 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003099 status = mbedtls_to_psa_error(
3100 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3101 if( status != PSA_SUCCESS )
3102 goto rsa_exit;
3103
Steven Cooreman4fed4552020-08-03 14:46:03 +02003104 status = mbedtls_to_psa_error(
3105 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003106 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003107 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003108 salt, salt_length,
3109 input_length,
3110 input,
3111 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003112 }
3113 else
John Durkop0e005192020-10-31 22:06:54 -07003114#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003116 status = PSA_ERROR_INVALID_ARGUMENT;
3117 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003118 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003119rsa_exit:
3120 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003121 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003122
Steven Cooremana2371e52020-07-28 14:30:39 +02003123 mbedtls_rsa_free( rsa );
3124 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126 else
John Durkop9814fa22020-11-04 12:28:15 -08003127#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003128 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003129 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003130 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003132
3133exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003134 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003135
Ronald Cron5c522922020-11-14 16:35:34 +01003136 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003137}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003138
Ronald Croncf56a0a2020-08-04 09:51:30 +02003139psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003140 psa_algorithm_t alg,
3141 const uint8_t *input,
3142 size_t input_length,
3143 const uint8_t *salt,
3144 size_t salt_length,
3145 uint8_t *output,
3146 size_t output_size,
3147 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003148{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003150 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003151 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003152
Darryl Green5cc689a2018-07-24 15:34:10 +01003153 (void) input;
3154 (void) input_length;
3155 (void) salt;
3156 (void) output;
3157 (void) output_size;
3158
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003159 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003160
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003161 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3162 return( PSA_ERROR_INVALID_ARGUMENT );
3163
Ronald Cron5c522922020-11-14 16:35:34 +01003164 status = psa_get_and_lock_transparent_key_slot_with_policy(
3165 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003166 if( status != PSA_SUCCESS )
3167 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003168 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003169 {
3170 status = PSA_ERROR_INVALID_ARGUMENT;
3171 goto exit;
3172 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173
John Durkop6ba40d12020-11-10 08:50:04 -08003174#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3175 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003176 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003177 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003178 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003179 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3180 slot->key.data,
3181 slot->key.bytes,
3182 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003183 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003184 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185
Steven Cooremana2371e52020-07-28 14:30:39 +02003186 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003187 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003188 status = PSA_ERROR_INVALID_ARGUMENT;
3189 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003190 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003191
John Durkop0e005192020-10-31 22:06:54 -07003192#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003193 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003194 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003195 status = mbedtls_to_psa_error(
3196 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003197 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003198 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003199 output_length,
3200 input,
3201 output,
3202 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003203 }
3204 else
John Durkop0e005192020-10-31 22:06:54 -07003205#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3206#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003207 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003208 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003209 status = mbedtls_to_psa_error(
3210 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3211 if( status != PSA_SUCCESS )
3212 goto rsa_exit;
3213
Steven Cooreman4fed4552020-08-03 14:46:03 +02003214 status = mbedtls_to_psa_error(
3215 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003216 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003217 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003218 salt, salt_length,
3219 output_length,
3220 input,
3221 output,
3222 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003223 }
3224 else
John Durkop0e005192020-10-31 22:06:54 -07003225#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003227 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003228 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003229
Steven Cooreman4fed4552020-08-03 14:46:03 +02003230rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003231 mbedtls_rsa_free( rsa );
3232 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003234 else
John Durkop6ba40d12020-11-10 08:50:04 -08003235#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3236 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003237 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003238 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003239 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003240
3241exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003242 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003243
Ronald Cron5c522922020-11-14 16:35:34 +01003244 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003245}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003246
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003247
3248
mohammad1603503973b2018-03-12 15:59:30 +02003249/****************************************************************/
3250/* Symmetric cryptography */
3251/****************************************************************/
3252
Ronald Cronab99ac22020-10-01 16:38:28 +02003253static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3254 mbedtls_svc_key_id_t key,
3255 psa_algorithm_t alg,
3256 mbedtls_operation_t cipher_operation )
3257{
3258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3259 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003260 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003261 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3262 PSA_KEY_USAGE_ENCRYPT :
3263 PSA_KEY_USAGE_DECRYPT );
3264
3265 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003266 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003267 {
Dave Rodgman54648242021-06-24 11:49:45 +01003268 status = PSA_ERROR_BAD_STATE;
3269 goto exit;
3270 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003271
Ronald Cronab99ac22020-10-01 16:38:28 +02003272 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003273 {
Dave Rodgman54648242021-06-24 11:49:45 +01003274 status = PSA_ERROR_INVALID_ARGUMENT;
3275 goto exit;
3276 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003277
Ronald Cronab99ac22020-10-01 16:38:28 +02003278 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3279 if( status != PSA_SUCCESS )
3280 goto exit;
3281
Ronald Cron49fafa92021-03-10 08:34:23 +01003282 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003283 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003284 * so we only set it (in the driver wrapper) after resources have been
3285 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003286 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003287 if( alg == PSA_ALG_ECB_NO_PADDING )
3288 operation->iv_required = 0;
3289 else
3290 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003291 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003292
Ronald Crona4af55f2020-12-14 14:36:06 +01003293 psa_key_attributes_t attributes = {
3294 .core = slot->attr
3295 };
3296
Ronald Cronab99ac22020-10-01 16:38:28 +02003297 /* Try doing the operation through a driver before using software fallback. */
3298 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003299 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3300 &attributes,
3301 slot->key.data,
3302 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003303 alg );
3304 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003305 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3306 &attributes,
3307 slot->key.data,
3308 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003309 alg );
3310
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003311exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003312 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003313 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003314
Ronald Cron5c522922020-11-14 16:35:34 +01003315 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003316
Ronald Cron5c522922020-11-14 16:35:34 +01003317 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003318}
3319
Gilles Peskinefe119512018-07-08 21:39:34 +02003320psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003321 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003322 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003323{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003324 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003325}
3326
Gilles Peskinefe119512018-07-08 21:39:34 +02003327psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003328 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003329 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003330{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003331 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003332}
3333
Gilles Peskinefe119512018-07-08 21:39:34 +02003334psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003335 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003336 size_t iv_size,
3337 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003338{
Ronald Cron6d051732020-10-01 14:10:20 +02003339 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003340
Ronald Cron5618a392021-03-26 09:52:26 +01003341 *iv_length = 0;
3342
Ronald Cron49fafa92021-03-10 08:34:23 +01003343 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003344 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003345 status = PSA_ERROR_BAD_STATE;
3346 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003347 }
3348
Steven Cooreman7df02922020-09-09 15:28:49 +02003349 if( operation->iv_set || ! operation->iv_required )
3350 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003351 status = PSA_ERROR_BAD_STATE;
3352 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003353 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003354
Ronald Cron5618a392021-03-26 09:52:26 +01003355 if( iv_size < operation->default_iv_length )
3356 {
3357 status = PSA_ERROR_BUFFER_TOO_SMALL;
3358 goto exit;
3359 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003360
Ronald Cron5618a392021-03-26 09:52:26 +01003361 status = psa_generate_random( iv, operation->default_iv_length );
3362 if( status != PSA_SUCCESS )
3363 goto exit;
3364
3365 status = psa_driver_wrapper_cipher_set_iv( operation,
3366 iv,
3367 operation->default_iv_length );
3368
3369exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003370 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003371 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003372 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003373 *iv_length = operation->default_iv_length;
3374 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003375 else
Moran Peker395db872018-05-31 14:07:14 +03003376 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003377
itayzafrir534bd7c2018-08-02 13:56:32 +03003378 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003379}
3380
Gilles Peskinefe119512018-07-08 21:39:34 +02003381psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003382 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003383 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003384{
Ronald Cron6d051732020-10-01 14:10:20 +02003385 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003386
Ronald Cron49fafa92021-03-10 08:34:23 +01003387 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003388 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003389 status = PSA_ERROR_BAD_STATE;
3390 goto exit;
3391 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003392
Steven Cooreman7df02922020-09-09 15:28:49 +02003393 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003394 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003395 status = PSA_ERROR_BAD_STATE;
3396 goto exit;
3397 }
Ronald Crona0d68172021-03-26 10:15:08 +01003398
3399 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003400 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003401 status = PSA_ERROR_INVALID_ARGUMENT;
3402 goto exit;
3403 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003404
Ronald Crondd24c9b2020-12-15 14:10:01 +01003405 status = psa_driver_wrapper_cipher_set_iv( operation,
3406 iv,
3407 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003408
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003409exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003410 if( status == PSA_SUCCESS )
3411 operation->iv_set = 1;
3412 else
mohammad1603503973b2018-03-12 15:59:30 +02003413 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003414 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003415}
3416
Gilles Peskinee553c652018-06-04 16:22:46 +02003417psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3418 const uint8_t *input,
3419 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003420 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003421 size_t output_size,
3422 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003423{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003425
Ronald Cron49fafa92021-03-10 08:34:23 +01003426 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003427 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003428 status = PSA_ERROR_BAD_STATE;
3429 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003430 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003431
Steven Cooreman7df02922020-09-09 15:28:49 +02003432 if( operation->iv_required && ! operation->iv_set )
3433 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003434 status = PSA_ERROR_BAD_STATE;
3435 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003436 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003437
Ronald Crondd24c9b2020-12-15 14:10:01 +01003438 status = psa_driver_wrapper_cipher_update( operation,
3439 input,
3440 input_length,
3441 output,
3442 output_size,
3443 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003444
3445exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003446 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003447 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003448
itayzafrir534bd7c2018-08-02 13:56:32 +03003449 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003450}
3451
Gilles Peskinee553c652018-06-04 16:22:46 +02003452psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3453 uint8_t *output,
3454 size_t output_size,
3455 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003456{
David Saadab4ecc272019-02-14 13:48:10 +02003457 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003458
Ronald Cron49fafa92021-03-10 08:34:23 +01003459 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003460 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003461 status = PSA_ERROR_BAD_STATE;
3462 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003463 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003464
Steven Cooreman7df02922020-09-09 15:28:49 +02003465 if( operation->iv_required && ! operation->iv_set )
3466 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003467 status = PSA_ERROR_BAD_STATE;
3468 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003469 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003470
Ronald Crondd24c9b2020-12-15 14:10:01 +01003471 status = psa_driver_wrapper_cipher_finish( operation,
3472 output,
3473 output_size,
3474 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003475
3476exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003477 if( status == PSA_SUCCESS )
3478 return( psa_cipher_abort( operation ) );
3479 else
3480 {
3481 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003482 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003483
Steven Cooremanef8575e2020-09-11 11:44:50 +02003484 return( status );
3485 }
mohammad1603503973b2018-03-12 15:59:30 +02003486}
3487
Gilles Peskinee553c652018-06-04 16:22:46 +02003488psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3489{
Ronald Cron49fafa92021-03-10 08:34:23 +01003490 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003491 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003492 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003493 * in use. It's ok to call abort on such an object, and there's
3494 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003495 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003496 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003497
Ronald Crondd24c9b2020-12-15 14:10:01 +01003498 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003499
Ronald Cron49fafa92021-03-10 08:34:23 +01003500 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003501 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003502 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003503
Moran Peker395db872018-05-31 14:07:14 +03003504 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003505}
3506
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003507psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3508 psa_algorithm_t alg,
3509 const uint8_t *input,
3510 size_t input_length,
3511 uint8_t *output,
3512 size_t output_size,
3513 size_t *output_length )
3514{
3515 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003516 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3517 psa_key_slot_t *slot;
3518 psa_key_type_t key_type;
3519 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003520
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003521 *output_length = 0;
3522
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003523 if( ! PSA_ALG_IS_CIPHER( alg ) )
3524 return( PSA_ERROR_INVALID_ARGUMENT );
3525
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003526 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3527 PSA_KEY_USAGE_ENCRYPT,
3528 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003529 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003530 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003531
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003532 psa_key_attributes_t attributes = {
3533 .core = slot->attr
3534 };
3535
3536 key_type = slot->attr.type;
3537 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3538
3539 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003540 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003541 if( output_size < iv_length )
3542 {
3543 status = PSA_ERROR_BUFFER_TOO_SMALL;
3544 goto exit;
3545 }
3546
3547 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003548 if( status != PSA_SUCCESS )
3549 goto exit;
3550 }
3551
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003552 status = psa_driver_wrapper_cipher_encrypt(
3553 &attributes, slot->key.data, slot->key.bytes,
3554 alg, input, input_length,
3555 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003556
3557exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003558 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003559
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003560 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003561}
3562
3563psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3564 psa_algorithm_t alg,
3565 const uint8_t *input,
3566 size_t input_length,
3567 uint8_t *output,
3568 size_t output_size,
3569 size_t *output_length )
3570{
3571 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003572 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3573 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003574
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003575 *output_length = 0;
3576
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003577 if( ! PSA_ALG_IS_CIPHER( alg ) )
3578 return( PSA_ERROR_INVALID_ARGUMENT );
3579
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003580 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3581 PSA_KEY_USAGE_DECRYPT,
3582 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003583 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003584 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003585
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003586 psa_key_attributes_t attributes = {
3587 .core = slot->attr
3588 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003589
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003590 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3591 {
3592 status = PSA_ERROR_INVALID_ARGUMENT;
3593 goto exit;
3594 }
3595
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003596 status = psa_driver_wrapper_cipher_decrypt(
3597 &attributes, slot->key.data, slot->key.bytes,
3598 alg, input, input_length,
3599 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003600
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003601exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003602 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003603
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003604 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003605}
3606
3607
mohammad16035955c982018-04-26 00:53:03 +03003608/****************************************************************/
3609/* AEAD */
3610/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003611
Ronald Croncf56a0a2020-08-04 09:51:30 +02003612psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003613 psa_algorithm_t alg,
3614 const uint8_t *nonce,
3615 size_t nonce_length,
3616 const uint8_t *additional_data,
3617 size_t additional_data_length,
3618 const uint8_t *plaintext,
3619 size_t plaintext_length,
3620 uint8_t *ciphertext,
3621 size_t ciphertext_size,
3622 size_t *ciphertext_length )
3623{
Ronald Cron215633c2021-03-16 17:15:37 +01003624 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3625 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003626
mohammad1603f08a5502018-06-03 15:05:47 +03003627 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003628
Steven Cooremanea7ab132021-03-17 16:28:00 +01003629 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3630 return( PSA_ERROR_NOT_SUPPORTED );
3631
Ronald Cron9a986162021-03-26 12:40:07 +01003632 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003633 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003634 if( status != PSA_SUCCESS )
3635 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003636
Ronald Cron215633c2021-03-16 17:15:37 +01003637 psa_key_attributes_t attributes = {
3638 .core = slot->attr
3639 };
mohammad16035955c982018-04-26 00:53:03 +03003640
Ronald Cronde822812021-03-17 16:08:20 +01003641 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003642 &attributes, slot->key.data, slot->key.bytes,
3643 alg,
3644 nonce, nonce_length,
3645 additional_data, additional_data_length,
3646 plaintext, plaintext_length,
3647 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003648
Gilles Peskineedf9a652018-08-17 18:11:56 +02003649 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3650 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003651
Ronald Cron9f310172021-03-16 16:36:37 +01003652 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003653
mohammad16035955c982018-04-26 00:53:03 +03003654 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003655}
3656
Ronald Croncf56a0a2020-08-04 09:51:30 +02003657psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003658 psa_algorithm_t alg,
3659 const uint8_t *nonce,
3660 size_t nonce_length,
3661 const uint8_t *additional_data,
3662 size_t additional_data_length,
3663 const uint8_t *ciphertext,
3664 size_t ciphertext_length,
3665 uint8_t *plaintext,
3666 size_t plaintext_size,
3667 size_t *plaintext_length )
3668{
Ronald Cron215633c2021-03-16 17:15:37 +01003669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3670 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003671
Gilles Peskineee652a32018-06-01 19:23:52 +02003672 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003673
Steven Cooremanea7ab132021-03-17 16:28:00 +01003674 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3675 return( PSA_ERROR_NOT_SUPPORTED );
3676
Ronald Cron9a986162021-03-26 12:40:07 +01003677 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003678 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003679 if( status != PSA_SUCCESS )
3680 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003681
Ronald Cron215633c2021-03-16 17:15:37 +01003682 psa_key_attributes_t attributes = {
3683 .core = slot->attr
3684 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003685
Ronald Cronde822812021-03-17 16:08:20 +01003686 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003687 &attributes, slot->key.data, slot->key.bytes,
3688 alg,
3689 nonce, nonce_length,
3690 additional_data, additional_data_length,
3691 ciphertext, ciphertext_length,
3692 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003693
Gilles Peskineedf9a652018-08-17 18:11:56 +02003694 if( status != PSA_SUCCESS && plaintext_size != 0 )
3695 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003696
Ronald Cron215633c2021-03-16 17:15:37 +01003697 psa_unlock_key_slot( slot );
3698
Gilles Peskineedf9a652018-08-17 18:11:56 +02003699 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003700}
3701
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003702/* Helper function to get the base algorithm from its variants. */
Paul Elliottd89304e2021-06-22 17:47:09 +01003703static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003704{
Paul Elliotte4030f22021-06-22 17:36:55 +01003705 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003706}
3707
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003708/* Set the key for a multipart authenticated operation. */
3709static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003710 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003711 mbedtls_svc_key_id_t key,
3712 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003713{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003714 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3715 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3716 psa_key_slot_t *slot = NULL;
3717 psa_key_usage_t key_usage = 0;
3718
Paul Elliottc2b71442021-06-24 18:17:52 +01003719 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3720 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003721 status = PSA_ERROR_INVALID_ARGUMENT;
3722 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003723 }
3724
3725 if( operation->id != 0 )
3726 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003727 status = PSA_ERROR_BAD_STATE;
3728 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003729 }
3730
3731 if( operation->nonce_set || operation->lengths_set ||
3732 operation->ad_started || operation->body_started )
3733 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003734 status = PSA_ERROR_BAD_STATE;
3735 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003736 }
3737
Paul Elliottd9343f22021-08-23 18:59:49 +01003738 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003739 key_usage = PSA_KEY_USAGE_ENCRYPT;
3740 else
3741 key_usage = PSA_KEY_USAGE_DECRYPT;
3742
3743 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3744 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003745 if( status != PSA_SUCCESS )
3746 goto exit;
3747
3748 psa_key_attributes_t attributes = {
3749 .core = slot->attr
3750 };
3751
Paul Elliottd9343f22021-08-23 18:59:49 +01003752 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003753 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3754 &attributes,
3755 slot->key.data,
3756 slot->key.bytes,
3757 alg );
3758 else
3759 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3760 &attributes,
3761 slot->key.data,
3762 slot->key.bytes,
3763 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003764 if( status != PSA_SUCCESS )
3765 goto exit;
3766
3767 operation->key_type = psa_get_key_type( &attributes );
3768
3769exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003770 unlock_status = psa_unlock_key_slot( slot );
3771
3772 if( status == PSA_SUCCESS )
3773 {
3774 status = unlock_status;
3775 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003776 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003777 }
3778 else
3779 psa_aead_abort( operation );
3780
3781 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003782}
3783
Paul Elliott302ff6b2021-04-20 18:10:30 +01003784/* Set the key for a multipart authenticated encryption operation. */
3785psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3786 mbedtls_svc_key_id_t key,
3787 psa_algorithm_t alg )
3788{
Paul Elliottd9343f22021-08-23 18:59:49 +01003789 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003790}
3791
3792/* Set the key for a multipart authenticated decryption operation. */
3793psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3794 mbedtls_svc_key_id_t key,
3795 psa_algorithm_t alg )
3796{
Paul Elliottd9343f22021-08-23 18:59:49 +01003797 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003798}
3799
3800/* Generate a random nonce / IV for multipart AEAD operation */
3801psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3802 uint8_t *nonce,
3803 size_t nonce_size,
3804 size_t *nonce_length )
3805{
3806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottb91da712021-05-20 14:43:47 +01003807 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003808
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003809 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003810
Paul Elliottcee785c2021-05-20 14:29:20 +01003811 if( operation->id == 0 )
3812 {
3813 status = PSA_ERROR_BAD_STATE;
3814 goto exit;
3815 }
3816
Paul Elliottdaf5c892021-08-25 16:24:58 +01003817 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003818 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003819 status = PSA_ERROR_BAD_STATE;
3820 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003821 }
3822
Paul Elliottbbe90b52021-05-11 22:22:42 +01003823 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003824 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003825 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003826 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003827 status = PSA_ERROR_BUFFER_TOO_SMALL;
3828 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003829 }
3830
3831 status = psa_generate_random( nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003832 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003833 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003834
Paul Elliott95271f12021-06-23 16:50:45 +01003835 status = psa_aead_set_nonce( operation, nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003836
Paul Elliott39dc6b82021-05-11 19:16:09 +01003837exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003838 if( status == PSA_SUCCESS )
3839 *nonce_length = required_nonce_size;
3840 else
3841 psa_aead_abort( operation );
3842
3843 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003844}
3845
3846/* Set the nonce for a multipart authenticated encryption or decryption
3847 operation.*/
3848psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3849 const uint8_t *nonce,
3850 size_t nonce_length )
3851{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003852 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3853
Paul Elliottcee785c2021-05-20 14:29:20 +01003854 if( operation->id == 0 )
3855 {
3856 status = PSA_ERROR_BAD_STATE;
3857 goto exit;
3858 }
3859
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003860 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003861 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003862 status = PSA_ERROR_BAD_STATE;
3863 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003864 }
3865
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003866#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
3867 if( operation->alg == PSA_ALG_GCM )
3868 {
3869 /* Not checking max nonce size here as GCM spec allows almost
3870 * arbitrarily large nonces. Please note that we do not generally
3871 * recommend the usage of nonces of greater length than
3872 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3873 * size, which can then lead to collisions if you encrypt a very
3874 * large number of messages.*/
3875 if( nonce_length == 0 )
3876 {
3877 status = PSA_ERROR_INVALID_ARGUMENT;
3878 goto exit;
3879 }
3880 }
3881#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3882#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
3883 if( operation->alg == PSA_ALG_CCM )
3884 {
3885 if( nonce_length < 7 || nonce_length > 13 )
3886 {
3887 status = PSA_ERROR_INVALID_ARGUMENT;
3888 goto exit;
3889 }
3890 }
3891 else
3892#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3893#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
3894 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
3895 {
3896 if( nonce_length != 12 )
3897 {
3898 status = PSA_ERROR_INVALID_ARGUMENT;
3899 goto exit;
3900 }
3901 }
3902#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
Paul Elliott1a98aca2021-05-20 18:24:07 +01003903
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003904 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3905 nonce_length );
3906
Paul Elliott39dc6b82021-05-11 19:16:09 +01003907exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003908 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003909 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003910 else
3911 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003912
3913 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003914}
3915
3916/* Declare the lengths of the message and additional data for multipart AEAD. */
3917psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3918 size_t ad_length,
3919 size_t plaintext_length )
3920{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3922
Paul Elliottcee785c2021-05-20 14:29:20 +01003923 if( operation->id == 0 )
3924 {
3925 status = PSA_ERROR_BAD_STATE;
3926 goto exit;
3927 }
3928
Paul Elliott6eb95982021-05-21 17:41:41 +01003929 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003930 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003931 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003932 status = PSA_ERROR_BAD_STATE;
3933 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003934 }
3935
Paul Elliott325d3742021-09-27 17:56:28 +01003936#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
3937 if( operation->alg == PSA_ALG_GCM )
3938 {
3939 /* Lengths can only be too large for GCM if size_t is bigger than 32
3940 * bits. Without the guard this code will generate warnings on 32bit
3941 * builds */
3942#if SIZE_MAX > UINT32_MAX
3943 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3944 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3945 {
3946 status = PSA_ERROR_INVALID_ARGUMENT;
3947 goto exit;
3948 }
3949#endif
3950 }
3951 else
3952#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3953#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
3954 if( operation->alg == PSA_ALG_CCM )
3955 {
3956 if( ad_length > 0xFF00 )
3957 {
3958 status = PSA_ERROR_INVALID_ARGUMENT;
3959 goto exit;
3960 }
3961 }
3962 else
3963#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3964#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
3965 if( operation->alg == PSA_ALG_CHACHA20_POLY1305 )
3966 {
3967 /* No length restrictions for ChaChaPoly. */
3968 }
3969#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
3970
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003971 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3972 plaintext_length );
3973
Paul Elliott39dc6b82021-05-11 19:16:09 +01003974exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003975 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003976 {
3977 operation->ad_remaining = ad_length;
3978 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003979 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01003980 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003981 else
3982 psa_aead_abort( operation );
3983
3984 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003985}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003986
3987/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01003988psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
3989 const uint8_t *input,
3990 size_t input_length )
3991{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3993
Paul Elliottcee785c2021-05-20 14:29:20 +01003994 if( operation->id == 0 )
3995 {
3996 status = PSA_ERROR_BAD_STATE;
3997 goto exit;
3998 }
3999
Paul Elliott6eb95982021-05-21 17:41:41 +01004000 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004001 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004002 status = PSA_ERROR_BAD_STATE;
4003 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004004 }
4005
Paul Elliottee4ffe02021-05-20 17:25:06 +01004006 if( operation->lengths_set )
4007 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004008 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004009 {
4010 status = PSA_ERROR_INVALID_ARGUMENT;
4011 goto exit;
4012 }
4013
4014 operation->ad_remaining -= input_length;
4015 }
4016
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004017 status = psa_driver_wrapper_aead_update_ad( operation, input,
4018 input_length );
4019
Paul Elliott39dc6b82021-05-11 19:16:09 +01004020exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004021 if( status == PSA_SUCCESS )
4022 operation->ad_started = 1;
4023 else
4024 psa_aead_abort( operation );
4025
4026 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004027}
4028
4029/* Encrypt or decrypt a message fragment in an active multipart AEAD
4030 operation.*/
4031psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4032 const uint8_t *input,
4033 size_t input_length,
4034 uint8_t *output,
4035 size_t output_size,
4036 size_t *output_length )
4037{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004039
4040 *output_length = 0;
4041
Paul Elliottcee785c2021-05-20 14:29:20 +01004042 if( operation->id == 0 )
4043 {
4044 status = PSA_ERROR_BAD_STATE;
4045 goto exit;
4046 }
4047
Paul Elliott6eb95982021-05-21 17:41:41 +01004048 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004049 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004050 status = PSA_ERROR_BAD_STATE;
4051 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004052 }
4053
Paul Elliottee4ffe02021-05-20 17:25:06 +01004054 if( operation->lengths_set )
4055 {
4056 /* Additional data length was supplied, but not all the additional
4057 data was supplied.*/
4058 if( operation->ad_remaining != 0 )
4059 {
4060 status = PSA_ERROR_INVALID_ARGUMENT;
4061 goto exit;
4062 }
4063
4064 /* Too much data provided. */
4065 if( operation->body_remaining < input_length )
4066 {
4067 status = PSA_ERROR_INVALID_ARGUMENT;
4068 goto exit;
4069 }
4070
4071 operation->body_remaining -= input_length;
4072 }
4073
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004074 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4075 output, output_size,
4076 output_length );
4077
Paul Elliott39dc6b82021-05-11 19:16:09 +01004078exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004079 if( status == PSA_SUCCESS )
4080 operation->body_started = 1;
4081 else
4082 psa_aead_abort( operation );
4083
4084 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004085}
4086
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004087static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004088{
Paul Elliott7f429b72021-06-24 18:08:54 +01004089 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004090 return( PSA_ERROR_BAD_STATE );
4091
Paul Elliotta5614442021-07-14 14:54:11 +01004092 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004093 operation->body_remaining != 0 ) )
4094 return( PSA_ERROR_INVALID_ARGUMENT );
4095
4096 return( PSA_SUCCESS );
4097}
4098
Paul Elliott302ff6b2021-04-20 18:10:30 +01004099/* Finish encrypting a message in a multipart AEAD operation. */
4100psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4101 uint8_t *ciphertext,
4102 size_t ciphertext_size,
4103 size_t *ciphertext_length,
4104 uint8_t *tag,
4105 size_t tag_size,
4106 size_t *tag_length )
4107{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004108 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4109
Paul Elliott302ff6b2021-04-20 18:10:30 +01004110 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004111 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004112
Paul Elliott814fffb2021-08-16 18:20:36 +01004113 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004114 if( status != PSA_SUCCESS )
4115 goto exit;
4116
Paul Elliott7f429b72021-06-24 18:08:54 +01004117 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004118 {
4119 status = PSA_ERROR_BAD_STATE;
4120 goto exit;
4121 }
4122
Paul Elliott39dc6b82021-05-11 19:16:09 +01004123 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4124 ciphertext_size,
4125 ciphertext_length,
4126 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004127
Paul Elliott39dc6b82021-05-11 19:16:09 +01004128exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004129 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004130 * the zero tag size, make sure the tag is set to something implausible.
4131 * Even if the operation succeeds, make sure we clear the rest of the
4132 * buffer to prevent potential leakage of anything previously placed in
4133 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004134 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004135 {
4136 if( status != PSA_SUCCESS )
4137 memset( tag, '!', tag_size );
4138 else if( *tag_length < tag_size )
4139 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4140 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004141
Paul Elliott39dc6b82021-05-11 19:16:09 +01004142 psa_aead_abort( operation );
4143
4144 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004145}
4146
4147/* Finish authenticating and decrypting a message in a multipart AEAD
4148 operation.*/
4149psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4150 uint8_t *plaintext,
4151 size_t plaintext_size,
4152 size_t *plaintext_length,
4153 const uint8_t *tag,
4154 size_t tag_length )
4155{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4157
Paul Elliott302ff6b2021-04-20 18:10:30 +01004158 *plaintext_length = 0;
4159
Paul Elliott814fffb2021-08-16 18:20:36 +01004160 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004161 if( status != PSA_SUCCESS )
4162 goto exit;
4163
Paul Elliott7f429b72021-06-24 18:08:54 +01004164 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004165 {
4166 status = PSA_ERROR_BAD_STATE;
4167 goto exit;
4168 }
4169
Paul Elliott39dc6b82021-05-11 19:16:09 +01004170 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4171 plaintext_size,
4172 plaintext_length,
4173 tag, tag_length );
4174
4175exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004176 psa_aead_abort( operation );
4177
4178 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004179}
4180
4181/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004182psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004183{
4184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4185
4186 if( operation->id == 0 )
4187 {
4188 /* The object has (apparently) been initialized but it is not (yet)
4189 * in use. It's ok to call abort on such an object, and there's
4190 * nothing to do. */
4191 return( PSA_SUCCESS );
4192 }
4193
4194 status = psa_driver_wrapper_aead_abort( operation );
4195
Paul Elliott70618b22021-09-22 17:12:16 +01004196 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004197
4198 return( status );
4199}
4200
Gilles Peskinee59236f2018-01-27 23:32:46 +01004201/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004202/* Generators */
4203/****************************************************************/
4204
John Durkop07cc04a2020-11-16 22:08:34 -08004205#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4206 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4207 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4208#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004209#endif /* At least one builtin KDF */
4210
4211#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4212 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4213 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4214static psa_status_t psa_key_derivation_start_hmac(
4215 psa_mac_operation_t *operation,
4216 psa_algorithm_t hash_alg,
4217 const uint8_t *hmac_key,
4218 size_t hmac_key_length )
4219{
4220 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4221 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4222 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4223 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4224 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4225
Steven Cooreman72f736a2021-05-07 14:14:37 +02004226 operation->is_sign = 1;
4227 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4228
Steven Cooreman094a77e2021-05-06 17:58:36 +02004229 status = psa_driver_wrapper_mac_sign_setup( operation,
4230 &attributes,
4231 hmac_key, hmac_key_length,
4232 PSA_ALG_HMAC( hash_alg ) );
4233
4234 psa_reset_key_attributes( &attributes );
4235 return( status );
4236}
4237#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004238
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004239#define HKDF_STATE_INIT 0 /* no input yet */
4240#define HKDF_STATE_STARTED 1 /* got salt */
4241#define HKDF_STATE_KEYED 2 /* got key */
4242#define HKDF_STATE_OUTPUT 3 /* output started */
4243
Gilles Peskinecbe66502019-05-16 16:59:18 +02004244static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004245 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004246{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004247 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4248 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004249 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004250 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004251}
4252
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004253psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004254{
4255 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004256 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004257 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004258 {
4259 /* The object has (apparently) been initialized but it is not
4260 * in use. It's ok to call abort on such an object, and there's
4261 * nothing to do. */
4262 }
4263 else
John Durkopd0321952020-10-29 21:37:36 -07004264#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004265 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004266 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004267 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004268 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004269 }
John Durkop07cc04a2020-11-16 22:08:34 -08004270 else
4271#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4272#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4273 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4274 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004275 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004276 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004277 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004278 if( operation->ctx.tls12_prf.secret != NULL )
4279 {
4280 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4281 operation->ctx.tls12_prf.secret_length );
4282 mbedtls_free( operation->ctx.tls12_prf.secret );
4283 }
4284
Janos Follath6a1d2622019-06-11 10:37:28 +01004285 if( operation->ctx.tls12_prf.seed != NULL )
4286 {
4287 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4288 operation->ctx.tls12_prf.seed_length );
4289 mbedtls_free( operation->ctx.tls12_prf.seed );
4290 }
4291
4292 if( operation->ctx.tls12_prf.label != NULL )
4293 {
4294 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4295 operation->ctx.tls12_prf.label_length );
4296 mbedtls_free( operation->ctx.tls12_prf.label );
4297 }
4298
Steven Cooremana6df6042021-04-29 19:32:25 +02004299 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004300
4301 /* We leave the fields Ai and output_block to be erased safely by the
4302 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004303 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004304 else
John Durkop07cc04a2020-11-16 22:08:34 -08004305#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4306 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004307 {
4308 status = PSA_ERROR_BAD_STATE;
4309 }
Janos Follath083036a2019-06-11 10:22:26 +01004310 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004311 return( status );
4312}
4313
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004314psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004315 size_t *capacity)
4316{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004317 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004318 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004319 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004320 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004321 }
4322
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004323 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004324 return( PSA_SUCCESS );
4325}
4326
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004327psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004328 size_t capacity )
4329{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004330 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004332 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004333 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004334 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004335 return( PSA_SUCCESS );
4336}
4337
John Durkopd0321952020-10-29 21:37:36 -07004338#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004339/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004340 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004341static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004342 psa_algorithm_t hash_alg,
4343 uint8_t *output,
4344 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004345{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004346 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004347 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004348 psa_status_t status;
4349
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004350 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4351 return( PSA_ERROR_BAD_STATE );
4352 hkdf->state = HKDF_STATE_OUTPUT;
4353
Gilles Peskinebef7f142018-07-12 17:22:21 +02004354 while( output_length != 0 )
4355 {
4356 /* Copy what remains of the current block */
4357 uint8_t n = hash_length - hkdf->offset_in_block;
4358 if( n > output_length )
4359 n = (uint8_t) output_length;
4360 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4361 output += n;
4362 output_length -= n;
4363 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004364 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004365 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004366 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004367 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004368 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004369 * object was corrupted or if this function is called directly
4370 * inside the library. */
4371 if( hkdf->block_number == 0xff )
4372 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004373
4374 /* We need a new block */
4375 ++hkdf->block_number;
4376 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004377
Steven Cooreman094a77e2021-05-06 17:58:36 +02004378 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4379 hash_alg,
4380 hkdf->prk,
4381 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004382 if( status != PSA_SUCCESS )
4383 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004384
Gilles Peskinebef7f142018-07-12 17:22:21 +02004385 if( hkdf->block_number != 1 )
4386 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004387 status = psa_mac_update( &hkdf->hmac,
4388 hkdf->output_block,
4389 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004390 if( status != PSA_SUCCESS )
4391 return( status );
4392 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004393 status = psa_mac_update( &hkdf->hmac,
4394 hkdf->info,
4395 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004396 if( status != PSA_SUCCESS )
4397 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004398 status = psa_mac_update( &hkdf->hmac,
4399 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004400 if( status != PSA_SUCCESS )
4401 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004402 status = psa_mac_sign_finish( &hkdf->hmac,
4403 hkdf->output_block,
4404 sizeof( hkdf->output_block ),
4405 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004406 if( status != PSA_SUCCESS )
4407 return( status );
4408 }
4409
4410 return( PSA_SUCCESS );
4411}
John Durkop07cc04a2020-11-16 22:08:34 -08004412#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004413
John Durkop07cc04a2020-11-16 22:08:34 -08004414#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4415 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004416static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4417 psa_tls12_prf_key_derivation_t *tls12_prf,
4418 psa_algorithm_t alg )
4419{
4420 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004421 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004422 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4423 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004424 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004425
Janos Follath7742fee2019-06-17 12:58:10 +01004426 /* We can't be wanting more output after block 0xff, otherwise
4427 * the capacity check in psa_key_derivation_output_bytes() would have
4428 * prevented this call. It could happen only if the operation
4429 * object was corrupted or if this function is called directly
4430 * inside the library. */
4431 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004432 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004433
4434 /* We need a new block */
4435 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004436 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004437
4438 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4439 *
4440 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4441 *
4442 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4443 * HMAC_hash(secret, A(2) + seed) +
4444 * HMAC_hash(secret, A(3) + seed) + ...
4445 *
4446 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004447 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004448 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004449 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004450 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004451 * is currently extracted as `output_block` and where i is
4452 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004453 */
4454
Steven Cooreman094a77e2021-05-06 17:58:36 +02004455 status = psa_key_derivation_start_hmac( &hmac,
4456 hash_alg,
4457 tls12_prf->secret,
4458 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004459 if( status != PSA_SUCCESS )
4460 goto cleanup;
4461
4462 /* Calculate A(i) where i = tls12_prf->block_number. */
4463 if( tls12_prf->block_number == 1 )
4464 {
4465 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4466 * the variable seed and in this instance means it in the context of the
4467 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004468 status = psa_mac_update( &hmac,
4469 tls12_prf->label,
4470 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004471 if( status != PSA_SUCCESS )
4472 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004473 status = psa_mac_update( &hmac,
4474 tls12_prf->seed,
4475 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004476 if( status != PSA_SUCCESS )
4477 goto cleanup;
4478 }
4479 else
4480 {
4481 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004482 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004483 if( status != PSA_SUCCESS )
4484 goto cleanup;
4485 }
4486
Steven Cooremana6df6042021-04-29 19:32:25 +02004487 status = psa_mac_sign_finish( &hmac,
4488 tls12_prf->Ai, hash_length,
4489 &hmac_output_length );
4490 if( hmac_output_length != hash_length )
4491 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004492 if( status != PSA_SUCCESS )
4493 goto cleanup;
4494
4495 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004496 status = psa_key_derivation_start_hmac( &hmac,
4497 hash_alg,
4498 tls12_prf->secret,
4499 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004500 if( status != PSA_SUCCESS )
4501 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004502 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004503 if( status != PSA_SUCCESS )
4504 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004505 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004506 if( status != PSA_SUCCESS )
4507 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004508 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004509 if( status != PSA_SUCCESS )
4510 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004511 status = psa_mac_sign_finish( &hmac,
4512 tls12_prf->output_block, hash_length,
4513 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004514 if( status != PSA_SUCCESS )
4515 goto cleanup;
4516
Janos Follath7742fee2019-06-17 12:58:10 +01004517
4518cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004519 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004520 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4521 status = cleanup_status;
4522
4523 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004524}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004525
Janos Follath844eb0e2019-06-19 12:10:49 +01004526static psa_status_t psa_key_derivation_tls12_prf_read(
4527 psa_tls12_prf_key_derivation_t *tls12_prf,
4528 psa_algorithm_t alg,
4529 uint8_t *output,
4530 size_t output_length )
4531{
4532 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004533 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004534 psa_status_t status;
4535 uint8_t offset, length;
4536
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004537 switch( tls12_prf->state )
4538 {
4539 case PSA_TLS12_PRF_STATE_LABEL_SET:
4540 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4541 break;
4542 case PSA_TLS12_PRF_STATE_OUTPUT:
4543 break;
4544 default:
4545 return( PSA_ERROR_BAD_STATE );
4546 }
4547
Janos Follath844eb0e2019-06-19 12:10:49 +01004548 while( output_length != 0 )
4549 {
4550 /* Check if we have fully processed the current block. */
4551 if( tls12_prf->left_in_block == 0 )
4552 {
4553 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4554 alg );
4555 if( status != PSA_SUCCESS )
4556 return( status );
4557
4558 continue;
4559 }
4560
4561 if( tls12_prf->left_in_block > output_length )
4562 length = (uint8_t) output_length;
4563 else
4564 length = tls12_prf->left_in_block;
4565
4566 offset = hash_length - tls12_prf->left_in_block;
4567 memcpy( output, tls12_prf->output_block + offset, length );
4568 output += length;
4569 output_length -= length;
4570 tls12_prf->left_in_block -= length;
4571 }
4572
4573 return( PSA_SUCCESS );
4574}
John Durkop07cc04a2020-11-16 22:08:34 -08004575#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4576 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004577
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004578psa_status_t psa_key_derivation_output_bytes(
4579 psa_key_derivation_operation_t *operation,
4580 uint8_t *output,
4581 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004582{
4583 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004584 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004585
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004586 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004587 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004588 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004589 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004590 }
4591
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004592 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004593 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004594 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004595 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004596 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004597 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004598 goto exit;
4599 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004600 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004601 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004602 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004603 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004604 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4605 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004606 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004607 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004608 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004609 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004610 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004611
John Durkopd0321952020-10-29 21:37:36 -07004612#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004613 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004614 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004615 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004616 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004617 output, output_length );
4618 }
Janos Follathadbec812019-06-14 11:05:39 +01004619 else
John Durkop07cc04a2020-11-16 22:08:34 -08004620#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4621#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4622 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004623 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004624 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004625 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004626 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004627 kdf_alg, output,
4628 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004629 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004630 else
John Durkop07cc04a2020-11-16 22:08:34 -08004631#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4632 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004633 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004634 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004635 return( PSA_ERROR_BAD_STATE );
4636 }
4637
4638exit:
4639 if( status != PSA_SUCCESS )
4640 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004641 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004642 * This allows us to differentiate between exhausted operations and
4643 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4644 * operations. */
4645 psa_algorithm_t alg = operation->alg;
4646 psa_key_derivation_abort( operation );
4647 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004648 memset( output, '!', output_length );
4649 }
4650 return( status );
4651}
4652
David Brown7807bf72021-02-09 16:28:23 -07004653#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004654static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4655{
4656 if( data_size >= 8 )
4657 mbedtls_des_key_set_parity( data );
4658 if( data_size >= 16 )
4659 mbedtls_des_key_set_parity( data + 8 );
4660 if( data_size >= 24 )
4661 mbedtls_des_key_set_parity( data + 16 );
4662}
David Brown7807bf72021-02-09 16:28:23 -07004663#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004664
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004665static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004666 psa_key_slot_t *slot,
4667 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004668 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004669{
4670 uint8_t *data = NULL;
4671 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304672 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004673 psa_status_t status;
4674
Gilles Peskine8e338702019-07-30 20:06:31 +02004675 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004676 return( PSA_ERROR_INVALID_ARGUMENT );
4677 if( bits % 8 != 0 )
4678 return( PSA_ERROR_INVALID_ARGUMENT );
4679 data = mbedtls_calloc( 1, bytes );
4680 if( data == NULL )
4681 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4682
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004683 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004684 if( status != PSA_SUCCESS )
4685 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004686#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004687 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004688 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004689#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004690
Ronald Cronbf33c932020-11-28 18:06:53 +01004691 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004692 psa_key_attributes_t attributes = {
4693 .core = slot->attr
4694 };
4695
Archanad8a83dc2021-06-14 10:04:16 +05304696 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4697 {
Archana449608b2021-09-08 15:36:05 +05304698 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4699 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304700 if( status != PSA_SUCCESS )
4701 goto exit;
4702 }
4703 status = psa_allocate_buffer_to_slot( slot, storage_size );
4704 if( status != PSA_SUCCESS )
4705 goto exit;
4706
Ronald Cronbf33c932020-11-28 18:06:53 +01004707 status = psa_driver_wrapper_import_key( &attributes,
4708 data, bytes,
4709 slot->key.data,
4710 slot->key.bytes,
4711 &slot->key.bytes, &bits );
4712 if( bits != slot->attr.bits )
4713 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004714
4715exit:
4716 mbedtls_free( data );
4717 return( status );
4718}
4719
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004720psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004721 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004722 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004723{
4724 psa_status_t status;
4725 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004726 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004727
Ronald Cron81709fc2020-11-14 12:10:32 +01004728 *key = MBEDTLS_SVC_KEY_ID_INIT;
4729
Gilles Peskine0f84d622019-09-12 19:03:13 +02004730 /* Reject any attempt to create a zero-length key so that we don't
4731 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4732 if( psa_get_key_bits( attributes ) == 0 )
4733 return( PSA_ERROR_INVALID_ARGUMENT );
4734
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004735 if( ! operation->can_output_key )
4736 return( PSA_ERROR_NOT_PERMITTED );
4737
Ronald Cron81709fc2020-11-14 12:10:32 +01004738 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4739 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004740#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4741 if( driver != NULL )
4742 {
4743 /* Deriving a key in a secure element is not implemented yet. */
4744 status = PSA_ERROR_NOT_SUPPORTED;
4745 }
4746#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004747 if( status == PSA_SUCCESS )
4748 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004749 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004750 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004751 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004752 }
4753 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004754 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004755 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004756 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004757
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004758 return( status );
4759}
4760
Gilles Peskineeab56e42018-07-12 17:12:33 +02004761
4762
4763/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004764/* Key derivation */
4765/****************************************************************/
4766
Steven Cooreman932ffb72021-02-15 12:14:32 +01004767#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004768static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004769 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004770 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004771{
John Durkop07cc04a2020-11-16 22:08:34 -08004772 int is_kdf_alg_supported;
4773
Janos Follath5fe19732019-06-20 15:09:30 +01004774 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4775 * initialisers for this union leave some bytes unspecified.) */
4776 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4777
Gilles Peskine969c5d62019-01-16 15:53:06 +01004778 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004779#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004780 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4781 is_kdf_alg_supported = 1;
4782 else
4783#endif
4784#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4785 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4786 is_kdf_alg_supported = 1;
4787 else
4788#endif
4789#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4790 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4791 is_kdf_alg_supported = 1;
4792 else
4793#endif
4794 is_kdf_alg_supported = 0;
4795
4796 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004797 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004798 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004799 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004800 if( hash_size == 0 )
4801 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004802 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4803 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004804 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004805 {
4806 return( PSA_ERROR_NOT_SUPPORTED );
4807 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004808 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004809 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004810 }
John Durkop07cc04a2020-11-16 22:08:34 -08004811
4812 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004813}
John Durkop07cc04a2020-11-16 22:08:34 -08004814#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004815
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004816psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004817 psa_algorithm_t alg )
4818{
4819 psa_status_t status;
4820
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004821 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004822 return( PSA_ERROR_BAD_STATE );
4823
Gilles Peskine6843c292019-01-18 16:44:49 +01004824 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4825 return( PSA_ERROR_INVALID_ARGUMENT );
4826 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004827 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004828#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004829 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004830 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004831#else
4832 return( PSA_ERROR_NOT_SUPPORTED );
4833#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004834 }
4835 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4836 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004837#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004838 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004839#else
4840 return( PSA_ERROR_NOT_SUPPORTED );
4841#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004842 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004843 else
4844 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004845
4846 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004847 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004848 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004849}
4850
John Durkopd0321952020-10-29 21:37:36 -07004851#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004852static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004853 psa_algorithm_t hash_alg,
4854 psa_key_derivation_step_t step,
4855 const uint8_t *data,
4856 size_t data_length )
4857{
4858 psa_status_t status;
4859 switch( step )
4860 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004861 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004862 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004863 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004864 else
4865 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004866 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4867 hash_alg,
4868 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004869 if( status != PSA_SUCCESS )
4870 return( status );
4871 hkdf->state = HKDF_STATE_STARTED;
4872 return( PSA_SUCCESS );
4873 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004874 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004875 /* If no salt was provided, use an empty salt. */
4876 if( hkdf->state == HKDF_STATE_INIT )
4877 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004878 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4879 hash_alg,
4880 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004881 if( status != PSA_SUCCESS )
4882 return( status );
4883 hkdf->state = HKDF_STATE_STARTED;
4884 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004885 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004886 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004887 status = psa_mac_update( &hkdf->hmac,
4888 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004889 if( status != PSA_SUCCESS )
4890 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004891 status = psa_mac_sign_finish( &hkdf->hmac,
4892 hkdf->prk,
4893 sizeof( hkdf->prk ),
4894 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004895 if( status != PSA_SUCCESS )
4896 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004897 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004898 hkdf->block_number = 0;
4899 hkdf->state = HKDF_STATE_KEYED;
4900 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004901 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004902 if( hkdf->state == HKDF_STATE_OUTPUT )
4903 return( PSA_ERROR_BAD_STATE );
4904 if( hkdf->info_set )
4905 return( PSA_ERROR_BAD_STATE );
4906 hkdf->info_length = data_length;
4907 if( data_length != 0 )
4908 {
4909 hkdf->info = mbedtls_calloc( 1, data_length );
4910 if( hkdf->info == NULL )
4911 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4912 memcpy( hkdf->info, data, data_length );
4913 }
4914 hkdf->info_set = 1;
4915 return( PSA_SUCCESS );
4916 default:
4917 return( PSA_ERROR_INVALID_ARGUMENT );
4918 }
4919}
John Durkop07cc04a2020-11-16 22:08:34 -08004920#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004921
John Durkop07cc04a2020-11-16 22:08:34 -08004922#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4923 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004924static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4925 const uint8_t *data,
4926 size_t data_length )
4927{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004928 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004929 return( PSA_ERROR_BAD_STATE );
4930
Janos Follathd6dce9f2019-07-04 09:11:38 +01004931 if( data_length != 0 )
4932 {
4933 prf->seed = mbedtls_calloc( 1, data_length );
4934 if( prf->seed == NULL )
4935 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004936
Janos Follathd6dce9f2019-07-04 09:11:38 +01004937 memcpy( prf->seed, data, data_length );
4938 prf->seed_length = data_length;
4939 }
Janos Follathf08e2652019-06-13 09:05:41 +01004940
Gilles Peskine43f958b2020-12-13 14:55:14 +01004941 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004942
4943 return( PSA_SUCCESS );
4944}
4945
Janos Follath81550542019-06-13 14:26:34 +01004946static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004947 const uint8_t *data,
4948 size_t data_length )
4949{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004950 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004951 return( PSA_ERROR_BAD_STATE );
4952
Steven Cooremana6df6042021-04-29 19:32:25 +02004953 if( data_length != 0 )
4954 {
4955 prf->secret = mbedtls_calloc( 1, data_length );
4956 if( prf->secret == NULL )
4957 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4958
4959 memcpy( prf->secret, data, data_length );
4960 prf->secret_length = data_length;
4961 }
Janos Follath81550542019-06-13 14:26:34 +01004962
Gilles Peskine43f958b2020-12-13 14:55:14 +01004963 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004964
4965 return( PSA_SUCCESS );
4966}
4967
Janos Follath63028dd2019-06-13 09:15:47 +01004968static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4969 const uint8_t *data,
4970 size_t data_length )
4971{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004972 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004973 return( PSA_ERROR_BAD_STATE );
4974
Janos Follathd6dce9f2019-07-04 09:11:38 +01004975 if( data_length != 0 )
4976 {
4977 prf->label = mbedtls_calloc( 1, data_length );
4978 if( prf->label == NULL )
4979 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004980
Janos Follathd6dce9f2019-07-04 09:11:38 +01004981 memcpy( prf->label, data, data_length );
4982 prf->label_length = data_length;
4983 }
Janos Follath63028dd2019-06-13 09:15:47 +01004984
Gilles Peskine43f958b2020-12-13 14:55:14 +01004985 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004986
4987 return( PSA_SUCCESS );
4988}
4989
Janos Follathb03233e2019-06-11 15:30:30 +01004990static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004991 psa_key_derivation_step_t step,
4992 const uint8_t *data,
4993 size_t data_length )
4994{
Janos Follathb03233e2019-06-11 15:30:30 +01004995 switch( step )
4996 {
Janos Follathf08e2652019-06-13 09:05:41 +01004997 case PSA_KEY_DERIVATION_INPUT_SEED:
4998 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004999 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005000 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005001 case PSA_KEY_DERIVATION_INPUT_LABEL:
5002 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005003 default:
5004 return( PSA_ERROR_INVALID_ARGUMENT );
5005 }
5006}
John Durkop07cc04a2020-11-16 22:08:34 -08005007#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5008 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5009
5010#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5011static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5012 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005013 const uint8_t *data,
5014 size_t data_length )
5015{
5016 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005017 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005018 uint8_t *cur = pms;
5019
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005020 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005021 return( PSA_ERROR_INVALID_ARGUMENT );
5022
5023 /* Quoting RFC 4279, Section 2:
5024 *
5025 * The premaster secret is formed as follows: if the PSK is N octets
5026 * long, concatenate a uint16 with the value N, N zero octets, a second
5027 * uint16 with the value N, and the PSK itself.
5028 */
5029
Joe Subbiani5ecac212021-06-24 13:00:03 +01005030 *cur++ = MBEDTLS_BYTE_1( data_length );
5031 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005032 memset( cur, 0, data_length );
5033 cur += data_length;
5034 *cur++ = pms[0];
5035 *cur++ = pms[1];
5036 memcpy( cur, data, data_length );
5037 cur += data_length;
5038
Steven Cooremana6df6042021-04-29 19:32:25 +02005039 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005040
5041 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5042 return( status );
5043}
Janos Follath6660f0e2019-06-17 08:44:03 +01005044
5045static psa_status_t psa_tls12_prf_psk_to_ms_input(
5046 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005047 psa_key_derivation_step_t step,
5048 const uint8_t *data,
5049 size_t data_length )
5050{
5051 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005052 {
Steven Cooremana6df6042021-04-29 19:32:25 +02005053 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005054 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005055 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005056
Steven Cooremana6df6042021-04-29 19:32:25 +02005057 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01005058}
John Durkop07cc04a2020-11-16 22:08:34 -08005059#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005060
Gilles Peskineb8965192019-09-24 16:21:10 +02005061/** Check whether the given key type is acceptable for the given
5062 * input step of a key derivation.
5063 *
5064 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5065 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5066 * Both secret and non-secret inputs can alternatively have the type
5067 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5068 * that the input was passed as a buffer rather than via a key object.
5069 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005070static int psa_key_derivation_check_input_type(
5071 psa_key_derivation_step_t step,
5072 psa_key_type_t key_type )
5073{
5074 switch( step )
5075 {
5076 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005077 if( key_type == PSA_KEY_TYPE_DERIVE )
5078 return( PSA_SUCCESS );
5079 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005080 return( PSA_SUCCESS );
5081 break;
5082 case PSA_KEY_DERIVATION_INPUT_LABEL:
5083 case PSA_KEY_DERIVATION_INPUT_SALT:
5084 case PSA_KEY_DERIVATION_INPUT_INFO:
5085 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005086 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5087 return( PSA_SUCCESS );
5088 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005089 return( PSA_SUCCESS );
5090 break;
5091 }
5092 return( PSA_ERROR_INVALID_ARGUMENT );
5093}
5094
Janos Follathb80a94e2019-06-12 15:54:46 +01005095static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005096 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005097 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005098 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005099 const uint8_t *data,
5100 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005101{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005102 psa_status_t status;
5103 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5104
5105 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005106 if( status != PSA_SUCCESS )
5107 goto exit;
5108
John Durkopd0321952020-10-29 21:37:36 -07005109#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005110 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005111 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005112 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005113 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005114 step, data, data_length );
5115 }
John Durkop07cc04a2020-11-16 22:08:34 -08005116 else
5117#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5118#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5119 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005120 {
Janos Follathb03233e2019-06-11 15:30:30 +01005121 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005122 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005123 }
John Durkop07cc04a2020-11-16 22:08:34 -08005124 else
5125#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5126#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5127 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005128 {
5129 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005130 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005131 }
5132 else
John Durkop07cc04a2020-11-16 22:08:34 -08005133#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005134 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005135 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005136 (void) data;
5137 (void) data_length;
5138 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005139 return( PSA_ERROR_BAD_STATE );
5140 }
5141
Gilles Peskine224b0d62019-09-23 18:13:17 +02005142exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005143 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005144 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005145 return( status );
5146}
5147
Janos Follath51f4a0f2019-06-14 11:35:55 +01005148psa_status_t psa_key_derivation_input_bytes(
5149 psa_key_derivation_operation_t *operation,
5150 psa_key_derivation_step_t step,
5151 const uint8_t *data,
5152 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005153{
Gilles Peskineb8965192019-09-24 16:21:10 +02005154 return( psa_key_derivation_input_internal( operation, step,
5155 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005156 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005157}
5158
Janos Follath51f4a0f2019-06-14 11:35:55 +01005159psa_status_t psa_key_derivation_input_key(
5160 psa_key_derivation_operation_t *operation,
5161 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005162 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005163{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005164 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005165 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005166 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005167
Ronald Cron5c522922020-11-14 16:35:34 +01005168 status = psa_get_and_lock_transparent_key_slot_with_policy(
5169 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005170 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005171 {
5172 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005173 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005174 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005175
5176 /* Passing a key object as a SECRET input unlocks the permission
5177 * to output to a key object. */
5178 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5179 operation->can_output_key = 1;
5180
Ronald Cronf95a2b12020-10-22 15:24:49 +02005181 status = psa_key_derivation_input_internal( operation,
5182 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005183 slot->key.data,
5184 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005185
Ronald Cron5c522922020-11-14 16:35:34 +01005186 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005187
Ronald Cron5c522922020-11-14 16:35:34 +01005188 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005189}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005190
5191
5192
5193/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005194/* Key agreement */
5195/****************************************************************/
5196
John Durkop6ba40d12020-11-10 08:50:04 -08005197#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005198static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5199 size_t peer_key_length,
5200 const mbedtls_ecp_keypair *our_key,
5201 uint8_t *shared_secret,
5202 size_t shared_secret_size,
5203 size_t *shared_secret_length )
5204{
Steven Cooremand4867872020-08-05 16:31:39 +02005205 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005206 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005207 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005208 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005209 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005210 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005211
Ronald Cron90857082020-11-25 14:58:33 +01005212 status = mbedtls_psa_ecp_load_representation(
5213 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005214 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005215 peer_key,
5216 peer_key_length,
5217 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005218 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005219 goto exit;
5220
Jaeden Amero97271b32019-01-10 19:38:51 +00005221 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005222 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005223 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005224 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005225 status = mbedtls_to_psa_error(
5226 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5227 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005228 goto exit;
5229
Jaeden Amero97271b32019-01-10 19:38:51 +00005230 status = mbedtls_to_psa_error(
5231 mbedtls_ecdh_calc_secret( &ecdh,
5232 shared_secret_length,
5233 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005234 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005235 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005236 if( status != PSA_SUCCESS )
5237 goto exit;
5238 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5239 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005240
5241exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005242 if( status != PSA_SUCCESS )
5243 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005244 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005245 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005246 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005247
Jaeden Amero97271b32019-01-10 19:38:51 +00005248 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005249}
John Durkop6ba40d12020-11-10 08:50:04 -08005250#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005251
Gilles Peskine01d718c2018-09-18 12:01:02 +02005252#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5253
Gilles Peskine0216fe12019-04-11 21:23:21 +02005254static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5255 psa_key_slot_t *private_key,
5256 const uint8_t *peer_key,
5257 size_t peer_key_length,
5258 uint8_t *shared_secret,
5259 size_t shared_secret_size,
5260 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005261{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005262 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005263 {
John Durkop6ba40d12020-11-10 08:50:04 -08005264#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005265 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005266 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005267 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005268 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005269 psa_status_t status = mbedtls_psa_ecp_load_representation(
5270 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005271 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005272 private_key->key.data,
5273 private_key->key.bytes,
5274 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005275 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005276 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005277 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005278 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005279 shared_secret, shared_secret_size,
5280 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005281 mbedtls_ecp_keypair_free( ecp );
5282 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005283 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005284#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005285 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005286 (void) private_key;
5287 (void) peer_key;
5288 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005289 (void) shared_secret;
5290 (void) shared_secret_size;
5291 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005292 return( PSA_ERROR_NOT_SUPPORTED );
5293 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005294}
5295
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005296/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005297 * to potentially free embedded data structures and wipe confidential data.
5298 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005299static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005300 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005301 psa_key_slot_t *private_key,
5302 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005303 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005304{
5305 psa_status_t status;
5306 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5307 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005308 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005309
5310 /* Step 1: run the secret agreement algorithm to generate the shared
5311 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005312 status = psa_key_agreement_raw_internal( ka_alg,
5313 private_key,
5314 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005315 shared_secret,
5316 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005317 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005318 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005319 goto exit;
5320
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005321 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005322 * the shared secret. A shared secret is permitted wherever a key
5323 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005324 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005325 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005326 shared_secret,
5327 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005328exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005329 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005330 return( status );
5331}
5332
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005333psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005334 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005335 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005336 const uint8_t *peer_key,
5337 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005338{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005339 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005340 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005341 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005342
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005343 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005344 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005345 status = psa_get_and_lock_transparent_key_slot_with_policy(
5346 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005347 if( status != PSA_SUCCESS )
5348 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005349 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005350 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005351 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005352 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005353 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005354 else
5355 {
5356 /* If a private key has been added as SECRET, we allow the derived
5357 * key material to be used as a key in PSA Crypto. */
5358 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5359 operation->can_output_key = 1;
5360 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005361
Ronald Cron5c522922020-11-14 16:35:34 +01005362 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005363
Ronald Cron5c522922020-11-14 16:35:34 +01005364 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005365}
5366
Gilles Peskinebe697d82019-05-16 18:00:41 +02005367psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005368 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005369 const uint8_t *peer_key,
5370 size_t peer_key_length,
5371 uint8_t *output,
5372 size_t output_size,
5373 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005374{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005375 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005376 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005377 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005378
5379 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5380 {
5381 status = PSA_ERROR_INVALID_ARGUMENT;
5382 goto exit;
5383 }
Ronald Cron5c522922020-11-14 16:35:34 +01005384 status = psa_get_and_lock_transparent_key_slot_with_policy(
5385 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005386 if( status != PSA_SUCCESS )
5387 goto exit;
5388
5389 status = psa_key_agreement_raw_internal( alg, slot,
5390 peer_key, peer_key_length,
5391 output, output_size,
5392 output_length );
5393
5394exit:
5395 if( status != PSA_SUCCESS )
5396 {
5397 /* If an error happens and is not handled properly, the output
5398 * may be used as a key to protect sensitive data. Arrange for such
5399 * a key to be random, which is likely to result in decryption or
5400 * verification errors. This is better than filling the buffer with
5401 * some constant data such as zeros, which would result in the data
5402 * being protected with a reproducible, easily knowable key.
5403 */
5404 psa_generate_random( output, output_size );
5405 *output_length = output_size;
5406 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005407
Ronald Cron5c522922020-11-14 16:35:34 +01005408 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005409
Ronald Cron5c522922020-11-14 16:35:34 +01005410 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005411}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005412
5413
Gilles Peskine30524eb2020-11-13 17:02:26 +01005414
Gilles Peskine86a440b2018-11-12 18:39:40 +01005415/****************************************************************/
5416/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005417/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005418
Gilles Peskine30524eb2020-11-13 17:02:26 +01005419/** Initialize the PSA random generator.
5420 */
5421static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5422{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005423#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5424 memset( rng, 0, sizeof( *rng ) );
5425#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5426
Gilles Peskine30524eb2020-11-13 17:02:26 +01005427 /* Set default configuration if
5428 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5429 if( rng->entropy_init == NULL )
5430 rng->entropy_init = mbedtls_entropy_init;
5431 if( rng->entropy_free == NULL )
5432 rng->entropy_free = mbedtls_entropy_free;
5433
5434 rng->entropy_init( &rng->entropy );
5435#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5436 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5437 /* The PSA entropy injection feature depends on using NV seed as an entropy
5438 * source. Add NV seed as an entropy source for PSA entropy injection. */
5439 mbedtls_entropy_add_source( &rng->entropy,
5440 mbedtls_nv_seed_poll, NULL,
5441 MBEDTLS_ENTROPY_BLOCK_SIZE,
5442 MBEDTLS_ENTROPY_SOURCE_STRONG );
5443#endif
5444
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005445 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005446#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005447}
5448
5449/** Deinitialize the PSA random generator.
5450 */
5451static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5452{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005453#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5454 memset( rng, 0, sizeof( *rng ) );
5455#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005456 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005457 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005458#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005459}
5460
5461/** Seed the PSA random generator.
5462 */
5463static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5464{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005465#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5466 /* Do nothing: the external RNG seeds itself. */
5467 (void) rng;
5468 return( PSA_SUCCESS );
5469#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005470 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005471 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5472 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005473 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005474#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005475}
5476
Gilles Peskinee59236f2018-01-27 23:32:46 +01005477psa_status_t psa_generate_random( uint8_t *output,
5478 size_t output_size )
5479{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005480 GUARD_MODULE_INITIALIZED;
5481
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005482#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5483
5484 size_t output_length = 0;
5485 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5486 output, output_size,
5487 &output_length );
5488 if( status != PSA_SUCCESS )
5489 return( status );
5490 /* Breaking up a request into smaller chunks is currently not supported
5491 * for the extrernal RNG interface. */
5492 if( output_length != output_size )
5493 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5494 return( PSA_SUCCESS );
5495
5496#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5497
Gilles Peskine71ddab92021-01-04 21:01:07 +01005498 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005499 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005500 size_t request_size =
5501 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5502 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5503 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005504 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5505 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005506 if( ret != 0 )
5507 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005508 output_size -= request_size;
5509 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005510 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005511 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005512#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005513}
5514
Gilles Peskine8814fc42020-12-14 15:33:44 +01005515/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005516 *
5517 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5518 * `psa_generate_random(...)`. The state parameter is ignored since the
5519 * PSA API doesn't support passing an explicit state.
5520 *
5521 * In the non-external case, psa_generate_random() calls an
5522 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5523 * and semantics as mbedtls_psa_get_random(). As an optimization,
5524 * instead of doing this back-and-forth between the PSA API and the
5525 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5526 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005527 */
5528#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5529int mbedtls_psa_get_random( void *p_rng,
5530 unsigned char *output,
5531 size_t output_size )
5532{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005533 /* This function takes a pointer to the RNG state because that's what
5534 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5535 * its own state internally and doesn't let the caller access that state.
5536 * So we just ignore the state parameter, and in practice we'll pass
5537 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005538 (void) p_rng;
5539 psa_status_t status = psa_generate_random( output, output_size );
5540 if( status == PSA_SUCCESS )
5541 return( 0 );
5542 else
5543 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5544}
5545#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5546
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005547#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005548#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005549
Gilles Peskine7228da22019-07-15 11:06:15 +02005550psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005551 size_t seed_size )
5552{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005553 if( global_data.initialized )
5554 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005555
5556 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5557 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5558 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5559 return( PSA_ERROR_INVALID_ARGUMENT );
5560
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005561 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005562}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005563#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005564
Ronald Cron3772afe2021-02-08 16:10:05 +01005565/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005566 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005567 * \param type The key type
5568 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005569 *
5570 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005571 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005572 * \retval #PSA_ERROR_INVALID_ARGUMENT
5573 * The size in bits of the key is not valid.
5574 * \retval #PSA_ERROR_NOT_SUPPORTED
5575 * The type and/or the size in bits of the key or the combination of
5576 * the two is not supported.
5577 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005578static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5579 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005580{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005582
Gilles Peskinee59236f2018-01-27 23:32:46 +01005583 if( key_type_is_raw_bytes( type ) )
5584 {
Archana4d7ae1d2021-07-07 02:50:22 +05305585 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005586 if( status != PSA_SUCCESS )
5587 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005588 }
5589 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005590#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005591 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5592 {
5593 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5594 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005595
Ronald Cron01b2aba2020-10-05 09:42:02 +02005596 /* Accept only byte-aligned keys, for the same reasons as
5597 * in psa_import_rsa_key(). */
5598 if( bits % 8 != 0 )
5599 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005600 }
5601 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005602#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005603
Ronald Cron5c4d3862020-12-07 11:07:24 +01005604#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005605 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5606 {
Ronald Crond81ab562021-02-16 09:01:16 +01005607 /* To avoid empty block, return successfully here. */
5608 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005609 }
5610 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005611#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005612 {
5613 return( PSA_ERROR_NOT_SUPPORTED );
5614 }
5615
5616 return( PSA_SUCCESS );
5617}
5618
Ronald Cron55ed0592020-10-05 10:30:40 +02005619psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005620 const psa_key_attributes_t *attributes,
5621 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005622{
5623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005624 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005625
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005626 if( ( attributes->domain_parameters == NULL ) &&
5627 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005628 return( PSA_ERROR_INVALID_ARGUMENT );
5629
Ronald Cron01b2aba2020-10-05 09:42:02 +02005630 if( key_type_is_raw_bytes( type ) )
5631 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005632 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005633 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005634 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005635
David Brown12ca5032021-02-11 11:02:00 -07005636#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005637 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005638 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005639#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005640 }
5641 else
5642
Jaeden Amero424fa932021-05-14 08:34:32 +01005643#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5644 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005645 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005646 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005647 return( mbedtls_psa_rsa_generate_key( attributes,
5648 key_buffer,
5649 key_buffer_size,
5650 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005651 }
5652 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005653#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5654 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005655
John Durkop9814fa22020-11-04 12:28:15 -08005656#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005657 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005658 {
Ronald Cron7023db52020-11-20 18:17:42 +01005659 return( mbedtls_psa_ecp_generate_key( attributes,
5660 key_buffer,
5661 key_buffer_size,
5662 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005663 }
5664 else
John Durkop9814fa22020-11-04 12:28:15 -08005665#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005666 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005667 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005668 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005669 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005670
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005671 return( PSA_SUCCESS );
5672}
Darryl Green0c6575a2018-11-07 16:05:30 +00005673
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005674psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005675 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005676{
5677 psa_status_t status;
5678 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005679 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005680 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005681
Ronald Cron81709fc2020-11-14 12:10:32 +01005682 *key = MBEDTLS_SVC_KEY_ID_INIT;
5683
Gilles Peskine0f84d622019-09-12 19:03:13 +02005684 /* Reject any attempt to create a zero-length key so that we don't
5685 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5686 if( psa_get_key_bits( attributes ) == 0 )
5687 return( PSA_ERROR_INVALID_ARGUMENT );
5688
Ronald Cron81709fc2020-11-14 12:10:32 +01005689 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5690 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005691 if( status != PSA_SUCCESS )
5692 goto exit;
5693
Ronald Cron977c2472020-10-13 08:32:21 +02005694 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305695 * storage ( thus not in the case of generating a key in a secure element
5696 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5697 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005698 if( slot->key.data == NULL )
5699 {
5700 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5701 PSA_KEY_LOCATION_LOCAL_STORAGE )
5702 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005703 status = psa_validate_key_type_and_size_for_key_generation(
5704 attributes->core.type, attributes->core.bits );
5705 if( status != PSA_SUCCESS )
5706 goto exit;
5707
5708 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5709 attributes->core.type,
5710 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005711 }
5712 else
5713 {
5714 status = psa_driver_wrapper_get_key_buffer_size(
5715 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005716 if( status != PSA_SUCCESS )
5717 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005718 }
Ronald Cron977c2472020-10-13 08:32:21 +02005719
5720 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5721 if( status != PSA_SUCCESS )
5722 goto exit;
5723 }
5724
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005725 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005726 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005727
Ronald Cron2b56bc82020-10-05 10:02:26 +02005728 if( status != PSA_SUCCESS )
5729 psa_remove_key_data_from_memory( slot );
5730
Gilles Peskine11792082019-08-06 18:36:36 +02005731exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005732 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005733 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005734 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005735 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005736
Darryl Green0c6575a2018-11-07 16:05:30 +00005737 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005738}
5739
Gilles Peskinee59236f2018-01-27 23:32:46 +01005740/****************************************************************/
5741/* Module setup */
5742/****************************************************************/
5743
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005744#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005745psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5746 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5747 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5748{
5749 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5750 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005751 global_data.rng.entropy_init = entropy_init;
5752 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005753 return( PSA_SUCCESS );
5754}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005755#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005756
Gilles Peskinee59236f2018-01-27 23:32:46 +01005757void mbedtls_psa_crypto_free( void )
5758{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005759 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005760 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5761 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005762 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005763 }
5764 /* Wipe all remaining data, including configuration.
5765 * In particular, this sets all state indicator to the value
5766 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005767 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005768#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005769 /* Unregister all secure element drivers, so that we restart from
5770 * a pristine state. */
5771 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005772#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005773}
5774
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005775#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5776/** Recover a transaction that was interrupted by a power failure.
5777 *
5778 * This function is called during initialization, before psa_crypto_init()
5779 * returns. If this function returns a failure status, the initialization
5780 * fails.
5781 */
5782static psa_status_t psa_crypto_recover_transaction(
5783 const psa_crypto_transaction_t *transaction )
5784{
5785 switch( transaction->unknown.type )
5786 {
5787 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5788 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005789 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005790 * is implemented.
5791 * https://github.com/ARMmbed/mbed-crypto/issues/218
5792 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005793 default:
5794 /* We found an unsupported transaction in the storage.
5795 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005796 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005797 }
5798}
5799#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5800
Gilles Peskinee59236f2018-01-27 23:32:46 +01005801psa_status_t psa_crypto_init( void )
5802{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005803 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005804
Gilles Peskinec6b69072018-11-20 21:42:52 +01005805 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005806 if( global_data.initialized != 0 )
5807 return( PSA_SUCCESS );
5808
Gilles Peskine30524eb2020-11-13 17:02:26 +01005809 /* Initialize and seed the random generator. */
5810 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005811 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005812 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005813 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005814 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005815 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005816
Gilles Peskine66fb1262018-12-10 16:29:04 +01005817 status = psa_initialize_key_slots( );
5818 if( status != PSA_SUCCESS )
5819 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005820
Gilles Peskined9348f22019-10-01 15:22:29 +02005821#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5822 status = psa_init_all_se_drivers( );
5823 if( status != PSA_SUCCESS )
5824 goto exit;
5825#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5826
Gilles Peskine4b734222019-07-24 15:56:31 +02005827#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005828 status = psa_crypto_load_transaction( );
5829 if( status == PSA_SUCCESS )
5830 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005831 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5832 if( status != PSA_SUCCESS )
5833 goto exit;
5834 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005835 }
5836 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5837 {
5838 /* There's no transaction to complete. It's all good. */
5839 status = PSA_SUCCESS;
5840 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005841#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005842
Gilles Peskinec6b69072018-11-20 21:42:52 +01005843 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005844 global_data.initialized = 1;
5845
5846exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005847 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005848 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005849 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005850}
5851
5852#endif /* MBEDTLS_PSA_CRYPTO_C */