blob: 9731932f363617ec67a19782d5f76a26e3801eb0 [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 Peskinec6b69072018-11-20 21:42:52 +0100106 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100107 unsigned rng_state : 2;
Gilles Peskine2d8a1822021-11-08 22:20:03 +0100108 mbedtls_psa_random_context_t rng;
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 );
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200204 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
205 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200207 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208
Gilles Peskine82e57d12020-11-13 21:31:17 +0100209#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
210 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100211 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
212 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100213 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220#endif
221
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
223 return( PSA_ERROR_NOT_SUPPORTED );
224 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
225 return( PSA_ERROR_INVALID_ARGUMENT );
226 case MBEDTLS_ERR_MD_ALLOC_FAILED:
227 return( PSA_ERROR_INSUFFICIENT_MEMORY );
228 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
229 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
Gilles Peskinef76aa772018-10-29 19:24:33 +0100231 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
232 return( PSA_ERROR_STORAGE_FAILURE );
233 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
236 return( PSA_ERROR_INVALID_ARGUMENT );
237 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
238 return( PSA_ERROR_BUFFER_TOO_SMALL );
239 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
244 return( PSA_ERROR_INVALID_ARGUMENT );
245 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
246 return( PSA_ERROR_INSUFFICIENT_MEMORY );
247
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100248 case MBEDTLS_ERR_PK_ALLOC_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_MEMORY );
250 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
251 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
252 return( PSA_ERROR_INVALID_ARGUMENT );
253 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100254 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100255 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
256 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
259 return( PSA_ERROR_NOT_SUPPORTED );
260 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
261 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
262 return( PSA_ERROR_NOT_PERMITTED );
263 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_PK_INVALID_ALG:
266 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
267 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
268 return( PSA_ERROR_NOT_SUPPORTED );
269 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
270 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200271 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
272 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100273
Gilles Peskineff2d2002019-05-06 15:26:23 +0200274 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
275 return( PSA_ERROR_HARDWARE_FAILURE );
276 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
277 return( PSA_ERROR_NOT_SUPPORTED );
278
Gilles Peskinea5905292018-02-07 20:59:33 +0100279 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_RSA_INVALID_PADDING:
282 return( PSA_ERROR_INVALID_PADDING );
283 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
284 return( PSA_ERROR_HARDWARE_FAILURE );
285 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
286 return( PSA_ERROR_INVALID_ARGUMENT );
287 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
288 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200289 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100290 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
291 return( PSA_ERROR_INVALID_SIGNATURE );
292 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
293 return( PSA_ERROR_BUFFER_TOO_SMALL );
294 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100295 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200296
itayzafrir5c753392018-05-08 11:18:38 +0300297 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300299 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300300 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
301 return( PSA_ERROR_BUFFER_TOO_SMALL );
302 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
303 return( PSA_ERROR_NOT_SUPPORTED );
304 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
305 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
306 return( PSA_ERROR_INVALID_SIGNATURE );
307 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
310 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100311
Janos Follatha13b9052019-11-22 12:48:59 +0000312 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
313 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300314
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 default:
David Saadab4ecc272019-02-14 13:48:10 +0200316 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100317 }
318}
319
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200320
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200321
322
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100323/****************************************************************/
324/* Key management */
325/****************************************************************/
326
John Durkop9814fa22020-11-04 12:28:15 -0800327#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800328 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100329 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
330 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
331 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100332mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100333 size_t bits,
334 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200335{
336 switch( curve )
337 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100338 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100339 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100340 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100341#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100342 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100343 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100344#endif
345#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100346 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100347 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100348#endif
349#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100350 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100351 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100352#endif
353#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100354 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100355 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100356#endif
357#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100358 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100359 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 528:
361 if( bits_is_sloppy )
362 return( MBEDTLS_ECP_DP_SECP521R1 );
363 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100364#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100365 }
366 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100367
Paul Elliott8ff510a2020-06-02 17:19:28 +0100368 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100370 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100371#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100372 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#endif
375#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100382#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 }
384 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100385
Paul Elliott8ff510a2020-06-02 17:19:28 +0100386 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100387 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100388 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100389#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100390 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 256:
393 if( bits_is_sloppy )
394 return( MBEDTLS_ECP_DP_CURVE25519 );
395 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#endif
397#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 }
402 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100403
Paul Elliott8ff510a2020-06-02 17:19:28 +0100404 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100407#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100408 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100410#endif
411#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 }
420 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200421 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100422
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100423 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200425}
John Durkop9814fa22020-11-04 12:28:15 -0800426#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100427 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
428 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
429 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
430 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200431
Archana4d7ae1d2021-07-07 02:50:22 +0530432psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530433 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200434{
435 /* Check that the bit size is acceptable for the key type */
436 switch( type )
437 {
438 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200439 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200440 case PSA_KEY_TYPE_DERIVE:
441 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100442#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443 case PSA_KEY_TYPE_AES:
444 if( bits != 128 && bits != 192 && bits != 256 )
445 return( PSA_ERROR_INVALID_ARGUMENT );
446 break;
447#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200448#if defined(PSA_WANT_KEY_TYPE_ARIA)
449 case PSA_KEY_TYPE_ARIA:
450 if( bits != 128 && bits != 192 && bits != 256 )
451 return( PSA_ERROR_INVALID_ARGUMENT );
452 break;
453#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100454#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455 case PSA_KEY_TYPE_CAMELLIA:
456 if( bits != 128 && bits != 192 && bits != 256 )
457 return( PSA_ERROR_INVALID_ARGUMENT );
458 break;
459#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100460#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461 case PSA_KEY_TYPE_DES:
462 if( bits != 64 && bits != 128 && bits != 192 )
463 return( PSA_ERROR_INVALID_ARGUMENT );
464 break;
465#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100466#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200467 case PSA_KEY_TYPE_CHACHA20:
468 if( bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472 default:
473 return( PSA_ERROR_NOT_SUPPORTED );
474 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200475 if( bits % 8 != 0 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200477
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478 return( PSA_SUCCESS );
479}
480
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 *
Steven Cooremancd640932021-03-08 12:00:27 +0100483 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
484 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100485 *
486 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \param[in] key_type The key type of the key to be used with the
488 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 *
490 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100491 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100492 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100493 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100494 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100495MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100496 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100497 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498{
Steven Cooremancd640932021-03-08 12:00:27 +0100499 if( PSA_ALG_IS_HMAC( algorithm ) )
500 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100501 if( key_type == PSA_KEY_TYPE_HMAC )
502 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504
505 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100506 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100507 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
508 * key. */
509 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
510 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
511 {
512 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
513 * the block length (larger than 1) for block ciphers. */
514 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
515 return( PSA_SUCCESS );
516 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100517 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100518
519 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100520}
521
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200522psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
523 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200524{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100525 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200526 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200527
Ronald Cronea0f8a62020-11-25 17:52:23 +0100528 slot->key.data = mbedtls_calloc( 1, buffer_length );
529 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200530 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200531
Ronald Cronea0f8a62020-11-25 17:52:23 +0100532 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200533 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200534}
535
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200536psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
537 const uint8_t* data,
538 size_t data_length )
539{
540 psa_status_t status = psa_allocate_buffer_to_slot( slot,
541 data_length );
542 if( status != PSA_SUCCESS )
543 return( status );
544
Ronald Cronea0f8a62020-11-25 17:52:23 +0100545 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200546 return( PSA_SUCCESS );
547}
548
Ronald Crona0fe59f2020-11-29 11:14:53 +0100549psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 const psa_key_attributes_t *attributes,
551 const uint8_t *data, size_t data_length,
552 uint8_t *key_buffer, size_t key_buffer_size,
553 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100554{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
556 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100557
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200558 /* zero-length keys are never supported. */
559 if( data_length == 0 )
560 return( PSA_ERROR_NOT_SUPPORTED );
561
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100562 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100563 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200565
Archana449608b2021-09-08 15:36:05 +0530566 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
567 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200568 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200569 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200570
Ronald Crondd04d422020-11-28 15:14:42 +0100571 /* Copy the key material. */
572 memcpy( key_buffer, data, data_length );
573 *key_buffer_length = data_length;
574 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200575
Steven Cooreman40120f62020-10-29 11:42:22 +0100576 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100577 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100578 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200579 {
John Durkop9814fa22020-11-04 12:28:15 -0800580#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
581 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100582 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200583 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100584 return( mbedtls_psa_ecp_import_key( attributes,
585 data, data_length,
586 key_buffer, key_buffer_size,
587 key_buffer_length,
588 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100589 }
John Durkop9814fa22020-11-04 12:28:15 -0800590#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
591 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700592#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100594 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200595 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100596 return( mbedtls_psa_rsa_import_key( attributes,
597 data, data_length,
598 key_buffer, key_buffer_size,
599 key_buffer_length,
600 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200601 }
John Durkop9814fa22020-11-04 12:28:15 -0800602#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
603 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100604 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100605
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100606 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100607}
608
Gilles Peskinef603c712019-01-19 13:40:11 +0100609/** Calculate the intersection of two algorithm usage policies.
610 *
611 * Return 0 (which allows no operation) on incompatibility.
612 */
613static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100614 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100615 psa_algorithm_t alg1,
616 psa_algorithm_t alg2 )
617{
Gilles Peskine549ea862019-05-22 11:45:59 +0200618 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100619 if( alg1 == alg2 )
620 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100621 /* If the policies are from the same hash-and-sign family, check
622 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200623 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
624 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100625 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100626 {
Steven Cooreman03488022021-02-18 12:07:20 +0100627 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
628 return( alg2 );
629 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
630 return( alg1 );
631 }
632 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100633 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100634 * restrictive tag length. */
635 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
636 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
637 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
638 {
639 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
640 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100641 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100642
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100643 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100644 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
645 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100646 {
Steven Cooremancd640932021-03-08 12:00:27 +0100647 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
648 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100649 }
650 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100651 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100652 ( alg1_len <= alg2_len ) )
653 {
654 return( alg2 );
655 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100656 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100657 ( alg2_len <= alg1_len ) )
658 {
659 return( alg1 );
660 }
661 }
662 /* If the policies are from the same MAC family, check whether one
663 * of them is a minimum-MAC-length policy. Calculate the most
664 * restrictive tag length. */
665 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
666 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
667 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
668 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100669 /* Validate the combination of key type and algorithm. Since the base
670 * algorithm of alg1 and alg2 are the same, we only need this once. */
671 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100672 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100673
Steven Cooreman31a876d2021-03-03 20:47:40 +0100674 /* Get the (exact or at-least) output lengths for both sides of the
675 * requested intersection. None of the currently supported algorithms
676 * have an output length dependent on the actual key size, so setting it
677 * to a bogus value of 0 is currently OK.
678 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100679 * Note that for at-least-this-length wildcard algorithms, the output
680 * length is set to the shortest allowed length, which allows us to
681 * calculate the most restrictive tag length for the intersection. */
682 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
683 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100684 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100685
Steven Cooremana1d83222021-02-25 10:20:29 +0100686 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100687 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
688 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100689 {
Steven Cooremancd640932021-03-08 12:00:27 +0100690 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100691 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100692
693 /* If only one is an at-least-this-length policy, the intersection would
694 * be the other (fixed-length) policy as long as said fixed length is
695 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100696 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100697 {
Steven Cooremancd640932021-03-08 12:00:27 +0100698 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100699 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100700 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100701 {
Steven Cooremancd640932021-03-08 12:00:27 +0100702 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100703 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100704
Steven Cooremancd640932021-03-08 12:00:27 +0100705 /* If none of them are wildcards, check whether they define the same tag
706 * length. This is still possible here when one is default-length and
707 * the other specific-length. Ensure to always return the
708 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100709 if( alg1_len == alg2_len )
710 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100711 }
712 /* If the policies are incompatible, allow nothing. */
713 return( 0 );
714}
715
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100716static int psa_key_algorithm_permits( psa_key_type_t key_type,
717 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200718 psa_algorithm_t requested_alg )
719{
Gilles Peskine549ea862019-05-22 11:45:59 +0200720 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200721 if( requested_alg == policy_alg )
722 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100723 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
724 * and requested_alg is the same hash-and-sign family with any hash,
725 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200726 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100727 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200728 {
Steven Cooreman03488022021-02-18 12:07:20 +0100729 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
730 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
731 }
732 /* If policy_alg is a wildcard AEAD algorithm of the same base as
733 * the requested algorithm, check the requested tag length to be
734 * equal-length or longer than the wildcard-specified length. */
735 if( PSA_ALG_IS_AEAD( policy_alg ) &&
736 PSA_ALG_IS_AEAD( requested_alg ) &&
737 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
738 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100739 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100740 {
741 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
742 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
743 }
Steven Cooremancd640932021-03-08 12:00:27 +0100744 /* If policy_alg is a MAC algorithm of the same base as the requested
745 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100746 if( PSA_ALG_IS_MAC( policy_alg ) &&
747 PSA_ALG_IS_MAC( requested_alg ) &&
748 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100749 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100750 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100751 /* Validate the combination of key type and algorithm. Since the policy
752 * and requested algorithms are the same, we only need this once. */
753 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100754 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100755
Steven Cooreman31a876d2021-03-03 20:47:40 +0100756 /* Get both the requested output length for the algorithm which is to be
757 * verified, and the default output length for the base algorithm.
758 * Note that none of the currently supported algorithms have an output
759 * length dependent on actual key size, so setting it to a bogus value
760 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100761 size_t requested_output_length = PSA_MAC_LENGTH(
762 key_type, 0, requested_alg );
763 size_t default_output_length = PSA_MAC_LENGTH(
764 key_type, 0,
765 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100766
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100767 /* If the policy is default-length, only allow an algorithm with
768 * a declared exact-length matching the default. */
769 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100770 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100771
772 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100773 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
775 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
776 {
777 return( 1 );
778 }
779
Steven Cooremancd640932021-03-08 12:00:27 +0100780 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
781 * check for the requested MAC length to be equal to or longer than the
782 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
784 {
785 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100787 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200788 }
Steven Cooremance48e852020-10-05 16:02:45 +0200789 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200790 * a key derivation with that key agreement should also be allowed. This
791 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200792 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
793 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
794 {
795 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
796 policy_alg );
797 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100798 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200799 return( 0 );
800}
801
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100802/** Test whether a policy permits an algorithm.
803 *
804 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100806 * \note This function requires providing the key type for which the policy is
807 * being validated, since some algorithm policy definitions (e.g. MAC)
808 * have different properties depending on what kind of cipher it is
809 * combined with.
810 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100811 * \retval PSA_SUCCESS When \p alg is a specific algorithm
812 * allowed by the \p policy.
813 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
814 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
815 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100816 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100817static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100818 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100819 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100820{
Steven Cooremand788fab2021-02-25 11:29:17 +0100821 /* '0' is not a valid algorithm */
822 if( alg == 0 )
823 return( PSA_ERROR_INVALID_ARGUMENT );
824
Steven Cooreman7e39f052021-02-23 14:18:32 +0100825 /* A requested algorithm cannot be a wildcard. */
826 if( PSA_ALG_IS_WILDCARD( alg ) )
827 return( PSA_ERROR_INVALID_ARGUMENT );
828
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100829 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
830 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100831 return( PSA_SUCCESS );
832 else
833 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100834}
835
Gilles Peskinef603c712019-01-19 13:40:11 +0100836/** Restrict a key policy based on a constraint.
837 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100838 * \note This function requires providing the key type for which the policy is
839 * being restricted, since some algorithm policy definitions (e.g. MAC)
840 * have different properties depending on what kind of cipher it is
841 * combined with.
842 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100843 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100844 * \param[in,out] policy The policy to restrict.
845 * \param[in] constraint The policy constraint to apply.
846 *
847 * \retval #PSA_SUCCESS
848 * \c *policy contains the intersection of the original value of
849 * \c *policy and \c *constraint.
850 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100851 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100852 * \c *policy is unchanged.
853 */
854static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100855 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100856 psa_key_policy_t *policy,
857 const psa_key_policy_t *constraint )
858{
859 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100860 psa_key_policy_algorithm_intersection( key_type, policy->alg,
861 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200862 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100863 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
864 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100865 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
866 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200867 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
868 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100869 policy->usage &= constraint->usage;
870 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200871 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100872 return( PSA_SUCCESS );
873}
874
Ronald Cron5c522922020-11-14 16:35:34 +0100875/** Get the description of a key given its identifier and policy constraints
876 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200877 *
Ronald Cron5c522922020-11-14 16:35:34 +0100878 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100879 * nonzero, the key must allow operations with this algorithm. If \p alg is
880 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100881 *
Ronald Cron5c522922020-11-14 16:35:34 +0100882 * In case of a persistent key, the function loads the description of the key
883 * into a key slot if not already done.
884 *
885 * On success, the returned key slot is locked. It is the responsibility of
886 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200887 */
Ronald Cron5c522922020-11-14 16:35:34 +0100888static psa_status_t psa_get_and_lock_key_slot_with_policy(
889 mbedtls_svc_key_id_t key,
890 psa_key_slot_t **p_slot,
891 psa_key_usage_t usage,
892 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100893{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
895 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
Ronald Cron5c522922020-11-14 16:35:34 +0100897 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100898 if( status != PSA_SUCCESS )
899 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200900 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100901
902 /* Enforce that usage policy for the key slot contains all the flags
903 * required by the usage parameter. There is one exception: public
904 * keys can always be exported, so we treat public key objects as
905 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200906 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100907 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200908
Gilles Peskine8e338702019-07-30 20:06:31 +0200909 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100910 {
911 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200912 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
915 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 if( alg != 0 )
917 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100918 status = psa_key_policy_permits( &slot->attr.policy,
919 slot->attr.type,
920 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100921 if( status != PSA_SUCCESS )
922 goto error;
923 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100924
Darryl Green06fd18d2018-07-16 11:21:11 +0100925 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926
927error:
928 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100929 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200930
931 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100932}
Darryl Green940d72c2018-07-13 13:18:51 +0100933
Ronald Cron5c522922020-11-14 16:35:34 +0100934/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200935 *
936 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200937 * available, as opposed to a key in a secure element and/or to be used
938 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200939 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * This is a temporary function that may be used instead of
941 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
942 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200943 *
Ronald Cron5c522922020-11-14 16:35:34 +0100944 * On success, the returned key slot is locked. It is the responsibility of the
945 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946 */
Ronald Cron5c522922020-11-14 16:35:34 +0100947static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
948 mbedtls_svc_key_id_t key,
949 psa_key_slot_t **p_slot,
950 psa_key_usage_t usage,
951 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200952{
Ronald Cron5c522922020-11-14 16:35:34 +0100953 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
954 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 if( status != PSA_SUCCESS )
956 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200957
Ronald Cronddae0f52021-08-24 15:39:44 +0200958 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 {
Ronald Cron5c522922020-11-14 16:35:34 +0100960 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961 *p_slot = NULL;
962 return( PSA_ERROR_NOT_SUPPORTED );
963 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200964
Gilles Peskine28f8f302019-07-24 13:30:31 +0200965 return( PSA_SUCCESS );
966}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200968psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000969{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100970 /* Data pointer will always be either a valid pointer or NULL in an
971 * initialized slot, so we can just free it. */
972 if( slot->key.data != NULL )
973 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
974
975 mbedtls_free( slot->key.data );
976 slot->key.data = NULL;
977 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000978
979 return( PSA_SUCCESS );
980}
981
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100982/** Completely wipe a slot in memory, including its policy.
983 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100984psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985{
986 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100987
TRodziewicz18cddc02021-07-13 12:19:15 +0200988 /*
989 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200990 * do our best to report an unexpected lock counter. Assert with
991 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
992 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
993 * function is called as part of the execution of a test suite, the
994 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200995 */
Ronald Cron5c522922020-11-14 16:35:34 +0100996 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100997 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200998 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100999 status = PSA_ERROR_CORRUPTION_DETECTED;
1000 }
1001
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001002 /* Multipart operations may still be using the key. This is safe
1003 * because all multipart operation objects are independent from
1004 * the key slot: if they need to access the key after the setup
1005 * phase, they have a copy of the key. Note that this means that
1006 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001007 /* At this point, key material and other type-specific content has
1008 * been wiped. Clear remaining metadata. We can call memset and not
1009 * zeroize because the metadata is not particularly sensitive. */
1010 memset( slot, 0, sizeof( *slot ) );
1011 return( status );
1012}
1013
Ronald Croncf56a0a2020-08-04 09:51:30 +02001014psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001015{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001016 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001017 psa_status_t status; /* status of the last operation */
1018 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001019#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1020 psa_se_drv_table_entry_t *driver;
1021#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022
Ronald Croncf56a0a2020-08-04 09:51:30 +02001023 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001024 return( PSA_SUCCESS );
1025
Ronald Cronf2911112020-10-29 17:51:10 +01001026 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001027 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001028 * key, this will load the key description from persistent memory if not
1029 * done yet. We cannot avoid this loading as without it we don't know if
1030 * the key is operated by an SE or not and this information is needed by
1031 * the current implementation.
1032 */
Ronald Cron5c522922020-11-14 16:35:34 +01001033 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001034 if( status != PSA_SUCCESS )
1035 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001036
Ronald Cronf2911112020-10-29 17:51:10 +01001037 /*
1038 * If the key slot containing the key description is under access by the
1039 * library (apart from the present access), the key cannot be destroyed
1040 * yet. For the time being, just return in error. Eventually (to be
1041 * implemented), the key should be destroyed when all accesses have
1042 * stopped.
1043 */
Ronald Cron5c522922020-11-14 16:35:34 +01001044 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001045 {
Ronald Cron5c522922020-11-14 16:35:34 +01001046 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001047 return( PSA_ERROR_GENERIC_ERROR );
1048 }
1049
Gilles Peskine6687cd02021-04-21 22:32:05 +02001050 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1051 {
1052 /* Refuse the destruction of a read-only key (which may or may not work
1053 * if we attempt it, depending on whether the key is merely read-only
1054 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001055 * Just do the best we can, which is to wipe the copy in memory
1056 * (done in this function's cleanup code). */
1057 overall_status = PSA_ERROR_NOT_PERMITTED;
1058 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001059 }
1060
Gilles Peskine354f7672019-07-12 23:46:38 +02001061#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001062 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001063 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001064 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001065 /* For a key in a secure element, we need to do three things:
1066 * remove the key file in internal storage, destroy the
1067 * key inside the secure element, and update the driver's
1068 * persistent data. Start a transaction that will encompass these
1069 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001070 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001071 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001072 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001073 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001074 status = psa_crypto_save_transaction( );
1075 if( status != PSA_SUCCESS )
1076 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001077 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001078 /* We should still try to destroy the key in the secure
1079 * element and the key metadata in storage. This is especially
1080 * important if the error is that the storage is full.
1081 * But how to do it exactly without risking an inconsistent
1082 * state after a reset?
1083 * https://github.com/ARMmbed/mbed-crypto/issues/215
1084 */
1085 overall_status = status;
1086 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001087 }
1088
Ronald Cronea0f8a62020-11-25 17:52:23 +01001089 status = psa_destroy_se_key( driver,
1090 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001091 if( overall_status == PSA_SUCCESS )
1092 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001093 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001094#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1095
Darryl Greend49a4992018-06-18 17:27:26 +01001096#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001097 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001098 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001099 status = psa_destroy_persistent_key( slot->attr.id );
1100 if( overall_status == PSA_SUCCESS )
1101 overall_status = status;
1102
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001103 /* TODO: other slots may have a copy of the same key. We should
1104 * invalidate them.
1105 * https://github.com/ARMmbed/mbed-crypto/issues/214
1106 */
Darryl Greend49a4992018-06-18 17:27:26 +01001107 }
1108#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001109
Gilles Peskinefc762652019-07-22 19:30:34 +02001110#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1111 if( driver != NULL )
1112 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001113 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
1116 status = psa_crypto_stop_transaction( );
1117 if( overall_status == PSA_SUCCESS )
1118 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001119 }
1120#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1121
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001122exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001123 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001124 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001125 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001126 overall_status = status;
1127 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001128}
1129
John Durkop07cc04a2020-11-16 22:08:34 -08001130#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001131 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001132static psa_status_t psa_get_rsa_public_exponent(
1133 const mbedtls_rsa_context *rsa,
1134 psa_key_attributes_t *attributes )
1135{
1136 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001138 uint8_t *buffer = NULL;
1139 size_t buflen;
1140 mbedtls_mpi_init( &mpi );
1141
1142 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1143 if( ret != 0 )
1144 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001145 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1146 {
1147 /* It's the default value, which is reported as an empty string,
1148 * so there's nothing to do. */
1149 goto exit;
1150 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001151
1152 buflen = mbedtls_mpi_size( &mpi );
1153 buffer = mbedtls_calloc( 1, buflen );
1154 if( buffer == NULL )
1155 {
1156 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1157 goto exit;
1158 }
1159 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1160 if( ret != 0 )
1161 goto exit;
1162 attributes->domain_parameters = buffer;
1163 attributes->domain_parameters_size = buflen;
1164
1165exit:
1166 mbedtls_mpi_free( &mpi );
1167 if( ret != 0 )
1168 mbedtls_free( buffer );
1169 return( mbedtls_to_psa_error( ret ) );
1170}
John Durkop07cc04a2020-11-16 22:08:34 -08001171#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001172 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001173
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001174/** Retrieve all the publicly-accessible attributes of a key.
1175 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001176psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001177 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001178{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001179 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001180 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001181 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001182
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001183 psa_reset_key_attributes( attributes );
1184
Ronald Cron5c522922020-11-14 16:35:34 +01001185 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001186 if( status != PSA_SUCCESS )
1187 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001188
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001189 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001190 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1191 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1192
1193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001194 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001195 psa_set_key_slot_number( attributes,
1196 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001197#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001198
Gilles Peskine8e338702019-07-30 20:06:31 +02001199 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001200 {
John Durkop07cc04a2020-11-16 22:08:34 -08001201#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001202 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001203 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001204 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001205 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001206 * is not yet implemented.
1207 * https://github.com/ARMmbed/mbed-crypto/issues/216
1208 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001209 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001210 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001211 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001212
Ronald Cron90857082020-11-25 14:58:33 +01001213 status = mbedtls_psa_rsa_load_representation(
1214 slot->attr.type,
1215 slot->key.data,
1216 slot->key.bytes,
1217 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001218 if( status != PSA_SUCCESS )
1219 break;
1220
Steven Cooremana2371e52020-07-28 14:30:39 +02001221 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001222 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001223 mbedtls_rsa_free( rsa );
1224 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001226 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001227#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001228 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 default:
1230 /* Nothing else to do. */
1231 break;
1232 }
1233
1234 if( status != PSA_SUCCESS )
1235 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001236
Ronald Cron5c522922020-11-14 16:35:34 +01001237 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001238
Ronald Cron5c522922020-11-14 16:35:34 +01001239 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001240}
1241
Gilles Peskinec8000c02019-08-02 20:15:51 +02001242#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1243psa_status_t psa_get_key_slot_number(
1244 const psa_key_attributes_t *attributes,
1245 psa_key_slot_number_t *slot_number )
1246{
1247 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1248 {
1249 *slot_number = attributes->slot_number;
1250 return( PSA_SUCCESS );
1251 }
1252 else
1253 return( PSA_ERROR_INVALID_ARGUMENT );
1254}
1255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1256
Ronald Crond18b5f82020-11-25 16:46:05 +01001257static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1258 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001259 uint8_t *data,
1260 size_t data_size,
1261 size_t *data_length )
1262{
Ronald Crond18b5f82020-11-25 16:46:05 +01001263 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001264 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001265 memcpy( data, key_buffer, key_buffer_size );
1266 memset( data + key_buffer_size, 0,
1267 data_size - key_buffer_size );
1268 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 return( PSA_SUCCESS );
1270}
1271
Ronald Cron7285cda2020-11-26 14:46:37 +01001272psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 const psa_key_attributes_t *attributes,
1274 const uint8_t *key_buffer, size_t key_buffer_size,
1275 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001276{
Ronald Crond18b5f82020-11-25 16:46:05 +01001277 psa_key_type_t type = attributes->core.type;
1278
Ronald Crond18b5f82020-11-25 16:46:05 +01001279 if( key_type_is_raw_bytes( type ) ||
1280 PSA_KEY_TYPE_IS_RSA( type ) ||
1281 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001282 {
1283 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001284 key_buffer, key_buffer_size,
1285 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001286 }
1287 else
1288 {
1289 /* This shouldn't happen in the reference implementation, but
1290 it is valid for a special-purpose implementation to omit
1291 support for exporting certain key types. */
1292 return( PSA_ERROR_NOT_SUPPORTED );
1293 }
1294}
1295
1296psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1297 uint8_t *data,
1298 size_t data_size,
1299 size_t *data_length )
1300{
1301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1302 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1303 psa_key_slot_t *slot;
1304
Ronald Crone907e552021-01-18 13:22:38 +01001305 /* Reject a zero-length output buffer now, since this can never be a
1306 * valid key representation. This way we know that data must be a valid
1307 * pointer and we can do things like memset(data, ..., data_size). */
1308 if( data_size == 0 )
1309 return( PSA_ERROR_BUFFER_TOO_SMALL );
1310
Ronald Cron9486f9d2020-11-26 13:36:23 +01001311 /* Set the key to empty now, so that even when there are errors, we always
1312 * set data_length to a value between 0 and data_size. On error, setting
1313 * the key to empty is a good choice because an empty key representation is
1314 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001315 *data_length = 0;
1316
Ronald Cron9486f9d2020-11-26 13:36:23 +01001317 /* Export requires the EXPORT flag. There is an exception for public keys,
1318 * which don't require any flag, but
1319 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1320 */
1321 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1322 PSA_KEY_USAGE_EXPORT, 0 );
1323 if( status != PSA_SUCCESS )
1324 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001325
Ronald Crond18b5f82020-11-25 16:46:05 +01001326 psa_key_attributes_t attributes = {
1327 .core = slot->attr
1328 };
Ronald Cron67227982020-11-26 15:16:05 +01001329 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001330 slot->key.data, slot->key.bytes,
1331 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001332
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333 unlock_status = psa_unlock_key_slot( slot );
1334
1335 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1336}
1337
Ronald Cron7285cda2020-11-26 14:46:37 +01001338psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001339 const psa_key_attributes_t *attributes,
1340 const uint8_t *key_buffer,
1341 size_t key_buffer_size,
1342 uint8_t *data,
1343 size_t data_size,
1344 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001345{
Ronald Crond18b5f82020-11-25 16:46:05 +01001346 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001347
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001349 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001350 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001351 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001352 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 key_buffer, key_buffer_size,
1355 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001356 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001359 {
John Durkop0e005192020-10-31 22:06:54 -07001360#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1361 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001362 return( mbedtls_psa_rsa_export_public_key( attributes,
1363 key_buffer,
1364 key_buffer_size,
1365 data,
1366 data_size,
1367 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001368#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 /* We don't know how to convert a private RSA key to public. */
1370 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001371#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1372 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001373 }
1374 else
Moran Pekera998bc62018-04-16 18:16:20 +03001375 {
John Durkop6ba40d12020-11-10 08:50:04 -08001376#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1377 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001378 return( mbedtls_psa_ecp_export_public_key( attributes,
1379 key_buffer,
1380 key_buffer_size,
1381 data,
1382 data_size,
1383 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001384#else
1385 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001386 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001387#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1388 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001389 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001390 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001391 else
1392 {
1393 /* This shouldn't happen in the reference implementation, but
1394 it is valid for a special-purpose implementation to omit
1395 support for exporting certain key types. */
1396 return( PSA_ERROR_NOT_SUPPORTED );
1397 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001398}
Ronald Crond18b5f82020-11-25 16:46:05 +01001399
Ronald Croncf56a0a2020-08-04 09:51:30 +02001400psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001401 uint8_t *data,
1402 size_t data_size,
1403 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001404{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001406 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001407 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001408
Ronald Crone907e552021-01-18 13:22:38 +01001409 /* Reject a zero-length output buffer now, since this can never be a
1410 * valid key representation. This way we know that data must be a valid
1411 * pointer and we can do things like memset(data, ..., data_size). */
1412 if( data_size == 0 )
1413 return( PSA_ERROR_BUFFER_TOO_SMALL );
1414
Darryl Greendd8fb772018-11-07 16:00:44 +00001415 /* Set the key to empty now, so that even when there are errors, we always
1416 * set data_length to a value between 0 and data_size. On error, setting
1417 * the key to empty is a good choice because an empty key representation is
1418 * unlikely to be accepted anywhere. */
1419 *data_length = 0;
1420
1421 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001422 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001423 if( status != PSA_SUCCESS )
1424 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001425
Ronald Cron9486f9d2020-11-26 13:36:23 +01001426 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1427 {
1428 status = PSA_ERROR_INVALID_ARGUMENT;
1429 goto exit;
1430 }
1431
Ronald Crond18b5f82020-11-25 16:46:05 +01001432 psa_key_attributes_t attributes = {
1433 .core = slot->attr
1434 };
Ronald Cron67227982020-11-26 15:16:05 +01001435 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 &attributes, slot->key.data, slot->key.bytes,
1437 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001438
1439exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001440 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001441
Ronald Cron5c522922020-11-14 16:35:34 +01001442 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001443}
1444
Gilles Peskine91e8c332019-08-02 19:19:39 +02001445#if defined(static_assert)
1446static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1447 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001448static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001449 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001450static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001451 "One or more key attribute flag is listed as both internal-only and external-only" );
1452#endif
1453
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001454/** Validate that a key policy is internally well-formed.
1455 *
1456 * This function only rejects invalid policies. It does not validate the
1457 * consistency of the policy with respect to other attributes of the key
1458 * such as the key type.
1459 */
1460static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001461{
1462 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001463 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001464 PSA_KEY_USAGE_ENCRYPT |
1465 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001466 PSA_KEY_USAGE_SIGN_MESSAGE |
1467 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001468 PSA_KEY_USAGE_SIGN_HASH |
1469 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001470 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001471 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1472 return( PSA_ERROR_INVALID_ARGUMENT );
1473
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 return( PSA_SUCCESS );
1475}
1476
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001477/** Validate the internal consistency of key attributes.
1478 *
1479 * This function only rejects invalid attribute values. If does not
1480 * validate the consistency of the attributes with any key data that may
1481 * be involved in the creation of the key.
1482 *
1483 * Call this function early in the key creation process.
1484 *
1485 * \param[in] attributes Key attributes for the new key.
1486 * \param[out] p_drv On any return, the driver for the key, if any.
1487 * NULL for a transparent key.
1488 *
1489 */
1490static psa_status_t psa_validate_key_attributes(
1491 const psa_key_attributes_t *attributes,
1492 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001493{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001494 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001495 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001496 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001497
Ronald Cron54b90082020-10-29 15:26:43 +01001498 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001499 if( status != PSA_SUCCESS )
1500 return( status );
1501
Ronald Crond2ed4812020-07-17 16:11:30 +02001502 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001503 if( status != PSA_SUCCESS )
1504 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001505
Ronald Cron65f38a32020-10-23 17:11:13 +02001506 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1507 {
1508 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1509 return( PSA_ERROR_INVALID_ARGUMENT );
1510 }
1511 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001513 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1514 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001515 }
1516
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001517 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001518 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001519 return( status );
1520
1521 /* Refuse to create overly large keys.
1522 * Note that this doesn't trigger on import if the attributes don't
1523 * explicitly specify a size (so psa_get_key_bits returns 0), so
1524 * psa_import_key() needs its own checks. */
1525 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1526 return( PSA_ERROR_NOT_SUPPORTED );
1527
Gilles Peskine91e8c332019-08-02 19:19:39 +02001528 /* Reject invalid flags. These should not be reachable through the API. */
1529 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1530 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1531 return( PSA_ERROR_INVALID_ARGUMENT );
1532
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001533 return( PSA_SUCCESS );
1534}
1535
Gilles Peskine4747d192019-04-17 15:05:45 +02001536/** Prepare a key slot to receive key material.
1537 *
1538 * This function allocates a key slot and sets its metadata.
1539 *
1540 * If this function fails, call psa_fail_key_creation().
1541 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001542 * This function is intended to be used as follows:
1543 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001544 * it with the specified attributes, and in case of a volatile key assign it
1545 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001546 * -# Populate the slot with the key material.
1547 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1548 * In case of failure at any step, stop the sequence and call
1549 * psa_fail_key_creation().
1550 *
Ronald Cron5c522922020-11-14 16:35:34 +01001551 * On success, the key slot is locked. It is the responsibility of the caller
1552 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001553 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001554 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001555 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 * \param[out] p_slot On success, a pointer to the prepared slot.
1557 * \param[out] p_drv On any return, the driver for the key, if any.
1558 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001559 *
1560 * \retval #PSA_SUCCESS
1561 * The key slot is ready to receive key material.
1562 * \return If this function fails, the key slot is an invalid state.
1563 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001564 */
1565static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001566 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001567 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001568 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001569 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001570{
1571 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001572 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001573 psa_key_slot_t *slot;
1574
Gilles Peskinedf179142019-07-15 22:02:14 +02001575 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001576 *p_drv = NULL;
1577
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001578 status = psa_validate_key_attributes( attributes, p_drv );
1579 if( status != PSA_SUCCESS )
1580 return( status );
1581
Ronald Cronc4d1b512020-07-31 11:26:37 +02001582 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 if( status != PSA_SUCCESS )
1584 return( status );
1585 slot = *p_slot;
1586
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001587 /* We're storing the declared bit-size of the key. It's up to each
1588 * creation mechanism to verify that this information is correct.
1589 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001590 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001591 * is optional (import, copy). In case of a volatile key, assign it the
1592 * volatile key identifier associated to the slot returned to contain its
1593 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001594
1595 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001596 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1597 {
1598#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1599 slot->attr.id = volatile_key_id;
1600#else
1601 slot->attr.id.key_id = volatile_key_id;
1602#endif
1603 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001604
Gilles Peskine91e8c332019-08-02 19:19:39 +02001605 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001606 * external-only flags, query `attributes`. Thanks to the check
1607 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001608 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001609 * may have set. */
1610 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001611
Gilles Peskinecbaff462019-07-12 23:46:04 +02001612#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001613 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001614 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001615 * create the key file in internal storage, create the
1616 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001617 * persistent data. This is done by starting a transaction that will
1618 * encompass these three actions.
1619 * For registering a volatile key, we just need to find an appropriate
1620 * slot number inside the SE. Since the key is designated volatile, creating
1621 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001622 /* The first thing to do is to find a slot number for the new key.
1623 * We save the slot number in persistent storage as part of the
1624 * transaction data. It will be needed to recover if the power
1625 * fails during the key creation process, to clean up on the secure
1626 * element side after restarting. Obtaining a slot number from the
1627 * secure element driver updates its persistent state, but we do not yet
1628 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001629 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001630 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001631 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001632 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001633 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001634 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001635 if( status != PSA_SUCCESS )
1636 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001637
1638 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001639 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1641 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001642 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 psa_crypto_transaction.key.id = slot->attr.id;
1644 status = psa_crypto_save_transaction( );
1645 if( status != PSA_SUCCESS )
1646 {
1647 (void) psa_crypto_stop_transaction( );
1648 return( status );
1649 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001650 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651
1652 status = psa_copy_key_material_into_slot(
1653 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001654 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001655
1656 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1657 {
1658 /* Key registration only makes sense with a secure element. */
1659 return( PSA_ERROR_INVALID_ARGUMENT );
1660 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001661#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1662
Ronald Cronc4d1b512020-07-31 11:26:37 +02001663 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001664}
Gilles Peskine4747d192019-04-17 15:05:45 +02001665
1666/** Finalize the creation of a key once its key material has been set.
1667 *
1668 * This entails writing the key to persistent storage.
1669 *
1670 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001671 * See the documentation of psa_start_key_creation() for the intended use
1672 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001673 *
Ronald Cron5c522922020-11-14 16:35:34 +01001674 * If the finalization succeeds, the function unlocks the key slot (it was
1675 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1676 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001677 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001678 * \param[in,out] slot Pointer to the slot with key material.
1679 * \param[in] driver The secure element driver for the key,
1680 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001681 * \param[out] key On success, identifier of the key. Note that the
1682 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001683 *
1684 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001685 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001686 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1687 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1688 * \retval #PSA_ERROR_ALREADY_EXISTS
1689 * \retval #PSA_ERROR_DATA_INVALID
1690 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001691 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001692 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 * \return If this function fails, the key slot is an invalid state.
1694 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001695 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001696static psa_status_t psa_finish_key_creation(
1697 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001698 psa_se_drv_table_entry_t *driver,
1699 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001700{
1701 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001702 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001703 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001704
1705#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001706 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001707 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001708#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1709 if( driver != NULL )
1710 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001711 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001712 psa_key_slot_number_t slot_number =
1713 psa_key_slot_get_slot_number( slot ) ;
1714
Gilles Peskineb46bef22019-07-30 21:32:04 +02001715#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001716 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001717 sizeof( data.slot_number ),
1718 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001719#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001721 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001722 (uint8_t*) &data,
1723 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001724 }
1725 else
1726#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1727 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001728 /* Key material is saved in export representation in the slot, so
1729 * just pass the slot buffer for storage. */
1730 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 slot->key.data,
1732 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001733 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001734 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001735#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1736
Gilles Peskinecbaff462019-07-12 23:46:04 +02001737#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001738 /* Finish the transaction for a key creation. This does not
1739 * happen when registering an existing key. Detect this case
1740 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001741 * creation of a persistent key in a secure element requires a transaction,
1742 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001743 if( driver != NULL &&
1744 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001745 {
1746 status = psa_save_se_persistent_data( driver );
1747 if( status != PSA_SUCCESS )
1748 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001749 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001750 return( status );
1751 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001752 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001753 }
1754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755
Ronald Cron50972942020-11-14 11:28:25 +01001756 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001757 {
1758 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001759 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001760 if( status != PSA_SUCCESS )
1761 *key = MBEDTLS_SVC_KEY_ID_INIT;
1762 }
Ronald Cron50972942020-11-14 11:28:25 +01001763
Gilles Peskine4747d192019-04-17 15:05:45 +02001764 return( status );
1765}
1766
1767/** Abort the creation of a key.
1768 *
1769 * You may call this function after calling psa_start_key_creation(),
1770 * or after psa_finish_key_creation() fails. In other circumstances, this
1771 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001772 * See the documentation of psa_start_key_creation() for the intended use
1773 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in,out] slot Pointer to the slot with key material.
1776 * \param[in] driver The secure element driver for the key,
1777 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001779static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001780 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001781{
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 (void) driver;
1783
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 if( slot == NULL )
1785 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001786
1787#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001788 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001789 * element, and the failure happened later (when saving metadata
1790 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001791 * element.
1792 * https://github.com/ARMmbed/mbed-crypto/issues/217
1793 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001794
Gilles Peskined7729582019-08-05 15:55:54 +02001795 /* Abort the ongoing transaction if any (there may not be one if
1796 * the creation process failed before starting one, or if the
1797 * key creation is a registration of a key in a secure element).
1798 * Earlier functions must already have done what it takes to undo any
1799 * partial creation. All that's left is to update the transaction data
1800 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001801 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001802#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1803
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 psa_wipe_key_slot( slot );
1805}
1806
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001807/** Validate optional attributes during key creation.
1808 *
1809 * Some key attributes are optional during key creation. If they are
1810 * specified in the attributes structure, check that they are consistent
1811 * with the data in the slot.
1812 *
1813 * This function should be called near the end of key creation, after
1814 * the slot in memory is fully populated but before saving persistent data.
1815 */
1816static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001817 const psa_key_slot_t *slot,
1818 const psa_key_attributes_t *attributes )
1819{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001820 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001821 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001822 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001823 return( PSA_ERROR_INVALID_ARGUMENT );
1824 }
1825
1826 if( attributes->domain_parameters_size != 0 )
1827 {
John Durkop0e005192020-10-31 22:06:54 -07001828#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1829 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001830 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001832 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001833 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001835
Ronald Cron90857082020-11-25 14:58:33 +01001836 psa_status_t status = mbedtls_psa_rsa_load_representation(
1837 slot->attr.type,
1838 slot->key.data,
1839 slot->key.bytes,
1840 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001841 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001842 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001843
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844 mbedtls_mpi_init( &actual );
1845 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001846 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001848 mbedtls_rsa_free( rsa );
1849 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 if( ret != 0 )
1851 goto rsa_exit;
1852 ret = mbedtls_mpi_read_binary( &required,
1853 attributes->domain_parameters,
1854 attributes->domain_parameters_size );
1855 if( ret != 0 )
1856 goto rsa_exit;
1857 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1858 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1859 rsa_exit:
1860 mbedtls_mpi_free( &actual );
1861 mbedtls_mpi_free( &required );
1862 if( ret != 0)
1863 return( mbedtls_to_psa_error( ret ) );
1864 }
1865 else
John Durkop9814fa22020-11-04 12:28:15 -08001866#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1867 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 {
1869 return( PSA_ERROR_INVALID_ARGUMENT );
1870 }
1871 }
1872
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001873 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001875 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876 return( PSA_ERROR_INVALID_ARGUMENT );
1877 }
1878
1879 return( PSA_SUCCESS );
1880}
1881
Gilles Peskine4747d192019-04-17 15:05:45 +02001882psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001883 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001884 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001885 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001886{
1887 psa_status_t status;
1888 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001889 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001890 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301891 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001892
Ronald Cron81709fc2020-11-14 12:10:32 +01001893 *key = MBEDTLS_SVC_KEY_ID_INIT;
1894
Gilles Peskine0f84d622019-09-12 19:03:13 +02001895 /* Reject zero-length symmetric keys (including raw data key objects).
1896 * This also rejects any key which might be encoded as an empty string,
1897 * which is never valid. */
1898 if( data_length == 0 )
1899 return( PSA_ERROR_INVALID_ARGUMENT );
1900
Archana449608b2021-09-08 15:36:05 +05301901 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301902 if( data_length > SIZE_MAX / 8 )
1903 return( PSA_ERROR_NOT_SUPPORTED );
1904
Gilles Peskinedf179142019-07-15 22:02:14 +02001905 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001906 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 if( status != PSA_SUCCESS )
1908 goto exit;
1909
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001910 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301911 * storage ( thus not in the case of importing a key in a secure element
1912 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1913 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001914 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001915 {
Archanad8a83dc2021-06-14 10:04:16 +05301916 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1917 {
Archana449608b2021-09-08 15:36:05 +05301918 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1919 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301920 if( status != PSA_SUCCESS )
1921 goto exit;
1922 }
1923 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001924 if( status != PSA_SUCCESS )
1925 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001926 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001927
1928 bits = slot->attr.bits;
1929 status = psa_driver_wrapper_import_key( attributes,
1930 data, data_length,
1931 slot->key.data,
1932 slot->key.bytes,
1933 &slot->key.bytes, &bits );
1934 if( status != PSA_SUCCESS )
1935 goto exit;
1936
1937 if( slot->attr.bits == 0 )
1938 slot->attr.bits = (psa_key_bits_t) bits;
1939 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001940 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001941 status = PSA_ERROR_INVALID_ARGUMENT;
1942 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001943 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001944
Archana6ed4bda2021-08-04 10:47:15 +05301945 /* Enforce a size limit, and in particular ensure that the bit
1946 * size fits in its representation type.*/
1947 if( bits > PSA_MAX_KEY_BITS )
1948 {
1949 status = PSA_ERROR_NOT_SUPPORTED;
1950 goto exit;
1951 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001952 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001953 if( status != PSA_SUCCESS )
1954 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955
Ronald Cron81709fc2020-11-14 12:10:32 +01001956 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001957exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001959 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001960
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 return( status );
1962}
1963
Gilles Peskined7729582019-08-05 15:55:54 +02001964#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1965psa_status_t mbedtls_psa_register_se_key(
1966 const psa_key_attributes_t *attributes )
1967{
1968 psa_status_t status;
1969 psa_key_slot_t *slot = NULL;
1970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001972
1973 /* Leaving attributes unspecified is not currently supported.
1974 * It could make sense to query the key type and size from the
1975 * secure element, but not all secure elements support this
1976 * and the driver HAL doesn't currently support it. */
1977 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1978 return( PSA_ERROR_NOT_SUPPORTED );
1979 if( psa_get_key_bits( attributes ) == 0 )
1980 return( PSA_ERROR_NOT_SUPPORTED );
1981
1982 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001983 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001984 if( status != PSA_SUCCESS )
1985 goto exit;
1986
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001988
1989exit:
1990 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001991 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskined7729582019-08-05 15:55:54 +02001993 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001995 return( status );
1996}
1997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1998
Ronald Croncf56a0a2020-08-04 09:51:30 +02001999psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002000 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002001 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002002{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002004 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002005 psa_key_slot_t *source_slot = NULL;
2006 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002007 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002008 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302009 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002010
Ronald Cron81709fc2020-11-14 12:10:32 +01002011 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2012
Archana8a180362021-07-05 02:18:48 +05302013 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002014 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002015 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002016 goto exit;
2017
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002018 status = psa_validate_optional_attributes( source_slot,
2019 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002020 if( status != PSA_SUCCESS )
2021 goto exit;
2022
Archana9d17bf42021-09-10 06:22:44 +05302023 /* The target key type and number of bits have been validated by
2024 * psa_validate_optional_attributes() to be either equal to zero or
2025 * equal to the ones of the source key. So it is safe to inherit
2026 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302027 * */
Archana9d17bf42021-09-10 06:22:44 +05302028 actual_attributes.core.bits = source_slot->attr.bits;
2029 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302030
2031
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002032 status = psa_restrict_key_policy( source_slot->attr.type,
2033 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002034 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002035 if( status != PSA_SUCCESS )
2036 goto exit;
2037
Ronald Cron81709fc2020-11-14 12:10:32 +01002038 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2039 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040 if( status != PSA_SUCCESS )
2041 goto exit;
Archana8a180362021-07-05 02:18:48 +05302042 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2043 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002044 {
Archana8a180362021-07-05 02:18:48 +05302045 /*
Archana9d17bf42021-09-10 06:22:44 +05302046 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302047 * the source key would need to be exported as plaintext and re-imported
2048 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302049 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302050 * appropriate API invocations from the application, if needed.
2051 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002052 status = PSA_ERROR_NOT_SUPPORTED;
2053 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002054 }
Archana8a180362021-07-05 02:18:48 +05302055 /*
2056 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302057 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302058 * - For opaque keys this translates to an invocation of the drivers'
2059 * copy_key entry point through the dispatch layer.
2060 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002061 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2062 {
Archana8a180362021-07-05 02:18:48 +05302063 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302064 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302065 if( status != PSA_SUCCESS )
2066 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302067
Archana8a180362021-07-05 02:18:48 +05302068 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2069 if( status != PSA_SUCCESS )
2070 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302071
Archana8a180362021-07-05 02:18:48 +05302072 status = psa_driver_wrapper_copy_key( &actual_attributes,
2073 source_slot->key.data,
2074 source_slot->key.bytes,
2075 target_slot->key.data,
2076 target_slot->key.bytes,
2077 &target_slot->key.bytes );
2078 if( status != PSA_SUCCESS )
2079 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002080 }
Archana8a180362021-07-05 02:18:48 +05302081 else
2082 {
Archana9d17bf42021-09-10 06:22:44 +05302083 status = psa_copy_key_material_into_slot( target_slot,
2084 source_slot->key.data,
2085 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302086 if( status != PSA_SUCCESS )
2087 goto exit;
2088 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002089 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002090exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002091 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002092 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002093
Ronald Cron5c522922020-11-14 16:35:34 +01002094 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002095
Ronald Cron5c522922020-11-14 16:35:34 +01002096 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002097}
2098
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002099
2100
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002101/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002102/* Message digests */
2103/****************************************************************/
2104
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002105psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2106{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002107 /* Aborting a non-active operation is allowed */
2108 if( operation->id == 0 )
2109 return( PSA_SUCCESS );
2110
2111 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2112 operation->id = 0;
2113
2114 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115}
2116
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002117psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002118 psa_algorithm_t alg )
2119{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002120 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002121
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002122 /* A context must be freshly initialized before it can be set up. */
2123 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002124 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002125 status = PSA_ERROR_BAD_STATE;
2126 goto exit;
2127 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002128
2129 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002130 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002131 status = PSA_ERROR_INVALID_ARGUMENT;
2132 goto exit;
2133 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002134
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002135 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2136 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002137 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2138
Dave Rodgman685b6a72021-06-24 11:49:14 +01002139 status = psa_driver_wrapper_hash_setup( operation, alg );
2140
2141exit:
2142 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002143 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002144
2145 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146}
2147
2148psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2149 const uint8_t *input,
2150 size_t input_length )
2151{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2153
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002154 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002155 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002156 status = PSA_ERROR_BAD_STATE;
2157 goto exit;
2158 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002159
Steven Cooremanc8288352021-03-04 14:02:19 +01002160 /* Don't require hash implementations to behave correctly on a
2161 * zero-length input, which may have an invalid pointer. */
2162 if( input_length == 0 )
2163 return( PSA_SUCCESS );
2164
Dave Rodgman685b6a72021-06-24 11:49:14 +01002165 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2166
2167exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168 if( status != PSA_SUCCESS )
2169 psa_hash_abort( operation );
2170
2171 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172}
2173
2174psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2175 uint8_t *hash,
2176 size_t hash_size,
2177 size_t *hash_length )
2178{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002179 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002180 if( operation->id == 0 )
2181 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182
Steven Cooreman1e582352021-02-18 17:24:37 +01002183 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002184 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002185 psa_hash_abort( operation );
2186 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187}
2188
Gilles Peskine2d277862018-06-18 15:41:12 +02002189psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2190 const uint8_t *hash,
2191 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192{
Ronald Cron69a63422021-10-18 09:47:58 +02002193 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002195 psa_status_t status = psa_hash_finish(
2196 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002197 actual_hash, sizeof( actual_hash ),
2198 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002199
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002201 goto exit;
2202
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002204 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002205 status = PSA_ERROR_INVALID_SIGNATURE;
2206 goto exit;
2207 }
2208
Steven Cooreman36876a02021-04-29 16:37:59 +02002209 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002210 status = PSA_ERROR_INVALID_SIGNATURE;
2211
2212exit:
Gilles Peskine60aebec2021-12-13 12:33:18 +01002213 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002214 if( status != PSA_SUCCESS )
2215 psa_hash_abort(operation);
2216
2217 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002218}
2219
Gilles Peskine0a749c82019-11-28 19:33:58 +01002220psa_status_t psa_hash_compute( psa_algorithm_t alg,
2221 const uint8_t *input, size_t input_length,
2222 uint8_t *hash, size_t hash_size,
2223 size_t *hash_length )
2224{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002225 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002226 if( !PSA_ALG_IS_HASH( alg ) )
2227 return( PSA_ERROR_INVALID_ARGUMENT );
2228
Steven Cooreman1e582352021-02-18 17:24:37 +01002229 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2230 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002231}
2232
2233psa_status_t psa_hash_compare( psa_algorithm_t alg,
2234 const uint8_t *input, size_t input_length,
2235 const uint8_t *hash, size_t hash_length )
2236{
Ronald Cron69a63422021-10-18 09:47:58 +02002237 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002238 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002239
2240 if( !PSA_ALG_IS_HASH( alg ) )
2241 return( PSA_ERROR_INVALID_ARGUMENT );
2242
Steven Cooreman1e582352021-02-18 17:24:37 +01002243 psa_status_t status = psa_driver_wrapper_hash_compute(
2244 alg, input, input_length,
2245 actual_hash, sizeof(actual_hash),
2246 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002247 if( status != PSA_SUCCESS )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002248 goto exit;
Steven Cooreman84d670d2021-02-18 16:22:53 +01002249 if( actual_hash_length != hash_length )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002250 {
2251 status = PSA_ERROR_INVALID_SIGNATURE;
2252 goto exit;
2253 }
Steven Cooreman36876a02021-04-29 16:37:59 +02002254 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002255 status = PSA_ERROR_INVALID_SIGNATURE;
2256
2257exit:
2258 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
2259 return( status );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002260}
2261
Gilles Peskineeb35d782019-01-22 17:56:16 +01002262psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2263 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002264{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002265 if( source_operation->id == 0 ||
2266 target_operation->id != 0 )
2267 {
2268 return( PSA_ERROR_BAD_STATE );
2269 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002270
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002271 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2272 target_operation );
2273 if( status != PSA_SUCCESS )
2274 psa_hash_abort( target_operation );
2275
2276 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002277}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278
2279
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002281/* MAC */
2282/****************************************************************/
2283
Steven Cooremane6804192021-03-19 18:28:56 +01002284psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002285{
Steven Cooremane6804192021-03-19 18:28:56 +01002286 /* Aborting a non-active operation is allowed */
2287 if( operation->id == 0 )
2288 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002289
Steven Cooremane6804192021-03-19 18:28:56 +01002290 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002291 operation->mac_size = 0;
2292 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002293 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002294
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002295 return( status );
2296}
2297
Ronald Cron2dff3b22021-06-17 16:33:22 +02002298static psa_status_t psa_mac_finalize_alg_and_key_validation(
2299 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002300 const psa_key_attributes_t *attributes,
2301 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002302{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002304 psa_key_type_t key_type = psa_get_key_type( attributes );
2305 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002306
Ronald Cron28ea0502021-06-17 16:10:24 +02002307 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002308 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002309
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002310 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002311 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002312 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002313 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002314
Steven Cooremand1a68f12021-05-10 11:13:41 +02002315 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002316 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002317
Ronald Cron79bdd822021-06-17 16:46:44 +02002318 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002319 {
2320 /* A very short MAC is too short for security since it can be
2321 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2322 * so we make this our minimum, even though 32 bits is still
2323 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002324 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002325 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002326
Ronald Cron79bdd822021-06-17 16:46:44 +02002327 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2328 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002329 {
2330 /* It's impossible to "truncate" to a larger length than the full length
2331 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002332 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002333 }
2334
Ronald Cron79bdd822021-06-17 16:46:44 +02002335 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002336}
2337
Gilles Peskinee59236f2018-01-27 23:32:46 +01002338static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2339 mbedtls_svc_key_id_t key,
2340 psa_algorithm_t alg,
2341 int is_sign )
2342{
2343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2344 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002345 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346
2347 /* A context must be freshly initialized before it can be set up. */
2348 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002349 {
Dave Rodgman54648242021-06-24 11:49:45 +01002350 status = PSA_ERROR_BAD_STATE;
2351 goto exit;
2352 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002353
2354 status = psa_get_and_lock_key_slot_with_policy(
2355 key,
2356 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002357 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 alg );
2359 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002360 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361
2362 psa_key_attributes_t attributes = {
2363 .core = slot->attr
2364 };
2365
Ronald Cron79bdd822021-06-17 16:46:44 +02002366 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2367 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002368 if( status != PSA_SUCCESS )
2369 goto exit;
2370
2371 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002372 /* Dispatch the MAC setup call with validated input */
2373 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002374 {
Steven Cooremane6804192021-03-19 18:28:56 +01002375 status = psa_driver_wrapper_mac_sign_setup( operation,
2376 &attributes,
2377 slot->key.data,
2378 slot->key.bytes,
2379 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002380 }
2381 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002382 {
Steven Cooremane6804192021-03-19 18:28:56 +01002383 status = psa_driver_wrapper_mac_verify_setup( operation,
2384 &attributes,
2385 slot->key.data,
2386 slot->key.bytes,
2387 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002388 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002389
Gilles Peskinefbfac682018-07-08 20:51:54 +02002390exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002391 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002392 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002393
Ronald Cron5c522922020-11-14 16:35:34 +01002394 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002395
Ronald Cron5c522922020-11-14 16:35:34 +01002396 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002397}
2398
Gilles Peskine89167cb2018-07-08 20:12:23 +02002399psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002400 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002401 psa_algorithm_t alg )
2402{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002403 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002404}
2405
2406psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002407 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002408 psa_algorithm_t alg )
2409{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002410 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002411}
2412
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002413psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002414 const uint8_t *input,
2415 size_t input_length )
2416{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002417 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002418 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002420 /* Don't require hash implementations to behave correctly on a
2421 * zero-length input, which may have an invalid pointer. */
2422 if( input_length == 0 )
2423 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002424
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002425 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2426 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002427 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002428 psa_mac_abort( operation );
2429
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002430 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002431}
2432
Steven Cooremana5b860a2021-03-19 19:04:39 +01002433psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002434 uint8_t *mac,
2435 size_t mac_size,
2436 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002437{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002438 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2439 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002440
Steven Cooremana5b860a2021-03-19 19:04:39 +01002441 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002442 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002443 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002444 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002445 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002446
Steven Cooreman72f736a2021-05-07 14:14:37 +02002447 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002448 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002449 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002450 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002451 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002452
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002453 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2454 * once all the error checks are done. */
2455 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002456 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002457 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002458 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002459 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002460
2461 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002462 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002463 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002464 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002465 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002466
Steven Cooremana5b860a2021-03-19 19:04:39 +01002467 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002468 mac, operation->mac_size,
2469 mac_length );
2470
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002471exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002472 /* In case of success, set the potential excess room in the output buffer
2473 * to an invalid value, to avoid potentially leaking a longer MAC.
2474 * In case of error, set the output length and content to a safe default,
2475 * such that in case the caller misses an error check, the output would be
2476 * an unachievable MAC.
2477 */
2478 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002479 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002480 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002481 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002482 }
mohammad16036df908f2018-04-02 08:34:15 -07002483
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002484 if( mac_size > operation->mac_size )
2485 memset( &mac[operation->mac_size], '!',
2486 mac_size - operation->mac_size );
2487
Steven Cooremana5b860a2021-03-19 19:04:39 +01002488 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002489
Steven Cooremana5b860a2021-03-19 19:04:39 +01002490 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002491}
2492
Steven Cooremana5b860a2021-03-19 19:04:39 +01002493psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002494 const uint8_t *mac,
2495 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002496{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2498 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002499
Steven Cooremana5b860a2021-03-19 19:04:39 +01002500 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002501 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002502 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002503 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002504 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002505
Steven Cooreman72f736a2021-05-07 14:14:37 +02002506 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002507 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002508 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002509 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002510 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002511
2512 if( operation->mac_size != mac_length )
2513 {
2514 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002515 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002516 }
2517
Steven Cooremana5b860a2021-03-19 19:04:39 +01002518 status = psa_driver_wrapper_mac_verify_finish( operation,
2519 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002520
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002521exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002522 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002523
Steven Cooremana5b860a2021-03-19 19:04:39 +01002524 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002525}
2526
Ronald Croncd989b52021-06-18 14:23:33 +02002527static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2528 psa_algorithm_t alg,
2529 const uint8_t *input,
2530 size_t input_length,
2531 uint8_t *mac,
2532 size_t mac_size,
2533 size_t *mac_length,
2534 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002535{
2536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002537 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2538 psa_key_slot_t *slot;
2539 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002540
Ronald Cron51131b52021-06-17 17:17:20 +02002541 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002542 key,
2543 &slot,
2544 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002545 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002546 if( status != PSA_SUCCESS )
2547 goto exit;
2548
Ronald Cron51131b52021-06-17 17:17:20 +02002549 psa_key_attributes_t attributes = {
2550 .core = slot->attr
2551 };
2552
2553 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2554 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002555 if( status != PSA_SUCCESS )
2556 goto exit;
2557
Ronald Cron51131b52021-06-17 17:17:20 +02002558 if( mac_size < operation_mac_size )
2559 {
2560 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002561 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002562 }
2563
2564 status = psa_driver_wrapper_mac_compute(
2565 &attributes,
2566 slot->key.data, slot->key.bytes,
2567 alg,
2568 input, input_length,
2569 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002570
2571exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002572 /* In case of success, set the potential excess room in the output buffer
2573 * to an invalid value, to avoid potentially leaking a longer MAC.
2574 * In case of error, set the output length and content to a safe default,
2575 * such that in case the caller misses an error check, the output would be
2576 * an unachievable MAC.
2577 */
2578 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002579 {
Ronald Cron51131b52021-06-17 17:17:20 +02002580 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002581 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002582 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002583 if( mac_size > operation_mac_size )
2584 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002585
Ronald Cron51131b52021-06-17 17:17:20 +02002586 unlock_status = psa_unlock_key_slot( slot );
2587
2588 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002589}
2590
Ronald Croncd989b52021-06-18 14:23:33 +02002591psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2592 psa_algorithm_t alg,
2593 const uint8_t *input,
2594 size_t input_length,
2595 uint8_t *mac,
2596 size_t mac_size,
2597 size_t *mac_length)
2598{
2599 return( psa_mac_compute_internal( key, alg,
2600 input, input_length,
2601 mac, mac_size, mac_length, 1 ) );
2602}
2603
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002604psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2605 psa_algorithm_t alg,
2606 const uint8_t *input,
2607 size_t input_length,
2608 const uint8_t *mac,
2609 size_t mac_length)
2610{
2611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002612 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2613 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002614
Ronald Crona587cbc2021-06-18 14:51:29 +02002615 status = psa_mac_compute_internal( key, alg,
2616 input, input_length,
2617 actual_mac, sizeof( actual_mac ),
2618 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002619 if( status != PSA_SUCCESS )
2620 goto exit;
2621
Ronald Crona587cbc2021-06-18 14:51:29 +02002622 if( mac_length != actual_mac_length )
2623 {
2624 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002625 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002626 }
2627 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2628 {
2629 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002630 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002631 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002632
2633exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002634 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002635
2636 return ( status );
2637}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002638
Gilles Peskinee59236f2018-01-27 23:32:46 +01002639/****************************************************************/
2640/* Asymmetric cryptography */
2641/****************************************************************/
2642
gabor-mezei-armf0486182021-05-12 11:03:09 +02002643static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002644 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002645{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002646 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002647 {
2648 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2649 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002650
Gilles Peskinef7b41372021-09-22 16:15:05 +02002651 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002652 {
2653 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2654 return( PSA_ERROR_INVALID_ARGUMENT );
2655 }
2656 }
2657 else
2658 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002659 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002660 return( PSA_ERROR_INVALID_ARGUMENT );
2661 }
2662
2663 return( PSA_SUCCESS );
2664}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002665
2666static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002667 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002668 psa_algorithm_t alg,
2669 const uint8_t * input,
2670 size_t input_length,
2671 uint8_t * signature,
2672 size_t signature_size,
2673 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002674{
2675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2676 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2677 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002678
2679 *signature_length = 0;
2680
gabor-mezei-armf0486182021-05-12 11:03:09 +02002681 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002682 if( status != PSA_SUCCESS )
2683 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002685 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002686 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002687 * buffer can in principle be empty since it doesn't actually have
2688 * to be a hash.) */
2689 if( signature_size == 0 )
2690 return( PSA_ERROR_BUFFER_TOO_SMALL );
2691
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002692 status = psa_get_and_lock_key_slot_with_policy(
2693 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002694 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2695 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002696 alg );
2697
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002698 if( status != PSA_SUCCESS )
2699 goto exit;
2700
2701 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2702 {
2703 status = PSA_ERROR_INVALID_ARGUMENT;
2704 goto exit;
2705 }
2706
2707 psa_key_attributes_t attributes = {
2708 .core = slot->attr
2709 };
2710
gabor-mezei-armf0486182021-05-12 11:03:09 +02002711 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002712 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002713 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002714 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002715 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002716 signature, signature_size, signature_length );
2717 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002718 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002719 {
2720
2721 status = psa_driver_wrapper_sign_hash(
2722 &attributes, slot->key.data, slot->key.bytes,
2723 alg, input, input_length,
2724 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002725 }
2726
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727
2728exit:
2729 /* Fill the unused part of the output buffer (the whole buffer on error,
2730 * the trailing part on success) with something that isn't a valid signature
2731 * (barring an attack on the signature and deliberately-crafted input),
2732 * in case the caller doesn't check the return status properly. */
2733 if( status == PSA_SUCCESS )
2734 memset( signature + *signature_length, '!',
2735 signature_size - *signature_length );
2736 else
2737 memset( signature, '!', signature_size );
2738 /* If signature_size is 0 then we have nothing to do. We must not call
2739 * memset because signature may be NULL in this case. */
2740
2741 unlock_status = psa_unlock_key_slot( slot );
2742
2743 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2744}
2745
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002746static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002747 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002748 psa_algorithm_t alg,
2749 const uint8_t * input,
2750 size_t input_length,
2751 const uint8_t * signature,
2752 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002753{
2754 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2755 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2756 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002757
gabor-mezei-armf0486182021-05-12 11:03:09 +02002758 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002759 if( status != PSA_SUCCESS )
2760 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002761
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002762 status = psa_get_and_lock_key_slot_with_policy(
2763 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002764 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2765 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002766 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002767
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002768 if( status != PSA_SUCCESS )
2769 return( status );
2770
2771 psa_key_attributes_t attributes = {
2772 .core = slot->attr
2773 };
2774
gabor-mezei-armf0486182021-05-12 11:03:09 +02002775 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002776 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002777 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002778 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002779 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002780 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002781 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002782 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002783 {
2784 status = psa_driver_wrapper_verify_hash(
2785 &attributes, slot->key.data, slot->key.bytes,
2786 alg, input, input_length,
2787 signature, signature_length );
2788 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002789
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002790 unlock_status = psa_unlock_key_slot( slot );
2791
2792 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002793
2794}
2795
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002796psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002797 const psa_key_attributes_t *attributes,
2798 const uint8_t *key_buffer,
2799 size_t key_buffer_size,
2800 psa_algorithm_t alg,
2801 const uint8_t *input,
2802 size_t input_length,
2803 uint8_t *signature,
2804 size_t signature_size,
2805 size_t *signature_length )
2806{
2807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002808
Gilles Peskinef7b41372021-09-22 16:15:05 +02002809 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002810 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002811 size_t hash_length;
2812 uint8_t hash[PSA_HASH_MAX_SIZE];
2813
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002814 status = psa_driver_wrapper_hash_compute(
2815 PSA_ALG_SIGN_GET_HASH( alg ),
2816 input, input_length,
2817 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002818
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002819 if( status != PSA_SUCCESS )
2820 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002821
2822 return psa_driver_wrapper_sign_hash(
2823 attributes, key_buffer, key_buffer_size,
2824 alg, hash, hash_length,
2825 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002826 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002827
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002828 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002829}
2830
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002831psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2832 psa_algorithm_t alg,
2833 const uint8_t * input,
2834 size_t input_length,
2835 uint8_t * signature,
2836 size_t signature_size,
2837 size_t * signature_length )
2838{
2839 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002840 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002841 signature, signature_size, signature_length );
2842}
2843
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002844psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002845 const psa_key_attributes_t *attributes,
2846 const uint8_t *key_buffer,
2847 size_t key_buffer_size,
2848 psa_algorithm_t alg,
2849 const uint8_t *input,
2850 size_t input_length,
2851 const uint8_t *signature,
2852 size_t signature_length )
2853{
2854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002855
Gilles Peskinef7b41372021-09-22 16:15:05 +02002856 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002857 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002858 size_t hash_length;
2859 uint8_t hash[PSA_HASH_MAX_SIZE];
2860
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002861 status = psa_driver_wrapper_hash_compute(
2862 PSA_ALG_SIGN_GET_HASH( alg ),
2863 input, input_length,
2864 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002865
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002866 if( status != PSA_SUCCESS )
2867 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002868
2869 return psa_driver_wrapper_verify_hash(
2870 attributes, key_buffer, key_buffer_size,
2871 alg, hash, hash_length,
2872 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002873 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002874
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002875 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002876}
2877
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002878psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2879 psa_algorithm_t alg,
2880 const uint8_t * input,
2881 size_t input_length,
2882 const uint8_t * signature,
2883 size_t signature_length )
2884{
2885 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002886 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002887 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002888}
2889
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002890psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002891 const psa_key_attributes_t *attributes,
2892 const uint8_t *key_buffer, size_t key_buffer_size,
2893 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2894 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002895{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002896 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002897 {
Ronald Cron4501c982021-03-19 20:09:32 +01002898 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2899 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002900 {
Ronald Cron4501c982021-03-19 20:09:32 +01002901#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2902 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2903 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002904 attributes,
2905 key_buffer, key_buffer_size,
2906 alg, hash, hash_length,
2907 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002908#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2909 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002910 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002911 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002912 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002913 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002914 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002915 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002916 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Ronald Cron4501c982021-03-19 20:09:32 +01002917 {
2918 if( PSA_ALG_IS_ECDSA( alg ) )
2919 {
2920#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2921 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2922 return( mbedtls_psa_ecdsa_sign_hash(
2923 attributes,
2924 key_buffer, key_buffer_size,
2925 alg, hash, hash_length,
2926 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002927#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2928 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002929 }
2930 else
2931 {
2932 return( PSA_ERROR_INVALID_ARGUMENT );
2933 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002934 }
Ronald Cron4501c982021-03-19 20:09:32 +01002935
2936 (void)key_buffer;
2937 (void)key_buffer_size;
2938 (void)hash;
2939 (void)hash_length;
2940 (void)signature;
2941 (void)signature_size;
2942 (void)signature_length;
2943
2944 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002945}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002946
2947psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2948 psa_algorithm_t alg,
2949 const uint8_t *hash,
2950 size_t hash_length,
2951 uint8_t *signature,
2952 size_t signature_size,
2953 size_t *signature_length )
2954{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002955 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002956 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002957 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002958}
2959
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002960psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002961 const psa_key_attributes_t *attributes,
2962 const uint8_t *key_buffer, size_t key_buffer_size,
2963 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2964 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002965{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002966 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002967 {
Ronald Cron4501c982021-03-19 20:09:32 +01002968 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2969 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002970 {
Ronald Cron4501c982021-03-19 20:09:32 +01002971#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2972 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2973 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002974 attributes,
2975 key_buffer, key_buffer_size,
2976 alg, hash, hash_length,
2977 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002978#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2979 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002980 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002981 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002982 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002983 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002984 }
itayzafrir5c753392018-05-08 11:18:38 +03002985 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002986 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002987 {
Ronald Cron4501c982021-03-19 20:09:32 +01002988 if( PSA_ALG_IS_ECDSA( alg ) )
2989 {
2990#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2991 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2992 return( mbedtls_psa_ecdsa_verify_hash(
2993 attributes,
2994 key_buffer, key_buffer_size,
2995 alg, hash, hash_length,
2996 signature, signature_length ) );
2997#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2998 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2999 }
3000 else
3001 {
3002 return( PSA_ERROR_INVALID_ARGUMENT );
3003 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003004 }
Ronald Cron4501c982021-03-19 20:09:32 +01003005
3006 (void)key_buffer;
3007 (void)key_buffer_size;
3008 (void)hash;
3009 (void)hash_length;
3010 (void)signature;
3011 (void)signature_length;
3012
3013 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003014}
3015
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003016psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3017 psa_algorithm_t alg,
3018 const uint8_t *hash,
3019 size_t hash_length,
3020 const uint8_t *signature,
3021 size_t signature_length )
3022{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003023 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003024 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003025 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003026}
3027
John Durkop0e005192020-10-31 22:06:54 -07003028#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003029static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3030 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003031{
3032 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3033 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3034 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003035
3036 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003037}
John Durkop0e005192020-10-31 22:06:54 -07003038#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003039
Ronald Croncf56a0a2020-08-04 09:51:30 +02003040psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041 psa_algorithm_t alg,
3042 const uint8_t *input,
3043 size_t input_length,
3044 const uint8_t *salt,
3045 size_t salt_length,
3046 uint8_t *output,
3047 size_t output_size,
3048 size_t *output_length )
3049{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003051 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003052 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003053
Darryl Green5cc689a2018-07-24 15:34:10 +01003054 (void) input;
3055 (void) input_length;
3056 (void) salt;
3057 (void) output;
3058 (void) output_size;
3059
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003060 *output_length = 0;
3061
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003062 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3063 return( PSA_ERROR_INVALID_ARGUMENT );
3064
Ronald Cron5c522922020-11-14 16:35:34 +01003065 status = psa_get_and_lock_transparent_key_slot_with_policy(
3066 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003067 if( status != PSA_SUCCESS )
3068 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003069 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3070 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003071 {
3072 status = PSA_ERROR_INVALID_ARGUMENT;
3073 goto exit;
3074 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003075
Gilles Peskine8e338702019-07-30 20:06:31 +02003076 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003077 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003078#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3079 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003080 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003081 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3082 slot->key.data,
3083 slot->key.bytes,
3084 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003085 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003086 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003087
3088 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003089 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003090 status = PSA_ERROR_BUFFER_TOO_SMALL;
3091 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003092 }
Ronald Cron89b4aa72021-09-08 14:28:35 +02003093#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3094 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003095 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3096 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003097#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003098 status = mbedtls_to_psa_error(
3099 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003100 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003101 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003102 input_length,
3103 input,
3104 output ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003105#else
3106 status = PSA_ERROR_NOT_SUPPORTED;
3107#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 }
3109 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3111 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003112#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003113 status = mbedtls_to_psa_error(
3114 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3115 if( status != PSA_SUCCESS )
3116 goto rsa_exit;
3117
Steven Cooreman4fed4552020-08-03 14:46:03 +02003118 status = mbedtls_to_psa_error(
3119 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003120 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003121 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003122 salt, salt_length,
3123 input_length,
3124 input,
3125 output ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003126#else
3127 status = PSA_ERROR_NOT_SUPPORTED;
3128#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003129 }
3130 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003132 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133 }
Ronald Cron89b4aa72021-09-08 14:28:35 +02003134#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3135 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003136rsa_exit:
3137 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003138 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003139
Steven Cooremana2371e52020-07-28 14:30:39 +02003140 mbedtls_rsa_free( rsa );
3141 mbedtls_free( rsa );
John Durkop9814fa22020-11-04 12:28:15 -08003142#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003143 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Ronald Cron89b4aa72021-09-08 14:28:35 +02003144 }
3145 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003146 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003147 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003148 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003149
3150exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003151 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003152
Ronald Cron5c522922020-11-14 16:35:34 +01003153 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003154}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003155
Ronald Croncf56a0a2020-08-04 09:51:30 +02003156psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003157 psa_algorithm_t alg,
3158 const uint8_t *input,
3159 size_t input_length,
3160 const uint8_t *salt,
3161 size_t salt_length,
3162 uint8_t *output,
3163 size_t output_size,
3164 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003165{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003166 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003167 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003168 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003169
Darryl Green5cc689a2018-07-24 15:34:10 +01003170 (void) input;
3171 (void) input_length;
3172 (void) salt;
3173 (void) output;
3174 (void) output_size;
3175
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003176 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003177
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003178 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3179 return( PSA_ERROR_INVALID_ARGUMENT );
3180
Ronald Cron5c522922020-11-14 16:35:34 +01003181 status = psa_get_and_lock_transparent_key_slot_with_policy(
3182 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003183 if( status != PSA_SUCCESS )
3184 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003185 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003186 {
3187 status = PSA_ERROR_INVALID_ARGUMENT;
3188 goto exit;
3189 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003190
Gilles Peskine8e338702019-07-30 20:06:31 +02003191 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003192 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003193#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3194 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003195 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003196 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3197 slot->key.data,
3198 slot->key.bytes,
3199 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003200 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003201 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003202
Steven Cooremana2371e52020-07-28 14:30:39 +02003203 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003204 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003205 status = PSA_ERROR_INVALID_ARGUMENT;
3206 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003207 }
Ronald Cron89b4aa72021-09-08 14:28:35 +02003208#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3209 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210
Gilles Peskine6afe7892018-05-31 13:16:08 +02003211 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003212 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003213#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003214 status = mbedtls_to_psa_error(
3215 mbedtls_rsa_pkcs1_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 output_length,
3219 input,
3220 output,
3221 output_size ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003222#else
3223 status = PSA_ERROR_NOT_SUPPORTED;
3224#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003225 }
3226 else
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003227 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003228 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003229#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003230 status = mbedtls_to_psa_error(
3231 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3232 if( status != PSA_SUCCESS )
3233 goto rsa_exit;
3234
Steven Cooreman4fed4552020-08-03 14:46:03 +02003235 status = mbedtls_to_psa_error(
3236 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003237 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003238 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003239 salt, salt_length,
3240 output_length,
3241 input,
3242 output,
3243 output_size ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003244#else
3245 status = PSA_ERROR_NOT_SUPPORTED;
3246#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003247 }
3248 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003249 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003250 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003251 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003252
Ronald Cron89b4aa72021-09-08 14:28:35 +02003253#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3254 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003255rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003256 mbedtls_rsa_free( rsa );
3257 mbedtls_free( rsa );
John Durkop6ba40d12020-11-10 08:50:04 -08003258#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3259 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Ronald Cron89b4aa72021-09-08 14:28:35 +02003260 }
3261 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003262 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003263 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003264 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003265
3266exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003267 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003268
Ronald Cron5c522922020-11-14 16:35:34 +01003269 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003270}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003271
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003272
3273
mohammad1603503973b2018-03-12 15:59:30 +02003274/****************************************************************/
3275/* Symmetric cryptography */
3276/****************************************************************/
3277
Ronald Cronab99ac22020-10-01 16:38:28 +02003278static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3279 mbedtls_svc_key_id_t key,
3280 psa_algorithm_t alg,
3281 mbedtls_operation_t cipher_operation )
3282{
3283 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3284 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003285 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003286 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3287 PSA_KEY_USAGE_ENCRYPT :
3288 PSA_KEY_USAGE_DECRYPT );
3289
3290 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003291 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003292 {
Dave Rodgman54648242021-06-24 11:49:45 +01003293 status = PSA_ERROR_BAD_STATE;
3294 goto exit;
3295 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003296
Ronald Cronab99ac22020-10-01 16:38:28 +02003297 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003298 {
Dave Rodgman54648242021-06-24 11:49:45 +01003299 status = PSA_ERROR_INVALID_ARGUMENT;
3300 goto exit;
3301 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003302
Ronald Cronab99ac22020-10-01 16:38:28 +02003303 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3304 if( status != PSA_SUCCESS )
3305 goto exit;
3306
Ronald Cron49fafa92021-03-10 08:34:23 +01003307 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003308 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003309 * so we only set it (in the driver wrapper) after resources have been
3310 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003311 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003312 if( alg == PSA_ALG_ECB_NO_PADDING )
3313 operation->iv_required = 0;
3314 else
3315 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003316 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003317
Ronald Crona4af55f2020-12-14 14:36:06 +01003318 psa_key_attributes_t attributes = {
3319 .core = slot->attr
3320 };
3321
Ronald Cronab99ac22020-10-01 16:38:28 +02003322 /* Try doing the operation through a driver before using software fallback. */
3323 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003324 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3325 &attributes,
3326 slot->key.data,
3327 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003328 alg );
3329 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003330 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3331 &attributes,
3332 slot->key.data,
3333 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003334 alg );
3335
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003336exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003337 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003338 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003339
Ronald Cron5c522922020-11-14 16:35:34 +01003340 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003341
Ronald Cron5c522922020-11-14 16:35:34 +01003342 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003343}
3344
Gilles Peskinefe119512018-07-08 21:39:34 +02003345psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003346 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003347 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003348{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003349 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003350}
3351
Gilles Peskinefe119512018-07-08 21:39:34 +02003352psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003353 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003354 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003355{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003356 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003357}
3358
Gilles Peskinefe119512018-07-08 21:39:34 +02003359psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003360 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003361 size_t iv_size,
3362 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003363{
Ronald Cron6d051732020-10-01 14:10:20 +02003364 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003365 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3366 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003367
Ronald Cron49fafa92021-03-10 08:34:23 +01003368 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003369 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003370 status = PSA_ERROR_BAD_STATE;
3371 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003372 }
3373
Steven Cooreman7df02922020-09-09 15:28:49 +02003374 if( operation->iv_set || ! operation->iv_required )
3375 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003376 status = PSA_ERROR_BAD_STATE;
3377 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003379
Ronald Cron2fb90522021-07-05 12:31:44 +02003380 default_iv_length = operation->default_iv_length;
3381 if( iv_size < default_iv_length )
Ronald Cron5618a392021-03-26 09:52:26 +01003382 {
3383 status = PSA_ERROR_BUFFER_TOO_SMALL;
3384 goto exit;
3385 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003386
Ronald Cron2fb90522021-07-05 12:31:44 +02003387 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
3388 {
3389 status = PSA_ERROR_GENERIC_ERROR;
3390 goto exit;
3391 }
3392
3393 status = psa_generate_random( local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003394 if( status != PSA_SUCCESS )
3395 goto exit;
3396
3397 status = psa_driver_wrapper_cipher_set_iv( operation,
Ronald Cron2fb90522021-07-05 12:31:44 +02003398 local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003399
3400exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003401 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003402 {
Ronald Cron2fb90522021-07-05 12:31:44 +02003403 memcpy( iv, local_iv, default_iv_length );
3404 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003405 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003406 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003407 else
Ronald Cron2fb90522021-07-05 12:31:44 +02003408 {
3409 *iv_length = 0;
Moran Peker395db872018-05-31 14:07:14 +03003410 psa_cipher_abort( operation );
Ronald Cron2fb90522021-07-05 12:31:44 +02003411 }
Ronald Cron6d051732020-10-01 14:10:20 +02003412
itayzafrir534bd7c2018-08-02 13:56:32 +03003413 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003414}
3415
Gilles Peskinefe119512018-07-08 21:39:34 +02003416psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003417 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003418 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003419{
Ronald Cron6d051732020-10-01 14:10:20 +02003420 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003421
Ronald Cron49fafa92021-03-10 08:34:23 +01003422 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003423 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003424 status = PSA_ERROR_BAD_STATE;
3425 goto exit;
3426 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003427
Steven Cooreman7df02922020-09-09 15:28:49 +02003428 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003429 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003430 status = PSA_ERROR_BAD_STATE;
3431 goto exit;
3432 }
Ronald Crona0d68172021-03-26 10:15:08 +01003433
3434 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003435 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003436 status = PSA_ERROR_INVALID_ARGUMENT;
3437 goto exit;
3438 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003439
Ronald Crondd24c9b2020-12-15 14:10:01 +01003440 status = psa_driver_wrapper_cipher_set_iv( operation,
3441 iv,
3442 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003443
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003444exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003445 if( status == PSA_SUCCESS )
3446 operation->iv_set = 1;
3447 else
mohammad1603503973b2018-03-12 15:59:30 +02003448 psa_cipher_abort( operation );
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_update( psa_cipher_operation_t *operation,
3453 const uint8_t *input,
3454 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003455 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003456 size_t output_size,
3457 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003458{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003460
Ronald Cron49fafa92021-03-10 08:34:23 +01003461 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003462 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003463 status = PSA_ERROR_BAD_STATE;
3464 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003465 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003466
Steven Cooreman7df02922020-09-09 15:28:49 +02003467 if( operation->iv_required && ! operation->iv_set )
3468 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003469 status = PSA_ERROR_BAD_STATE;
3470 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003471 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003472
Ronald Crondd24c9b2020-12-15 14:10:01 +01003473 status = psa_driver_wrapper_cipher_update( operation,
3474 input,
3475 input_length,
3476 output,
3477 output_size,
3478 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003479
3480exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003481 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003482 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003483
itayzafrir534bd7c2018-08-02 13:56:32 +03003484 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003485}
3486
Gilles Peskinee553c652018-06-04 16:22:46 +02003487psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3488 uint8_t *output,
3489 size_t output_size,
3490 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003491{
David Saadab4ecc272019-02-14 13:48:10 +02003492 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003493
Ronald Cron49fafa92021-03-10 08:34:23 +01003494 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003495 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003496 status = PSA_ERROR_BAD_STATE;
3497 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003498 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003499
Steven Cooreman7df02922020-09-09 15:28:49 +02003500 if( operation->iv_required && ! operation->iv_set )
3501 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003502 status = PSA_ERROR_BAD_STATE;
3503 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003504 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003505
Ronald Crondd24c9b2020-12-15 14:10:01 +01003506 status = psa_driver_wrapper_cipher_finish( operation,
3507 output,
3508 output_size,
3509 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003510
3511exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003512 if( status == PSA_SUCCESS )
3513 return( psa_cipher_abort( operation ) );
3514 else
3515 {
3516 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003517 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003518
Steven Cooremanef8575e2020-09-11 11:44:50 +02003519 return( status );
3520 }
mohammad1603503973b2018-03-12 15:59:30 +02003521}
3522
Gilles Peskinee553c652018-06-04 16:22:46 +02003523psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3524{
Ronald Cron49fafa92021-03-10 08:34:23 +01003525 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003526 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003527 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003528 * in use. It's ok to call abort on such an object, and there's
3529 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003530 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003531 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003532
Ronald Crondd24c9b2020-12-15 14:10:01 +01003533 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003534
Ronald Cron49fafa92021-03-10 08:34:23 +01003535 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003536 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003537 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003538
Moran Peker395db872018-05-31 14:07:14 +03003539 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003540}
3541
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003542psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3543 psa_algorithm_t alg,
3544 const uint8_t *input,
3545 size_t input_length,
3546 uint8_t *output,
3547 size_t output_size,
3548 size_t *output_length )
3549{
3550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003551 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003552 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02003553 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3554 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003555
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003556 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003557 {
3558 status = PSA_ERROR_INVALID_ARGUMENT;
3559 goto exit;
3560 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003561
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3563 PSA_KEY_USAGE_ENCRYPT,
3564 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003565 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003566 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 psa_key_attributes_t attributes = {
3569 .core = slot->attr
3570 };
3571
Ronald Cronc6e6f502021-07-09 18:44:58 +02003572 default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
3573 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003574 {
Ronald Cronc6e6f502021-07-09 18:44:58 +02003575 status = PSA_ERROR_GENERIC_ERROR;
3576 goto exit;
3577 }
3578
3579 if( default_iv_length > 0 )
3580 {
3581 if( output_size < default_iv_length )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003582 {
3583 status = PSA_ERROR_BUFFER_TOO_SMALL;
3584 goto exit;
3585 }
3586
Ronald Cronc6e6f502021-07-09 18:44:58 +02003587 status = psa_generate_random( local_iv, default_iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003588 if( status != PSA_SUCCESS )
3589 goto exit;
3590 }
3591
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003592 status = psa_driver_wrapper_cipher_encrypt(
3593 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02003594 alg, local_iv, default_iv_length, input, input_length,
3595 output + default_iv_length, output_size - default_iv_length,
3596 output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003597
3598exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003599 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003600 if( status == PSA_SUCCESS )
3601 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003602
Ronald Cron9b674282021-07-09 09:19:35 +02003603 if( status == PSA_SUCCESS )
Ronald Cronc6e6f502021-07-09 18:44:58 +02003604 {
3605 if( default_iv_length > 0 )
3606 memcpy( output, local_iv, default_iv_length );
3607 *output_length += default_iv_length;
3608 }
Ronald Cron9b674282021-07-09 09:19:35 +02003609 else
Ronald Cron23919522021-07-08 19:00:07 +02003610 *output_length = 0;
3611
3612 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003613}
3614
3615psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3616 psa_algorithm_t alg,
3617 const uint8_t *input,
3618 size_t input_length,
3619 uint8_t *output,
3620 size_t output_size,
3621 size_t *output_length )
3622{
3623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003624 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003625 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003626
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003627 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003628 {
3629 status = PSA_ERROR_INVALID_ARGUMENT;
3630 goto exit;
3631 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003632
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003633 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3634 PSA_KEY_USAGE_DECRYPT,
3635 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003636 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003637 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003638
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003639 psa_key_attributes_t attributes = {
3640 .core = slot->attr
3641 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003642
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003643 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3644 {
3645 status = PSA_ERROR_INVALID_ARGUMENT;
3646 goto exit;
3647 }
3648 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003649 {
3650 status = PSA_ERROR_INVALID_ARGUMENT;
3651 goto exit;
3652 }
3653
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003654 status = psa_driver_wrapper_cipher_decrypt(
3655 &attributes, slot->key.data, slot->key.bytes,
3656 alg, input, input_length,
3657 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003658
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003659exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003660 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003661 if( status == PSA_SUCCESS )
3662 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003663
Ronald Cron23919522021-07-08 19:00:07 +02003664 if( status != PSA_SUCCESS )
3665 *output_length = 0;
3666
3667 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003668}
3669
3670
mohammad16035955c982018-04-26 00:53:03 +03003671/****************************************************************/
3672/* AEAD */
3673/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003674
Paul Elliottbaff51c2021-09-28 17:44:45 +01003675/* Helper function to get the base algorithm from its variants. */
3676static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3677{
3678 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3679}
3680
3681/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003682static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3683 size_t nonce_length )
3684{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003685 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3686
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003687 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003688 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003689#if defined(PSA_WANT_ALG_GCM)
3690 case PSA_ALG_GCM:
3691 /* Not checking max nonce size here as GCM spec allows almost
3692 * arbitrarily large nonces. Please note that we do not generally
3693 * recommend the usage of nonces of greater length than
3694 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3695 * size, which can then lead to collisions if you encrypt a very
3696 * large number of messages.*/
3697 if( nonce_length != 0 )
3698 return( PSA_SUCCESS );
3699 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003700#endif /* PSA_WANT_ALG_GCM */
3701#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003702 case PSA_ALG_CCM:
3703 if( nonce_length >= 7 && nonce_length <= 13 )
3704 return( PSA_SUCCESS );
3705 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003706#endif /* PSA_WANT_ALG_CCM */
3707#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003708 case PSA_ALG_CHACHA20_POLY1305:
3709 if( nonce_length == 12 )
3710 return( PSA_SUCCESS );
Bence Szépkúti6d48e202021-11-15 20:04:15 +01003711 else if( nonce_length == 8 )
3712 return( PSA_ERROR_NOT_SUPPORTED );
3713 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003714#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003715 default:
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003716 return( PSA_ERROR_NOT_SUPPORTED );
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003717 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003718
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003719 return( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003720}
3721
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01003722static psa_status_t psa_aead_check_algorithm( psa_algorithm_t alg )
3723{
Bence Szépkúti08f34652021-12-08 21:07:13 +01003724 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3725 return( PSA_ERROR_INVALID_ARGUMENT );
3726
3727 return( PSA_SUCCESS );
3728}
3729
Ronald Croncf56a0a2020-08-04 09:51:30 +02003730psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003731 psa_algorithm_t alg,
3732 const uint8_t *nonce,
3733 size_t nonce_length,
3734 const uint8_t *additional_data,
3735 size_t additional_data_length,
3736 const uint8_t *plaintext,
3737 size_t plaintext_length,
3738 uint8_t *ciphertext,
3739 size_t ciphertext_size,
3740 size_t *ciphertext_length )
3741{
Ronald Cron215633c2021-03-16 17:15:37 +01003742 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3743 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003744
mohammad1603f08a5502018-06-03 15:05:47 +03003745 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003746
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003747 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003748 if( status != PSA_SUCCESS )
3749 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003750
Ronald Cron9a986162021-03-26 12:40:07 +01003751 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003752 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003753 if( status != PSA_SUCCESS )
3754 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003755
Ronald Cron215633c2021-03-16 17:15:37 +01003756 psa_key_attributes_t attributes = {
3757 .core = slot->attr
3758 };
mohammad16035955c982018-04-26 00:53:03 +03003759
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003760 status = psa_aead_check_nonce_length( alg, nonce_length );
3761 if( status != PSA_SUCCESS )
3762 goto exit;
3763
Ronald Cronde822812021-03-17 16:08:20 +01003764 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003765 &attributes, slot->key.data, slot->key.bytes,
3766 alg,
3767 nonce, nonce_length,
3768 additional_data, additional_data_length,
3769 plaintext, plaintext_length,
3770 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003771
Gilles Peskineedf9a652018-08-17 18:11:56 +02003772 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3773 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003774
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003775exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003776 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003777
mohammad16035955c982018-04-26 00:53:03 +03003778 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003779}
3780
Ronald Croncf56a0a2020-08-04 09:51:30 +02003781psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003782 psa_algorithm_t alg,
3783 const uint8_t *nonce,
3784 size_t nonce_length,
3785 const uint8_t *additional_data,
3786 size_t additional_data_length,
3787 const uint8_t *ciphertext,
3788 size_t ciphertext_length,
3789 uint8_t *plaintext,
3790 size_t plaintext_size,
3791 size_t *plaintext_length )
3792{
Ronald Cron215633c2021-03-16 17:15:37 +01003793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3794 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003795
Gilles Peskineee652a32018-06-01 19:23:52 +02003796 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003797
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003798 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003799 if( status != PSA_SUCCESS )
3800 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003801
Ronald Cron9a986162021-03-26 12:40:07 +01003802 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003803 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003804 if( status != PSA_SUCCESS )
3805 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003806
Ronald Cron215633c2021-03-16 17:15:37 +01003807 psa_key_attributes_t attributes = {
3808 .core = slot->attr
3809 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003810
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003811 status = psa_aead_check_nonce_length( alg, nonce_length );
3812 if( status != PSA_SUCCESS )
3813 goto exit;
3814
Ronald Cronde822812021-03-17 16:08:20 +01003815 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003816 &attributes, slot->key.data, slot->key.bytes,
3817 alg,
3818 nonce, nonce_length,
3819 additional_data, additional_data_length,
3820 ciphertext, ciphertext_length,
3821 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003822
Gilles Peskineedf9a652018-08-17 18:11:56 +02003823 if( status != PSA_SUCCESS && plaintext_size != 0 )
3824 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003825
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003826exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003827 psa_unlock_key_slot( slot );
3828
Gilles Peskineedf9a652018-08-17 18:11:56 +02003829 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003830}
3831
Andrzej Kurekf8816012021-12-19 17:00:12 +01003832static psa_status_t psa_validate_tag_length( psa_aead_operation_t *operation,
3833 psa_algorithm_t alg ) {
3834 uint8_t tag_len = 0;
3835 if( psa_driver_get_tag_len( operation, &tag_len ) != PSA_SUCCESS )
3836 {
3837 return( PSA_ERROR_INVALID_ARGUMENT );
3838 }
3839
3840 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
3841 {
3842#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
3843 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
3844 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
3845 if( tag_len < 4 || tag_len > 16 || tag_len % 2 )
3846 return( PSA_ERROR_INVALID_ARGUMENT );
3847 break;
3848#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3849
3850#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
3851 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
3852 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
3853 if( tag_len != 4 && tag_len != 8 && ( tag_len < 12 || tag_len > 16 ) )
3854 return( PSA_ERROR_INVALID_ARGUMENT );
3855 break;
3856#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3857
3858#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
3859 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
3860 /* We only support the default tag length. */
3861 if( tag_len != 16 )
3862 return( PSA_ERROR_INVALID_ARGUMENT );
3863 break;
3864#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
3865
3866 default:
3867 (void) tag_len;
3868 return( PSA_ERROR_NOT_SUPPORTED );
3869 }
3870 return( PSA_SUCCESS );
3871}
3872
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003873/* Set the key for a multipart authenticated operation. */
3874static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003875 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003876 mbedtls_svc_key_id_t key,
3877 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003878{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003879 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3880 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3881 psa_key_slot_t *slot = NULL;
3882 psa_key_usage_t key_usage = 0;
3883
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003884 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003885 if( status != PSA_SUCCESS )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003886 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003887
3888 if( operation->id != 0 )
3889 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003890 status = PSA_ERROR_BAD_STATE;
3891 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003892 }
3893
3894 if( operation->nonce_set || operation->lengths_set ||
3895 operation->ad_started || operation->body_started )
3896 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003897 status = PSA_ERROR_BAD_STATE;
3898 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003899 }
3900
Paul Elliottd9343f22021-08-23 18:59:49 +01003901 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003902 key_usage = PSA_KEY_USAGE_ENCRYPT;
3903 else
3904 key_usage = PSA_KEY_USAGE_DECRYPT;
3905
3906 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3907 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003908 if( status != PSA_SUCCESS )
3909 goto exit;
3910
3911 psa_key_attributes_t attributes = {
3912 .core = slot->attr
3913 };
3914
Paul Elliottd9343f22021-08-23 18:59:49 +01003915 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003916 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3917 &attributes,
3918 slot->key.data,
3919 slot->key.bytes,
3920 alg );
3921 else
3922 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3923 &attributes,
3924 slot->key.data,
3925 slot->key.bytes,
3926 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003927 if( status != PSA_SUCCESS )
3928 goto exit;
3929
Andrzej Kurekf8816012021-12-19 17:00:12 +01003930 if( ( status = psa_validate_tag_length( operation, alg ) ) != PSA_SUCCESS )
3931 goto exit;
3932
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003933 operation->key_type = psa_get_key_type( &attributes );
3934
3935exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003936 unlock_status = psa_unlock_key_slot( slot );
3937
3938 if( status == PSA_SUCCESS )
3939 {
3940 status = unlock_status;
3941 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003942 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003943 }
3944 else
3945 psa_aead_abort( operation );
3946
3947 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003948}
3949
Paul Elliott302ff6b2021-04-20 18:10:30 +01003950/* Set the key for a multipart authenticated encryption operation. */
3951psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3952 mbedtls_svc_key_id_t key,
3953 psa_algorithm_t alg )
3954{
Paul Elliottd9343f22021-08-23 18:59:49 +01003955 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003956}
3957
3958/* Set the key for a multipart authenticated decryption operation. */
3959psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3960 mbedtls_svc_key_id_t key,
3961 psa_algorithm_t alg )
3962{
Paul Elliottd9343f22021-08-23 18:59:49 +01003963 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003964}
3965
3966/* Generate a random nonce / IV for multipart AEAD operation */
3967psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3968 uint8_t *nonce,
3969 size_t nonce_size,
3970 size_t *nonce_length )
3971{
3972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01003973 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01003974 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003975
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003976 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003977
Paul Elliottcee785c2021-05-20 14:29:20 +01003978 if( operation->id == 0 )
3979 {
3980 status = PSA_ERROR_BAD_STATE;
3981 goto exit;
3982 }
3983
Paul Elliottdaf5c892021-08-25 16:24:58 +01003984 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003985 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003986 status = PSA_ERROR_BAD_STATE;
3987 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003988 }
3989
Paul Elliotte193ea82021-10-01 13:00:16 +01003990 /* For CCM, this size may not be correct according to the PSA
3991 * specification. The PSA Crypto 1.0.1 specification states:
3992 *
3993 * CCM encodes the plaintext length pLen in L octets, with L the smallest
3994 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
3995 *
3996 * However this restriction that L has to be the smallest integer is not
3997 * applied in practice, and it is not implementable here since the
3998 * plaintext length may or may not be known at this time. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003999 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01004000 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01004001 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004002 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004003 status = PSA_ERROR_BUFFER_TOO_SMALL;
4004 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004005 }
4006
Ronald Croncae59092021-11-26 18:53:58 +01004007 status = psa_generate_random( local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004008 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01004009 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004010
Ronald Croncae59092021-11-26 18:53:58 +01004011 status = psa_aead_set_nonce( operation, local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004012
Paul Elliott39dc6b82021-05-11 19:16:09 +01004013exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004014 if( status == PSA_SUCCESS )
Ronald Croncae59092021-11-26 18:53:58 +01004015 {
4016 memcpy( nonce, local_nonce, required_nonce_size );
Paul Elliott39dc6b82021-05-11 19:16:09 +01004017 *nonce_length = required_nonce_size;
Ronald Croncae59092021-11-26 18:53:58 +01004018 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004019 else
4020 psa_aead_abort( operation );
4021
4022 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004023}
4024
4025/* Set the nonce for a multipart authenticated encryption or decryption
4026 operation.*/
4027psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
4028 const uint8_t *nonce,
4029 size_t nonce_length )
4030{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4032
Paul Elliottcee785c2021-05-20 14:29:20 +01004033 if( operation->id == 0 )
4034 {
4035 status = PSA_ERROR_BAD_STATE;
4036 goto exit;
4037 }
4038
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004039 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004040 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004041 status = PSA_ERROR_BAD_STATE;
4042 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004043 }
4044
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004045 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004046 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004047 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004048 status = PSA_ERROR_INVALID_ARGUMENT;
4049 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004050 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004051
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004052 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
4053 nonce_length );
4054
Paul Elliott39dc6b82021-05-11 19:16:09 +01004055exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004056 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004057 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004058 else
4059 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004060
4061 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004062}
4063
4064/* Declare the lengths of the message and additional data for multipart AEAD. */
4065psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
4066 size_t ad_length,
4067 size_t plaintext_length )
4068{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004069 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4070
Paul Elliottcee785c2021-05-20 14:29:20 +01004071 if( operation->id == 0 )
4072 {
4073 status = PSA_ERROR_BAD_STATE;
4074 goto exit;
4075 }
4076
Paul Elliott6eb95982021-05-21 17:41:41 +01004077 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01004078 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004079 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004080 status = PSA_ERROR_BAD_STATE;
4081 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004082 }
4083
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004084 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01004085 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004086#if defined(PSA_WANT_ALG_GCM)
4087 case PSA_ALG_GCM:
4088 /* Lengths can only be too large for GCM if size_t is bigger than 32
4089 * bits. Without the guard this code will generate warnings on 32bit
4090 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004091#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004092 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
4093 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
4094 {
4095 status = PSA_ERROR_INVALID_ARGUMENT;
4096 goto exit;
4097 }
Paul Elliott325d3742021-09-27 17:56:28 +01004098#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004099 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004100#endif /* PSA_WANT_ALG_GCM */
4101#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004102 case PSA_ALG_CCM:
4103 if( ad_length > 0xFF00 )
4104 {
4105 status = PSA_ERROR_INVALID_ARGUMENT;
4106 goto exit;
4107 }
4108 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004109#endif /* PSA_WANT_ALG_CCM */
4110#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004111 case PSA_ALG_CHACHA20_POLY1305:
4112 /* No length restrictions for ChaChaPoly. */
4113 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004114#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004115 default:
4116 break;
4117 }
Paul Elliott325d3742021-09-27 17:56:28 +01004118
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004119 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
4120 plaintext_length );
4121
Paul Elliott39dc6b82021-05-11 19:16:09 +01004122exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004123 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004124 {
4125 operation->ad_remaining = ad_length;
4126 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004127 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01004128 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004129 else
4130 psa_aead_abort( operation );
4131
4132 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004133}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004134
4135/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004136psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4137 const uint8_t *input,
4138 size_t input_length )
4139{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004140 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4141
Paul Elliottcee785c2021-05-20 14:29:20 +01004142 if( operation->id == 0 )
4143 {
4144 status = PSA_ERROR_BAD_STATE;
4145 goto exit;
4146 }
4147
Paul Elliott6eb95982021-05-21 17:41:41 +01004148 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004149 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004150 status = PSA_ERROR_BAD_STATE;
4151 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004152 }
4153
Paul Elliottee4ffe02021-05-20 17:25:06 +01004154 if( operation->lengths_set )
4155 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004156 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004157 {
4158 status = PSA_ERROR_INVALID_ARGUMENT;
4159 goto exit;
4160 }
4161
4162 operation->ad_remaining -= input_length;
4163 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004164#if defined(PSA_WANT_ALG_CCM)
4165 else if( operation->alg == PSA_ALG_CCM )
4166 {
4167 status = PSA_ERROR_BAD_STATE;
4168 goto exit;
4169 }
4170#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004171
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004172 status = psa_driver_wrapper_aead_update_ad( operation, input,
4173 input_length );
4174
Paul Elliott39dc6b82021-05-11 19:16:09 +01004175exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004176 if( status == PSA_SUCCESS )
4177 operation->ad_started = 1;
4178 else
4179 psa_aead_abort( operation );
4180
4181 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004182}
4183
4184/* Encrypt or decrypt a message fragment in an active multipart AEAD
4185 operation.*/
4186psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4187 const uint8_t *input,
4188 size_t input_length,
4189 uint8_t *output,
4190 size_t output_size,
4191 size_t *output_length )
4192{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004194
4195 *output_length = 0;
4196
Paul Elliottcee785c2021-05-20 14:29:20 +01004197 if( operation->id == 0 )
4198 {
4199 status = PSA_ERROR_BAD_STATE;
4200 goto exit;
4201 }
4202
Paul Elliott6eb95982021-05-21 17:41:41 +01004203 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004204 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004205 status = PSA_ERROR_BAD_STATE;
4206 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004207 }
4208
Paul Elliottee4ffe02021-05-20 17:25:06 +01004209 if( operation->lengths_set )
4210 {
4211 /* Additional data length was supplied, but not all the additional
4212 data was supplied.*/
4213 if( operation->ad_remaining != 0 )
4214 {
4215 status = PSA_ERROR_INVALID_ARGUMENT;
4216 goto exit;
4217 }
4218
4219 /* Too much data provided. */
4220 if( operation->body_remaining < input_length )
4221 {
4222 status = PSA_ERROR_INVALID_ARGUMENT;
4223 goto exit;
4224 }
4225
4226 operation->body_remaining -= input_length;
4227 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004228#if defined(PSA_WANT_ALG_CCM)
4229 else if( operation->alg == PSA_ALG_CCM )
4230 {
4231 status = PSA_ERROR_BAD_STATE;
4232 goto exit;
4233 }
4234#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004235
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004236 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4237 output, output_size,
4238 output_length );
4239
Paul Elliott39dc6b82021-05-11 19:16:09 +01004240exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004241 if( status == PSA_SUCCESS )
4242 operation->body_started = 1;
4243 else
4244 psa_aead_abort( operation );
4245
4246 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004247}
4248
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004249static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004250{
Paul Elliott7f429b72021-06-24 18:08:54 +01004251 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004252 return( PSA_ERROR_BAD_STATE );
4253
Paul Elliotta5614442021-07-14 14:54:11 +01004254 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004255 operation->body_remaining != 0 ) )
4256 return( PSA_ERROR_INVALID_ARGUMENT );
4257
4258 return( PSA_SUCCESS );
4259}
4260
Paul Elliott302ff6b2021-04-20 18:10:30 +01004261/* Finish encrypting a message in a multipart AEAD operation. */
4262psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4263 uint8_t *ciphertext,
4264 size_t ciphertext_size,
4265 size_t *ciphertext_length,
4266 uint8_t *tag,
4267 size_t tag_size,
4268 size_t *tag_length )
4269{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4271
Paul Elliott302ff6b2021-04-20 18:10:30 +01004272 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004273 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004274
Paul Elliott814fffb2021-08-16 18:20:36 +01004275 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004276 if( status != PSA_SUCCESS )
4277 goto exit;
4278
Paul Elliott7f429b72021-06-24 18:08:54 +01004279 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004280 {
4281 status = PSA_ERROR_BAD_STATE;
4282 goto exit;
4283 }
4284
Paul Elliott39dc6b82021-05-11 19:16:09 +01004285 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4286 ciphertext_size,
4287 ciphertext_length,
4288 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004289
Paul Elliott39dc6b82021-05-11 19:16:09 +01004290exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004291 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004292 * the zero tag size, make sure the tag is set to something implausible.
4293 * Even if the operation succeeds, make sure we clear the rest of the
4294 * buffer to prevent potential leakage of anything previously placed in
4295 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004296 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004297 {
4298 if( status != PSA_SUCCESS )
4299 memset( tag, '!', tag_size );
4300 else if( *tag_length < tag_size )
4301 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4302 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004303
Paul Elliott39dc6b82021-05-11 19:16:09 +01004304 psa_aead_abort( operation );
4305
4306 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004307}
4308
4309/* Finish authenticating and decrypting a message in a multipart AEAD
4310 operation.*/
4311psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4312 uint8_t *plaintext,
4313 size_t plaintext_size,
4314 size_t *plaintext_length,
4315 const uint8_t *tag,
4316 size_t tag_length )
4317{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4319
Paul Elliott302ff6b2021-04-20 18:10:30 +01004320 *plaintext_length = 0;
4321
Paul Elliott814fffb2021-08-16 18:20:36 +01004322 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004323 if( status != PSA_SUCCESS )
4324 goto exit;
4325
Paul Elliott7f429b72021-06-24 18:08:54 +01004326 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004327 {
4328 status = PSA_ERROR_BAD_STATE;
4329 goto exit;
4330 }
4331
Paul Elliott39dc6b82021-05-11 19:16:09 +01004332 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4333 plaintext_size,
4334 plaintext_length,
4335 tag, tag_length );
4336
4337exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004338 psa_aead_abort( operation );
4339
4340 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004341}
4342
4343/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004344psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004345{
4346 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4347
4348 if( operation->id == 0 )
4349 {
4350 /* The object has (apparently) been initialized but it is not (yet)
4351 * in use. It's ok to call abort on such an object, and there's
4352 * nothing to do. */
4353 return( PSA_SUCCESS );
4354 }
4355
4356 status = psa_driver_wrapper_aead_abort( operation );
4357
Paul Elliott70618b22021-09-22 17:12:16 +01004358 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004359
4360 return( status );
4361}
4362
Gilles Peskinee59236f2018-01-27 23:32:46 +01004363/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004364/* Generators */
4365/****************************************************************/
4366
John Durkop07cc04a2020-11-16 22:08:34 -08004367#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4368 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4369 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4370#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004371#endif /* At least one builtin KDF */
4372
4373#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4374 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4375 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4376static psa_status_t psa_key_derivation_start_hmac(
4377 psa_mac_operation_t *operation,
4378 psa_algorithm_t hash_alg,
4379 const uint8_t *hmac_key,
4380 size_t hmac_key_length )
4381{
4382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4383 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4384 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4385 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4386 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4387
Steven Cooreman72f736a2021-05-07 14:14:37 +02004388 operation->is_sign = 1;
4389 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4390
Steven Cooreman094a77e2021-05-06 17:58:36 +02004391 status = psa_driver_wrapper_mac_sign_setup( operation,
4392 &attributes,
4393 hmac_key, hmac_key_length,
4394 PSA_ALG_HMAC( hash_alg ) );
4395
4396 psa_reset_key_attributes( &attributes );
4397 return( status );
4398}
4399#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004400
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004401#define HKDF_STATE_INIT 0 /* no input yet */
4402#define HKDF_STATE_STARTED 1 /* got salt */
4403#define HKDF_STATE_KEYED 2 /* got key */
4404#define HKDF_STATE_OUTPUT 3 /* output started */
4405
Gilles Peskinecbe66502019-05-16 16:59:18 +02004406static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004407 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004408{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004409 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4410 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004411 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004412 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004413}
4414
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004415psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004416{
4417 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004418 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004419 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004420 {
4421 /* The object has (apparently) been initialized but it is not
4422 * in use. It's ok to call abort on such an object, and there's
4423 * nothing to do. */
4424 }
4425 else
John Durkopd0321952020-10-29 21:37:36 -07004426#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004427 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004428 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004429 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004430 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004431 }
John Durkop07cc04a2020-11-16 22:08:34 -08004432 else
4433#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4434#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4435 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4436 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004437 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004438 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004439 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004440 if( operation->ctx.tls12_prf.secret != NULL )
4441 {
4442 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4443 operation->ctx.tls12_prf.secret_length );
4444 mbedtls_free( operation->ctx.tls12_prf.secret );
4445 }
4446
Janos Follath6a1d2622019-06-11 10:37:28 +01004447 if( operation->ctx.tls12_prf.seed != NULL )
4448 {
4449 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4450 operation->ctx.tls12_prf.seed_length );
4451 mbedtls_free( operation->ctx.tls12_prf.seed );
4452 }
4453
4454 if( operation->ctx.tls12_prf.label != NULL )
4455 {
4456 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4457 operation->ctx.tls12_prf.label_length );
4458 mbedtls_free( operation->ctx.tls12_prf.label );
4459 }
4460
Steven Cooremana6df6042021-04-29 19:32:25 +02004461 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004462
4463 /* We leave the fields Ai and output_block to be erased safely by the
4464 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004465 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004466 else
John Durkop07cc04a2020-11-16 22:08:34 -08004467#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4468 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004469 {
4470 status = PSA_ERROR_BAD_STATE;
4471 }
Janos Follath083036a2019-06-11 10:22:26 +01004472 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004473 return( status );
4474}
4475
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004476psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004477 size_t *capacity)
4478{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004479 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004480 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004481 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004482 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004483 }
4484
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004485 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004486 return( PSA_SUCCESS );
4487}
4488
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004489psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004490 size_t capacity )
4491{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004492 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004493 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004494 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004495 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004496 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004497 return( PSA_SUCCESS );
4498}
4499
John Durkopd0321952020-10-29 21:37:36 -07004500#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004501/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004502 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004503static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004504 psa_algorithm_t hash_alg,
4505 uint8_t *output,
4506 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004507{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004508 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004509 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004510 psa_status_t status;
4511
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004512 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4513 return( PSA_ERROR_BAD_STATE );
4514 hkdf->state = HKDF_STATE_OUTPUT;
4515
Gilles Peskinebef7f142018-07-12 17:22:21 +02004516 while( output_length != 0 )
4517 {
4518 /* Copy what remains of the current block */
4519 uint8_t n = hash_length - hkdf->offset_in_block;
4520 if( n > output_length )
4521 n = (uint8_t) output_length;
4522 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4523 output += n;
4524 output_length -= n;
4525 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004526 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004527 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004528 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004529 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004530 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004531 * object was corrupted or if this function is called directly
4532 * inside the library. */
4533 if( hkdf->block_number == 0xff )
4534 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004535
4536 /* We need a new block */
4537 ++hkdf->block_number;
4538 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004539
Steven Cooreman094a77e2021-05-06 17:58:36 +02004540 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4541 hash_alg,
4542 hkdf->prk,
4543 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004544 if( status != PSA_SUCCESS )
4545 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004546
Gilles Peskinebef7f142018-07-12 17:22:21 +02004547 if( hkdf->block_number != 1 )
4548 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004549 status = psa_mac_update( &hkdf->hmac,
4550 hkdf->output_block,
4551 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004552 if( status != PSA_SUCCESS )
4553 return( status );
4554 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004555 status = psa_mac_update( &hkdf->hmac,
4556 hkdf->info,
4557 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004558 if( status != PSA_SUCCESS )
4559 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004560 status = psa_mac_update( &hkdf->hmac,
4561 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004562 if( status != PSA_SUCCESS )
4563 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004564 status = psa_mac_sign_finish( &hkdf->hmac,
4565 hkdf->output_block,
4566 sizeof( hkdf->output_block ),
4567 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004568 if( status != PSA_SUCCESS )
4569 return( status );
4570 }
4571
4572 return( PSA_SUCCESS );
4573}
John Durkop07cc04a2020-11-16 22:08:34 -08004574#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004575
John Durkop07cc04a2020-11-16 22:08:34 -08004576#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4577 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004578static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4579 psa_tls12_prf_key_derivation_t *tls12_prf,
4580 psa_algorithm_t alg )
4581{
4582 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004583 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004584 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4585 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004586 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004587
Janos Follath7742fee2019-06-17 12:58:10 +01004588 /* We can't be wanting more output after block 0xff, otherwise
4589 * the capacity check in psa_key_derivation_output_bytes() would have
4590 * prevented this call. It could happen only if the operation
4591 * object was corrupted or if this function is called directly
4592 * inside the library. */
4593 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004594 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004595
4596 /* We need a new block */
4597 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004598 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004599
4600 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4601 *
4602 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4603 *
4604 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4605 * HMAC_hash(secret, A(2) + seed) +
4606 * HMAC_hash(secret, A(3) + seed) + ...
4607 *
4608 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004609 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004610 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004611 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004612 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004613 * is currently extracted as `output_block` and where i is
4614 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004615 */
4616
Steven Cooreman094a77e2021-05-06 17:58:36 +02004617 status = psa_key_derivation_start_hmac( &hmac,
4618 hash_alg,
4619 tls12_prf->secret,
4620 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004621 if( status != PSA_SUCCESS )
4622 goto cleanup;
4623
4624 /* Calculate A(i) where i = tls12_prf->block_number. */
4625 if( tls12_prf->block_number == 1 )
4626 {
4627 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4628 * the variable seed and in this instance means it in the context of the
4629 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004630 status = psa_mac_update( &hmac,
4631 tls12_prf->label,
4632 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004633 if( status != PSA_SUCCESS )
4634 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004635 status = psa_mac_update( &hmac,
4636 tls12_prf->seed,
4637 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004638 if( status != PSA_SUCCESS )
4639 goto cleanup;
4640 }
4641 else
4642 {
4643 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004644 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004645 if( status != PSA_SUCCESS )
4646 goto cleanup;
4647 }
4648
Steven Cooremana6df6042021-04-29 19:32:25 +02004649 status = psa_mac_sign_finish( &hmac,
4650 tls12_prf->Ai, hash_length,
4651 &hmac_output_length );
4652 if( hmac_output_length != hash_length )
4653 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004654 if( status != PSA_SUCCESS )
4655 goto cleanup;
4656
4657 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004658 status = psa_key_derivation_start_hmac( &hmac,
4659 hash_alg,
4660 tls12_prf->secret,
4661 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004662 if( status != PSA_SUCCESS )
4663 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004664 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004665 if( status != PSA_SUCCESS )
4666 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004667 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004668 if( status != PSA_SUCCESS )
4669 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004670 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004671 if( status != PSA_SUCCESS )
4672 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004673 status = psa_mac_sign_finish( &hmac,
4674 tls12_prf->output_block, hash_length,
4675 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004676 if( status != PSA_SUCCESS )
4677 goto cleanup;
4678
Janos Follath7742fee2019-06-17 12:58:10 +01004679
4680cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004681 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004682 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4683 status = cleanup_status;
4684
4685 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004686}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004687
Janos Follath844eb0e2019-06-19 12:10:49 +01004688static psa_status_t psa_key_derivation_tls12_prf_read(
4689 psa_tls12_prf_key_derivation_t *tls12_prf,
4690 psa_algorithm_t alg,
4691 uint8_t *output,
4692 size_t output_length )
4693{
4694 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004695 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004696 psa_status_t status;
4697 uint8_t offset, length;
4698
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004699 switch( tls12_prf->state )
4700 {
4701 case PSA_TLS12_PRF_STATE_LABEL_SET:
4702 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4703 break;
4704 case PSA_TLS12_PRF_STATE_OUTPUT:
4705 break;
4706 default:
4707 return( PSA_ERROR_BAD_STATE );
4708 }
4709
Janos Follath844eb0e2019-06-19 12:10:49 +01004710 while( output_length != 0 )
4711 {
4712 /* Check if we have fully processed the current block. */
4713 if( tls12_prf->left_in_block == 0 )
4714 {
4715 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4716 alg );
4717 if( status != PSA_SUCCESS )
4718 return( status );
4719
4720 continue;
4721 }
4722
4723 if( tls12_prf->left_in_block > output_length )
4724 length = (uint8_t) output_length;
4725 else
4726 length = tls12_prf->left_in_block;
4727
4728 offset = hash_length - tls12_prf->left_in_block;
4729 memcpy( output, tls12_prf->output_block + offset, length );
4730 output += length;
4731 output_length -= length;
4732 tls12_prf->left_in_block -= length;
4733 }
4734
4735 return( PSA_SUCCESS );
4736}
John Durkop07cc04a2020-11-16 22:08:34 -08004737#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4738 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004739
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004740psa_status_t psa_key_derivation_output_bytes(
4741 psa_key_derivation_operation_t *operation,
4742 uint8_t *output,
4743 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004744{
4745 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004746 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004747
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004748 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004749 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004750 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004751 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004752 }
4753
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004754 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004755 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004756 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004757 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004758 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004759 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004760 goto exit;
4761 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004762 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004763 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004764 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004765 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004766 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4767 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004768 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004769 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004770 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004771 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004772 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004773
John Durkopd0321952020-10-29 21:37:36 -07004774#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004775 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004776 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004777 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004778 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004779 output, output_length );
4780 }
Janos Follathadbec812019-06-14 11:05:39 +01004781 else
John Durkop07cc04a2020-11-16 22:08:34 -08004782#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4783#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4784 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004785 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004786 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004787 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004788 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004789 kdf_alg, output,
4790 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004791 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004792 else
John Durkop07cc04a2020-11-16 22:08:34 -08004793#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4794 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004795 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004796 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004797 return( PSA_ERROR_BAD_STATE );
4798 }
4799
4800exit:
4801 if( status != PSA_SUCCESS )
4802 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004803 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004804 * This allows us to differentiate between exhausted operations and
4805 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4806 * operations. */
4807 psa_algorithm_t alg = operation->alg;
4808 psa_key_derivation_abort( operation );
4809 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004810 memset( output, '!', output_length );
4811 }
4812 return( status );
4813}
4814
David Brown7807bf72021-02-09 16:28:23 -07004815#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004816static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4817{
4818 if( data_size >= 8 )
4819 mbedtls_des_key_set_parity( data );
4820 if( data_size >= 16 )
4821 mbedtls_des_key_set_parity( data + 8 );
4822 if( data_size >= 24 )
4823 mbedtls_des_key_set_parity( data + 16 );
4824}
David Brown7807bf72021-02-09 16:28:23 -07004825#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004826
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004827static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004828 psa_key_slot_t *slot,
4829 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004830 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004831{
4832 uint8_t *data = NULL;
4833 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304834 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004835 psa_status_t status;
4836
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004837 /*
4838 * ECC key types require the generation of a private key which is an integer
4839 * in the range [1, N - 1], where N is the boundary of the private key domain:
4840 * N is the prime p for Diffie-Hellman, or the order of the
4841 * curve’s base point for ECC.
4842 *
4843 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
4844 * This function generates the private key using the following process:
4845 *
4846 * 1. Draw a byte string of length ceiling(m/8) bytes.
4847 * 2. If m is not a multiple of 8, set the most significant
4848 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
4849 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
4850 * 4. If k > N - 2, discard the result and return to step 1.
4851 * 5. Output k + 1 as the private key.
4852 *
4853 * This method allows compliance to NIST standards
4854 */
4855 if ( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
4856 {
4857 int cmp_result;
4858 do {
4859 int ret;
4860 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
4861 slot->attr.type );
4862 mbedtls_ecp_group_id grp_id =
4863 mbedtls_ecc_group_of_psa( curve, bits, 0 );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004864
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004865 mbedtls_ecp_keypair ecp;
4866 mbedtls_ecp_keypair_init( &ecp );
4867
4868 if( ( ret = mbedtls_ecp_group_load( &ecp.grp, grp_id ) ) != 0 )
4869 return( ret );
4870
4871 /* N is the boundary of the private key domain */
4872 mbedtls_mpi N = ecp.grp.N;
4873 /* Let m be the bit size of N */
4874 size_t m = ecp.grp.nbits;
4875
4876 size_t m_bytes = PSA_BITS_TO_BYTES( m );
4877
4878 /* Alloc buffer once */
4879 if ( data == NULL )
4880 data = mbedtls_calloc( 1, m_bytes );
4881 if( data == NULL )
4882 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4883
4884 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
4885 status = psa_key_derivation_output_bytes( operation, data, m_bytes );
4886 if( status != PSA_SUCCESS )
4887 goto exit;
4888
4889 /* 2. If m is not a multiple of 8 */
4890 if (m % 8)
4891 {
4892 /* set the most significant
4893 * (8 * ceiling(m/8) - m) bits of the first byte in
4894 * the string to zero.
4895 */
4896 uint8_t clear_bit_count = ( 8 * m_bytes - m );
4897 uint8_t clear_bit_mask = ( ( 1 << clear_bit_count ) - 1 );
4898 clear_bit_mask = ~( clear_bit_mask << ( 8 - clear_bit_count ) );
4899 data[0] = ( data[0] & clear_bit_mask );
4900 }
4901
4902 /* 3. Convert the string to integer k by decoding it as a
4903 * big-endian byte string.
4904 */
4905 mbedtls_mpi k;
4906 mbedtls_mpi_init( &k );
4907 mbedtls_mpi_read_binary( &k, data, m_bytes);
4908
4909 /* 4. If k > N - 2, discard the result and return to step 1. */
4910 mbedtls_mpi diff_N_2;
4911 mbedtls_mpi_init( &diff_N_2 );
4912 mbedtls_mpi_sub_int( &diff_N_2, &N, 2);
4913 cmp_result = mbedtls_mpi_cmp_mpi( &k, &diff_N_2 );
4914
4915 /* 5. Output k + 1 as the private key. */
4916 mbedtls_mpi sum_k_1;
4917 mbedtls_mpi_init( &sum_k_1 );
4918 mbedtls_mpi_add_int( &sum_k_1, &k, 1);
4919 mbedtls_mpi_write_binary( &sum_k_1, data, m_bytes);
4920 } while ( cmp_result == 1 );
4921 } else {
4922 if( ! key_type_is_raw_bytes( slot->attr.type ) )
4923 return( PSA_ERROR_INVALID_ARGUMENT );
4924 if( bits % 8 != 0 )
4925 return( PSA_ERROR_INVALID_ARGUMENT );
4926 data = mbedtls_calloc( 1, bytes );
4927 if( data == NULL )
4928 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4929
4930 status = psa_key_derivation_output_bytes( operation, data, bytes );
4931 if( status != PSA_SUCCESS )
4932 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004933#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004934 if( slot->attr.type == PSA_KEY_TYPE_DES )
4935 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004936#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004937 }
Ronald Crondd04d422020-11-28 15:14:42 +01004938
Ronald Cronbf33c932020-11-28 18:06:53 +01004939 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004940 psa_key_attributes_t attributes = {
4941 .core = slot->attr
4942 };
4943
Archanad8a83dc2021-06-14 10:04:16 +05304944 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4945 {
Archana449608b2021-09-08 15:36:05 +05304946 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4947 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304948 if( status != PSA_SUCCESS )
4949 goto exit;
4950 }
4951 status = psa_allocate_buffer_to_slot( slot, storage_size );
4952 if( status != PSA_SUCCESS )
4953 goto exit;
4954
Ronald Cronbf33c932020-11-28 18:06:53 +01004955 status = psa_driver_wrapper_import_key( &attributes,
4956 data, bytes,
4957 slot->key.data,
4958 slot->key.bytes,
4959 &slot->key.bytes, &bits );
4960 if( bits != slot->attr.bits )
4961 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004962
4963exit:
4964 mbedtls_free( data );
4965 return( status );
4966}
4967
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004968psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004969 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004970 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004971{
4972 psa_status_t status;
4973 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004974 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004975
Ronald Cron81709fc2020-11-14 12:10:32 +01004976 *key = MBEDTLS_SVC_KEY_ID_INIT;
4977
Gilles Peskine0f84d622019-09-12 19:03:13 +02004978 /* Reject any attempt to create a zero-length key so that we don't
4979 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4980 if( psa_get_key_bits( attributes ) == 0 )
4981 return( PSA_ERROR_INVALID_ARGUMENT );
4982
Dave Rodgmand69da6c2021-11-16 10:32:48 +00004983 if( operation->alg == PSA_ALG_NONE )
4984 return( PSA_ERROR_BAD_STATE );
4985
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004986 if( ! operation->can_output_key )
4987 return( PSA_ERROR_NOT_PERMITTED );
4988
Ronald Cron81709fc2020-11-14 12:10:32 +01004989 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4990 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004991#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4992 if( driver != NULL )
4993 {
4994 /* Deriving a key in a secure element is not implemented yet. */
4995 status = PSA_ERROR_NOT_SUPPORTED;
4996 }
4997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004998 if( status == PSA_SUCCESS )
4999 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005000 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005001 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005002 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005003 }
5004 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005005 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005006 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005007 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005008
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005009 return( status );
5010}
5011
Gilles Peskineeab56e42018-07-12 17:12:33 +02005012
5013
5014/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005015/* Key derivation */
5016/****************************************************************/
5017
Steven Cooreman932ffb72021-02-15 12:14:32 +01005018#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005019static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005020 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005021 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005022{
John Durkop07cc04a2020-11-16 22:08:34 -08005023 int is_kdf_alg_supported;
5024
Janos Follath5fe19732019-06-20 15:09:30 +01005025 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5026 * initialisers for this union leave some bytes unspecified.) */
5027 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5028
Gilles Peskine969c5d62019-01-16 15:53:06 +01005029 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005030#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005031 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5032 is_kdf_alg_supported = 1;
5033 else
5034#endif
5035#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5036 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5037 is_kdf_alg_supported = 1;
5038 else
5039#endif
5040#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5041 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5042 is_kdf_alg_supported = 1;
5043 else
5044#endif
5045 is_kdf_alg_supported = 0;
5046
5047 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005048 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005049 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005050 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005051 if( hash_size == 0 )
5052 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005053 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5054 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005055 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005056 {
5057 return( PSA_ERROR_NOT_SUPPORTED );
5058 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005059 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005060 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005061 }
John Durkop07cc04a2020-11-16 22:08:34 -08005062
5063 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005064}
John Durkop07cc04a2020-11-16 22:08:34 -08005065#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005066
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005067psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005068 psa_algorithm_t alg )
5069{
5070 psa_status_t status;
5071
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005072 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005073 return( PSA_ERROR_BAD_STATE );
5074
Gilles Peskine6843c292019-01-18 16:44:49 +01005075 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5076 return( PSA_ERROR_INVALID_ARGUMENT );
5077 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005078 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005079#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005080 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005081 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005082#else
5083 return( PSA_ERROR_NOT_SUPPORTED );
5084#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005085 }
5086 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5087 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005088#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005089 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005090#else
5091 return( PSA_ERROR_NOT_SUPPORTED );
5092#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005093 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005094 else
5095 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005096
5097 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005098 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005099 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005100}
5101
John Durkopd0321952020-10-29 21:37:36 -07005102#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005103static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005104 psa_algorithm_t hash_alg,
5105 psa_key_derivation_step_t step,
5106 const uint8_t *data,
5107 size_t data_length )
5108{
5109 psa_status_t status;
5110 switch( step )
5111 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005112 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005113 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005114 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005115 else
5116 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005117 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5118 hash_alg,
5119 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005120 if( status != PSA_SUCCESS )
5121 return( status );
5122 hkdf->state = HKDF_STATE_STARTED;
5123 return( PSA_SUCCESS );
5124 }
Gilles Peskine03410b52019-05-16 16:05:19 +02005125 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005126 /* If no salt was provided, use an empty salt. */
5127 if( hkdf->state == HKDF_STATE_INIT )
5128 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005129 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5130 hash_alg,
5131 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005132 if( status != PSA_SUCCESS )
5133 return( status );
5134 hkdf->state = HKDF_STATE_STARTED;
5135 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005136 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005137 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005138 status = psa_mac_update( &hkdf->hmac,
5139 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005140 if( status != PSA_SUCCESS )
5141 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005142 status = psa_mac_sign_finish( &hkdf->hmac,
5143 hkdf->prk,
5144 sizeof( hkdf->prk ),
5145 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005146 if( status != PSA_SUCCESS )
5147 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005148 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005149 hkdf->block_number = 0;
5150 hkdf->state = HKDF_STATE_KEYED;
5151 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005152 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005153 if( hkdf->state == HKDF_STATE_OUTPUT )
5154 return( PSA_ERROR_BAD_STATE );
5155 if( hkdf->info_set )
5156 return( PSA_ERROR_BAD_STATE );
5157 hkdf->info_length = data_length;
5158 if( data_length != 0 )
5159 {
5160 hkdf->info = mbedtls_calloc( 1, data_length );
5161 if( hkdf->info == NULL )
5162 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5163 memcpy( hkdf->info, data, data_length );
5164 }
5165 hkdf->info_set = 1;
5166 return( PSA_SUCCESS );
5167 default:
5168 return( PSA_ERROR_INVALID_ARGUMENT );
5169 }
5170}
John Durkop07cc04a2020-11-16 22:08:34 -08005171#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005172
John Durkop07cc04a2020-11-16 22:08:34 -08005173#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5174 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005175static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5176 const uint8_t *data,
5177 size_t data_length )
5178{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005179 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005180 return( PSA_ERROR_BAD_STATE );
5181
Janos Follathd6dce9f2019-07-04 09:11:38 +01005182 if( data_length != 0 )
5183 {
5184 prf->seed = mbedtls_calloc( 1, data_length );
5185 if( prf->seed == NULL )
5186 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005187
Janos Follathd6dce9f2019-07-04 09:11:38 +01005188 memcpy( prf->seed, data, data_length );
5189 prf->seed_length = data_length;
5190 }
Janos Follathf08e2652019-06-13 09:05:41 +01005191
Gilles Peskine43f958b2020-12-13 14:55:14 +01005192 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005193
5194 return( PSA_SUCCESS );
5195}
5196
Janos Follath81550542019-06-13 14:26:34 +01005197static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01005198 const uint8_t *data,
5199 size_t data_length )
5200{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005201 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01005202 return( PSA_ERROR_BAD_STATE );
5203
Steven Cooremana6df6042021-04-29 19:32:25 +02005204 if( data_length != 0 )
5205 {
5206 prf->secret = mbedtls_calloc( 1, data_length );
5207 if( prf->secret == NULL )
5208 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5209
5210 memcpy( prf->secret, data, data_length );
5211 prf->secret_length = data_length;
5212 }
Janos Follath81550542019-06-13 14:26:34 +01005213
Gilles Peskine43f958b2020-12-13 14:55:14 +01005214 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005215
5216 return( PSA_SUCCESS );
5217}
5218
Janos Follath63028dd2019-06-13 09:15:47 +01005219static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5220 const uint8_t *data,
5221 size_t data_length )
5222{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005223 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005224 return( PSA_ERROR_BAD_STATE );
5225
Janos Follathd6dce9f2019-07-04 09:11:38 +01005226 if( data_length != 0 )
5227 {
5228 prf->label = mbedtls_calloc( 1, data_length );
5229 if( prf->label == NULL )
5230 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005231
Janos Follathd6dce9f2019-07-04 09:11:38 +01005232 memcpy( prf->label, data, data_length );
5233 prf->label_length = data_length;
5234 }
Janos Follath63028dd2019-06-13 09:15:47 +01005235
Gilles Peskine43f958b2020-12-13 14:55:14 +01005236 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005237
5238 return( PSA_SUCCESS );
5239}
5240
Janos Follathb03233e2019-06-11 15:30:30 +01005241static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005242 psa_key_derivation_step_t step,
5243 const uint8_t *data,
5244 size_t data_length )
5245{
Janos Follathb03233e2019-06-11 15:30:30 +01005246 switch( step )
5247 {
Janos Follathf08e2652019-06-13 09:05:41 +01005248 case PSA_KEY_DERIVATION_INPUT_SEED:
5249 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005250 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005251 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005252 case PSA_KEY_DERIVATION_INPUT_LABEL:
5253 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005254 default:
5255 return( PSA_ERROR_INVALID_ARGUMENT );
5256 }
5257}
John Durkop07cc04a2020-11-16 22:08:34 -08005258#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5259 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5260
5261#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5262static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5263 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005264 const uint8_t *data,
5265 size_t data_length )
5266{
5267 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005268 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005269 uint8_t *cur = pms;
5270
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005271 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005272 return( PSA_ERROR_INVALID_ARGUMENT );
5273
5274 /* Quoting RFC 4279, Section 2:
5275 *
5276 * The premaster secret is formed as follows: if the PSK is N octets
5277 * long, concatenate a uint16 with the value N, N zero octets, a second
5278 * uint16 with the value N, and the PSK itself.
5279 */
5280
Joe Subbiani5ecac212021-06-24 13:00:03 +01005281 *cur++ = MBEDTLS_BYTE_1( data_length );
5282 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005283 memset( cur, 0, data_length );
5284 cur += data_length;
5285 *cur++ = pms[0];
5286 *cur++ = pms[1];
5287 memcpy( cur, data, data_length );
5288 cur += data_length;
5289
Steven Cooremana6df6042021-04-29 19:32:25 +02005290 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005291
5292 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5293 return( status );
5294}
Janos Follath6660f0e2019-06-17 08:44:03 +01005295
5296static psa_status_t psa_tls12_prf_psk_to_ms_input(
5297 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005298 psa_key_derivation_step_t step,
5299 const uint8_t *data,
5300 size_t data_length )
5301{
5302 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005303 {
Steven Cooremana6df6042021-04-29 19:32:25 +02005304 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005305 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005306 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005307
Steven Cooremana6df6042021-04-29 19:32:25 +02005308 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01005309}
John Durkop07cc04a2020-11-16 22:08:34 -08005310#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005311
Gilles Peskineb8965192019-09-24 16:21:10 +02005312/** Check whether the given key type is acceptable for the given
5313 * input step of a key derivation.
5314 *
5315 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5316 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5317 * Both secret and non-secret inputs can alternatively have the type
5318 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5319 * that the input was passed as a buffer rather than via a key object.
5320 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005321static int psa_key_derivation_check_input_type(
5322 psa_key_derivation_step_t step,
5323 psa_key_type_t key_type )
5324{
5325 switch( step )
5326 {
5327 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005328 if( key_type == PSA_KEY_TYPE_DERIVE )
5329 return( PSA_SUCCESS );
5330 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005331 return( PSA_SUCCESS );
5332 break;
5333 case PSA_KEY_DERIVATION_INPUT_LABEL:
5334 case PSA_KEY_DERIVATION_INPUT_SALT:
5335 case PSA_KEY_DERIVATION_INPUT_INFO:
5336 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005337 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5338 return( PSA_SUCCESS );
5339 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005340 return( PSA_SUCCESS );
5341 break;
5342 }
5343 return( PSA_ERROR_INVALID_ARGUMENT );
5344}
5345
Janos Follathb80a94e2019-06-12 15:54:46 +01005346static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005347 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005348 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005349 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005350 const uint8_t *data,
5351 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005352{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005353 psa_status_t status;
5354 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5355
5356 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005357 if( status != PSA_SUCCESS )
5358 goto exit;
5359
John Durkopd0321952020-10-29 21:37:36 -07005360#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005361 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005362 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005363 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005364 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005365 step, data, data_length );
5366 }
John Durkop07cc04a2020-11-16 22:08:34 -08005367 else
5368#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5369#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5370 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005371 {
Janos Follathb03233e2019-06-11 15:30:30 +01005372 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005373 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005374 }
John Durkop07cc04a2020-11-16 22:08:34 -08005375 else
5376#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5377#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5378 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005379 {
5380 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005381 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005382 }
5383 else
John Durkop07cc04a2020-11-16 22:08:34 -08005384#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005385 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005386 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005387 (void) data;
5388 (void) data_length;
5389 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005390 return( PSA_ERROR_BAD_STATE );
5391 }
5392
Gilles Peskine224b0d62019-09-23 18:13:17 +02005393exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005394 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005395 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005396 return( status );
5397}
5398
Janos Follath51f4a0f2019-06-14 11:35:55 +01005399psa_status_t psa_key_derivation_input_bytes(
5400 psa_key_derivation_operation_t *operation,
5401 psa_key_derivation_step_t step,
5402 const uint8_t *data,
5403 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005404{
Gilles Peskineb8965192019-09-24 16:21:10 +02005405 return( psa_key_derivation_input_internal( operation, step,
5406 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005407 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005408}
5409
Janos Follath51f4a0f2019-06-14 11:35:55 +01005410psa_status_t psa_key_derivation_input_key(
5411 psa_key_derivation_operation_t *operation,
5412 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005413 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005414{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005416 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005417 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005418
Ronald Cron5c522922020-11-14 16:35:34 +01005419 status = psa_get_and_lock_transparent_key_slot_with_policy(
5420 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005421 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005422 {
5423 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005424 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005425 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005426
5427 /* Passing a key object as a SECRET input unlocks the permission
5428 * to output to a key object. */
5429 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5430 operation->can_output_key = 1;
5431
Ronald Cronf95a2b12020-10-22 15:24:49 +02005432 status = psa_key_derivation_input_internal( operation,
5433 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005434 slot->key.data,
5435 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005436
Ronald Cron5c522922020-11-14 16:35:34 +01005437 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005438
Ronald Cron5c522922020-11-14 16:35:34 +01005439 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005440}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005441
5442
5443
5444/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005445/* Key agreement */
5446/****************************************************************/
5447
John Durkop6ba40d12020-11-10 08:50:04 -08005448#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005449static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5450 size_t peer_key_length,
5451 const mbedtls_ecp_keypair *our_key,
5452 uint8_t *shared_secret,
5453 size_t shared_secret_size,
5454 size_t *shared_secret_length )
5455{
Steven Cooremand4867872020-08-05 16:31:39 +02005456 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005457 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005458 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005459 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005460 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005461 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005462
Ronald Cron90857082020-11-25 14:58:33 +01005463 status = mbedtls_psa_ecp_load_representation(
5464 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005465 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005466 peer_key,
5467 peer_key_length,
5468 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005469 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005470 goto exit;
5471
Jaeden Amero97271b32019-01-10 19:38:51 +00005472 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005473 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005474 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005475 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005476 status = mbedtls_to_psa_error(
5477 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5478 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005479 goto exit;
5480
Jaeden Amero97271b32019-01-10 19:38:51 +00005481 status = mbedtls_to_psa_error(
5482 mbedtls_ecdh_calc_secret( &ecdh,
5483 shared_secret_length,
5484 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005485 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005486 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005487 if( status != PSA_SUCCESS )
5488 goto exit;
5489 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5490 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005491
5492exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005493 if( status != PSA_SUCCESS )
5494 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005495 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005496 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005497 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005498
Jaeden Amero97271b32019-01-10 19:38:51 +00005499 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005500}
John Durkop6ba40d12020-11-10 08:50:04 -08005501#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005502
Gilles Peskine01d718c2018-09-18 12:01:02 +02005503#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5504
Gilles Peskine0216fe12019-04-11 21:23:21 +02005505static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5506 psa_key_slot_t *private_key,
5507 const uint8_t *peer_key,
5508 size_t peer_key_length,
5509 uint8_t *shared_secret,
5510 size_t shared_secret_size,
5511 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005512{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005513 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005514 {
John Durkop6ba40d12020-11-10 08:50:04 -08005515#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005516 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005517 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005518 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005519 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005520 psa_status_t status = mbedtls_psa_ecp_load_representation(
5521 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005522 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005523 private_key->key.data,
5524 private_key->key.bytes,
5525 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005526 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005527 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005528 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005529 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005530 shared_secret, shared_secret_size,
5531 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005532 mbedtls_ecp_keypair_free( ecp );
5533 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005534 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005535#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005536 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005537 (void) private_key;
5538 (void) peer_key;
5539 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005540 (void) shared_secret;
5541 (void) shared_secret_size;
5542 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005543 return( PSA_ERROR_NOT_SUPPORTED );
5544 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005545}
5546
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005547/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005548 * to potentially free embedded data structures and wipe confidential data.
5549 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005550static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005551 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005552 psa_key_slot_t *private_key,
5553 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005554 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005555{
5556 psa_status_t status;
5557 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5558 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005559 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005560
5561 /* Step 1: run the secret agreement algorithm to generate the shared
5562 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005563 status = psa_key_agreement_raw_internal( ka_alg,
5564 private_key,
5565 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005566 shared_secret,
5567 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005568 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005569 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005570 goto exit;
5571
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005572 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005573 * the shared secret. A shared secret is permitted wherever a key
5574 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005575 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005576 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005577 shared_secret,
5578 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005579exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005580 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005581 return( status );
5582}
5583
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005585 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005586 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005587 const uint8_t *peer_key,
5588 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005589{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005591 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005592 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005593
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005594 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005595 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005596 status = psa_get_and_lock_transparent_key_slot_with_policy(
5597 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005598 if( status != PSA_SUCCESS )
5599 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005600 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005601 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005602 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005603 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005604 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005605 else
5606 {
5607 /* If a private key has been added as SECRET, we allow the derived
5608 * key material to be used as a key in PSA Crypto. */
5609 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5610 operation->can_output_key = 1;
5611 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005612
Ronald Cron5c522922020-11-14 16:35:34 +01005613 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005614
Ronald Cron5c522922020-11-14 16:35:34 +01005615 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005616}
5617
Gilles Peskinebe697d82019-05-16 18:00:41 +02005618psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005619 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005620 const uint8_t *peer_key,
5621 size_t peer_key_length,
5622 uint8_t *output,
5623 size_t output_size,
5624 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005625{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005626 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005627 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005628 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005629
5630 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5631 {
5632 status = PSA_ERROR_INVALID_ARGUMENT;
5633 goto exit;
5634 }
Ronald Cron5c522922020-11-14 16:35:34 +01005635 status = psa_get_and_lock_transparent_key_slot_with_policy(
5636 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005637 if( status != PSA_SUCCESS )
5638 goto exit;
5639
5640 status = psa_key_agreement_raw_internal( alg, slot,
5641 peer_key, peer_key_length,
5642 output, output_size,
5643 output_length );
5644
5645exit:
5646 if( status != PSA_SUCCESS )
5647 {
5648 /* If an error happens and is not handled properly, the output
5649 * may be used as a key to protect sensitive data. Arrange for such
5650 * a key to be random, which is likely to result in decryption or
5651 * verification errors. This is better than filling the buffer with
5652 * some constant data such as zeros, which would result in the data
5653 * being protected with a reproducible, easily knowable key.
5654 */
5655 psa_generate_random( output, output_size );
5656 *output_length = output_size;
5657 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005658
Ronald Cron5c522922020-11-14 16:35:34 +01005659 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005660
Ronald Cron5c522922020-11-14 16:35:34 +01005661 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005662}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005663
5664
Gilles Peskine30524eb2020-11-13 17:02:26 +01005665
Gilles Peskine86a440b2018-11-12 18:39:40 +01005666/****************************************************************/
5667/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005668/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005669
Gilles Peskine30524eb2020-11-13 17:02:26 +01005670/** Initialize the PSA random generator.
5671 */
5672static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5673{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005674#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5675 memset( rng, 0, sizeof( *rng ) );
5676#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5677
Gilles Peskine30524eb2020-11-13 17:02:26 +01005678 /* Set default configuration if
5679 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5680 if( rng->entropy_init == NULL )
5681 rng->entropy_init = mbedtls_entropy_init;
5682 if( rng->entropy_free == NULL )
5683 rng->entropy_free = mbedtls_entropy_free;
5684
5685 rng->entropy_init( &rng->entropy );
5686#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5687 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5688 /* The PSA entropy injection feature depends on using NV seed as an entropy
5689 * source. Add NV seed as an entropy source for PSA entropy injection. */
5690 mbedtls_entropy_add_source( &rng->entropy,
5691 mbedtls_nv_seed_poll, NULL,
5692 MBEDTLS_ENTROPY_BLOCK_SIZE,
5693 MBEDTLS_ENTROPY_SOURCE_STRONG );
5694#endif
5695
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005696 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005697#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005698}
5699
5700/** Deinitialize the PSA random generator.
5701 */
5702static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5703{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005704#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5705 memset( rng, 0, sizeof( *rng ) );
5706#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005707 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005708 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005709#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005710}
5711
5712/** Seed the PSA random generator.
5713 */
5714static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5715{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005716#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5717 /* Do nothing: the external RNG seeds itself. */
5718 (void) rng;
5719 return( PSA_SUCCESS );
5720#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005721 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005722 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5723 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005724 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005725#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005726}
5727
Gilles Peskinee59236f2018-01-27 23:32:46 +01005728psa_status_t psa_generate_random( uint8_t *output,
5729 size_t output_size )
5730{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005731 GUARD_MODULE_INITIALIZED;
5732
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005733#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5734
5735 size_t output_length = 0;
5736 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5737 output, output_size,
5738 &output_length );
5739 if( status != PSA_SUCCESS )
5740 return( status );
5741 /* Breaking up a request into smaller chunks is currently not supported
5742 * for the extrernal RNG interface. */
5743 if( output_length != output_size )
5744 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5745 return( PSA_SUCCESS );
5746
5747#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5748
Gilles Peskine71ddab92021-01-04 21:01:07 +01005749 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005750 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005751 size_t request_size =
5752 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5753 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5754 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005755 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5756 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005757 if( ret != 0 )
5758 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005759 output_size -= request_size;
5760 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005761 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005762 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005763#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005764}
5765
Gilles Peskine8814fc42020-12-14 15:33:44 +01005766/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005767 *
5768 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5769 * `psa_generate_random(...)`. The state parameter is ignored since the
5770 * PSA API doesn't support passing an explicit state.
5771 *
5772 * In the non-external case, psa_generate_random() calls an
5773 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5774 * and semantics as mbedtls_psa_get_random(). As an optimization,
5775 * instead of doing this back-and-forth between the PSA API and the
5776 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5777 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005778 */
5779#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5780int mbedtls_psa_get_random( void *p_rng,
5781 unsigned char *output,
5782 size_t output_size )
5783{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005784 /* This function takes a pointer to the RNG state because that's what
5785 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5786 * its own state internally and doesn't let the caller access that state.
5787 * So we just ignore the state parameter, and in practice we'll pass
5788 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005789 (void) p_rng;
5790 psa_status_t status = psa_generate_random( output, output_size );
5791 if( status == PSA_SUCCESS )
5792 return( 0 );
5793 else
5794 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5795}
5796#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5797
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005798#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005799#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005800
Gilles Peskine7228da22019-07-15 11:06:15 +02005801psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005802 size_t seed_size )
5803{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005804 if( global_data.initialized )
5805 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005806
5807 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5808 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5809 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5810 return( PSA_ERROR_INVALID_ARGUMENT );
5811
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005812 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005813}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005814#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005815
Ronald Cron3772afe2021-02-08 16:10:05 +01005816/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005817 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005818 * \param type The key type
5819 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005820 *
5821 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005822 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005823 * \retval #PSA_ERROR_INVALID_ARGUMENT
5824 * The size in bits of the key is not valid.
5825 * \retval #PSA_ERROR_NOT_SUPPORTED
5826 * The type and/or the size in bits of the key or the combination of
5827 * the two is not supported.
5828 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005829static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5830 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005831{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005832 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005833
Gilles Peskinee59236f2018-01-27 23:32:46 +01005834 if( key_type_is_raw_bytes( type ) )
5835 {
Archana4d7ae1d2021-07-07 02:50:22 +05305836 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005837 if( status != PSA_SUCCESS )
5838 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005839 }
5840 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005841#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005842 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5843 {
5844 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5845 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005846
Ronald Cron01b2aba2020-10-05 09:42:02 +02005847 /* Accept only byte-aligned keys, for the same reasons as
5848 * in psa_import_rsa_key(). */
5849 if( bits % 8 != 0 )
5850 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005851 }
5852 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005853#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005854
Ronald Cron5c4d3862020-12-07 11:07:24 +01005855#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005856 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5857 {
Ronald Crond81ab562021-02-16 09:01:16 +01005858 /* To avoid empty block, return successfully here. */
5859 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005860 }
5861 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005862#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005863 {
5864 return( PSA_ERROR_NOT_SUPPORTED );
5865 }
5866
5867 return( PSA_SUCCESS );
5868}
5869
Ronald Cron55ed0592020-10-05 10:30:40 +02005870psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005871 const psa_key_attributes_t *attributes,
5872 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005873{
5874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005875 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005876
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005877 if( ( attributes->domain_parameters == NULL ) &&
5878 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005879 return( PSA_ERROR_INVALID_ARGUMENT );
5880
Ronald Cron01b2aba2020-10-05 09:42:02 +02005881 if( key_type_is_raw_bytes( type ) )
5882 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005883 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005884 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005885 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005886
David Brown12ca5032021-02-11 11:02:00 -07005887#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005888 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005889 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005890#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005891 }
5892 else
5893
Jaeden Amero424fa932021-05-14 08:34:32 +01005894#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5895 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005896 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005897 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005898 return( mbedtls_psa_rsa_generate_key( attributes,
5899 key_buffer,
5900 key_buffer_size,
5901 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005902 }
5903 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005904#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5905 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005906
John Durkop9814fa22020-11-04 12:28:15 -08005907#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005908 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005909 {
Ronald Cron7023db52020-11-20 18:17:42 +01005910 return( mbedtls_psa_ecp_generate_key( attributes,
5911 key_buffer,
5912 key_buffer_size,
5913 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005914 }
5915 else
John Durkop9814fa22020-11-04 12:28:15 -08005916#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005917 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005918 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005919 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005920 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005921
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005922 return( PSA_SUCCESS );
5923}
Darryl Green0c6575a2018-11-07 16:05:30 +00005924
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005925psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005926 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005927{
5928 psa_status_t status;
5929 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005930 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005931 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005932
Ronald Cron81709fc2020-11-14 12:10:32 +01005933 *key = MBEDTLS_SVC_KEY_ID_INIT;
5934
Gilles Peskine0f84d622019-09-12 19:03:13 +02005935 /* Reject any attempt to create a zero-length key so that we don't
5936 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5937 if( psa_get_key_bits( attributes ) == 0 )
5938 return( PSA_ERROR_INVALID_ARGUMENT );
5939
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02005940 /* Reject any attempt to create a public key. */
5941 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5942 return( PSA_ERROR_INVALID_ARGUMENT );
5943
Ronald Cron81709fc2020-11-14 12:10:32 +01005944 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5945 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005946 if( status != PSA_SUCCESS )
5947 goto exit;
5948
Ronald Cron977c2472020-10-13 08:32:21 +02005949 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305950 * storage ( thus not in the case of generating a key in a secure element
5951 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5952 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005953 if( slot->key.data == NULL )
5954 {
5955 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5956 PSA_KEY_LOCATION_LOCAL_STORAGE )
5957 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005958 status = psa_validate_key_type_and_size_for_key_generation(
5959 attributes->core.type, attributes->core.bits );
5960 if( status != PSA_SUCCESS )
5961 goto exit;
5962
5963 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5964 attributes->core.type,
5965 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005966 }
5967 else
5968 {
5969 status = psa_driver_wrapper_get_key_buffer_size(
5970 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005971 if( status != PSA_SUCCESS )
5972 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005973 }
Ronald Cron977c2472020-10-13 08:32:21 +02005974
5975 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5976 if( status != PSA_SUCCESS )
5977 goto exit;
5978 }
5979
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005980 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005981 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005982
Ronald Cron2b56bc82020-10-05 10:02:26 +02005983 if( status != PSA_SUCCESS )
5984 psa_remove_key_data_from_memory( slot );
5985
Gilles Peskine11792082019-08-06 18:36:36 +02005986exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005987 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005988 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005989 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005990 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005991
Darryl Green0c6575a2018-11-07 16:05:30 +00005992 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005993}
5994
Gilles Peskinee59236f2018-01-27 23:32:46 +01005995/****************************************************************/
5996/* Module setup */
5997/****************************************************************/
5998
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005999#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006000psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6001 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6002 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6003{
6004 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6005 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006006 global_data.rng.entropy_init = entropy_init;
6007 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006008 return( PSA_SUCCESS );
6009}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006010#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006011
Gilles Peskinee59236f2018-01-27 23:32:46 +01006012void mbedtls_psa_crypto_free( void )
6013{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006014 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006015 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6016 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006017 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006018 }
6019 /* Wipe all remaining data, including configuration.
6020 * In particular, this sets all state indicator to the value
6021 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006022 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Ronald Cron9ba76912021-04-10 16:57:30 +02006023
6024 /* Terminate drivers */
6025 psa_driver_wrapper_free( );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006026}
6027
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006028#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6029/** Recover a transaction that was interrupted by a power failure.
6030 *
6031 * This function is called during initialization, before psa_crypto_init()
6032 * returns. If this function returns a failure status, the initialization
6033 * fails.
6034 */
6035static psa_status_t psa_crypto_recover_transaction(
6036 const psa_crypto_transaction_t *transaction )
6037{
6038 switch( transaction->unknown.type )
6039 {
6040 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6041 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006042 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006043 * is implemented.
6044 * https://github.com/ARMmbed/mbed-crypto/issues/218
6045 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006046 default:
6047 /* We found an unsupported transaction in the storage.
6048 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006049 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006050 }
6051}
6052#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6053
Gilles Peskinee59236f2018-01-27 23:32:46 +01006054psa_status_t psa_crypto_init( void )
6055{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006056 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006057
Gilles Peskinec6b69072018-11-20 21:42:52 +01006058 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006059 if( global_data.initialized != 0 )
6060 return( PSA_SUCCESS );
6061
Gilles Peskine30524eb2020-11-13 17:02:26 +01006062 /* Initialize and seed the random generator. */
6063 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006064 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006065 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006066 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006067 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006068 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006069
Gilles Peskine66fb1262018-12-10 16:29:04 +01006070 status = psa_initialize_key_slots( );
6071 if( status != PSA_SUCCESS )
6072 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006073
Ronald Cron9ba76912021-04-10 16:57:30 +02006074 /* Init drivers */
6075 status = psa_driver_wrapper_init( );
Gilles Peskined9348f22019-10-01 15:22:29 +02006076 if( status != PSA_SUCCESS )
6077 goto exit;
Gilles Peskined9348f22019-10-01 15:22:29 +02006078
Gilles Peskine4b734222019-07-24 15:56:31 +02006079#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006080 status = psa_crypto_load_transaction( );
6081 if( status == PSA_SUCCESS )
6082 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006083 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6084 if( status != PSA_SUCCESS )
6085 goto exit;
6086 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006087 }
6088 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6089 {
6090 /* There's no transaction to complete. It's all good. */
6091 status = PSA_SUCCESS;
6092 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006093#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006094
Gilles Peskinec6b69072018-11-20 21:42:52 +01006095 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006096 global_data.initialized = 1;
6097
6098exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006099 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006100 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006101 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006102}
6103
6104#endif /* MBEDTLS_PSA_CRYPTO_C */