blob: 25560854a7924653f9626ea0514821223a1bd70d [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
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 Durkop07cc04a2020-11-16 22:08:34 -0800327/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
328 * current test driver in key_management.c is using this function
329 * when accelerators are used for ECC key pair and public key.
330 * Once that dependency is resolved these guards can be removed.
331 */
John Durkop9814fa22020-11-04 12:28:15 -0800332#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800333 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
334 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
335 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100336mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100337 size_t bits,
338 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200339{
340 switch( curve )
341 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100342 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100343 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100344 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100345#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100346 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100347 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100348#endif
349#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100350 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100351 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100352#endif
353#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100354 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100355 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100356#endif
357#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100358 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100359 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100360#endif
361#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100363 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100364 case 528:
365 if( bits_is_sloppy )
366 return( MBEDTLS_ECP_DP_SECP521R1 );
367 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100368#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 }
370 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100371
Paul Elliott8ff510a2020-06-02 17:19:28 +0100372 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100373 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100375#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100382#endif
383#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100384 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100386#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 }
388 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100389
Paul Elliott8ff510a2020-06-02 17:19:28 +0100390 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100393#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 case 256:
397 if( bits_is_sloppy )
398 return( MBEDTLS_ECP_DP_CURVE25519 );
399 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
401#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100402 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100404#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 }
406 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100407
Paul Elliott8ff510a2020-06-02 17:19:28 +0100408 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 }
424 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200425 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100427 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200429}
John Durkop9814fa22020-11-04 12:28:15 -0800430#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800431 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
432 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
433 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200434
Archana4d7ae1d2021-07-07 02:50:22 +0530435psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530436 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437{
438 /* Check that the bit size is acceptable for the key type */
439 switch( type )
440 {
441 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200442 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200443 case PSA_KEY_TYPE_DERIVE:
444 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100445#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446 case PSA_KEY_TYPE_AES:
447 if( bits != 128 && bits != 192 && bits != 256 )
448 return( PSA_ERROR_INVALID_ARGUMENT );
449 break;
450#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100451#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200452 case PSA_KEY_TYPE_CAMELLIA:
453 if( bits != 128 && bits != 192 && bits != 256 )
454 return( PSA_ERROR_INVALID_ARGUMENT );
455 break;
456#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100457#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200458 case PSA_KEY_TYPE_DES:
459 if( bits != 64 && bits != 128 && bits != 192 )
460 return( PSA_ERROR_INVALID_ARGUMENT );
461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200464 case PSA_KEY_TYPE_CHACHA20:
465 if( bits != 256 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200469 default:
470 return( PSA_ERROR_NOT_SUPPORTED );
471 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200472 if( bits % 8 != 0 )
473 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200474
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 return( PSA_SUCCESS );
476}
477
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100478/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100479 *
Steven Cooremancd640932021-03-08 12:00:27 +0100480 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
481 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100482 *
483 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100484 * \param[in] key_type The key type of the key to be used with the
485 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100486 *
487 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100491 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100493 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495{
Steven Cooremancd640932021-03-08 12:00:27 +0100496 if( PSA_ALG_IS_HMAC( algorithm ) )
497 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 if( key_type == PSA_KEY_TYPE_HMAC )
499 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100501
502 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
505 * key. */
506 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
507 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
508 {
509 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
510 * the block length (larger than 1) for block ciphers. */
511 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
512 return( PSA_SUCCESS );
513 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100514 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100515
516 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100517}
518
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200519psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
520 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200521{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100522 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200523 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200524
Ronald Cronea0f8a62020-11-25 17:52:23 +0100525 slot->key.data = mbedtls_calloc( 1, buffer_length );
526 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200527 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200528
Ronald Cronea0f8a62020-11-25 17:52:23 +0100529 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200530 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200531}
532
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200533psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
534 const uint8_t* data,
535 size_t data_length )
536{
537 psa_status_t status = psa_allocate_buffer_to_slot( slot,
538 data_length );
539 if( status != PSA_SUCCESS )
540 return( status );
541
Ronald Cronea0f8a62020-11-25 17:52:23 +0100542 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200543 return( PSA_SUCCESS );
544}
545
Ronald Crona0fe59f2020-11-29 11:14:53 +0100546psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100547 const psa_key_attributes_t *attributes,
548 const uint8_t *data, size_t data_length,
549 uint8_t *key_buffer, size_t key_buffer_size,
550 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100551{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
553 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100554
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200555 /* zero-length keys are never supported. */
556 if( data_length == 0 )
557 return( PSA_ERROR_NOT_SUPPORTED );
558
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100559 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100560 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100561 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200562
Archana449608b2021-09-08 15:36:05 +0530563 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
564 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200565 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200566 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200567
Ronald Crondd04d422020-11-28 15:14:42 +0100568 /* Copy the key material. */
569 memcpy( key_buffer, data, data_length );
570 *key_buffer_length = data_length;
571 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200572
Steven Cooreman40120f62020-10-29 11:42:22 +0100573 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100574 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100575 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200576 {
John Durkop9814fa22020-11-04 12:28:15 -0800577#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
578 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100579 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200580 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100581 return( mbedtls_psa_ecp_import_key( attributes,
582 data, data_length,
583 key_buffer, key_buffer_size,
584 key_buffer_length,
585 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100586 }
John Durkop9814fa22020-11-04 12:28:15 -0800587#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
588 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700589#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
590 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100591 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200592 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 return( mbedtls_psa_rsa_import_key( attributes,
594 data, data_length,
595 key_buffer, key_buffer_size,
596 key_buffer_length,
597 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200598 }
John Durkop9814fa22020-11-04 12:28:15 -0800599#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
600 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100601 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100602
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100603 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100604}
605
Gilles Peskinef603c712019-01-19 13:40:11 +0100606/** Calculate the intersection of two algorithm usage policies.
607 *
608 * Return 0 (which allows no operation) on incompatibility.
609 */
610static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100611 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100612 psa_algorithm_t alg1,
613 psa_algorithm_t alg2 )
614{
Gilles Peskine549ea862019-05-22 11:45:59 +0200615 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 if( alg1 == alg2 )
617 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100618 /* If the policies are from the same hash-and-sign family, check
619 * if one is a wildcard. If so the other has the specific algorithm. */
620 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
621 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
622 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100623 {
Steven Cooreman03488022021-02-18 12:07:20 +0100624 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
625 return( alg2 );
626 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
627 return( alg1 );
628 }
629 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100630 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100631 * restrictive tag length. */
632 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
633 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
634 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
635 {
636 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
637 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100638 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100639
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100640 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100641 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
642 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100643 {
Steven Cooremancd640932021-03-08 12:00:27 +0100644 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
645 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100646 }
647 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100648 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100649 ( alg1_len <= alg2_len ) )
650 {
651 return( alg2 );
652 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100653 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100654 ( alg2_len <= alg1_len ) )
655 {
656 return( alg1 );
657 }
658 }
659 /* If the policies are from the same MAC family, check whether one
660 * of them is a minimum-MAC-length policy. Calculate the most
661 * restrictive tag length. */
662 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
663 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
664 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
665 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100666 /* Validate the combination of key type and algorithm. Since the base
667 * algorithm of alg1 and alg2 are the same, we only need this once. */
668 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100669 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100670
Steven Cooreman31a876d2021-03-03 20:47:40 +0100671 /* Get the (exact or at-least) output lengths for both sides of the
672 * requested intersection. None of the currently supported algorithms
673 * have an output length dependent on the actual key size, so setting it
674 * to a bogus value of 0 is currently OK.
675 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100676 * Note that for at-least-this-length wildcard algorithms, the output
677 * length is set to the shortest allowed length, which allows us to
678 * calculate the most restrictive tag length for the intersection. */
679 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
680 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100681 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100682
Steven Cooremana1d83222021-02-25 10:20:29 +0100683 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100684 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
685 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100686 {
Steven Cooremancd640932021-03-08 12:00:27 +0100687 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100688 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100689
690 /* If only one is an at-least-this-length policy, the intersection would
691 * be the other (fixed-length) policy as long as said fixed length is
692 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100693 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100694 {
Steven Cooremancd640932021-03-08 12:00:27 +0100695 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100696 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100697 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100698 {
Steven Cooremancd640932021-03-08 12:00:27 +0100699 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100700 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100701
Steven Cooremancd640932021-03-08 12:00:27 +0100702 /* If none of them are wildcards, check whether they define the same tag
703 * length. This is still possible here when one is default-length and
704 * the other specific-length. Ensure to always return the
705 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100706 if( alg1_len == alg2_len )
707 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100708 }
709 /* If the policies are incompatible, allow nothing. */
710 return( 0 );
711}
712
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100713static int psa_key_algorithm_permits( psa_key_type_t key_type,
714 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200715 psa_algorithm_t requested_alg )
716{
Gilles Peskine549ea862019-05-22 11:45:59 +0200717 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200718 if( requested_alg == policy_alg )
719 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100720 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
721 * and requested_alg is the same hash-and-sign family with any hash,
722 * then requested_alg is compliant with policy_alg. */
723 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
724 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200725 {
Steven Cooreman03488022021-02-18 12:07:20 +0100726 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
727 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
728 }
729 /* If policy_alg is a wildcard AEAD algorithm of the same base as
730 * the requested algorithm, check the requested tag length to be
731 * equal-length or longer than the wildcard-specified length. */
732 if( PSA_ALG_IS_AEAD( policy_alg ) &&
733 PSA_ALG_IS_AEAD( requested_alg ) &&
734 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
735 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100736 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100737 {
738 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
739 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
740 }
Steven Cooremancd640932021-03-08 12:00:27 +0100741 /* If policy_alg is a MAC algorithm of the same base as the requested
742 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100743 if( PSA_ALG_IS_MAC( policy_alg ) &&
744 PSA_ALG_IS_MAC( requested_alg ) &&
745 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100746 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100747 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100748 /* Validate the combination of key type and algorithm. Since the policy
749 * and requested algorithms are the same, we only need this once. */
750 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100751 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100752
Steven Cooreman31a876d2021-03-03 20:47:40 +0100753 /* Get both the requested output length for the algorithm which is to be
754 * verified, and the default output length for the base algorithm.
755 * Note that none of the currently supported algorithms have an output
756 * length dependent on actual key size, so setting it to a bogus value
757 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100758 size_t requested_output_length = PSA_MAC_LENGTH(
759 key_type, 0, requested_alg );
760 size_t default_output_length = PSA_MAC_LENGTH(
761 key_type, 0,
762 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100763
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100764 /* If the policy is default-length, only allow an algorithm with
765 * a declared exact-length matching the default. */
766 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100767 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768
769 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100770 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100771 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
772 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
773 {
774 return( 1 );
775 }
776
Steven Cooremancd640932021-03-08 12:00:27 +0100777 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
778 * check for the requested MAC length to be equal to or longer than the
779 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100780 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
781 {
782 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100783 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200785 }
Steven Cooremance48e852020-10-05 16:02:45 +0200786 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200787 * a key derivation with that key agreement should also be allowed. This
788 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200789 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
790 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
791 {
792 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
793 policy_alg );
794 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100795 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200796 return( 0 );
797}
798
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100799/** Test whether a policy permits an algorithm.
800 *
801 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100802 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100803 * \note This function requires providing the key type for which the policy is
804 * being validated, since some algorithm policy definitions (e.g. MAC)
805 * have different properties depending on what kind of cipher it is
806 * combined with.
807 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100808 * \retval PSA_SUCCESS When \p alg is a specific algorithm
809 * allowed by the \p policy.
810 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
811 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
812 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100813 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100815 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100816 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100817{
Steven Cooremand788fab2021-02-25 11:29:17 +0100818 /* '0' is not a valid algorithm */
819 if( alg == 0 )
820 return( PSA_ERROR_INVALID_ARGUMENT );
821
Steven Cooreman7e39f052021-02-23 14:18:32 +0100822 /* A requested algorithm cannot be a wildcard. */
823 if( PSA_ALG_IS_WILDCARD( alg ) )
824 return( PSA_ERROR_INVALID_ARGUMENT );
825
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100826 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
827 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828 return( PSA_SUCCESS );
829 else
830 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831}
832
Gilles Peskinef603c712019-01-19 13:40:11 +0100833/** Restrict a key policy based on a constraint.
834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being restricted, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100840 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100841 * \param[in,out] policy The policy to restrict.
842 * \param[in] constraint The policy constraint to apply.
843 *
844 * \retval #PSA_SUCCESS
845 * \c *policy contains the intersection of the original value of
846 * \c *policy and \c *constraint.
847 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100848 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100849 * \c *policy is unchanged.
850 */
851static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 psa_key_policy_t *policy,
854 const psa_key_policy_t *constraint )
855{
856 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100857 psa_key_policy_algorithm_intersection( key_type, policy->alg,
858 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200859 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100860 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
861 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100862 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
863 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200864 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
865 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 policy->usage &= constraint->usage;
867 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200868 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100869 return( PSA_SUCCESS );
870}
871
Ronald Cron5c522922020-11-14 16:35:34 +0100872/** Get the description of a key given its identifier and policy constraints
873 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200874 *
Ronald Cron5c522922020-11-14 16:35:34 +0100875 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100876 * nonzero, the key must allow operations with this algorithm. If \p alg is
877 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100878 *
Ronald Cron5c522922020-11-14 16:35:34 +0100879 * In case of a persistent key, the function loads the description of the key
880 * into a key slot if not already done.
881 *
882 * On success, the returned key slot is locked. It is the responsibility of
883 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200884 */
Ronald Cron5c522922020-11-14 16:35:34 +0100885static psa_status_t psa_get_and_lock_key_slot_with_policy(
886 mbedtls_svc_key_id_t key,
887 psa_key_slot_t **p_slot,
888 psa_key_usage_t usage,
889 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100890{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200891 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
892 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100893
Ronald Cron5c522922020-11-14 16:35:34 +0100894 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100895 if( status != PSA_SUCCESS )
896 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100898
899 /* Enforce that usage policy for the key slot contains all the flags
900 * required by the usage parameter. There is one exception: public
901 * keys can always be exported, so we treat public key objects as
902 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200903 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100904 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200905
Gilles Peskine8e338702019-07-30 20:06:31 +0200906 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100907 {
908 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100910 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100911
912 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100913 if( alg != 0 )
914 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100915 status = psa_key_policy_permits( &slot->attr.policy,
916 slot->attr.type,
917 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100918 if( status != PSA_SUCCESS )
919 goto error;
920 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100921
Darryl Green06fd18d2018-07-16 11:21:11 +0100922 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200923
924error:
925 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100926 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100929}
Darryl Green940d72c2018-07-13 13:18:51 +0100930
Ronald Cron5c522922020-11-14 16:35:34 +0100931/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200932 *
933 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200934 * available, as opposed to a key in a secure element and/or to be used
935 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200937 * This is a temporary function that may be used instead of
938 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
939 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940 *
Ronald Cron5c522922020-11-14 16:35:34 +0100941 * On success, the returned key slot is locked. It is the responsibility of the
942 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200943 */
Ronald Cron5c522922020-11-14 16:35:34 +0100944static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
945 mbedtls_svc_key_id_t key,
946 psa_key_slot_t **p_slot,
947 psa_key_usage_t usage,
948 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200949{
Ronald Cron5c522922020-11-14 16:35:34 +0100950 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
951 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200952 if( status != PSA_SUCCESS )
953 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200954
Ronald Cronddae0f52021-08-24 15:39:44 +0200955 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 {
Ronald Cron5c522922020-11-14 16:35:34 +0100957 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200958 *p_slot = NULL;
959 return( PSA_ERROR_NOT_SUPPORTED );
960 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200961
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 return( PSA_SUCCESS );
963}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200965psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000966{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100967 /* Data pointer will always be either a valid pointer or NULL in an
968 * initialized slot, so we can just free it. */
969 if( slot->key.data != NULL )
970 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
971
972 mbedtls_free( slot->key.data );
973 slot->key.data = NULL;
974 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000975
976 return( PSA_SUCCESS );
977}
978
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100979/** Completely wipe a slot in memory, including its policy.
980 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100981psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100982{
983 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100984
TRodziewicz18cddc02021-07-13 12:19:15 +0200985 /*
986 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200987 * do our best to report an unexpected lock counter. Assert with
988 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
989 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
990 * function is called as part of the execution of a test suite, the
991 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200992 */
Ronald Cron5c522922020-11-14 16:35:34 +0100993 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100994 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200995 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100996 status = PSA_ERROR_CORRUPTION_DETECTED;
997 }
998
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200999 /* Multipart operations may still be using the key. This is safe
1000 * because all multipart operation objects are independent from
1001 * the key slot: if they need to access the key after the setup
1002 * phase, they have a copy of the key. Note that this means that
1003 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001004 /* At this point, key material and other type-specific content has
1005 * been wiped. Clear remaining metadata. We can call memset and not
1006 * zeroize because the metadata is not particularly sensitive. */
1007 memset( slot, 0, sizeof( *slot ) );
1008 return( status );
1009}
1010
Ronald Croncf56a0a2020-08-04 09:51:30 +02001011psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001012{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001013 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001014 psa_status_t status; /* status of the last operation */
1015 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001016#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1017 psa_se_drv_table_entry_t *driver;
1018#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001019
Ronald Croncf56a0a2020-08-04 09:51:30 +02001020 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001021 return( PSA_SUCCESS );
1022
Ronald Cronf2911112020-10-29 17:51:10 +01001023 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001024 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001025 * key, this will load the key description from persistent memory if not
1026 * done yet. We cannot avoid this loading as without it we don't know if
1027 * the key is operated by an SE or not and this information is needed by
1028 * the current implementation.
1029 */
Ronald Cron5c522922020-11-14 16:35:34 +01001030 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001031 if( status != PSA_SUCCESS )
1032 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001033
Ronald Cronf2911112020-10-29 17:51:10 +01001034 /*
1035 * If the key slot containing the key description is under access by the
1036 * library (apart from the present access), the key cannot be destroyed
1037 * yet. For the time being, just return in error. Eventually (to be
1038 * implemented), the key should be destroyed when all accesses have
1039 * stopped.
1040 */
Ronald Cron5c522922020-11-14 16:35:34 +01001041 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001042 {
Ronald Cron5c522922020-11-14 16:35:34 +01001043 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001044 return( PSA_ERROR_GENERIC_ERROR );
1045 }
1046
Gilles Peskine6687cd02021-04-21 22:32:05 +02001047 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1048 {
1049 /* Refuse the destruction of a read-only key (which may or may not work
1050 * if we attempt it, depending on whether the key is merely read-only
1051 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001052 * Just do the best we can, which is to wipe the copy in memory
1053 * (done in this function's cleanup code). */
1054 overall_status = PSA_ERROR_NOT_PERMITTED;
1055 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001056 }
1057
Gilles Peskine354f7672019-07-12 23:46:38 +02001058#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001059 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001060 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001061 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001062 /* For a key in a secure element, we need to do three things:
1063 * remove the key file in internal storage, destroy the
1064 * key inside the secure element, and update the driver's
1065 * persistent data. Start a transaction that will encompass these
1066 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001067 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001068 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001069 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001070 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001071 status = psa_crypto_save_transaction( );
1072 if( status != PSA_SUCCESS )
1073 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001074 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001075 /* We should still try to destroy the key in the secure
1076 * element and the key metadata in storage. This is especially
1077 * important if the error is that the storage is full.
1078 * But how to do it exactly without risking an inconsistent
1079 * state after a reset?
1080 * https://github.com/ARMmbed/mbed-crypto/issues/215
1081 */
1082 overall_status = status;
1083 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 }
1085
Ronald Cronea0f8a62020-11-25 17:52:23 +01001086 status = psa_destroy_se_key( driver,
1087 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001088 if( overall_status == PSA_SUCCESS )
1089 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001090 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001091#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1092
Darryl Greend49a4992018-06-18 17:27:26 +01001093#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001094 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001095 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001096 status = psa_destroy_persistent_key( slot->attr.id );
1097 if( overall_status == PSA_SUCCESS )
1098 overall_status = status;
1099
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001100 /* TODO: other slots may have a copy of the same key. We should
1101 * invalidate them.
1102 * https://github.com/ARMmbed/mbed-crypto/issues/214
1103 */
Darryl Greend49a4992018-06-18 17:27:26 +01001104 }
1105#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001106
Gilles Peskinefc762652019-07-22 19:30:34 +02001107#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1108 if( driver != NULL )
1109 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001110 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001111 if( overall_status == PSA_SUCCESS )
1112 overall_status = status;
1113 status = psa_crypto_stop_transaction( );
1114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001116 }
1117#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1118
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001119exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001120 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001121 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001122 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123 overall_status = status;
1124 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001125}
1126
John Durkop07cc04a2020-11-16 22:08:34 -08001127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001128 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001129static psa_status_t psa_get_rsa_public_exponent(
1130 const mbedtls_rsa_context *rsa,
1131 psa_key_attributes_t *attributes )
1132{
1133 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001135 uint8_t *buffer = NULL;
1136 size_t buflen;
1137 mbedtls_mpi_init( &mpi );
1138
1139 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1140 if( ret != 0 )
1141 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001142 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1143 {
1144 /* It's the default value, which is reported as an empty string,
1145 * so there's nothing to do. */
1146 goto exit;
1147 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001148
1149 buflen = mbedtls_mpi_size( &mpi );
1150 buffer = mbedtls_calloc( 1, buflen );
1151 if( buffer == NULL )
1152 {
1153 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1154 goto exit;
1155 }
1156 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1157 if( ret != 0 )
1158 goto exit;
1159 attributes->domain_parameters = buffer;
1160 attributes->domain_parameters_size = buflen;
1161
1162exit:
1163 mbedtls_mpi_free( &mpi );
1164 if( ret != 0 )
1165 mbedtls_free( buffer );
1166 return( mbedtls_to_psa_error( ret ) );
1167}
John Durkop07cc04a2020-11-16 22:08:34 -08001168#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001169 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001170
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001171/** Retrieve all the publicly-accessible attributes of a key.
1172 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001173psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001174 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001175{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001176 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001177 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001178 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001180 psa_reset_key_attributes( attributes );
1181
Ronald Cron5c522922020-11-14 16:35:34 +01001182 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001183 if( status != PSA_SUCCESS )
1184 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001185
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001186 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001187 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1188 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1189
1190#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001191 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001192 psa_set_key_slot_number( attributes,
1193 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001194#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001195
Gilles Peskine8e338702019-07-30 20:06:31 +02001196 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001197 {
John Durkop07cc04a2020-11-16 22:08:34 -08001198#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001199 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001200 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001201 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001202 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001203 * is not yet implemented.
1204 * https://github.com/ARMmbed/mbed-crypto/issues/216
1205 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001206 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001207 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001208 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001209
Ronald Cron90857082020-11-25 14:58:33 +01001210 status = mbedtls_psa_rsa_load_representation(
1211 slot->attr.type,
1212 slot->key.data,
1213 slot->key.bytes,
1214 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001215 if( status != PSA_SUCCESS )
1216 break;
1217
Steven Cooremana2371e52020-07-28 14:30:39 +02001218 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001220 mbedtls_rsa_free( rsa );
1221 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001222 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001224#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001225 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001226 default:
1227 /* Nothing else to do. */
1228 break;
1229 }
1230
1231 if( status != PSA_SUCCESS )
1232 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001233
Ronald Cron5c522922020-11-14 16:35:34 +01001234 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001235
Ronald Cron5c522922020-11-14 16:35:34 +01001236 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001237}
1238
Gilles Peskinec8000c02019-08-02 20:15:51 +02001239#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1240psa_status_t psa_get_key_slot_number(
1241 const psa_key_attributes_t *attributes,
1242 psa_key_slot_number_t *slot_number )
1243{
1244 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1245 {
1246 *slot_number = attributes->slot_number;
1247 return( PSA_SUCCESS );
1248 }
1249 else
1250 return( PSA_ERROR_INVALID_ARGUMENT );
1251}
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1253
Ronald Crond18b5f82020-11-25 16:46:05 +01001254static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1255 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001256 uint8_t *data,
1257 size_t data_size,
1258 size_t *data_length )
1259{
Ronald Crond18b5f82020-11-25 16:46:05 +01001260 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001261 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001262 memcpy( data, key_buffer, key_buffer_size );
1263 memset( data + key_buffer_size, 0,
1264 data_size - key_buffer_size );
1265 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001266 return( PSA_SUCCESS );
1267}
1268
Ronald Cron7285cda2020-11-26 14:46:37 +01001269psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001270 const psa_key_attributes_t *attributes,
1271 const uint8_t *key_buffer, size_t key_buffer_size,
1272 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001273{
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 psa_key_type_t type = attributes->core.type;
1275
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 if( key_type_is_raw_bytes( type ) ||
1277 PSA_KEY_TYPE_IS_RSA( type ) ||
1278 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001279 {
1280 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001281 key_buffer, key_buffer_size,
1282 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001283 }
1284 else
1285 {
1286 /* This shouldn't happen in the reference implementation, but
1287 it is valid for a special-purpose implementation to omit
1288 support for exporting certain key types. */
1289 return( PSA_ERROR_NOT_SUPPORTED );
1290 }
1291}
1292
1293psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1294 uint8_t *data,
1295 size_t data_size,
1296 size_t *data_length )
1297{
1298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1299 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1300 psa_key_slot_t *slot;
1301
Ronald Crone907e552021-01-18 13:22:38 +01001302 /* Reject a zero-length output buffer now, since this can never be a
1303 * valid key representation. This way we know that data must be a valid
1304 * pointer and we can do things like memset(data, ..., data_size). */
1305 if( data_size == 0 )
1306 return( PSA_ERROR_BUFFER_TOO_SMALL );
1307
Ronald Cron9486f9d2020-11-26 13:36:23 +01001308 /* Set the key to empty now, so that even when there are errors, we always
1309 * set data_length to a value between 0 and data_size. On error, setting
1310 * the key to empty is a good choice because an empty key representation is
1311 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001312 *data_length = 0;
1313
Ronald Cron9486f9d2020-11-26 13:36:23 +01001314 /* Export requires the EXPORT flag. There is an exception for public keys,
1315 * which don't require any flag, but
1316 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1317 */
1318 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1319 PSA_KEY_USAGE_EXPORT, 0 );
1320 if( status != PSA_SUCCESS )
1321 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001322
Ronald Crond18b5f82020-11-25 16:46:05 +01001323 psa_key_attributes_t attributes = {
1324 .core = slot->attr
1325 };
Ronald Cron67227982020-11-26 15:16:05 +01001326 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001327 slot->key.data, slot->key.bytes,
1328 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001329
Ronald Cron9486f9d2020-11-26 13:36:23 +01001330 unlock_status = psa_unlock_key_slot( slot );
1331
1332 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1333}
1334
Ronald Cron7285cda2020-11-26 14:46:37 +01001335psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001336 const psa_key_attributes_t *attributes,
1337 const uint8_t *key_buffer,
1338 size_t key_buffer_size,
1339 uint8_t *data,
1340 size_t data_size,
1341 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342{
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001346 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001348 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001349 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001350 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 key_buffer, key_buffer_size,
1352 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001353 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001354
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001356 {
John Durkop0e005192020-10-31 22:06:54 -07001357#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1358 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001359 return( mbedtls_psa_rsa_export_public_key( attributes,
1360 key_buffer,
1361 key_buffer_size,
1362 data,
1363 data_size,
1364 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001365#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001366 /* We don't know how to convert a private RSA key to public. */
1367 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001368#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1369 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001370 }
1371 else
Moran Pekera998bc62018-04-16 18:16:20 +03001372 {
John Durkop6ba40d12020-11-10 08:50:04 -08001373#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001375 return( mbedtls_psa_ecp_export_public_key( attributes,
1376 key_buffer,
1377 key_buffer_size,
1378 data,
1379 data_size,
1380 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001381#else
1382 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001383 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001384#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1385 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001386 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001387 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001388 else
1389 {
1390 /* This shouldn't happen in the reference implementation, but
1391 it is valid for a special-purpose implementation to omit
1392 support for exporting certain key types. */
1393 return( PSA_ERROR_NOT_SUPPORTED );
1394 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001395}
Ronald Crond18b5f82020-11-25 16:46:05 +01001396
Ronald Croncf56a0a2020-08-04 09:51:30 +02001397psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001398 uint8_t *data,
1399 size_t data_size,
1400 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001401{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001403 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001404 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001405
Ronald Crone907e552021-01-18 13:22:38 +01001406 /* Reject a zero-length output buffer now, since this can never be a
1407 * valid key representation. This way we know that data must be a valid
1408 * pointer and we can do things like memset(data, ..., data_size). */
1409 if( data_size == 0 )
1410 return( PSA_ERROR_BUFFER_TOO_SMALL );
1411
Darryl Greendd8fb772018-11-07 16:00:44 +00001412 /* Set the key to empty now, so that even when there are errors, we always
1413 * set data_length to a value between 0 and data_size. On error, setting
1414 * the key to empty is a good choice because an empty key representation is
1415 * unlikely to be accepted anywhere. */
1416 *data_length = 0;
1417
1418 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001419 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001420 if( status != PSA_SUCCESS )
1421 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001422
Ronald Cron9486f9d2020-11-26 13:36:23 +01001423 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1424 {
1425 status = PSA_ERROR_INVALID_ARGUMENT;
1426 goto exit;
1427 }
1428
Ronald Crond18b5f82020-11-25 16:46:05 +01001429 psa_key_attributes_t attributes = {
1430 .core = slot->attr
1431 };
Ronald Cron67227982020-11-26 15:16:05 +01001432 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 &attributes, slot->key.data, slot->key.bytes,
1434 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001435
1436exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001437 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001438
Ronald Cron5c522922020-11-14 16:35:34 +01001439 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001440}
1441
Gilles Peskine91e8c332019-08-02 19:19:39 +02001442#if defined(static_assert)
1443static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1444 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001445static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001446 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001447static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001448 "One or more key attribute flag is listed as both internal-only and external-only" );
1449#endif
1450
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001451/** Validate that a key policy is internally well-formed.
1452 *
1453 * This function only rejects invalid policies. It does not validate the
1454 * consistency of the policy with respect to other attributes of the key
1455 * such as the key type.
1456 */
1457static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001458{
1459 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001460 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001461 PSA_KEY_USAGE_ENCRYPT |
1462 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001463 PSA_KEY_USAGE_SIGN_MESSAGE |
1464 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001465 PSA_KEY_USAGE_SIGN_HASH |
1466 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001467 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001468 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1469 return( PSA_ERROR_INVALID_ARGUMENT );
1470
Gilles Peskine4747d192019-04-17 15:05:45 +02001471 return( PSA_SUCCESS );
1472}
1473
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001474/** Validate the internal consistency of key attributes.
1475 *
1476 * This function only rejects invalid attribute values. If does not
1477 * validate the consistency of the attributes with any key data that may
1478 * be involved in the creation of the key.
1479 *
1480 * Call this function early in the key creation process.
1481 *
1482 * \param[in] attributes Key attributes for the new key.
1483 * \param[out] p_drv On any return, the driver for the key, if any.
1484 * NULL for a transparent key.
1485 *
1486 */
1487static psa_status_t psa_validate_key_attributes(
1488 const psa_key_attributes_t *attributes,
1489 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001490{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001491 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001492 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001493 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001494
Ronald Cron54b90082020-10-29 15:26:43 +01001495 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001496 if( status != PSA_SUCCESS )
1497 return( status );
1498
Ronald Crond2ed4812020-07-17 16:11:30 +02001499 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001500 if( status != PSA_SUCCESS )
1501 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001502
Ronald Cron65f38a32020-10-23 17:11:13 +02001503 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1504 {
1505 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1506 return( PSA_ERROR_INVALID_ARGUMENT );
1507 }
1508 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001509 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001510 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1511 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 }
1513
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001515 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516 return( status );
1517
1518 /* Refuse to create overly large keys.
1519 * Note that this doesn't trigger on import if the attributes don't
1520 * explicitly specify a size (so psa_get_key_bits returns 0), so
1521 * psa_import_key() needs its own checks. */
1522 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1523 return( PSA_ERROR_NOT_SUPPORTED );
1524
Gilles Peskine91e8c332019-08-02 19:19:39 +02001525 /* Reject invalid flags. These should not be reachable through the API. */
1526 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1527 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1528 return( PSA_ERROR_INVALID_ARGUMENT );
1529
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001530 return( PSA_SUCCESS );
1531}
1532
Gilles Peskine4747d192019-04-17 15:05:45 +02001533/** Prepare a key slot to receive key material.
1534 *
1535 * This function allocates a key slot and sets its metadata.
1536 *
1537 * If this function fails, call psa_fail_key_creation().
1538 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001539 * This function is intended to be used as follows:
1540 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001541 * it with the specified attributes, and in case of a volatile key assign it
1542 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001543 * -# Populate the slot with the key material.
1544 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1545 * In case of failure at any step, stop the sequence and call
1546 * psa_fail_key_creation().
1547 *
Ronald Cron5c522922020-11-14 16:35:34 +01001548 * On success, the key slot is locked. It is the responsibility of the caller
1549 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001550 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001551 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001552 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001553 * \param[out] p_slot On success, a pointer to the prepared slot.
1554 * \param[out] p_drv On any return, the driver for the key, if any.
1555 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001556 *
1557 * \retval #PSA_SUCCESS
1558 * The key slot is ready to receive key material.
1559 * \return If this function fails, the key slot is an invalid state.
1560 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001561 */
1562static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001563 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001564 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001565 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001566 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001567{
1568 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001569 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001570 psa_key_slot_t *slot;
1571
Gilles Peskinedf179142019-07-15 22:02:14 +02001572 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001573 *p_drv = NULL;
1574
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001575 status = psa_validate_key_attributes( attributes, p_drv );
1576 if( status != PSA_SUCCESS )
1577 return( status );
1578
Ronald Cronc4d1b512020-07-31 11:26:37 +02001579 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001580 if( status != PSA_SUCCESS )
1581 return( status );
1582 slot = *p_slot;
1583
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001584 /* We're storing the declared bit-size of the key. It's up to each
1585 * creation mechanism to verify that this information is correct.
1586 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001587 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001588 * is optional (import, copy). In case of a volatile key, assign it the
1589 * volatile key identifier associated to the slot returned to contain its
1590 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001591
1592 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001593 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1594 {
1595#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1596 slot->attr.id = volatile_key_id;
1597#else
1598 slot->attr.id.key_id = volatile_key_id;
1599#endif
1600 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001601
Gilles Peskine91e8c332019-08-02 19:19:39 +02001602 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001603 * external-only flags, query `attributes`. Thanks to the check
1604 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001605 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001606 * may have set. */
1607 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001608
Gilles Peskinecbaff462019-07-12 23:46:04 +02001609#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001610 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001611 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001612 * create the key file in internal storage, create the
1613 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001614 * persistent data. This is done by starting a transaction that will
1615 * encompass these three actions.
1616 * For registering a volatile key, we just need to find an appropriate
1617 * slot number inside the SE. Since the key is designated volatile, creating
1618 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001619 /* The first thing to do is to find a slot number for the new key.
1620 * We save the slot number in persistent storage as part of the
1621 * transaction data. It will be needed to recover if the power
1622 * fails during the key creation process, to clean up on the secure
1623 * element side after restarting. Obtaining a slot number from the
1624 * secure element driver updates its persistent state, but we do not yet
1625 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001626 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001627 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001628 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001629 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001630 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001631 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001632 if( status != PSA_SUCCESS )
1633 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001634
1635 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001636 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001637 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1638 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001639 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640 psa_crypto_transaction.key.id = slot->attr.id;
1641 status = psa_crypto_save_transaction( );
1642 if( status != PSA_SUCCESS )
1643 {
1644 (void) psa_crypto_stop_transaction( );
1645 return( status );
1646 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001647 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001648
1649 status = psa_copy_key_material_into_slot(
1650 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001651 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001652
1653 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1654 {
1655 /* Key registration only makes sense with a secure element. */
1656 return( PSA_ERROR_INVALID_ARGUMENT );
1657 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001658#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1659
Ronald Cronc4d1b512020-07-31 11:26:37 +02001660 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001661}
Gilles Peskine4747d192019-04-17 15:05:45 +02001662
1663/** Finalize the creation of a key once its key material has been set.
1664 *
1665 * This entails writing the key to persistent storage.
1666 *
1667 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001668 * See the documentation of psa_start_key_creation() for the intended use
1669 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001670 *
Ronald Cron5c522922020-11-14 16:35:34 +01001671 * If the finalization succeeds, the function unlocks the key slot (it was
1672 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1673 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001674 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001675 * \param[in,out] slot Pointer to the slot with key material.
1676 * \param[in] driver The secure element driver for the key,
1677 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001678 * \param[out] key On success, identifier of the key. Note that the
1679 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001680 *
1681 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001682 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001683 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1684 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1685 * \retval #PSA_ERROR_ALREADY_EXISTS
1686 * \retval #PSA_ERROR_DATA_INVALID
1687 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001688 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001689 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001690 * \return If this function fails, the key slot is an invalid state.
1691 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001693static psa_status_t psa_finish_key_creation(
1694 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001695 psa_se_drv_table_entry_t *driver,
1696 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001697{
1698 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001699 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001700 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001701
1702#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001703 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001704 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001705#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1706 if( driver != NULL )
1707 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001708 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001709 psa_key_slot_number_t slot_number =
1710 psa_key_slot_get_slot_number( slot ) ;
1711
Gilles Peskineb46bef22019-07-30 21:32:04 +02001712#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001713 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714 sizeof( data.slot_number ),
1715 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001716#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001717 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001718 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001719 (uint8_t*) &data,
1720 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001721 }
1722 else
1723#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1724 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001725 /* Key material is saved in export representation in the slot, so
1726 * just pass the slot buffer for storage. */
1727 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001728 slot->key.data,
1729 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001730 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001731 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001732#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1733
Gilles Peskinecbaff462019-07-12 23:46:04 +02001734#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001735 /* Finish the transaction for a key creation. This does not
1736 * happen when registering an existing key. Detect this case
1737 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001738 * creation of a persistent key in a secure element requires a transaction,
1739 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001740 if( driver != NULL &&
1741 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001742 {
1743 status = psa_save_se_persistent_data( driver );
1744 if( status != PSA_SUCCESS )
1745 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001746 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747 return( status );
1748 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001749 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001750 }
1751#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1752
Ronald Cron50972942020-11-14 11:28:25 +01001753 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001754 {
1755 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001756 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001757 if( status != PSA_SUCCESS )
1758 *key = MBEDTLS_SVC_KEY_ID_INIT;
1759 }
Ronald Cron50972942020-11-14 11:28:25 +01001760
Gilles Peskine4747d192019-04-17 15:05:45 +02001761 return( status );
1762}
1763
1764/** Abort the creation of a key.
1765 *
1766 * You may call this function after calling psa_start_key_creation(),
1767 * or after psa_finish_key_creation() fails. In other circumstances, this
1768 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001769 * See the documentation of psa_start_key_creation() for the intended use
1770 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001771 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001772 * \param[in,out] slot Pointer to the slot with key material.
1773 * \param[in] driver The secure element driver for the key,
1774 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001776static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001777 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001778{
Gilles Peskine011e4282019-06-26 18:34:38 +02001779 (void) driver;
1780
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 if( slot == NULL )
1782 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001783
1784#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001785 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001786 * element, and the failure happened later (when saving metadata
1787 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001788 * element.
1789 * https://github.com/ARMmbed/mbed-crypto/issues/217
1790 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001791
Gilles Peskined7729582019-08-05 15:55:54 +02001792 /* Abort the ongoing transaction if any (there may not be one if
1793 * the creation process failed before starting one, or if the
1794 * key creation is a registration of a key in a secure element).
1795 * Earlier functions must already have done what it takes to undo any
1796 * partial creation. All that's left is to update the transaction data
1797 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001798 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001799#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1800
Gilles Peskine4747d192019-04-17 15:05:45 +02001801 psa_wipe_key_slot( slot );
1802}
1803
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001804/** Validate optional attributes during key creation.
1805 *
1806 * Some key attributes are optional during key creation. If they are
1807 * specified in the attributes structure, check that they are consistent
1808 * with the data in the slot.
1809 *
1810 * This function should be called near the end of key creation, after
1811 * the slot in memory is fully populated but before saving persistent data.
1812 */
1813static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001814 const psa_key_slot_t *slot,
1815 const psa_key_attributes_t *attributes )
1816{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001817 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001818 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001819 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001820 return( PSA_ERROR_INVALID_ARGUMENT );
1821 }
1822
1823 if( attributes->domain_parameters_size != 0 )
1824 {
John Durkop0e005192020-10-31 22:06:54 -07001825#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1826 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001827 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001829 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001830 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001832
Ronald Cron90857082020-11-25 14:58:33 +01001833 psa_status_t status = mbedtls_psa_rsa_load_representation(
1834 slot->attr.type,
1835 slot->key.data,
1836 slot->key.bytes,
1837 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001838 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001839 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001840
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 mbedtls_mpi_init( &actual );
1842 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001843 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001845 mbedtls_rsa_free( rsa );
1846 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 if( ret != 0 )
1848 goto rsa_exit;
1849 ret = mbedtls_mpi_read_binary( &required,
1850 attributes->domain_parameters,
1851 attributes->domain_parameters_size );
1852 if( ret != 0 )
1853 goto rsa_exit;
1854 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1855 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1856 rsa_exit:
1857 mbedtls_mpi_free( &actual );
1858 mbedtls_mpi_free( &required );
1859 if( ret != 0)
1860 return( mbedtls_to_psa_error( ret ) );
1861 }
1862 else
John Durkop9814fa22020-11-04 12:28:15 -08001863#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1864 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001865 {
1866 return( PSA_ERROR_INVALID_ARGUMENT );
1867 }
1868 }
1869
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001870 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001872 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001873 return( PSA_ERROR_INVALID_ARGUMENT );
1874 }
1875
1876 return( PSA_SUCCESS );
1877}
1878
Gilles Peskine4747d192019-04-17 15:05:45 +02001879psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001881 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001882 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001883{
1884 psa_status_t status;
1885 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001886 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001887 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301888 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001889
Ronald Cron81709fc2020-11-14 12:10:32 +01001890 *key = MBEDTLS_SVC_KEY_ID_INIT;
1891
Gilles Peskine0f84d622019-09-12 19:03:13 +02001892 /* Reject zero-length symmetric keys (including raw data key objects).
1893 * This also rejects any key which might be encoded as an empty string,
1894 * which is never valid. */
1895 if( data_length == 0 )
1896 return( PSA_ERROR_INVALID_ARGUMENT );
1897
Archana449608b2021-09-08 15:36:05 +05301898 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301899 if( data_length > SIZE_MAX / 8 )
1900 return( PSA_ERROR_NOT_SUPPORTED );
1901
Gilles Peskinedf179142019-07-15 22:02:14 +02001902 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001903 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 if( status != PSA_SUCCESS )
1905 goto exit;
1906
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001907 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301908 * storage ( thus not in the case of importing a key in a secure element
1909 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1910 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001911 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001912 {
Archanad8a83dc2021-06-14 10:04:16 +05301913 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1914 {
Archana449608b2021-09-08 15:36:05 +05301915 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1916 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301917 if( status != PSA_SUCCESS )
1918 goto exit;
1919 }
1920 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001921 if( status != PSA_SUCCESS )
1922 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001923 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001924
1925 bits = slot->attr.bits;
1926 status = psa_driver_wrapper_import_key( attributes,
1927 data, data_length,
1928 slot->key.data,
1929 slot->key.bytes,
1930 &slot->key.bytes, &bits );
1931 if( status != PSA_SUCCESS )
1932 goto exit;
1933
1934 if( slot->attr.bits == 0 )
1935 slot->attr.bits = (psa_key_bits_t) bits;
1936 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001937 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001938 status = PSA_ERROR_INVALID_ARGUMENT;
1939 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001940 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001941
Archana6ed4bda2021-08-04 10:47:15 +05301942 /* Enforce a size limit, and in particular ensure that the bit
1943 * size fits in its representation type.*/
1944 if( bits > PSA_MAX_KEY_BITS )
1945 {
1946 status = PSA_ERROR_NOT_SUPPORTED;
1947 goto exit;
1948 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001949 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001950 if( status != PSA_SUCCESS )
1951 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952
Ronald Cron81709fc2020-11-14 12:10:32 +01001953 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001955 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001956 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001957
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 return( status );
1959}
1960
Gilles Peskined7729582019-08-05 15:55:54 +02001961#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1962psa_status_t mbedtls_psa_register_se_key(
1963 const psa_key_attributes_t *attributes )
1964{
1965 psa_status_t status;
1966 psa_key_slot_t *slot = NULL;
1967 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001968 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001969
1970 /* Leaving attributes unspecified is not currently supported.
1971 * It could make sense to query the key type and size from the
1972 * secure element, but not all secure elements support this
1973 * and the driver HAL doesn't currently support it. */
1974 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1975 return( PSA_ERROR_NOT_SUPPORTED );
1976 if( psa_get_key_bits( attributes ) == 0 )
1977 return( PSA_ERROR_NOT_SUPPORTED );
1978
1979 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001980 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001981 if( status != PSA_SUCCESS )
1982 goto exit;
1983
Ronald Cron81709fc2020-11-14 12:10:32 +01001984 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001985
1986exit:
1987 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001988 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001989
Gilles Peskined7729582019-08-05 15:55:54 +02001990 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001991 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001992 return( status );
1993}
1994#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1995
Ronald Croncf56a0a2020-08-04 09:51:30 +02001996psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001997 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001998 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001999{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002000 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002001 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002002 psa_key_slot_t *source_slot = NULL;
2003 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002004 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002005 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302006 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002007
Ronald Cron81709fc2020-11-14 12:10:32 +01002008 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2009
Archana8a180362021-07-05 02:18:48 +05302010 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002011 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002012 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002013 goto exit;
2014
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002015 status = psa_validate_optional_attributes( source_slot,
2016 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 if( status != PSA_SUCCESS )
2018 goto exit;
2019
Archana9d17bf42021-09-10 06:22:44 +05302020 /* The target key type and number of bits have been validated by
2021 * psa_validate_optional_attributes() to be either equal to zero or
2022 * equal to the ones of the source key. So it is safe to inherit
2023 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302024 * */
Archana9d17bf42021-09-10 06:22:44 +05302025 actual_attributes.core.bits = source_slot->attr.bits;
2026 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302027
2028
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002029 status = psa_restrict_key_policy( source_slot->attr.type,
2030 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002031 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002032 if( status != PSA_SUCCESS )
2033 goto exit;
2034
Ronald Cron81709fc2020-11-14 12:10:32 +01002035 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2036 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002037 if( status != PSA_SUCCESS )
2038 goto exit;
Archana8a180362021-07-05 02:18:48 +05302039 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2040 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002041 {
Archana8a180362021-07-05 02:18:48 +05302042 /*
Archana9d17bf42021-09-10 06:22:44 +05302043 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302044 * the source key would need to be exported as plaintext and re-imported
2045 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302046 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302047 * appropriate API invocations from the application, if needed.
2048 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002049 status = PSA_ERROR_NOT_SUPPORTED;
2050 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002051 }
Archana8a180362021-07-05 02:18:48 +05302052 /*
2053 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302054 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302055 * - For opaque keys this translates to an invocation of the drivers'
2056 * copy_key entry point through the dispatch layer.
2057 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002058 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2059 {
Archana8a180362021-07-05 02:18:48 +05302060 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302061 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302062 if( status != PSA_SUCCESS )
2063 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302064
Archana8a180362021-07-05 02:18:48 +05302065 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2066 if( status != PSA_SUCCESS )
2067 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302068
Archana8a180362021-07-05 02:18:48 +05302069 status = psa_driver_wrapper_copy_key( &actual_attributes,
2070 source_slot->key.data,
2071 source_slot->key.bytes,
2072 target_slot->key.data,
2073 target_slot->key.bytes,
2074 &target_slot->key.bytes );
2075 if( status != PSA_SUCCESS )
2076 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002077 }
Archana8a180362021-07-05 02:18:48 +05302078 else
2079 {
Archana9d17bf42021-09-10 06:22:44 +05302080 status = psa_copy_key_material_into_slot( target_slot,
2081 source_slot->key.data,
2082 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302083 if( status != PSA_SUCCESS )
2084 goto exit;
2085 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002086 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002087exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002088 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002089 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002090
Ronald Cron5c522922020-11-14 16:35:34 +01002091 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002092
Ronald Cron5c522922020-11-14 16:35:34 +01002093 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002094}
2095
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002096
2097
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002098/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002099/* Message digests */
2100/****************************************************************/
2101
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002102psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2103{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002104 /* Aborting a non-active operation is allowed */
2105 if( operation->id == 0 )
2106 return( PSA_SUCCESS );
2107
2108 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2109 operation->id = 0;
2110
2111 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002112}
2113
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002114psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115 psa_algorithm_t alg )
2116{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002117 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002118
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002119 /* A context must be freshly initialized before it can be set up. */
2120 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002121 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002122 status = PSA_ERROR_BAD_STATE;
2123 goto exit;
2124 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002125
2126 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002127 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002128 status = PSA_ERROR_INVALID_ARGUMENT;
2129 goto exit;
2130 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002131
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002132 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2133 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002134 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2135
Dave Rodgman685b6a72021-06-24 11:49:14 +01002136 status = psa_driver_wrapper_hash_setup( operation, alg );
2137
2138exit:
2139 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002140 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002141
2142 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002143}
2144
2145psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2146 const uint8_t *input,
2147 size_t input_length )
2148{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2150
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002151 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002152 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153 status = PSA_ERROR_BAD_STATE;
2154 goto exit;
2155 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002156
Steven Cooremanc8288352021-03-04 14:02:19 +01002157 /* Don't require hash implementations to behave correctly on a
2158 * zero-length input, which may have an invalid pointer. */
2159 if( input_length == 0 )
2160 return( PSA_SUCCESS );
2161
Dave Rodgman685b6a72021-06-24 11:49:14 +01002162 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2163
2164exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002165 if( status != PSA_SUCCESS )
2166 psa_hash_abort( operation );
2167
2168 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169}
2170
2171psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2172 uint8_t *hash,
2173 size_t hash_size,
2174 size_t *hash_length )
2175{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002176 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002177 if( operation->id == 0 )
2178 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002179
Steven Cooreman1e582352021-02-18 17:24:37 +01002180 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002181 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002182 psa_hash_abort( operation );
2183 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002184}
2185
Gilles Peskine2d277862018-06-18 15:41:12 +02002186psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2187 const uint8_t *hash,
2188 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189{
2190 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2191 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002192 psa_status_t status = psa_hash_finish(
2193 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002194 actual_hash, sizeof( actual_hash ),
2195 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002196
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002198 goto exit;
2199
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002201 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202 status = PSA_ERROR_INVALID_SIGNATURE;
2203 goto exit;
2204 }
2205
Steven Cooreman36876a02021-04-29 16:37:59 +02002206 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002207 status = PSA_ERROR_INVALID_SIGNATURE;
2208
2209exit:
2210 if( status != PSA_SUCCESS )
2211 psa_hash_abort(operation);
2212
2213 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214}
2215
Gilles Peskine0a749c82019-11-28 19:33:58 +01002216psa_status_t psa_hash_compute( psa_algorithm_t alg,
2217 const uint8_t *input, size_t input_length,
2218 uint8_t *hash, size_t hash_size,
2219 size_t *hash_length )
2220{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002221 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002222 if( !PSA_ALG_IS_HASH( alg ) )
2223 return( PSA_ERROR_INVALID_ARGUMENT );
2224
Steven Cooreman1e582352021-02-18 17:24:37 +01002225 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2226 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002227}
2228
2229psa_status_t psa_hash_compare( psa_algorithm_t alg,
2230 const uint8_t *input, size_t input_length,
2231 const uint8_t *hash, size_t hash_length )
2232{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002233 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2234 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002235
2236 if( !PSA_ALG_IS_HASH( alg ) )
2237 return( PSA_ERROR_INVALID_ARGUMENT );
2238
Steven Cooreman1e582352021-02-18 17:24:37 +01002239 psa_status_t status = psa_driver_wrapper_hash_compute(
2240 alg, input, input_length,
2241 actual_hash, sizeof(actual_hash),
2242 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002243 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002244 return( status );
2245 if( actual_hash_length != hash_length )
2246 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002247 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002248 return( PSA_ERROR_INVALID_SIGNATURE );
2249 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002250}
2251
Gilles Peskineeb35d782019-01-22 17:56:16 +01002252psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2253 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002254{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002255 if( source_operation->id == 0 ||
2256 target_operation->id != 0 )
2257 {
2258 return( PSA_ERROR_BAD_STATE );
2259 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002260
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002261 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2262 target_operation );
2263 if( status != PSA_SUCCESS )
2264 psa_hash_abort( target_operation );
2265
2266 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002267}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002268
2269
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002271/* MAC */
2272/****************************************************************/
2273
Steven Cooremane6804192021-03-19 18:28:56 +01002274psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002275{
Steven Cooremane6804192021-03-19 18:28:56 +01002276 /* Aborting a non-active operation is allowed */
2277 if( operation->id == 0 )
2278 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002279
Steven Cooremane6804192021-03-19 18:28:56 +01002280 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002281 operation->mac_size = 0;
2282 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002283 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002284
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002285 return( status );
2286}
2287
Ronald Cron2dff3b22021-06-17 16:33:22 +02002288static psa_status_t psa_mac_finalize_alg_and_key_validation(
2289 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002290 const psa_key_attributes_t *attributes,
2291 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002292{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002293 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002294 psa_key_type_t key_type = psa_get_key_type( attributes );
2295 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002296
Ronald Cron28ea0502021-06-17 16:10:24 +02002297 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002298 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002299
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002300 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002302 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002303 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002304
Steven Cooremand1a68f12021-05-10 11:13:41 +02002305 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002306 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002307
Ronald Cron79bdd822021-06-17 16:46:44 +02002308 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002309 {
2310 /* A very short MAC is too short for security since it can be
2311 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2312 * so we make this our minimum, even though 32 bits is still
2313 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002314 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002315 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002316
Ronald Cron79bdd822021-06-17 16:46:44 +02002317 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2318 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002319 {
2320 /* It's impossible to "truncate" to a larger length than the full length
2321 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002322 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002323 }
2324
Ronald Cron79bdd822021-06-17 16:46:44 +02002325 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002326}
2327
Gilles Peskinee59236f2018-01-27 23:32:46 +01002328static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2329 mbedtls_svc_key_id_t key,
2330 psa_algorithm_t alg,
2331 int is_sign )
2332{
2333 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2334 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002335 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002336
2337 /* A context must be freshly initialized before it can be set up. */
2338 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002339 {
Dave Rodgman54648242021-06-24 11:49:45 +01002340 status = PSA_ERROR_BAD_STATE;
2341 goto exit;
2342 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343
2344 status = psa_get_and_lock_key_slot_with_policy(
2345 key,
2346 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002347 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002348 alg );
2349 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002350 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351
2352 psa_key_attributes_t attributes = {
2353 .core = slot->attr
2354 };
2355
Ronald Cron79bdd822021-06-17 16:46:44 +02002356 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2357 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 if( status != PSA_SUCCESS )
2359 goto exit;
2360
2361 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002362 /* Dispatch the MAC setup call with validated input */
2363 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002364 {
Steven Cooremane6804192021-03-19 18:28:56 +01002365 status = psa_driver_wrapper_mac_sign_setup( operation,
2366 &attributes,
2367 slot->key.data,
2368 slot->key.bytes,
2369 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002370 }
2371 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002372 {
Steven Cooremane6804192021-03-19 18:28:56 +01002373 status = psa_driver_wrapper_mac_verify_setup( operation,
2374 &attributes,
2375 slot->key.data,
2376 slot->key.bytes,
2377 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002378 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002379
Gilles Peskinefbfac682018-07-08 20:51:54 +02002380exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002381 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002382 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002383
Ronald Cron5c522922020-11-14 16:35:34 +01002384 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002385
Ronald Cron5c522922020-11-14 16:35:34 +01002386 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002387}
2388
Gilles Peskine89167cb2018-07-08 20:12:23 +02002389psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002390 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002391 psa_algorithm_t alg )
2392{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002393 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002394}
2395
2396psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002397 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002398 psa_algorithm_t alg )
2399{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002400 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002401}
2402
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002403psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002404 const uint8_t *input,
2405 size_t input_length )
2406{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002407 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002408 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002409
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002410 /* Don't require hash implementations to behave correctly on a
2411 * zero-length input, which may have an invalid pointer. */
2412 if( input_length == 0 )
2413 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002414
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002415 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2416 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002417 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002418 psa_mac_abort( operation );
2419
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002420 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002421}
2422
Steven Cooremana5b860a2021-03-19 19:04:39 +01002423psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002424 uint8_t *mac,
2425 size_t mac_size,
2426 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002427{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002428 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2429 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002430
Steven Cooremana5b860a2021-03-19 19:04:39 +01002431 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002432 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002433 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002434 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002435 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002436
Steven Cooreman72f736a2021-05-07 14:14:37 +02002437 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002438 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002439 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002440 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002441 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002442
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002443 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2444 * once all the error checks are done. */
2445 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002446 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002447 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002448 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002449 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002450
2451 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002452 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002453 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002454 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002455 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002456
Steven Cooremana5b860a2021-03-19 19:04:39 +01002457 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002458 mac, operation->mac_size,
2459 mac_length );
2460
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002461exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002462 /* In case of success, set the potential excess room in the output buffer
2463 * to an invalid value, to avoid potentially leaking a longer MAC.
2464 * In case of error, set the output length and content to a safe default,
2465 * such that in case the caller misses an error check, the output would be
2466 * an unachievable MAC.
2467 */
2468 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002469 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002470 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002471 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002472 }
mohammad16036df908f2018-04-02 08:34:15 -07002473
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002474 if( mac_size > operation->mac_size )
2475 memset( &mac[operation->mac_size], '!',
2476 mac_size - operation->mac_size );
2477
Steven Cooremana5b860a2021-03-19 19:04:39 +01002478 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002479
Steven Cooremana5b860a2021-03-19 19:04:39 +01002480 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002481}
2482
Steven Cooremana5b860a2021-03-19 19:04:39 +01002483psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002484 const uint8_t *mac,
2485 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002486{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2488 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002489
Steven Cooremana5b860a2021-03-19 19:04:39 +01002490 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002491 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002492 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002493 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002494 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002495
Steven Cooreman72f736a2021-05-07 14:14:37 +02002496 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002497 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002498 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002499 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002500 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002501
2502 if( operation->mac_size != mac_length )
2503 {
2504 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002505 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002506 }
2507
Steven Cooremana5b860a2021-03-19 19:04:39 +01002508 status = psa_driver_wrapper_mac_verify_finish( operation,
2509 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002510
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002511exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002512 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002513
Steven Cooremana5b860a2021-03-19 19:04:39 +01002514 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515}
2516
Ronald Croncd989b52021-06-18 14:23:33 +02002517static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2518 psa_algorithm_t alg,
2519 const uint8_t *input,
2520 size_t input_length,
2521 uint8_t *mac,
2522 size_t mac_size,
2523 size_t *mac_length,
2524 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002525{
2526 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002527 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2528 psa_key_slot_t *slot;
2529 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530
Ronald Cron51131b52021-06-17 17:17:20 +02002531 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002532 key,
2533 &slot,
2534 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002535 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002536 if( status != PSA_SUCCESS )
2537 goto exit;
2538
Ronald Cron51131b52021-06-17 17:17:20 +02002539 psa_key_attributes_t attributes = {
2540 .core = slot->attr
2541 };
2542
2543 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2544 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002545 if( status != PSA_SUCCESS )
2546 goto exit;
2547
Ronald Cron51131b52021-06-17 17:17:20 +02002548 if( mac_size < operation_mac_size )
2549 {
2550 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002551 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002552 }
2553
2554 status = psa_driver_wrapper_mac_compute(
2555 &attributes,
2556 slot->key.data, slot->key.bytes,
2557 alg,
2558 input, input_length,
2559 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002560
2561exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002562 /* In case of success, set the potential excess room in the output buffer
2563 * to an invalid value, to avoid potentially leaking a longer MAC.
2564 * In case of error, set the output length and content to a safe default,
2565 * such that in case the caller misses an error check, the output would be
2566 * an unachievable MAC.
2567 */
2568 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002569 {
Ronald Cron51131b52021-06-17 17:17:20 +02002570 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002571 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002572 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002573 if( mac_size > operation_mac_size )
2574 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002575
Ronald Cron51131b52021-06-17 17:17:20 +02002576 unlock_status = psa_unlock_key_slot( slot );
2577
2578 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002579}
2580
Ronald Croncd989b52021-06-18 14:23:33 +02002581psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2582 psa_algorithm_t alg,
2583 const uint8_t *input,
2584 size_t input_length,
2585 uint8_t *mac,
2586 size_t mac_size,
2587 size_t *mac_length)
2588{
2589 return( psa_mac_compute_internal( key, alg,
2590 input, input_length,
2591 mac, mac_size, mac_length, 1 ) );
2592}
2593
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002594psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2595 psa_algorithm_t alg,
2596 const uint8_t *input,
2597 size_t input_length,
2598 const uint8_t *mac,
2599 size_t mac_length)
2600{
2601 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002602 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2603 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002604
Ronald Crona587cbc2021-06-18 14:51:29 +02002605 status = psa_mac_compute_internal( key, alg,
2606 input, input_length,
2607 actual_mac, sizeof( actual_mac ),
2608 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002609 if( status != PSA_SUCCESS )
2610 goto exit;
2611
Ronald Crona587cbc2021-06-18 14:51:29 +02002612 if( mac_length != actual_mac_length )
2613 {
2614 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002615 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002616 }
2617 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2618 {
2619 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002620 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002621 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002622
2623exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002624 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002625
2626 return ( status );
2627}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002628
Gilles Peskinee59236f2018-01-27 23:32:46 +01002629/****************************************************************/
2630/* Asymmetric cryptography */
2631/****************************************************************/
2632
gabor-mezei-armf0486182021-05-12 11:03:09 +02002633static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002634 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002635{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002636 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002637 {
2638 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2639 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002640
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002641 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2642 {
2643 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2644 return( PSA_ERROR_INVALID_ARGUMENT );
2645 }
2646 }
2647 else
2648 {
2649 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2650 return( PSA_ERROR_INVALID_ARGUMENT );
2651 }
2652
2653 return( PSA_SUCCESS );
2654}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002655
2656static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002657 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002658 psa_algorithm_t alg,
2659 const uint8_t * input,
2660 size_t input_length,
2661 uint8_t * signature,
2662 size_t signature_size,
2663 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002664{
2665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2666 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2667 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002668
2669 *signature_length = 0;
2670
gabor-mezei-armf0486182021-05-12 11:03:09 +02002671 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002672 if( status != PSA_SUCCESS )
2673 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002674
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002675 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002676 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002677 * buffer can in principle be empty since it doesn't actually have
2678 * to be a hash.) */
2679 if( signature_size == 0 )
2680 return( PSA_ERROR_BUFFER_TOO_SMALL );
2681
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002682 status = psa_get_and_lock_key_slot_with_policy(
2683 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002684 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2685 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002686 alg );
2687
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002688 if( status != PSA_SUCCESS )
2689 goto exit;
2690
2691 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2692 {
2693 status = PSA_ERROR_INVALID_ARGUMENT;
2694 goto exit;
2695 }
2696
2697 psa_key_attributes_t attributes = {
2698 .core = slot->attr
2699 };
2700
gabor-mezei-armf0486182021-05-12 11:03:09 +02002701 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002702 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002703 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002704 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002705 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002706 signature, signature_size, signature_length );
2707 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002708 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002709 {
2710
2711 status = psa_driver_wrapper_sign_hash(
2712 &attributes, slot->key.data, slot->key.bytes,
2713 alg, input, input_length,
2714 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002715 }
2716
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002717
2718exit:
2719 /* Fill the unused part of the output buffer (the whole buffer on error,
2720 * the trailing part on success) with something that isn't a valid signature
2721 * (barring an attack on the signature and deliberately-crafted input),
2722 * in case the caller doesn't check the return status properly. */
2723 if( status == PSA_SUCCESS )
2724 memset( signature + *signature_length, '!',
2725 signature_size - *signature_length );
2726 else
2727 memset( signature, '!', signature_size );
2728 /* If signature_size is 0 then we have nothing to do. We must not call
2729 * memset because signature may be NULL in this case. */
2730
2731 unlock_status = psa_unlock_key_slot( slot );
2732
2733 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2734}
2735
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002736static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002737 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002738 psa_algorithm_t alg,
2739 const uint8_t * input,
2740 size_t input_length,
2741 const uint8_t * signature,
2742 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002743{
2744 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2745 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2746 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002747
gabor-mezei-armf0486182021-05-12 11:03:09 +02002748 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002749 if( status != PSA_SUCCESS )
2750 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002751
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002752 status = psa_get_and_lock_key_slot_with_policy(
2753 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002754 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2755 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002756 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002757
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002758 if( status != PSA_SUCCESS )
2759 return( status );
2760
2761 psa_key_attributes_t attributes = {
2762 .core = slot->attr
2763 };
2764
gabor-mezei-armf0486182021-05-12 11:03:09 +02002765 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002766 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002767 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002768 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002769 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002770 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002771 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002772 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002773 {
2774 status = psa_driver_wrapper_verify_hash(
2775 &attributes, slot->key.data, slot->key.bytes,
2776 alg, input, input_length,
2777 signature, signature_length );
2778 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002779
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002780 unlock_status = psa_unlock_key_slot( slot );
2781
2782 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002783
2784}
2785
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002786psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002787 const psa_key_attributes_t *attributes,
2788 const uint8_t *key_buffer,
2789 size_t key_buffer_size,
2790 psa_algorithm_t alg,
2791 const uint8_t *input,
2792 size_t input_length,
2793 uint8_t *signature,
2794 size_t signature_size,
2795 size_t *signature_length )
2796{
2797 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002798
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002799 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2800 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002801 size_t hash_length;
2802 uint8_t hash[PSA_HASH_MAX_SIZE];
2803
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002804 status = psa_driver_wrapper_hash_compute(
2805 PSA_ALG_SIGN_GET_HASH( alg ),
2806 input, input_length,
2807 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002808
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002809 if( status != PSA_SUCCESS )
2810 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002811
2812 return psa_driver_wrapper_sign_hash(
2813 attributes, key_buffer, key_buffer_size,
2814 alg, hash, hash_length,
2815 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002816 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002817
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002818 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002819}
2820
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002821psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2822 psa_algorithm_t alg,
2823 const uint8_t * input,
2824 size_t input_length,
2825 uint8_t * signature,
2826 size_t signature_size,
2827 size_t * signature_length )
2828{
2829 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002830 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002831 signature, signature_size, signature_length );
2832}
2833
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002834psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002835 const psa_key_attributes_t *attributes,
2836 const uint8_t *key_buffer,
2837 size_t key_buffer_size,
2838 psa_algorithm_t alg,
2839 const uint8_t *input,
2840 size_t input_length,
2841 const uint8_t *signature,
2842 size_t signature_length )
2843{
2844 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002845
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002846 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2847 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002848 size_t hash_length;
2849 uint8_t hash[PSA_HASH_MAX_SIZE];
2850
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002851 status = psa_driver_wrapper_hash_compute(
2852 PSA_ALG_SIGN_GET_HASH( alg ),
2853 input, input_length,
2854 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002855
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002856 if( status != PSA_SUCCESS )
2857 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002858
2859 return psa_driver_wrapper_verify_hash(
2860 attributes, key_buffer, key_buffer_size,
2861 alg, hash, hash_length,
2862 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002863 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002864
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002865 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002866}
2867
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002868psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2869 psa_algorithm_t alg,
2870 const uint8_t * input,
2871 size_t input_length,
2872 const uint8_t * signature,
2873 size_t signature_length )
2874{
2875 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002876 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002877 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002878}
2879
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002880psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002881 const psa_key_attributes_t *attributes,
2882 const uint8_t *key_buffer, size_t key_buffer_size,
2883 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2884 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002885{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002886 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002887 {
Ronald Cron4501c982021-03-19 20:09:32 +01002888 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2889 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002890 {
Ronald Cron4501c982021-03-19 20:09:32 +01002891#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2892 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2893 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002894 attributes,
2895 key_buffer, key_buffer_size,
2896 alg, hash, hash_length,
2897 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002898#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2899 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002900 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002901 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002902 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002903 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002904 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002905 }
2906 else
Ronald Cron4501c982021-03-19 20:09:32 +01002907 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2908 {
2909 if( PSA_ALG_IS_ECDSA( alg ) )
2910 {
2911#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2912 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2913 return( mbedtls_psa_ecdsa_sign_hash(
2914 attributes,
2915 key_buffer, key_buffer_size,
2916 alg, hash, hash_length,
2917 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002918#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2919 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002920 }
2921 else
2922 {
2923 return( PSA_ERROR_INVALID_ARGUMENT );
2924 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002925 }
Ronald Cron4501c982021-03-19 20:09:32 +01002926
2927 (void)key_buffer;
2928 (void)key_buffer_size;
2929 (void)hash;
2930 (void)hash_length;
2931 (void)signature;
2932 (void)signature_size;
2933 (void)signature_length;
2934
2935 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002936}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002937
2938psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2939 psa_algorithm_t alg,
2940 const uint8_t *hash,
2941 size_t hash_length,
2942 uint8_t *signature,
2943 size_t signature_size,
2944 size_t *signature_length )
2945{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002946 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002947 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002948 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002949}
2950
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002951psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002952 const psa_key_attributes_t *attributes,
2953 const uint8_t *key_buffer, size_t key_buffer_size,
2954 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2955 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002956{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002957 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002958 {
Ronald Cron4501c982021-03-19 20:09:32 +01002959 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2960 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002961 {
Ronald Cron4501c982021-03-19 20:09:32 +01002962#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2963 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2964 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002965 attributes,
2966 key_buffer, key_buffer_size,
2967 alg, hash, hash_length,
2968 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2970 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002971 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002972 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002973 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002974 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002975 }
itayzafrir5c753392018-05-08 11:18:38 +03002976 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002977 else
Ronald Cron4501c982021-03-19 20:09:32 +01002978 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002979 {
Ronald Cron4501c982021-03-19 20:09:32 +01002980 if( PSA_ALG_IS_ECDSA( alg ) )
2981 {
2982#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2983 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2984 return( mbedtls_psa_ecdsa_verify_hash(
2985 attributes,
2986 key_buffer, key_buffer_size,
2987 alg, hash, hash_length,
2988 signature, signature_length ) );
2989#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2990 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2991 }
2992 else
2993 {
2994 return( PSA_ERROR_INVALID_ARGUMENT );
2995 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002996 }
Ronald Cron4501c982021-03-19 20:09:32 +01002997
2998 (void)key_buffer;
2999 (void)key_buffer_size;
3000 (void)hash;
3001 (void)hash_length;
3002 (void)signature;
3003 (void)signature_length;
3004
3005 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003006}
3007
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003008psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3009 psa_algorithm_t alg,
3010 const uint8_t *hash,
3011 size_t hash_length,
3012 const uint8_t *signature,
3013 size_t signature_length )
3014{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003015 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003016 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003017 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003018}
3019
John Durkop0e005192020-10-31 22:06:54 -07003020#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003021static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3022 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003023{
3024 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3025 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3026 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003027
3028 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003029}
John Durkop0e005192020-10-31 22:06:54 -07003030#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003031
Ronald Croncf56a0a2020-08-04 09:51:30 +02003032psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003033 psa_algorithm_t alg,
3034 const uint8_t *input,
3035 size_t input_length,
3036 const uint8_t *salt,
3037 size_t salt_length,
3038 uint8_t *output,
3039 size_t output_size,
3040 size_t *output_length )
3041{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003043 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003044 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003045
Darryl Green5cc689a2018-07-24 15:34:10 +01003046 (void) input;
3047 (void) input_length;
3048 (void) salt;
3049 (void) output;
3050 (void) output_size;
3051
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003052 *output_length = 0;
3053
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003054 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3055 return( PSA_ERROR_INVALID_ARGUMENT );
3056
Ronald Cron5c522922020-11-14 16:35:34 +01003057 status = psa_get_and_lock_transparent_key_slot_with_policy(
3058 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003059 if( status != PSA_SUCCESS )
3060 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003061 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3062 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003063 {
3064 status = PSA_ERROR_INVALID_ARGUMENT;
3065 goto exit;
3066 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003067
John Durkop6ba40d12020-11-10 08:50:04 -08003068#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3069 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003070 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003071 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003072 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003073 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3074 slot->key.data,
3075 slot->key.bytes,
3076 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003077 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003078 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003079
3080 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003081 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003082 status = PSA_ERROR_BUFFER_TOO_SMALL;
3083 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003084 }
John Durkop0e005192020-10-31 22:06:54 -07003085#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003086 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3087 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003088 status = mbedtls_to_psa_error(
3089 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003090 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003091 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003092 input_length,
3093 input,
3094 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003095 }
3096 else
John Durkop0e005192020-10-31 22:06:54 -07003097#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3098#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003099 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3100 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003101 status = mbedtls_to_psa_error(
3102 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3103 if( status != PSA_SUCCESS )
3104 goto rsa_exit;
3105
Steven Cooreman4fed4552020-08-03 14:46:03 +02003106 status = mbedtls_to_psa_error(
3107 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003108 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003109 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003110 salt, salt_length,
3111 input_length,
3112 input,
3113 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114 }
3115 else
John Durkop0e005192020-10-31 22:06:54 -07003116#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003117 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003118 status = PSA_ERROR_INVALID_ARGUMENT;
3119 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003121rsa_exit:
3122 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003123 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003124
Steven Cooremana2371e52020-07-28 14:30:39 +02003125 mbedtls_rsa_free( rsa );
3126 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003128 else
John Durkop9814fa22020-11-04 12:28:15 -08003129#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003130 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003132 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003134
3135exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003136 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003137
Ronald Cron5c522922020-11-14 16:35:34 +01003138 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003139}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003140
Ronald Croncf56a0a2020-08-04 09:51:30 +02003141psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003142 psa_algorithm_t alg,
3143 const uint8_t *input,
3144 size_t input_length,
3145 const uint8_t *salt,
3146 size_t salt_length,
3147 uint8_t *output,
3148 size_t output_size,
3149 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003150{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003152 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003153 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003154
Darryl Green5cc689a2018-07-24 15:34:10 +01003155 (void) input;
3156 (void) input_length;
3157 (void) salt;
3158 (void) output;
3159 (void) output_size;
3160
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003161 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003163 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3164 return( PSA_ERROR_INVALID_ARGUMENT );
3165
Ronald Cron5c522922020-11-14 16:35:34 +01003166 status = psa_get_and_lock_transparent_key_slot_with_policy(
3167 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003168 if( status != PSA_SUCCESS )
3169 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003170 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171 {
3172 status = PSA_ERROR_INVALID_ARGUMENT;
3173 goto exit;
3174 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003175
John Durkop6ba40d12020-11-10 08:50:04 -08003176#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3177 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003178 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003179 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003180 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003181 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3182 slot->key.data,
3183 slot->key.bytes,
3184 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003185 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003186 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003187
Steven Cooremana2371e52020-07-28 14:30:39 +02003188 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003189 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003190 status = PSA_ERROR_INVALID_ARGUMENT;
3191 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003192 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003193
John Durkop0e005192020-10-31 22:06:54 -07003194#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003195 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003196 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003197 status = mbedtls_to_psa_error(
3198 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003199 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003200 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003201 output_length,
3202 input,
3203 output,
3204 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 }
3206 else
John Durkop0e005192020-10-31 22:06:54 -07003207#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3208#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003209 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003211 status = mbedtls_to_psa_error(
3212 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3213 if( status != PSA_SUCCESS )
3214 goto rsa_exit;
3215
Steven Cooreman4fed4552020-08-03 14:46:03 +02003216 status = mbedtls_to_psa_error(
3217 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003218 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003219 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003220 salt, salt_length,
3221 output_length,
3222 input,
3223 output,
3224 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003225 }
3226 else
John Durkop0e005192020-10-31 22:06:54 -07003227#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003228 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003229 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003230 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003231
Steven Cooreman4fed4552020-08-03 14:46:03 +02003232rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003233 mbedtls_rsa_free( rsa );
3234 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003235 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003236 else
John Durkop6ba40d12020-11-10 08:50:04 -08003237#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3238 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003239 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003240 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003241 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003242
3243exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003244 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003245
Ronald Cron5c522922020-11-14 16:35:34 +01003246 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003247}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003248
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003249
3250
mohammad1603503973b2018-03-12 15:59:30 +02003251/****************************************************************/
3252/* Symmetric cryptography */
3253/****************************************************************/
3254
Ronald Cronab99ac22020-10-01 16:38:28 +02003255static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3256 mbedtls_svc_key_id_t key,
3257 psa_algorithm_t alg,
3258 mbedtls_operation_t cipher_operation )
3259{
3260 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3261 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003262 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003263 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3264 PSA_KEY_USAGE_ENCRYPT :
3265 PSA_KEY_USAGE_DECRYPT );
3266
3267 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003268 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003269 {
Dave Rodgman54648242021-06-24 11:49:45 +01003270 status = PSA_ERROR_BAD_STATE;
3271 goto exit;
3272 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003273
Ronald Cronab99ac22020-10-01 16:38:28 +02003274 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003275 {
Dave Rodgman54648242021-06-24 11:49:45 +01003276 status = PSA_ERROR_INVALID_ARGUMENT;
3277 goto exit;
3278 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003279
Ronald Cronab99ac22020-10-01 16:38:28 +02003280 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3281 if( status != PSA_SUCCESS )
3282 goto exit;
3283
Ronald Cron49fafa92021-03-10 08:34:23 +01003284 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003285 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003286 * so we only set it (in the driver wrapper) after resources have been
3287 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003288 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003289 if( alg == PSA_ALG_ECB_NO_PADDING )
3290 operation->iv_required = 0;
3291 else
3292 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003293 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003294
Ronald Crona4af55f2020-12-14 14:36:06 +01003295 psa_key_attributes_t attributes = {
3296 .core = slot->attr
3297 };
3298
Ronald Cronab99ac22020-10-01 16:38:28 +02003299 /* Try doing the operation through a driver before using software fallback. */
3300 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003301 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3302 &attributes,
3303 slot->key.data,
3304 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003305 alg );
3306 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003307 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3308 &attributes,
3309 slot->key.data,
3310 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003311 alg );
3312
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003313exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003314 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003315 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003316
Ronald Cron5c522922020-11-14 16:35:34 +01003317 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003318
Ronald Cron5c522922020-11-14 16:35:34 +01003319 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003320}
3321
Gilles Peskinefe119512018-07-08 21:39:34 +02003322psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003323 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003324 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003325{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003326 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003327}
3328
Gilles Peskinefe119512018-07-08 21:39:34 +02003329psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003330 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003331 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003332{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003333 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003334}
3335
Gilles Peskinefe119512018-07-08 21:39:34 +02003336psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003337 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003338 size_t iv_size,
3339 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003340{
Ronald Cron6d051732020-10-01 14:10:20 +02003341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003342
Ronald Cron5618a392021-03-26 09:52:26 +01003343 *iv_length = 0;
3344
Ronald Cron49fafa92021-03-10 08:34:23 +01003345 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003346 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003347 status = PSA_ERROR_BAD_STATE;
3348 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003349 }
3350
Steven Cooreman7df02922020-09-09 15:28:49 +02003351 if( operation->iv_set || ! operation->iv_required )
3352 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003353 status = PSA_ERROR_BAD_STATE;
3354 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003355 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003356
Ronald Cron5618a392021-03-26 09:52:26 +01003357 if( iv_size < operation->default_iv_length )
3358 {
3359 status = PSA_ERROR_BUFFER_TOO_SMALL;
3360 goto exit;
3361 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003362
Ronald Cron5618a392021-03-26 09:52:26 +01003363 status = psa_generate_random( iv, operation->default_iv_length );
3364 if( status != PSA_SUCCESS )
3365 goto exit;
3366
3367 status = psa_driver_wrapper_cipher_set_iv( operation,
3368 iv,
3369 operation->default_iv_length );
3370
3371exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003372 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003373 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003374 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003375 *iv_length = operation->default_iv_length;
3376 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003377 else
Moran Peker395db872018-05-31 14:07:14 +03003378 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003379
itayzafrir534bd7c2018-08-02 13:56:32 +03003380 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003381}
3382
Gilles Peskinefe119512018-07-08 21:39:34 +02003383psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003384 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003385 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003386{
Ronald Cron6d051732020-10-01 14:10:20 +02003387 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003388
Ronald Cron49fafa92021-03-10 08:34:23 +01003389 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003390 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003391 status = PSA_ERROR_BAD_STATE;
3392 goto exit;
3393 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003394
Steven Cooreman7df02922020-09-09 15:28:49 +02003395 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003396 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003397 status = PSA_ERROR_BAD_STATE;
3398 goto exit;
3399 }
Ronald Crona0d68172021-03-26 10:15:08 +01003400
3401 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003402 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003403 status = PSA_ERROR_INVALID_ARGUMENT;
3404 goto exit;
3405 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003406
Ronald Crondd24c9b2020-12-15 14:10:01 +01003407 status = psa_driver_wrapper_cipher_set_iv( operation,
3408 iv,
3409 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003410
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003411exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003412 if( status == PSA_SUCCESS )
3413 operation->iv_set = 1;
3414 else
mohammad1603503973b2018-03-12 15:59:30 +02003415 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003416 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003417}
3418
Gilles Peskinee553c652018-06-04 16:22:46 +02003419psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3420 const uint8_t *input,
3421 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003422 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003423 size_t output_size,
3424 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003425{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003427
Ronald Cron49fafa92021-03-10 08:34:23 +01003428 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003429 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003430 status = PSA_ERROR_BAD_STATE;
3431 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003432 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003433
Steven Cooreman7df02922020-09-09 15:28:49 +02003434 if( operation->iv_required && ! operation->iv_set )
3435 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003436 status = PSA_ERROR_BAD_STATE;
3437 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003438 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003439
Ronald Crondd24c9b2020-12-15 14:10:01 +01003440 status = psa_driver_wrapper_cipher_update( operation,
3441 input,
3442 input_length,
3443 output,
3444 output_size,
3445 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003446
3447exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003448 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003449 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003450
itayzafrir534bd7c2018-08-02 13:56:32 +03003451 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003452}
3453
Gilles Peskinee553c652018-06-04 16:22:46 +02003454psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3455 uint8_t *output,
3456 size_t output_size,
3457 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003458{
David Saadab4ecc272019-02-14 13:48:10 +02003459 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
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 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003472
Ronald Crondd24c9b2020-12-15 14:10:01 +01003473 status = psa_driver_wrapper_cipher_finish( operation,
3474 output,
3475 output_size,
3476 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003477
3478exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003479 if( status == PSA_SUCCESS )
3480 return( psa_cipher_abort( operation ) );
3481 else
3482 {
3483 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003484 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003485
Steven Cooremanef8575e2020-09-11 11:44:50 +02003486 return( status );
3487 }
mohammad1603503973b2018-03-12 15:59:30 +02003488}
3489
Gilles Peskinee553c652018-06-04 16:22:46 +02003490psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3491{
Ronald Cron49fafa92021-03-10 08:34:23 +01003492 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003493 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003494 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003495 * in use. It's ok to call abort on such an object, and there's
3496 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003497 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003498 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003499
Ronald Crondd24c9b2020-12-15 14:10:01 +01003500 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003501
Ronald Cron49fafa92021-03-10 08:34:23 +01003502 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003503 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003504 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003505
Moran Peker395db872018-05-31 14:07:14 +03003506 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003507}
3508
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003509psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3510 psa_algorithm_t alg,
3511 const uint8_t *input,
3512 size_t input_length,
3513 uint8_t *output,
3514 size_t output_size,
3515 size_t *output_length )
3516{
3517 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003518 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3519 psa_key_slot_t *slot;
3520 psa_key_type_t key_type;
3521 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003522
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003523 *output_length = 0;
3524
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003525 if( ! PSA_ALG_IS_CIPHER( alg ) )
3526 return( PSA_ERROR_INVALID_ARGUMENT );
3527
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003528 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3529 PSA_KEY_USAGE_ENCRYPT,
3530 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003531 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003532 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003533
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003534 psa_key_attributes_t attributes = {
3535 .core = slot->attr
3536 };
3537
3538 key_type = slot->attr.type;
3539 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3540
3541 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003542 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003543 if( output_size < iv_length )
3544 {
3545 status = PSA_ERROR_BUFFER_TOO_SMALL;
3546 goto exit;
3547 }
3548
3549 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003550 if( status != PSA_SUCCESS )
3551 goto exit;
3552 }
3553
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003554 status = psa_driver_wrapper_cipher_encrypt(
3555 &attributes, slot->key.data, slot->key.bytes,
3556 alg, input, input_length,
3557 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003558
3559exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003560 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003561
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003562 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003563}
3564
3565psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3566 psa_algorithm_t alg,
3567 const uint8_t *input,
3568 size_t input_length,
3569 uint8_t *output,
3570 size_t output_size,
3571 size_t *output_length )
3572{
3573 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003574 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3575 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003576
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003577 *output_length = 0;
3578
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003579 if( ! PSA_ALG_IS_CIPHER( alg ) )
3580 return( PSA_ERROR_INVALID_ARGUMENT );
3581
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003582 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3583 PSA_KEY_USAGE_DECRYPT,
3584 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003585 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003586 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003587
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003588 psa_key_attributes_t attributes = {
3589 .core = slot->attr
3590 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003591
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003592 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3593 {
3594 status = PSA_ERROR_INVALID_ARGUMENT;
3595 goto exit;
3596 }
3597
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003598 status = psa_driver_wrapper_cipher_decrypt(
3599 &attributes, slot->key.data, slot->key.bytes,
3600 alg, input, input_length,
3601 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003602
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003603exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003604 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003605
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003606 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003607}
3608
3609
mohammad16035955c982018-04-26 00:53:03 +03003610/****************************************************************/
3611/* AEAD */
3612/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003613
Paul Elliottbaff51c2021-09-28 17:44:45 +01003614/* Helper function to get the base algorithm from its variants. */
3615static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3616{
3617 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3618}
3619
3620/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003621static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3622 size_t nonce_length )
3623{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003624 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3625
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003626 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003627 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003628#if defined(PSA_WANT_ALG_GCM)
3629 case PSA_ALG_GCM:
3630 /* Not checking max nonce size here as GCM spec allows almost
3631 * arbitrarily large nonces. Please note that we do not generally
3632 * recommend the usage of nonces of greater length than
3633 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3634 * size, which can then lead to collisions if you encrypt a very
3635 * large number of messages.*/
3636 if( nonce_length != 0 )
3637 return( PSA_SUCCESS );
3638 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003639#endif /* PSA_WANT_ALG_GCM */
3640#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003641 case PSA_ALG_CCM:
3642 if( nonce_length >= 7 && nonce_length <= 13 )
3643 return( PSA_SUCCESS );
3644 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003645#endif /* PSA_WANT_ALG_CCM */
3646#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003647 case PSA_ALG_CHACHA20_POLY1305:
3648 if( nonce_length == 12 )
3649 return( PSA_SUCCESS );
3650 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003651#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003652 default:
3653 break;
3654 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003655
Paul Elliott60116ae2021-09-29 14:19:11 +01003656 return( PSA_ERROR_NOT_SUPPORTED );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003657}
3658
Ronald Croncf56a0a2020-08-04 09:51:30 +02003659psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003660 psa_algorithm_t alg,
3661 const uint8_t *nonce,
3662 size_t nonce_length,
3663 const uint8_t *additional_data,
3664 size_t additional_data_length,
3665 const uint8_t *plaintext,
3666 size_t plaintext_length,
3667 uint8_t *ciphertext,
3668 size_t ciphertext_size,
3669 size_t *ciphertext_length )
3670{
Ronald Cron215633c2021-03-16 17:15:37 +01003671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3672 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003673
mohammad1603f08a5502018-06-03 15:05:47 +03003674 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003675
Steven Cooremanea7ab132021-03-17 16:28:00 +01003676 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3677 return( PSA_ERROR_NOT_SUPPORTED );
3678
Ronald Cron9a986162021-03-26 12:40:07 +01003679 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003680 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003681 if( status != PSA_SUCCESS )
3682 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003683
Ronald Cron215633c2021-03-16 17:15:37 +01003684 psa_key_attributes_t attributes = {
3685 .core = slot->attr
3686 };
mohammad16035955c982018-04-26 00:53:03 +03003687
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003688 status = psa_aead_check_nonce_length( alg, nonce_length );
3689 if( status != PSA_SUCCESS )
3690 goto exit;
3691
Ronald Cronde822812021-03-17 16:08:20 +01003692 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003693 &attributes, slot->key.data, slot->key.bytes,
3694 alg,
3695 nonce, nonce_length,
3696 additional_data, additional_data_length,
3697 plaintext, plaintext_length,
3698 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003699
Gilles Peskineedf9a652018-08-17 18:11:56 +02003700 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3701 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003702
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003703exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003704 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003705
mohammad16035955c982018-04-26 00:53:03 +03003706 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003707}
3708
Ronald Croncf56a0a2020-08-04 09:51:30 +02003709psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003710 psa_algorithm_t alg,
3711 const uint8_t *nonce,
3712 size_t nonce_length,
3713 const uint8_t *additional_data,
3714 size_t additional_data_length,
3715 const uint8_t *ciphertext,
3716 size_t ciphertext_length,
3717 uint8_t *plaintext,
3718 size_t plaintext_size,
3719 size_t *plaintext_length )
3720{
Ronald Cron215633c2021-03-16 17:15:37 +01003721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3722 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003723
Gilles Peskineee652a32018-06-01 19:23:52 +02003724 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003725
Steven Cooremanea7ab132021-03-17 16:28:00 +01003726 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3727 return( PSA_ERROR_NOT_SUPPORTED );
3728
Ronald Cron9a986162021-03-26 12:40:07 +01003729 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003730 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003731 if( status != PSA_SUCCESS )
3732 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003733
Ronald Cron215633c2021-03-16 17:15:37 +01003734 psa_key_attributes_t attributes = {
3735 .core = slot->attr
3736 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003737
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003738 status = psa_aead_check_nonce_length( alg, nonce_length );
3739 if( status != PSA_SUCCESS )
3740 goto exit;
3741
Ronald Cronde822812021-03-17 16:08:20 +01003742 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003743 &attributes, slot->key.data, slot->key.bytes,
3744 alg,
3745 nonce, nonce_length,
3746 additional_data, additional_data_length,
3747 ciphertext, ciphertext_length,
3748 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003749
Gilles Peskineedf9a652018-08-17 18:11:56 +02003750 if( status != PSA_SUCCESS && plaintext_size != 0 )
3751 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003752
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003753exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003754 psa_unlock_key_slot( slot );
3755
Gilles Peskineedf9a652018-08-17 18:11:56 +02003756 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003757}
3758
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003759/* Set the key for a multipart authenticated operation. */
3760static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003761 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003762 mbedtls_svc_key_id_t key,
3763 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003764{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003765 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3766 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3767 psa_key_slot_t *slot = NULL;
3768 psa_key_usage_t key_usage = 0;
3769
Paul Elliottc2b71442021-06-24 18:17:52 +01003770 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3771 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003772 status = PSA_ERROR_INVALID_ARGUMENT;
3773 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003774 }
3775
3776 if( operation->id != 0 )
3777 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003778 status = PSA_ERROR_BAD_STATE;
3779 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003780 }
3781
3782 if( operation->nonce_set || operation->lengths_set ||
3783 operation->ad_started || operation->body_started )
3784 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003785 status = PSA_ERROR_BAD_STATE;
3786 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003787 }
3788
Paul Elliottd9343f22021-08-23 18:59:49 +01003789 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003790 key_usage = PSA_KEY_USAGE_ENCRYPT;
3791 else
3792 key_usage = PSA_KEY_USAGE_DECRYPT;
3793
3794 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3795 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003796 if( status != PSA_SUCCESS )
3797 goto exit;
3798
3799 psa_key_attributes_t attributes = {
3800 .core = slot->attr
3801 };
3802
Paul Elliottd9343f22021-08-23 18:59:49 +01003803 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003804 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3805 &attributes,
3806 slot->key.data,
3807 slot->key.bytes,
3808 alg );
3809 else
3810 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3811 &attributes,
3812 slot->key.data,
3813 slot->key.bytes,
3814 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003815 if( status != PSA_SUCCESS )
3816 goto exit;
3817
3818 operation->key_type = psa_get_key_type( &attributes );
3819
3820exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003821 unlock_status = psa_unlock_key_slot( slot );
3822
3823 if( status == PSA_SUCCESS )
3824 {
3825 status = unlock_status;
3826 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003827 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003828 }
3829 else
3830 psa_aead_abort( operation );
3831
3832 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003833}
3834
Paul Elliott302ff6b2021-04-20 18:10:30 +01003835/* Set the key for a multipart authenticated encryption operation. */
3836psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3837 mbedtls_svc_key_id_t key,
3838 psa_algorithm_t alg )
3839{
Paul Elliottd9343f22021-08-23 18:59:49 +01003840 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003841}
3842
3843/* Set the key for a multipart authenticated decryption operation. */
3844psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3845 mbedtls_svc_key_id_t key,
3846 psa_algorithm_t alg )
3847{
Paul Elliottd9343f22021-08-23 18:59:49 +01003848 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003849}
3850
3851/* Generate a random nonce / IV for multipart AEAD operation */
3852psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3853 uint8_t *nonce,
3854 size_t nonce_size,
3855 size_t *nonce_length )
3856{
3857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottb91da712021-05-20 14:43:47 +01003858 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003859
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003860 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003861
Paul Elliottcee785c2021-05-20 14:29:20 +01003862 if( operation->id == 0 )
3863 {
3864 status = PSA_ERROR_BAD_STATE;
3865 goto exit;
3866 }
3867
Paul Elliottdaf5c892021-08-25 16:24:58 +01003868 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003869 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003870 status = PSA_ERROR_BAD_STATE;
3871 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003872 }
3873
Paul Elliottbbe90b52021-05-11 22:22:42 +01003874 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003875 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003876 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003877 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003878 status = PSA_ERROR_BUFFER_TOO_SMALL;
3879 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003880 }
3881
3882 status = psa_generate_random( nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003883 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003884 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003885
Paul Elliott95271f12021-06-23 16:50:45 +01003886 status = psa_aead_set_nonce( operation, nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003887
Paul Elliott39dc6b82021-05-11 19:16:09 +01003888exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003889 if( status == PSA_SUCCESS )
3890 *nonce_length = required_nonce_size;
3891 else
3892 psa_aead_abort( operation );
3893
3894 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003895}
3896
3897/* Set the nonce for a multipart authenticated encryption or decryption
3898 operation.*/
3899psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3900 const uint8_t *nonce,
3901 size_t nonce_length )
3902{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3904
Paul Elliottcee785c2021-05-20 14:29:20 +01003905 if( operation->id == 0 )
3906 {
3907 status = PSA_ERROR_BAD_STATE;
3908 goto exit;
3909 }
3910
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003911 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003912 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003913 status = PSA_ERROR_BAD_STATE;
3914 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003915 }
3916
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003917 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003918 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003919 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003920 status = PSA_ERROR_INVALID_ARGUMENT;
3921 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003922 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003923
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003924 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3925 nonce_length );
3926
Paul Elliott39dc6b82021-05-11 19:16:09 +01003927exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003928 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003929 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003930 else
3931 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003932
3933 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003934}
3935
3936/* Declare the lengths of the message and additional data for multipart AEAD. */
3937psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3938 size_t ad_length,
3939 size_t plaintext_length )
3940{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3942
Paul Elliottcee785c2021-05-20 14:29:20 +01003943 if( operation->id == 0 )
3944 {
3945 status = PSA_ERROR_BAD_STATE;
3946 goto exit;
3947 }
3948
Paul Elliott6eb95982021-05-21 17:41:41 +01003949 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003950 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003951 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003952 status = PSA_ERROR_BAD_STATE;
3953 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003954 }
3955
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003956 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003957 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003958#if defined(PSA_WANT_ALG_GCM)
3959 case PSA_ALG_GCM:
3960 /* Lengths can only be too large for GCM if size_t is bigger than 32
3961 * bits. Without the guard this code will generate warnings on 32bit
3962 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003963#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003964 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3965 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3966 {
3967 status = PSA_ERROR_INVALID_ARGUMENT;
3968 goto exit;
3969 }
Paul Elliott325d3742021-09-27 17:56:28 +01003970#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003971 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003972#endif /* PSA_WANT_ALG_GCM */
3973#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003974 case PSA_ALG_CCM:
3975 if( ad_length > 0xFF00 )
3976 {
3977 status = PSA_ERROR_INVALID_ARGUMENT;
3978 goto exit;
3979 }
3980 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003981#endif /* PSA_WANT_ALG_CCM */
3982#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003983 case PSA_ALG_CHACHA20_POLY1305:
3984 /* No length restrictions for ChaChaPoly. */
3985 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003986#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003987 default:
3988 break;
3989 }
Paul Elliott325d3742021-09-27 17:56:28 +01003990
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003991 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3992 plaintext_length );
3993
Paul Elliott39dc6b82021-05-11 19:16:09 +01003994exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003995 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003996 {
3997 operation->ad_remaining = ad_length;
3998 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003999 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01004000 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004001 else
4002 psa_aead_abort( operation );
4003
4004 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004005}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004006
4007/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004008psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4009 const uint8_t *input,
4010 size_t input_length )
4011{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4013
Paul Elliottcee785c2021-05-20 14:29:20 +01004014 if( operation->id == 0 )
4015 {
4016 status = PSA_ERROR_BAD_STATE;
4017 goto exit;
4018 }
4019
Paul Elliott6eb95982021-05-21 17:41:41 +01004020 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004021 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004022 status = PSA_ERROR_BAD_STATE;
4023 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004024 }
4025
Paul Elliottee4ffe02021-05-20 17:25:06 +01004026 if( operation->lengths_set )
4027 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004028 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004029 {
4030 status = PSA_ERROR_INVALID_ARGUMENT;
4031 goto exit;
4032 }
4033
4034 operation->ad_remaining -= input_length;
4035 }
4036
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004037 status = psa_driver_wrapper_aead_update_ad( operation, input,
4038 input_length );
4039
Paul Elliott39dc6b82021-05-11 19:16:09 +01004040exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004041 if( status == PSA_SUCCESS )
4042 operation->ad_started = 1;
4043 else
4044 psa_aead_abort( operation );
4045
4046 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004047}
4048
4049/* Encrypt or decrypt a message fragment in an active multipart AEAD
4050 operation.*/
4051psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4052 const uint8_t *input,
4053 size_t input_length,
4054 uint8_t *output,
4055 size_t output_size,
4056 size_t *output_length )
4057{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004059
4060 *output_length = 0;
4061
Paul Elliottcee785c2021-05-20 14:29:20 +01004062 if( operation->id == 0 )
4063 {
4064 status = PSA_ERROR_BAD_STATE;
4065 goto exit;
4066 }
4067
Paul Elliott6eb95982021-05-21 17:41:41 +01004068 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004069 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004070 status = PSA_ERROR_BAD_STATE;
4071 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004072 }
4073
Paul Elliottee4ffe02021-05-20 17:25:06 +01004074 if( operation->lengths_set )
4075 {
4076 /* Additional data length was supplied, but not all the additional
4077 data was supplied.*/
4078 if( operation->ad_remaining != 0 )
4079 {
4080 status = PSA_ERROR_INVALID_ARGUMENT;
4081 goto exit;
4082 }
4083
4084 /* Too much data provided. */
4085 if( operation->body_remaining < input_length )
4086 {
4087 status = PSA_ERROR_INVALID_ARGUMENT;
4088 goto exit;
4089 }
4090
4091 operation->body_remaining -= input_length;
4092 }
4093
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004094 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4095 output, output_size,
4096 output_length );
4097
Paul Elliott39dc6b82021-05-11 19:16:09 +01004098exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004099 if( status == PSA_SUCCESS )
4100 operation->body_started = 1;
4101 else
4102 psa_aead_abort( operation );
4103
4104 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004105}
4106
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004107static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004108{
Paul Elliott7f429b72021-06-24 18:08:54 +01004109 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004110 return( PSA_ERROR_BAD_STATE );
4111
Paul Elliotta5614442021-07-14 14:54:11 +01004112 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004113 operation->body_remaining != 0 ) )
4114 return( PSA_ERROR_INVALID_ARGUMENT );
4115
4116 return( PSA_SUCCESS );
4117}
4118
Paul Elliott302ff6b2021-04-20 18:10:30 +01004119/* Finish encrypting a message in a multipart AEAD operation. */
4120psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4121 uint8_t *ciphertext,
4122 size_t ciphertext_size,
4123 size_t *ciphertext_length,
4124 uint8_t *tag,
4125 size_t tag_size,
4126 size_t *tag_length )
4127{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004128 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4129
Paul Elliott302ff6b2021-04-20 18:10:30 +01004130 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004131 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004132
Paul Elliott814fffb2021-08-16 18:20:36 +01004133 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004134 if( status != PSA_SUCCESS )
4135 goto exit;
4136
Paul Elliott7f429b72021-06-24 18:08:54 +01004137 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004138 {
4139 status = PSA_ERROR_BAD_STATE;
4140 goto exit;
4141 }
4142
Paul Elliott39dc6b82021-05-11 19:16:09 +01004143 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4144 ciphertext_size,
4145 ciphertext_length,
4146 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004147
Paul Elliott39dc6b82021-05-11 19:16:09 +01004148exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004149 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004150 * the zero tag size, make sure the tag is set to something implausible.
4151 * Even if the operation succeeds, make sure we clear the rest of the
4152 * buffer to prevent potential leakage of anything previously placed in
4153 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004154 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004155 {
4156 if( status != PSA_SUCCESS )
4157 memset( tag, '!', tag_size );
4158 else if( *tag_length < tag_size )
4159 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4160 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004161
Paul Elliott39dc6b82021-05-11 19:16:09 +01004162 psa_aead_abort( operation );
4163
4164 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004165}
4166
4167/* Finish authenticating and decrypting a message in a multipart AEAD
4168 operation.*/
4169psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4170 uint8_t *plaintext,
4171 size_t plaintext_size,
4172 size_t *plaintext_length,
4173 const uint8_t *tag,
4174 size_t tag_length )
4175{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004176 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4177
Paul Elliott302ff6b2021-04-20 18:10:30 +01004178 *plaintext_length = 0;
4179
Paul Elliott814fffb2021-08-16 18:20:36 +01004180 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004181 if( status != PSA_SUCCESS )
4182 goto exit;
4183
Paul Elliott7f429b72021-06-24 18:08:54 +01004184 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004185 {
4186 status = PSA_ERROR_BAD_STATE;
4187 goto exit;
4188 }
4189
Paul Elliott39dc6b82021-05-11 19:16:09 +01004190 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4191 plaintext_size,
4192 plaintext_length,
4193 tag, tag_length );
4194
4195exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004196 psa_aead_abort( operation );
4197
4198 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004199}
4200
4201/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004202psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004203{
4204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4205
4206 if( operation->id == 0 )
4207 {
4208 /* The object has (apparently) been initialized but it is not (yet)
4209 * in use. It's ok to call abort on such an object, and there's
4210 * nothing to do. */
4211 return( PSA_SUCCESS );
4212 }
4213
4214 status = psa_driver_wrapper_aead_abort( operation );
4215
Paul Elliott70618b22021-09-22 17:12:16 +01004216 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004217
4218 return( status );
4219}
4220
Gilles Peskinee59236f2018-01-27 23:32:46 +01004221/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004222/* Generators */
4223/****************************************************************/
4224
John Durkop07cc04a2020-11-16 22:08:34 -08004225#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4226 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4227 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4228#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004229#endif /* At least one builtin KDF */
4230
4231#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4232 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4233 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4234static psa_status_t psa_key_derivation_start_hmac(
4235 psa_mac_operation_t *operation,
4236 psa_algorithm_t hash_alg,
4237 const uint8_t *hmac_key,
4238 size_t hmac_key_length )
4239{
4240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4241 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4242 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4243 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4244 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4245
Steven Cooreman72f736a2021-05-07 14:14:37 +02004246 operation->is_sign = 1;
4247 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4248
Steven Cooreman094a77e2021-05-06 17:58:36 +02004249 status = psa_driver_wrapper_mac_sign_setup( operation,
4250 &attributes,
4251 hmac_key, hmac_key_length,
4252 PSA_ALG_HMAC( hash_alg ) );
4253
4254 psa_reset_key_attributes( &attributes );
4255 return( status );
4256}
4257#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004258
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004259#define HKDF_STATE_INIT 0 /* no input yet */
4260#define HKDF_STATE_STARTED 1 /* got salt */
4261#define HKDF_STATE_KEYED 2 /* got key */
4262#define HKDF_STATE_OUTPUT 3 /* output started */
4263
Gilles Peskinecbe66502019-05-16 16:59:18 +02004264static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004265 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004266{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004267 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4268 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004269 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004270 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004271}
4272
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004273psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004274{
4275 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004276 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004277 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004278 {
4279 /* The object has (apparently) been initialized but it is not
4280 * in use. It's ok to call abort on such an object, and there's
4281 * nothing to do. */
4282 }
4283 else
John Durkopd0321952020-10-29 21:37:36 -07004284#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004285 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004286 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004287 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004288 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004289 }
John Durkop07cc04a2020-11-16 22:08:34 -08004290 else
4291#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4292#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4293 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4294 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004295 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004296 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004297 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004298 if( operation->ctx.tls12_prf.secret != NULL )
4299 {
4300 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4301 operation->ctx.tls12_prf.secret_length );
4302 mbedtls_free( operation->ctx.tls12_prf.secret );
4303 }
4304
Janos Follath6a1d2622019-06-11 10:37:28 +01004305 if( operation->ctx.tls12_prf.seed != NULL )
4306 {
4307 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4308 operation->ctx.tls12_prf.seed_length );
4309 mbedtls_free( operation->ctx.tls12_prf.seed );
4310 }
4311
4312 if( operation->ctx.tls12_prf.label != NULL )
4313 {
4314 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4315 operation->ctx.tls12_prf.label_length );
4316 mbedtls_free( operation->ctx.tls12_prf.label );
4317 }
4318
Steven Cooremana6df6042021-04-29 19:32:25 +02004319 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004320
4321 /* We leave the fields Ai and output_block to be erased safely by the
4322 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004323 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004324 else
John Durkop07cc04a2020-11-16 22:08:34 -08004325#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4326 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004327 {
4328 status = PSA_ERROR_BAD_STATE;
4329 }
Janos Follath083036a2019-06-11 10:22:26 +01004330 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004331 return( status );
4332}
4333
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004334psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004335 size_t *capacity)
4336{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004337 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004338 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004339 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004340 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004341 }
4342
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004343 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004344 return( PSA_SUCCESS );
4345}
4346
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004347psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004348 size_t capacity )
4349{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004350 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004351 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004352 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004353 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004354 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004355 return( PSA_SUCCESS );
4356}
4357
John Durkopd0321952020-10-29 21:37:36 -07004358#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004359/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004360 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004361static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004362 psa_algorithm_t hash_alg,
4363 uint8_t *output,
4364 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004365{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004366 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004367 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004368 psa_status_t status;
4369
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004370 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4371 return( PSA_ERROR_BAD_STATE );
4372 hkdf->state = HKDF_STATE_OUTPUT;
4373
Gilles Peskinebef7f142018-07-12 17:22:21 +02004374 while( output_length != 0 )
4375 {
4376 /* Copy what remains of the current block */
4377 uint8_t n = hash_length - hkdf->offset_in_block;
4378 if( n > output_length )
4379 n = (uint8_t) output_length;
4380 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4381 output += n;
4382 output_length -= n;
4383 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004384 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004385 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004386 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004387 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004388 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004389 * object was corrupted or if this function is called directly
4390 * inside the library. */
4391 if( hkdf->block_number == 0xff )
4392 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004393
4394 /* We need a new block */
4395 ++hkdf->block_number;
4396 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004397
Steven Cooreman094a77e2021-05-06 17:58:36 +02004398 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4399 hash_alg,
4400 hkdf->prk,
4401 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004402 if( status != PSA_SUCCESS )
4403 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004404
Gilles Peskinebef7f142018-07-12 17:22:21 +02004405 if( hkdf->block_number != 1 )
4406 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004407 status = psa_mac_update( &hkdf->hmac,
4408 hkdf->output_block,
4409 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004410 if( status != PSA_SUCCESS )
4411 return( status );
4412 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004413 status = psa_mac_update( &hkdf->hmac,
4414 hkdf->info,
4415 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004416 if( status != PSA_SUCCESS )
4417 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004418 status = psa_mac_update( &hkdf->hmac,
4419 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004420 if( status != PSA_SUCCESS )
4421 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004422 status = psa_mac_sign_finish( &hkdf->hmac,
4423 hkdf->output_block,
4424 sizeof( hkdf->output_block ),
4425 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004426 if( status != PSA_SUCCESS )
4427 return( status );
4428 }
4429
4430 return( PSA_SUCCESS );
4431}
John Durkop07cc04a2020-11-16 22:08:34 -08004432#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004433
John Durkop07cc04a2020-11-16 22:08:34 -08004434#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4435 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004436static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4437 psa_tls12_prf_key_derivation_t *tls12_prf,
4438 psa_algorithm_t alg )
4439{
4440 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004441 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004442 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4443 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004444 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004445
Janos Follath7742fee2019-06-17 12:58:10 +01004446 /* We can't be wanting more output after block 0xff, otherwise
4447 * the capacity check in psa_key_derivation_output_bytes() would have
4448 * prevented this call. It could happen only if the operation
4449 * object was corrupted or if this function is called directly
4450 * inside the library. */
4451 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004452 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004453
4454 /* We need a new block */
4455 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004456 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004457
4458 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4459 *
4460 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4461 *
4462 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4463 * HMAC_hash(secret, A(2) + seed) +
4464 * HMAC_hash(secret, A(3) + seed) + ...
4465 *
4466 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004467 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004468 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004469 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004470 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004471 * is currently extracted as `output_block` and where i is
4472 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004473 */
4474
Steven Cooreman094a77e2021-05-06 17:58:36 +02004475 status = psa_key_derivation_start_hmac( &hmac,
4476 hash_alg,
4477 tls12_prf->secret,
4478 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004479 if( status != PSA_SUCCESS )
4480 goto cleanup;
4481
4482 /* Calculate A(i) where i = tls12_prf->block_number. */
4483 if( tls12_prf->block_number == 1 )
4484 {
4485 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4486 * the variable seed and in this instance means it in the context of the
4487 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004488 status = psa_mac_update( &hmac,
4489 tls12_prf->label,
4490 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004491 if( status != PSA_SUCCESS )
4492 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004493 status = psa_mac_update( &hmac,
4494 tls12_prf->seed,
4495 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004496 if( status != PSA_SUCCESS )
4497 goto cleanup;
4498 }
4499 else
4500 {
4501 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004502 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004503 if( status != PSA_SUCCESS )
4504 goto cleanup;
4505 }
4506
Steven Cooremana6df6042021-04-29 19:32:25 +02004507 status = psa_mac_sign_finish( &hmac,
4508 tls12_prf->Ai, hash_length,
4509 &hmac_output_length );
4510 if( hmac_output_length != hash_length )
4511 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004512 if( status != PSA_SUCCESS )
4513 goto cleanup;
4514
4515 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004516 status = psa_key_derivation_start_hmac( &hmac,
4517 hash_alg,
4518 tls12_prf->secret,
4519 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004520 if( status != PSA_SUCCESS )
4521 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004522 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004523 if( status != PSA_SUCCESS )
4524 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004525 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004526 if( status != PSA_SUCCESS )
4527 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004528 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004529 if( status != PSA_SUCCESS )
4530 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004531 status = psa_mac_sign_finish( &hmac,
4532 tls12_prf->output_block, hash_length,
4533 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004534 if( status != PSA_SUCCESS )
4535 goto cleanup;
4536
Janos Follath7742fee2019-06-17 12:58:10 +01004537
4538cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004539 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004540 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4541 status = cleanup_status;
4542
4543 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004544}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004545
Janos Follath844eb0e2019-06-19 12:10:49 +01004546static psa_status_t psa_key_derivation_tls12_prf_read(
4547 psa_tls12_prf_key_derivation_t *tls12_prf,
4548 psa_algorithm_t alg,
4549 uint8_t *output,
4550 size_t output_length )
4551{
4552 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004553 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004554 psa_status_t status;
4555 uint8_t offset, length;
4556
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004557 switch( tls12_prf->state )
4558 {
4559 case PSA_TLS12_PRF_STATE_LABEL_SET:
4560 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4561 break;
4562 case PSA_TLS12_PRF_STATE_OUTPUT:
4563 break;
4564 default:
4565 return( PSA_ERROR_BAD_STATE );
4566 }
4567
Janos Follath844eb0e2019-06-19 12:10:49 +01004568 while( output_length != 0 )
4569 {
4570 /* Check if we have fully processed the current block. */
4571 if( tls12_prf->left_in_block == 0 )
4572 {
4573 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4574 alg );
4575 if( status != PSA_SUCCESS )
4576 return( status );
4577
4578 continue;
4579 }
4580
4581 if( tls12_prf->left_in_block > output_length )
4582 length = (uint8_t) output_length;
4583 else
4584 length = tls12_prf->left_in_block;
4585
4586 offset = hash_length - tls12_prf->left_in_block;
4587 memcpy( output, tls12_prf->output_block + offset, length );
4588 output += length;
4589 output_length -= length;
4590 tls12_prf->left_in_block -= length;
4591 }
4592
4593 return( PSA_SUCCESS );
4594}
John Durkop07cc04a2020-11-16 22:08:34 -08004595#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4596 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004597
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004598psa_status_t psa_key_derivation_output_bytes(
4599 psa_key_derivation_operation_t *operation,
4600 uint8_t *output,
4601 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004602{
4603 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004604 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004605
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004606 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004607 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004608 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004609 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004610 }
4611
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004612 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004613 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004614 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004615 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004616 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004617 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004618 goto exit;
4619 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004620 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004621 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004622 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004623 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004624 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4625 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004626 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004627 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004628 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004629 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004630 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004631
John Durkopd0321952020-10-29 21:37:36 -07004632#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004633 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004634 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004635 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004636 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004637 output, output_length );
4638 }
Janos Follathadbec812019-06-14 11:05:39 +01004639 else
John Durkop07cc04a2020-11-16 22:08:34 -08004640#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4641#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4642 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004643 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004644 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004645 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004647 kdf_alg, output,
4648 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004649 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004650 else
John Durkop07cc04a2020-11-16 22:08:34 -08004651#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4652 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004653 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004654 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004655 return( PSA_ERROR_BAD_STATE );
4656 }
4657
4658exit:
4659 if( status != PSA_SUCCESS )
4660 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004661 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004662 * This allows us to differentiate between exhausted operations and
4663 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4664 * operations. */
4665 psa_algorithm_t alg = operation->alg;
4666 psa_key_derivation_abort( operation );
4667 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004668 memset( output, '!', output_length );
4669 }
4670 return( status );
4671}
4672
David Brown7807bf72021-02-09 16:28:23 -07004673#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004674static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4675{
4676 if( data_size >= 8 )
4677 mbedtls_des_key_set_parity( data );
4678 if( data_size >= 16 )
4679 mbedtls_des_key_set_parity( data + 8 );
4680 if( data_size >= 24 )
4681 mbedtls_des_key_set_parity( data + 16 );
4682}
David Brown7807bf72021-02-09 16:28:23 -07004683#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004684
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004685static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004686 psa_key_slot_t *slot,
4687 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004688 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004689{
4690 uint8_t *data = NULL;
4691 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304692 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004693 psa_status_t status;
4694
Gilles Peskine8e338702019-07-30 20:06:31 +02004695 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004696 return( PSA_ERROR_INVALID_ARGUMENT );
4697 if( bits % 8 != 0 )
4698 return( PSA_ERROR_INVALID_ARGUMENT );
4699 data = mbedtls_calloc( 1, bytes );
4700 if( data == NULL )
4701 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4702
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004703 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004704 if( status != PSA_SUCCESS )
4705 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004706#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004707 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004708 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004709#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004710
Ronald Cronbf33c932020-11-28 18:06:53 +01004711 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004712 psa_key_attributes_t attributes = {
4713 .core = slot->attr
4714 };
4715
Archanad8a83dc2021-06-14 10:04:16 +05304716 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4717 {
Archana449608b2021-09-08 15:36:05 +05304718 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4719 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304720 if( status != PSA_SUCCESS )
4721 goto exit;
4722 }
4723 status = psa_allocate_buffer_to_slot( slot, storage_size );
4724 if( status != PSA_SUCCESS )
4725 goto exit;
4726
Ronald Cronbf33c932020-11-28 18:06:53 +01004727 status = psa_driver_wrapper_import_key( &attributes,
4728 data, bytes,
4729 slot->key.data,
4730 slot->key.bytes,
4731 &slot->key.bytes, &bits );
4732 if( bits != slot->attr.bits )
4733 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004734
4735exit:
4736 mbedtls_free( data );
4737 return( status );
4738}
4739
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004740psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004741 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004742 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004743{
4744 psa_status_t status;
4745 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004746 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004747
Ronald Cron81709fc2020-11-14 12:10:32 +01004748 *key = MBEDTLS_SVC_KEY_ID_INIT;
4749
Gilles Peskine0f84d622019-09-12 19:03:13 +02004750 /* Reject any attempt to create a zero-length key so that we don't
4751 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4752 if( psa_get_key_bits( attributes ) == 0 )
4753 return( PSA_ERROR_INVALID_ARGUMENT );
4754
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004755 if( ! operation->can_output_key )
4756 return( PSA_ERROR_NOT_PERMITTED );
4757
Ronald Cron81709fc2020-11-14 12:10:32 +01004758 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4759 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004760#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4761 if( driver != NULL )
4762 {
4763 /* Deriving a key in a secure element is not implemented yet. */
4764 status = PSA_ERROR_NOT_SUPPORTED;
4765 }
4766#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004767 if( status == PSA_SUCCESS )
4768 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004769 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004770 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004771 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004772 }
4773 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004774 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004775 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004776 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004777
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004778 return( status );
4779}
4780
Gilles Peskineeab56e42018-07-12 17:12:33 +02004781
4782
4783/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004784/* Key derivation */
4785/****************************************************************/
4786
Steven Cooreman932ffb72021-02-15 12:14:32 +01004787#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004788static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004789 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004790 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004791{
John Durkop07cc04a2020-11-16 22:08:34 -08004792 int is_kdf_alg_supported;
4793
Janos Follath5fe19732019-06-20 15:09:30 +01004794 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4795 * initialisers for this union leave some bytes unspecified.) */
4796 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4797
Gilles Peskine969c5d62019-01-16 15:53:06 +01004798 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004799#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004800 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4801 is_kdf_alg_supported = 1;
4802 else
4803#endif
4804#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4805 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4806 is_kdf_alg_supported = 1;
4807 else
4808#endif
4809#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4810 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4811 is_kdf_alg_supported = 1;
4812 else
4813#endif
4814 is_kdf_alg_supported = 0;
4815
4816 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004818 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004819 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004820 if( hash_size == 0 )
4821 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004822 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4823 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004824 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004825 {
4826 return( PSA_ERROR_NOT_SUPPORTED );
4827 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004828 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004829 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004830 }
John Durkop07cc04a2020-11-16 22:08:34 -08004831
4832 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004833}
John Durkop07cc04a2020-11-16 22:08:34 -08004834#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004835
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004836psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004837 psa_algorithm_t alg )
4838{
4839 psa_status_t status;
4840
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004841 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004842 return( PSA_ERROR_BAD_STATE );
4843
Gilles Peskine6843c292019-01-18 16:44:49 +01004844 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4845 return( PSA_ERROR_INVALID_ARGUMENT );
4846 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004847 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004848#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004849 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004850 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004851#else
4852 return( PSA_ERROR_NOT_SUPPORTED );
4853#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004854 }
4855 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4856 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004857#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004858 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004859#else
4860 return( PSA_ERROR_NOT_SUPPORTED );
4861#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004862 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004863 else
4864 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004865
4866 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004867 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004868 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004869}
4870
John Durkopd0321952020-10-29 21:37:36 -07004871#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004872static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004873 psa_algorithm_t hash_alg,
4874 psa_key_derivation_step_t step,
4875 const uint8_t *data,
4876 size_t data_length )
4877{
4878 psa_status_t status;
4879 switch( step )
4880 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004881 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004882 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004883 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004884 else
4885 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004886 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4887 hash_alg,
4888 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004889 if( status != PSA_SUCCESS )
4890 return( status );
4891 hkdf->state = HKDF_STATE_STARTED;
4892 return( PSA_SUCCESS );
4893 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004894 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004895 /* If no salt was provided, use an empty salt. */
4896 if( hkdf->state == HKDF_STATE_INIT )
4897 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004898 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4899 hash_alg,
4900 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004901 if( status != PSA_SUCCESS )
4902 return( status );
4903 hkdf->state = HKDF_STATE_STARTED;
4904 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004905 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004906 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004907 status = psa_mac_update( &hkdf->hmac,
4908 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004909 if( status != PSA_SUCCESS )
4910 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004911 status = psa_mac_sign_finish( &hkdf->hmac,
4912 hkdf->prk,
4913 sizeof( hkdf->prk ),
4914 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004915 if( status != PSA_SUCCESS )
4916 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004917 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004918 hkdf->block_number = 0;
4919 hkdf->state = HKDF_STATE_KEYED;
4920 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004921 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004922 if( hkdf->state == HKDF_STATE_OUTPUT )
4923 return( PSA_ERROR_BAD_STATE );
4924 if( hkdf->info_set )
4925 return( PSA_ERROR_BAD_STATE );
4926 hkdf->info_length = data_length;
4927 if( data_length != 0 )
4928 {
4929 hkdf->info = mbedtls_calloc( 1, data_length );
4930 if( hkdf->info == NULL )
4931 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4932 memcpy( hkdf->info, data, data_length );
4933 }
4934 hkdf->info_set = 1;
4935 return( PSA_SUCCESS );
4936 default:
4937 return( PSA_ERROR_INVALID_ARGUMENT );
4938 }
4939}
John Durkop07cc04a2020-11-16 22:08:34 -08004940#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004941
John Durkop07cc04a2020-11-16 22:08:34 -08004942#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4943 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004944static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4945 const uint8_t *data,
4946 size_t data_length )
4947{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004948 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004949 return( PSA_ERROR_BAD_STATE );
4950
Janos Follathd6dce9f2019-07-04 09:11:38 +01004951 if( data_length != 0 )
4952 {
4953 prf->seed = mbedtls_calloc( 1, data_length );
4954 if( prf->seed == NULL )
4955 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004956
Janos Follathd6dce9f2019-07-04 09:11:38 +01004957 memcpy( prf->seed, data, data_length );
4958 prf->seed_length = data_length;
4959 }
Janos Follathf08e2652019-06-13 09:05:41 +01004960
Gilles Peskine43f958b2020-12-13 14:55:14 +01004961 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004962
4963 return( PSA_SUCCESS );
4964}
4965
Janos Follath81550542019-06-13 14:26:34 +01004966static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004967 const uint8_t *data,
4968 size_t data_length )
4969{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004970 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004971 return( PSA_ERROR_BAD_STATE );
4972
Steven Cooremana6df6042021-04-29 19:32:25 +02004973 if( data_length != 0 )
4974 {
4975 prf->secret = mbedtls_calloc( 1, data_length );
4976 if( prf->secret == NULL )
4977 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4978
4979 memcpy( prf->secret, data, data_length );
4980 prf->secret_length = data_length;
4981 }
Janos Follath81550542019-06-13 14:26:34 +01004982
Gilles Peskine43f958b2020-12-13 14:55:14 +01004983 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004984
4985 return( PSA_SUCCESS );
4986}
4987
Janos Follath63028dd2019-06-13 09:15:47 +01004988static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4989 const uint8_t *data,
4990 size_t data_length )
4991{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004992 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004993 return( PSA_ERROR_BAD_STATE );
4994
Janos Follathd6dce9f2019-07-04 09:11:38 +01004995 if( data_length != 0 )
4996 {
4997 prf->label = mbedtls_calloc( 1, data_length );
4998 if( prf->label == NULL )
4999 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005000
Janos Follathd6dce9f2019-07-04 09:11:38 +01005001 memcpy( prf->label, data, data_length );
5002 prf->label_length = data_length;
5003 }
Janos Follath63028dd2019-06-13 09:15:47 +01005004
Gilles Peskine43f958b2020-12-13 14:55:14 +01005005 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005006
5007 return( PSA_SUCCESS );
5008}
5009
Janos Follathb03233e2019-06-11 15:30:30 +01005010static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005011 psa_key_derivation_step_t step,
5012 const uint8_t *data,
5013 size_t data_length )
5014{
Janos Follathb03233e2019-06-11 15:30:30 +01005015 switch( step )
5016 {
Janos Follathf08e2652019-06-13 09:05:41 +01005017 case PSA_KEY_DERIVATION_INPUT_SEED:
5018 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005019 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005020 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005021 case PSA_KEY_DERIVATION_INPUT_LABEL:
5022 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005023 default:
5024 return( PSA_ERROR_INVALID_ARGUMENT );
5025 }
5026}
John Durkop07cc04a2020-11-16 22:08:34 -08005027#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5028 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5029
5030#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5031static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5032 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005033 const uint8_t *data,
5034 size_t data_length )
5035{
5036 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005037 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005038 uint8_t *cur = pms;
5039
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005040 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005041 return( PSA_ERROR_INVALID_ARGUMENT );
5042
5043 /* Quoting RFC 4279, Section 2:
5044 *
5045 * The premaster secret is formed as follows: if the PSK is N octets
5046 * long, concatenate a uint16 with the value N, N zero octets, a second
5047 * uint16 with the value N, and the PSK itself.
5048 */
5049
Joe Subbiani5ecac212021-06-24 13:00:03 +01005050 *cur++ = MBEDTLS_BYTE_1( data_length );
5051 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005052 memset( cur, 0, data_length );
5053 cur += data_length;
5054 *cur++ = pms[0];
5055 *cur++ = pms[1];
5056 memcpy( cur, data, data_length );
5057 cur += data_length;
5058
Steven Cooremana6df6042021-04-29 19:32:25 +02005059 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005060
5061 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5062 return( status );
5063}
Janos Follath6660f0e2019-06-17 08:44:03 +01005064
5065static psa_status_t psa_tls12_prf_psk_to_ms_input(
5066 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005067 psa_key_derivation_step_t step,
5068 const uint8_t *data,
5069 size_t data_length )
5070{
5071 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005072 {
Steven Cooremana6df6042021-04-29 19:32:25 +02005073 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005074 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005075 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005076
Steven Cooremana6df6042021-04-29 19:32:25 +02005077 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01005078}
John Durkop07cc04a2020-11-16 22:08:34 -08005079#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005080
Gilles Peskineb8965192019-09-24 16:21:10 +02005081/** Check whether the given key type is acceptable for the given
5082 * input step of a key derivation.
5083 *
5084 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5085 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5086 * Both secret and non-secret inputs can alternatively have the type
5087 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5088 * that the input was passed as a buffer rather than via a key object.
5089 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005090static int psa_key_derivation_check_input_type(
5091 psa_key_derivation_step_t step,
5092 psa_key_type_t key_type )
5093{
5094 switch( step )
5095 {
5096 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005097 if( key_type == PSA_KEY_TYPE_DERIVE )
5098 return( PSA_SUCCESS );
5099 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005100 return( PSA_SUCCESS );
5101 break;
5102 case PSA_KEY_DERIVATION_INPUT_LABEL:
5103 case PSA_KEY_DERIVATION_INPUT_SALT:
5104 case PSA_KEY_DERIVATION_INPUT_INFO:
5105 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005106 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5107 return( PSA_SUCCESS );
5108 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005109 return( PSA_SUCCESS );
5110 break;
5111 }
5112 return( PSA_ERROR_INVALID_ARGUMENT );
5113}
5114
Janos Follathb80a94e2019-06-12 15:54:46 +01005115static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005116 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005117 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005118 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005119 const uint8_t *data,
5120 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005121{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005122 psa_status_t status;
5123 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5124
5125 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005126 if( status != PSA_SUCCESS )
5127 goto exit;
5128
John Durkopd0321952020-10-29 21:37:36 -07005129#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005130 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005131 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005132 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005133 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005134 step, data, data_length );
5135 }
John Durkop07cc04a2020-11-16 22:08:34 -08005136 else
5137#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5138#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5139 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005140 {
Janos Follathb03233e2019-06-11 15:30:30 +01005141 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005142 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005143 }
John Durkop07cc04a2020-11-16 22:08:34 -08005144 else
5145#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5146#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5147 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005148 {
5149 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005150 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005151 }
5152 else
John Durkop07cc04a2020-11-16 22:08:34 -08005153#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005154 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005155 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005156 (void) data;
5157 (void) data_length;
5158 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005159 return( PSA_ERROR_BAD_STATE );
5160 }
5161
Gilles Peskine224b0d62019-09-23 18:13:17 +02005162exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005163 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005164 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005165 return( status );
5166}
5167
Janos Follath51f4a0f2019-06-14 11:35:55 +01005168psa_status_t psa_key_derivation_input_bytes(
5169 psa_key_derivation_operation_t *operation,
5170 psa_key_derivation_step_t step,
5171 const uint8_t *data,
5172 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005173{
Gilles Peskineb8965192019-09-24 16:21:10 +02005174 return( psa_key_derivation_input_internal( operation, step,
5175 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005176 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005177}
5178
Janos Follath51f4a0f2019-06-14 11:35:55 +01005179psa_status_t psa_key_derivation_input_key(
5180 psa_key_derivation_operation_t *operation,
5181 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005182 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005183{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005185 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005186 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005187
Ronald Cron5c522922020-11-14 16:35:34 +01005188 status = psa_get_and_lock_transparent_key_slot_with_policy(
5189 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005190 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005191 {
5192 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005193 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005194 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005195
5196 /* Passing a key object as a SECRET input unlocks the permission
5197 * to output to a key object. */
5198 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5199 operation->can_output_key = 1;
5200
Ronald Cronf95a2b12020-10-22 15:24:49 +02005201 status = psa_key_derivation_input_internal( operation,
5202 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005203 slot->key.data,
5204 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005205
Ronald Cron5c522922020-11-14 16:35:34 +01005206 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005207
Ronald Cron5c522922020-11-14 16:35:34 +01005208 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005209}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005210
5211
5212
5213/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005214/* Key agreement */
5215/****************************************************************/
5216
John Durkop6ba40d12020-11-10 08:50:04 -08005217#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005218static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5219 size_t peer_key_length,
5220 const mbedtls_ecp_keypair *our_key,
5221 uint8_t *shared_secret,
5222 size_t shared_secret_size,
5223 size_t *shared_secret_length )
5224{
Steven Cooremand4867872020-08-05 16:31:39 +02005225 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005226 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005227 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005228 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005229 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005230 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005231
Ronald Cron90857082020-11-25 14:58:33 +01005232 status = mbedtls_psa_ecp_load_representation(
5233 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005234 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005235 peer_key,
5236 peer_key_length,
5237 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005238 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005239 goto exit;
5240
Jaeden Amero97271b32019-01-10 19:38:51 +00005241 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005242 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005243 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005244 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005245 status = mbedtls_to_psa_error(
5246 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5247 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005248 goto exit;
5249
Jaeden Amero97271b32019-01-10 19:38:51 +00005250 status = mbedtls_to_psa_error(
5251 mbedtls_ecdh_calc_secret( &ecdh,
5252 shared_secret_length,
5253 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005254 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005255 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005256 if( status != PSA_SUCCESS )
5257 goto exit;
5258 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5259 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005260
5261exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005262 if( status != PSA_SUCCESS )
5263 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005264 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005265 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005266 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005267
Jaeden Amero97271b32019-01-10 19:38:51 +00005268 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005269}
John Durkop6ba40d12020-11-10 08:50:04 -08005270#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005271
Gilles Peskine01d718c2018-09-18 12:01:02 +02005272#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5273
Gilles Peskine0216fe12019-04-11 21:23:21 +02005274static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5275 psa_key_slot_t *private_key,
5276 const uint8_t *peer_key,
5277 size_t peer_key_length,
5278 uint8_t *shared_secret,
5279 size_t shared_secret_size,
5280 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005281{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005282 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005283 {
John Durkop6ba40d12020-11-10 08:50:04 -08005284#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005285 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005286 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005287 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005288 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005289 psa_status_t status = mbedtls_psa_ecp_load_representation(
5290 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005291 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005292 private_key->key.data,
5293 private_key->key.bytes,
5294 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005295 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005296 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005297 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005298 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005299 shared_secret, shared_secret_size,
5300 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005301 mbedtls_ecp_keypair_free( ecp );
5302 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005303 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005304#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005305 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005306 (void) private_key;
5307 (void) peer_key;
5308 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005309 (void) shared_secret;
5310 (void) shared_secret_size;
5311 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005312 return( PSA_ERROR_NOT_SUPPORTED );
5313 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005314}
5315
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005316/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005317 * to potentially free embedded data structures and wipe confidential data.
5318 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005319static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005320 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005321 psa_key_slot_t *private_key,
5322 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005323 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005324{
5325 psa_status_t status;
5326 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5327 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005328 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005329
5330 /* Step 1: run the secret agreement algorithm to generate the shared
5331 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005332 status = psa_key_agreement_raw_internal( ka_alg,
5333 private_key,
5334 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005335 shared_secret,
5336 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005337 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005338 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005339 goto exit;
5340
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005341 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005342 * the shared secret. A shared secret is permitted wherever a key
5343 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005344 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005345 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005346 shared_secret,
5347 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005348exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005349 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005350 return( status );
5351}
5352
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005353psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005354 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005355 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005356 const uint8_t *peer_key,
5357 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005358{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005359 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005360 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005361 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005362
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005363 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005364 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005365 status = psa_get_and_lock_transparent_key_slot_with_policy(
5366 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005367 if( status != PSA_SUCCESS )
5368 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005369 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005370 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005371 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005372 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005373 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005374 else
5375 {
5376 /* If a private key has been added as SECRET, we allow the derived
5377 * key material to be used as a key in PSA Crypto. */
5378 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5379 operation->can_output_key = 1;
5380 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005381
Ronald Cron5c522922020-11-14 16:35:34 +01005382 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005383
Ronald Cron5c522922020-11-14 16:35:34 +01005384 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005385}
5386
Gilles Peskinebe697d82019-05-16 18:00:41 +02005387psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005388 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005389 const uint8_t *peer_key,
5390 size_t peer_key_length,
5391 uint8_t *output,
5392 size_t output_size,
5393 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005394{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005396 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005397 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005398
5399 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5400 {
5401 status = PSA_ERROR_INVALID_ARGUMENT;
5402 goto exit;
5403 }
Ronald Cron5c522922020-11-14 16:35:34 +01005404 status = psa_get_and_lock_transparent_key_slot_with_policy(
5405 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005406 if( status != PSA_SUCCESS )
5407 goto exit;
5408
5409 status = psa_key_agreement_raw_internal( alg, slot,
5410 peer_key, peer_key_length,
5411 output, output_size,
5412 output_length );
5413
5414exit:
5415 if( status != PSA_SUCCESS )
5416 {
5417 /* If an error happens and is not handled properly, the output
5418 * may be used as a key to protect sensitive data. Arrange for such
5419 * a key to be random, which is likely to result in decryption or
5420 * verification errors. This is better than filling the buffer with
5421 * some constant data such as zeros, which would result in the data
5422 * being protected with a reproducible, easily knowable key.
5423 */
5424 psa_generate_random( output, output_size );
5425 *output_length = output_size;
5426 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005427
Ronald Cron5c522922020-11-14 16:35:34 +01005428 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005429
Ronald Cron5c522922020-11-14 16:35:34 +01005430 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005431}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005432
5433
Gilles Peskine30524eb2020-11-13 17:02:26 +01005434
Gilles Peskine86a440b2018-11-12 18:39:40 +01005435/****************************************************************/
5436/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005437/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005438
Gilles Peskine30524eb2020-11-13 17:02:26 +01005439/** Initialize the PSA random generator.
5440 */
5441static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5442{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005443#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5444 memset( rng, 0, sizeof( *rng ) );
5445#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5446
Gilles Peskine30524eb2020-11-13 17:02:26 +01005447 /* Set default configuration if
5448 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5449 if( rng->entropy_init == NULL )
5450 rng->entropy_init = mbedtls_entropy_init;
5451 if( rng->entropy_free == NULL )
5452 rng->entropy_free = mbedtls_entropy_free;
5453
5454 rng->entropy_init( &rng->entropy );
5455#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5456 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5457 /* The PSA entropy injection feature depends on using NV seed as an entropy
5458 * source. Add NV seed as an entropy source for PSA entropy injection. */
5459 mbedtls_entropy_add_source( &rng->entropy,
5460 mbedtls_nv_seed_poll, NULL,
5461 MBEDTLS_ENTROPY_BLOCK_SIZE,
5462 MBEDTLS_ENTROPY_SOURCE_STRONG );
5463#endif
5464
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005465 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005466#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005467}
5468
5469/** Deinitialize the PSA random generator.
5470 */
5471static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5472{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005473#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5474 memset( rng, 0, sizeof( *rng ) );
5475#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005476 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005477 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005478#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005479}
5480
5481/** Seed the PSA random generator.
5482 */
5483static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5484{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005485#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5486 /* Do nothing: the external RNG seeds itself. */
5487 (void) rng;
5488 return( PSA_SUCCESS );
5489#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005490 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005491 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5492 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005493 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005494#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005495}
5496
Gilles Peskinee59236f2018-01-27 23:32:46 +01005497psa_status_t psa_generate_random( uint8_t *output,
5498 size_t output_size )
5499{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005500 GUARD_MODULE_INITIALIZED;
5501
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005502#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5503
5504 size_t output_length = 0;
5505 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5506 output, output_size,
5507 &output_length );
5508 if( status != PSA_SUCCESS )
5509 return( status );
5510 /* Breaking up a request into smaller chunks is currently not supported
5511 * for the extrernal RNG interface. */
5512 if( output_length != output_size )
5513 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5514 return( PSA_SUCCESS );
5515
5516#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5517
Gilles Peskine71ddab92021-01-04 21:01:07 +01005518 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005519 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005520 size_t request_size =
5521 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5522 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5523 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005524 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5525 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005526 if( ret != 0 )
5527 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005528 output_size -= request_size;
5529 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005530 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005531 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005532#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005533}
5534
Gilles Peskine8814fc42020-12-14 15:33:44 +01005535/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005536 *
5537 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5538 * `psa_generate_random(...)`. The state parameter is ignored since the
5539 * PSA API doesn't support passing an explicit state.
5540 *
5541 * In the non-external case, psa_generate_random() calls an
5542 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5543 * and semantics as mbedtls_psa_get_random(). As an optimization,
5544 * instead of doing this back-and-forth between the PSA API and the
5545 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5546 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005547 */
5548#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5549int mbedtls_psa_get_random( void *p_rng,
5550 unsigned char *output,
5551 size_t output_size )
5552{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005553 /* This function takes a pointer to the RNG state because that's what
5554 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5555 * its own state internally and doesn't let the caller access that state.
5556 * So we just ignore the state parameter, and in practice we'll pass
5557 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005558 (void) p_rng;
5559 psa_status_t status = psa_generate_random( output, output_size );
5560 if( status == PSA_SUCCESS )
5561 return( 0 );
5562 else
5563 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5564}
5565#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5566
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005567#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005568#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005569
Gilles Peskine7228da22019-07-15 11:06:15 +02005570psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005571 size_t seed_size )
5572{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005573 if( global_data.initialized )
5574 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005575
5576 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5577 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5578 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5579 return( PSA_ERROR_INVALID_ARGUMENT );
5580
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005581 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005582}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005583#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005584
Ronald Cron3772afe2021-02-08 16:10:05 +01005585/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005586 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005587 * \param type The key type
5588 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005589 *
5590 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005591 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005592 * \retval #PSA_ERROR_INVALID_ARGUMENT
5593 * The size in bits of the key is not valid.
5594 * \retval #PSA_ERROR_NOT_SUPPORTED
5595 * The type and/or the size in bits of the key or the combination of
5596 * the two is not supported.
5597 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005598static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5599 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005600{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005601 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005602
Gilles Peskinee59236f2018-01-27 23:32:46 +01005603 if( key_type_is_raw_bytes( type ) )
5604 {
Archana4d7ae1d2021-07-07 02:50:22 +05305605 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005606 if( status != PSA_SUCCESS )
5607 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005608 }
5609 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005610#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005611 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5612 {
5613 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5614 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005615
Ronald Cron01b2aba2020-10-05 09:42:02 +02005616 /* Accept only byte-aligned keys, for the same reasons as
5617 * in psa_import_rsa_key(). */
5618 if( bits % 8 != 0 )
5619 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005620 }
5621 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005622#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005623
Ronald Cron5c4d3862020-12-07 11:07:24 +01005624#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005625 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5626 {
Ronald Crond81ab562021-02-16 09:01:16 +01005627 /* To avoid empty block, return successfully here. */
5628 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005629 }
5630 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005631#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005632 {
5633 return( PSA_ERROR_NOT_SUPPORTED );
5634 }
5635
5636 return( PSA_SUCCESS );
5637}
5638
Ronald Cron55ed0592020-10-05 10:30:40 +02005639psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005640 const psa_key_attributes_t *attributes,
5641 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005642{
5643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005644 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005645
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005646 if( ( attributes->domain_parameters == NULL ) &&
5647 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005648 return( PSA_ERROR_INVALID_ARGUMENT );
5649
Ronald Cron01b2aba2020-10-05 09:42:02 +02005650 if( key_type_is_raw_bytes( type ) )
5651 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005652 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005653 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005654 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005655
David Brown12ca5032021-02-11 11:02:00 -07005656#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005657 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005658 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005659#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005660 }
5661 else
5662
Jaeden Amero424fa932021-05-14 08:34:32 +01005663#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5664 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005665 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005666 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005667 return( mbedtls_psa_rsa_generate_key( attributes,
5668 key_buffer,
5669 key_buffer_size,
5670 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005671 }
5672 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005673#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5674 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005675
John Durkop9814fa22020-11-04 12:28:15 -08005676#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005677 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005678 {
Ronald Cron7023db52020-11-20 18:17:42 +01005679 return( mbedtls_psa_ecp_generate_key( attributes,
5680 key_buffer,
5681 key_buffer_size,
5682 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005683 }
5684 else
John Durkop9814fa22020-11-04 12:28:15 -08005685#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005686 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005687 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005688 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005689 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005690
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005691 return( PSA_SUCCESS );
5692}
Darryl Green0c6575a2018-11-07 16:05:30 +00005693
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005694psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005695 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005696{
5697 psa_status_t status;
5698 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005699 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005700 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005701
Ronald Cron81709fc2020-11-14 12:10:32 +01005702 *key = MBEDTLS_SVC_KEY_ID_INIT;
5703
Gilles Peskine0f84d622019-09-12 19:03:13 +02005704 /* Reject any attempt to create a zero-length key so that we don't
5705 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5706 if( psa_get_key_bits( attributes ) == 0 )
5707 return( PSA_ERROR_INVALID_ARGUMENT );
5708
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02005709 /* Reject any attempt to create a public key. */
5710 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5711 return( PSA_ERROR_INVALID_ARGUMENT );
5712
Ronald Cron81709fc2020-11-14 12:10:32 +01005713 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5714 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005715 if( status != PSA_SUCCESS )
5716 goto exit;
5717
Ronald Cron977c2472020-10-13 08:32:21 +02005718 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305719 * storage ( thus not in the case of generating a key in a secure element
5720 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5721 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005722 if( slot->key.data == NULL )
5723 {
5724 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5725 PSA_KEY_LOCATION_LOCAL_STORAGE )
5726 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005727 status = psa_validate_key_type_and_size_for_key_generation(
5728 attributes->core.type, attributes->core.bits );
5729 if( status != PSA_SUCCESS )
5730 goto exit;
5731
5732 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5733 attributes->core.type,
5734 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005735 }
5736 else
5737 {
5738 status = psa_driver_wrapper_get_key_buffer_size(
5739 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005740 if( status != PSA_SUCCESS )
5741 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005742 }
Ronald Cron977c2472020-10-13 08:32:21 +02005743
5744 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5745 if( status != PSA_SUCCESS )
5746 goto exit;
5747 }
5748
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005749 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005750 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005751
Ronald Cron2b56bc82020-10-05 10:02:26 +02005752 if( status != PSA_SUCCESS )
5753 psa_remove_key_data_from_memory( slot );
5754
Gilles Peskine11792082019-08-06 18:36:36 +02005755exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005756 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005757 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005758 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005759 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005760
Darryl Green0c6575a2018-11-07 16:05:30 +00005761 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005762}
5763
Gilles Peskinee59236f2018-01-27 23:32:46 +01005764/****************************************************************/
5765/* Module setup */
5766/****************************************************************/
5767
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005768#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005769psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5770 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5771 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5772{
5773 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5774 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005775 global_data.rng.entropy_init = entropy_init;
5776 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005777 return( PSA_SUCCESS );
5778}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005779#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005780
Gilles Peskinee59236f2018-01-27 23:32:46 +01005781void mbedtls_psa_crypto_free( void )
5782{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005783 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005784 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5785 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005786 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005787 }
5788 /* Wipe all remaining data, including configuration.
5789 * In particular, this sets all state indicator to the value
5790 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005791 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005792#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005793 /* Unregister all secure element drivers, so that we restart from
5794 * a pristine state. */
5795 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005796#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005797}
5798
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005799#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5800/** Recover a transaction that was interrupted by a power failure.
5801 *
5802 * This function is called during initialization, before psa_crypto_init()
5803 * returns. If this function returns a failure status, the initialization
5804 * fails.
5805 */
5806static psa_status_t psa_crypto_recover_transaction(
5807 const psa_crypto_transaction_t *transaction )
5808{
5809 switch( transaction->unknown.type )
5810 {
5811 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5812 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005813 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005814 * is implemented.
5815 * https://github.com/ARMmbed/mbed-crypto/issues/218
5816 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005817 default:
5818 /* We found an unsupported transaction in the storage.
5819 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005820 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005821 }
5822}
5823#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5824
Gilles Peskinee59236f2018-01-27 23:32:46 +01005825psa_status_t psa_crypto_init( void )
5826{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005827 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005828
Gilles Peskinec6b69072018-11-20 21:42:52 +01005829 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005830 if( global_data.initialized != 0 )
5831 return( PSA_SUCCESS );
5832
Gilles Peskine30524eb2020-11-13 17:02:26 +01005833 /* Initialize and seed the random generator. */
5834 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005835 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005836 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005837 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005838 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005839 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005840
Gilles Peskine66fb1262018-12-10 16:29:04 +01005841 status = psa_initialize_key_slots( );
5842 if( status != PSA_SUCCESS )
5843 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005844
Gilles Peskined9348f22019-10-01 15:22:29 +02005845#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5846 status = psa_init_all_se_drivers( );
5847 if( status != PSA_SUCCESS )
5848 goto exit;
5849#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5850
Gilles Peskine4b734222019-07-24 15:56:31 +02005851#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005852 status = psa_crypto_load_transaction( );
5853 if( status == PSA_SUCCESS )
5854 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005855 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5856 if( status != PSA_SUCCESS )
5857 goto exit;
5858 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005859 }
5860 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5861 {
5862 /* There's no transaction to complete. It's all good. */
5863 status = PSA_SUCCESS;
5864 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005865#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005866
Gilles Peskinec6b69072018-11-20 21:42:52 +01005867 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005868 global_data.initialized = 1;
5869
5870exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005871 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005872 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005873 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005874}
5875
5876#endif /* MBEDTLS_PSA_CRYPTO_C */