blob: 9134dee64a9fd547469241506036977765ad4cce [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 Durkop9814fa22020-11-04 12:28:15 -0800327#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800328 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100329 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
330 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
331 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100332mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100333 size_t bits,
334 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200335{
336 switch( curve )
337 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100338 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100339 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100340 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100341#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100342 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100343 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100344#endif
345#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100346 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100347 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100348#endif
349#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100350 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100351 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100352#endif
353#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100354 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100355 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100356#endif
357#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100358 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100359 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 528:
361 if( bits_is_sloppy )
362 return( MBEDTLS_ECP_DP_SECP521R1 );
363 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100364#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100365 }
366 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100367
Paul Elliott8ff510a2020-06-02 17:19:28 +0100368 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100370 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100371#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100372 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#endif
375#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100382#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 }
384 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100385
Paul Elliott8ff510a2020-06-02 17:19:28 +0100386 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100387 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100388 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100389#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100390 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100392 case 256:
393 if( bits_is_sloppy )
394 return( MBEDTLS_ECP_DP_CURVE25519 );
395 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#endif
397#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 }
402 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100403
Paul Elliott8ff510a2020-06-02 17:19:28 +0100404 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100407#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100408 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100410#endif
411#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 }
420 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200421 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100422
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100423 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200425}
John Durkop9814fa22020-11-04 12:28:15 -0800426#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100427 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
428 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
429 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
430 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200431
Archana4d7ae1d2021-07-07 02:50:22 +0530432psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530433 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200434{
435 /* Check that the bit size is acceptable for the key type */
436 switch( type )
437 {
438 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200439 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200440 case PSA_KEY_TYPE_DERIVE:
441 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100442#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443 case PSA_KEY_TYPE_AES:
444 if( bits != 128 && bits != 192 && bits != 256 )
445 return( PSA_ERROR_INVALID_ARGUMENT );
446 break;
447#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200448#if defined(PSA_WANT_KEY_TYPE_ARIA)
449 case PSA_KEY_TYPE_ARIA:
450 if( bits != 128 && bits != 192 && bits != 256 )
451 return( PSA_ERROR_INVALID_ARGUMENT );
452 break;
453#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100454#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455 case PSA_KEY_TYPE_CAMELLIA:
456 if( bits != 128 && bits != 192 && bits != 256 )
457 return( PSA_ERROR_INVALID_ARGUMENT );
458 break;
459#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100460#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200461 case PSA_KEY_TYPE_DES:
462 if( bits != 64 && bits != 128 && bits != 192 )
463 return( PSA_ERROR_INVALID_ARGUMENT );
464 break;
465#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100466#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200467 case PSA_KEY_TYPE_CHACHA20:
468 if( bits != 256 )
469 return( PSA_ERROR_INVALID_ARGUMENT );
470 break;
471#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200472 default:
473 return( PSA_ERROR_NOT_SUPPORTED );
474 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200475 if( bits % 8 != 0 )
476 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200477
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478 return( PSA_SUCCESS );
479}
480
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100481/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100482 *
Steven Cooremancd640932021-03-08 12:00:27 +0100483 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
484 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100485 *
486 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100487 * \param[in] key_type The key type of the key to be used with the
488 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100489 *
490 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100491 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100492 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100493 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100494 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100495MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100496 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100497 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498{
Steven Cooremancd640932021-03-08 12:00:27 +0100499 if( PSA_ALG_IS_HMAC( algorithm ) )
500 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100501 if( key_type == PSA_KEY_TYPE_HMAC )
502 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504
505 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100506 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100507 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
508 * key. */
509 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
510 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
511 {
512 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
513 * the block length (larger than 1) for block ciphers. */
514 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
515 return( PSA_SUCCESS );
516 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100517 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100518
519 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100520}
521
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200522psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
523 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200524{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100525 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200526 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200527
Ronald Cronea0f8a62020-11-25 17:52:23 +0100528 slot->key.data = mbedtls_calloc( 1, buffer_length );
529 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200530 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200531
Ronald Cronea0f8a62020-11-25 17:52:23 +0100532 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200533 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200534}
535
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200536psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
537 const uint8_t* data,
538 size_t data_length )
539{
540 psa_status_t status = psa_allocate_buffer_to_slot( slot,
541 data_length );
542 if( status != PSA_SUCCESS )
543 return( status );
544
Ronald Cronea0f8a62020-11-25 17:52:23 +0100545 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200546 return( PSA_SUCCESS );
547}
548
Ronald Crona0fe59f2020-11-29 11:14:53 +0100549psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100550 const psa_key_attributes_t *attributes,
551 const uint8_t *data, size_t data_length,
552 uint8_t *key_buffer, size_t key_buffer_size,
553 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100554{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
556 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100557
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200558 /* zero-length keys are never supported. */
559 if( data_length == 0 )
560 return( PSA_ERROR_NOT_SUPPORTED );
561
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100562 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100563 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200565
Archana449608b2021-09-08 15:36:05 +0530566 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
567 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200568 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200569 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200570
Ronald Crondd04d422020-11-28 15:14:42 +0100571 /* Copy the key material. */
572 memcpy( key_buffer, data, data_length );
573 *key_buffer_length = data_length;
574 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200575
Steven Cooreman40120f62020-10-29 11:42:22 +0100576 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100577 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100578 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200579 {
John Durkop9814fa22020-11-04 12:28:15 -0800580#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
581 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100582 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200583 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100584 return( mbedtls_psa_ecp_import_key( attributes,
585 data, data_length,
586 key_buffer, key_buffer_size,
587 key_buffer_length,
588 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100589 }
John Durkop9814fa22020-11-04 12:28:15 -0800590#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
591 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700592#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100594 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200595 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100596 return( mbedtls_psa_rsa_import_key( attributes,
597 data, data_length,
598 key_buffer, key_buffer_size,
599 key_buffer_length,
600 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200601 }
John Durkop9814fa22020-11-04 12:28:15 -0800602#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
603 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100604 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100605
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100606 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100607}
608
Gilles Peskinef603c712019-01-19 13:40:11 +0100609/** Calculate the intersection of two algorithm usage policies.
610 *
611 * Return 0 (which allows no operation) on incompatibility.
612 */
613static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100614 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100615 psa_algorithm_t alg1,
616 psa_algorithm_t alg2 )
617{
Gilles Peskine549ea862019-05-22 11:45:59 +0200618 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100619 if( alg1 == alg2 )
620 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100621 /* If the policies are from the same hash-and-sign family, check
622 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200623 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
624 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100625 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100626 {
Steven Cooreman03488022021-02-18 12:07:20 +0100627 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
628 return( alg2 );
629 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
630 return( alg1 );
631 }
632 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100633 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100634 * restrictive tag length. */
635 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
636 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
637 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
638 {
639 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
640 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100641 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100642
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100643 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100644 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
645 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100646 {
Steven Cooremancd640932021-03-08 12:00:27 +0100647 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
648 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100649 }
650 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100651 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100652 ( alg1_len <= alg2_len ) )
653 {
654 return( alg2 );
655 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100656 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100657 ( alg2_len <= alg1_len ) )
658 {
659 return( alg1 );
660 }
661 }
662 /* If the policies are from the same MAC family, check whether one
663 * of them is a minimum-MAC-length policy. Calculate the most
664 * restrictive tag length. */
665 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
666 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
667 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
668 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100669 /* Validate the combination of key type and algorithm. Since the base
670 * algorithm of alg1 and alg2 are the same, we only need this once. */
671 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100672 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100673
Steven Cooreman31a876d2021-03-03 20:47:40 +0100674 /* Get the (exact or at-least) output lengths for both sides of the
675 * requested intersection. None of the currently supported algorithms
676 * have an output length dependent on the actual key size, so setting it
677 * to a bogus value of 0 is currently OK.
678 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100679 * Note that for at-least-this-length wildcard algorithms, the output
680 * length is set to the shortest allowed length, which allows us to
681 * calculate the most restrictive tag length for the intersection. */
682 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
683 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100684 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100685
Steven Cooremana1d83222021-02-25 10:20:29 +0100686 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100687 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
688 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100689 {
Steven Cooremancd640932021-03-08 12:00:27 +0100690 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100691 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100692
693 /* If only one is an at-least-this-length policy, the intersection would
694 * be the other (fixed-length) policy as long as said fixed length is
695 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100696 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100697 {
Steven Cooremancd640932021-03-08 12:00:27 +0100698 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100699 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100700 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100701 {
Steven Cooremancd640932021-03-08 12:00:27 +0100702 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100703 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100704
Steven Cooremancd640932021-03-08 12:00:27 +0100705 /* If none of them are wildcards, check whether they define the same tag
706 * length. This is still possible here when one is default-length and
707 * the other specific-length. Ensure to always return the
708 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100709 if( alg1_len == alg2_len )
710 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100711 }
712 /* If the policies are incompatible, allow nothing. */
713 return( 0 );
714}
715
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100716static int psa_key_algorithm_permits( psa_key_type_t key_type,
717 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200718 psa_algorithm_t requested_alg )
719{
Gilles Peskine549ea862019-05-22 11:45:59 +0200720 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200721 if( requested_alg == policy_alg )
722 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100723 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
724 * and requested_alg is the same hash-and-sign family with any hash,
725 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200726 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100727 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200728 {
Steven Cooreman03488022021-02-18 12:07:20 +0100729 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
730 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
731 }
732 /* If policy_alg is a wildcard AEAD algorithm of the same base as
733 * the requested algorithm, check the requested tag length to be
734 * equal-length or longer than the wildcard-specified length. */
735 if( PSA_ALG_IS_AEAD( policy_alg ) &&
736 PSA_ALG_IS_AEAD( requested_alg ) &&
737 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
738 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100739 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100740 {
741 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
742 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
743 }
Steven Cooremancd640932021-03-08 12:00:27 +0100744 /* If policy_alg is a MAC algorithm of the same base as the requested
745 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100746 if( PSA_ALG_IS_MAC( policy_alg ) &&
747 PSA_ALG_IS_MAC( requested_alg ) &&
748 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100749 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100750 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100751 /* Validate the combination of key type and algorithm. Since the policy
752 * and requested algorithms are the same, we only need this once. */
753 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100754 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100755
Steven Cooreman31a876d2021-03-03 20:47:40 +0100756 /* Get both the requested output length for the algorithm which is to be
757 * verified, and the default output length for the base algorithm.
758 * Note that none of the currently supported algorithms have an output
759 * length dependent on actual key size, so setting it to a bogus value
760 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100761 size_t requested_output_length = PSA_MAC_LENGTH(
762 key_type, 0, requested_alg );
763 size_t default_output_length = PSA_MAC_LENGTH(
764 key_type, 0,
765 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100766
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100767 /* If the policy is default-length, only allow an algorithm with
768 * a declared exact-length matching the default. */
769 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100770 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100771
772 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100773 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
775 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
776 {
777 return( 1 );
778 }
779
Steven Cooremancd640932021-03-08 12:00:27 +0100780 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
781 * check for the requested MAC length to be equal to or longer than the
782 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
784 {
785 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100787 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200788 }
Steven Cooremance48e852020-10-05 16:02:45 +0200789 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200790 * a key derivation with that key agreement should also be allowed. This
791 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200792 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
793 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
794 {
795 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
796 policy_alg );
797 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100798 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200799 return( 0 );
800}
801
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100802/** Test whether a policy permits an algorithm.
803 *
804 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100805 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100806 * \note This function requires providing the key type for which the policy is
807 * being validated, since some algorithm policy definitions (e.g. MAC)
808 * have different properties depending on what kind of cipher it is
809 * combined with.
810 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100811 * \retval PSA_SUCCESS When \p alg is a specific algorithm
812 * allowed by the \p policy.
813 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
814 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
815 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100816 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100817static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100818 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100819 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100820{
Steven Cooremand788fab2021-02-25 11:29:17 +0100821 /* '0' is not a valid algorithm */
822 if( alg == 0 )
823 return( PSA_ERROR_INVALID_ARGUMENT );
824
Steven Cooreman7e39f052021-02-23 14:18:32 +0100825 /* A requested algorithm cannot be a wildcard. */
826 if( PSA_ALG_IS_WILDCARD( alg ) )
827 return( PSA_ERROR_INVALID_ARGUMENT );
828
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100829 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
830 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100831 return( PSA_SUCCESS );
832 else
833 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100834}
835
Gilles Peskinef603c712019-01-19 13:40:11 +0100836/** Restrict a key policy based on a constraint.
837 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100838 * \note This function requires providing the key type for which the policy is
839 * being restricted, since some algorithm policy definitions (e.g. MAC)
840 * have different properties depending on what kind of cipher it is
841 * combined with.
842 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100843 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100844 * \param[in,out] policy The policy to restrict.
845 * \param[in] constraint The policy constraint to apply.
846 *
847 * \retval #PSA_SUCCESS
848 * \c *policy contains the intersection of the original value of
849 * \c *policy and \c *constraint.
850 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100851 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100852 * \c *policy is unchanged.
853 */
854static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100855 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100856 psa_key_policy_t *policy,
857 const psa_key_policy_t *constraint )
858{
859 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100860 psa_key_policy_algorithm_intersection( key_type, policy->alg,
861 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200862 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100863 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
864 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100865 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
866 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200867 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
868 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100869 policy->usage &= constraint->usage;
870 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200871 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100872 return( PSA_SUCCESS );
873}
874
Ronald Cron5c522922020-11-14 16:35:34 +0100875/** Get the description of a key given its identifier and policy constraints
876 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200877 *
Ronald Cron5c522922020-11-14 16:35:34 +0100878 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100879 * nonzero, the key must allow operations with this algorithm. If \p alg is
880 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100881 *
Ronald Cron5c522922020-11-14 16:35:34 +0100882 * In case of a persistent key, the function loads the description of the key
883 * into a key slot if not already done.
884 *
885 * On success, the returned key slot is locked. It is the responsibility of
886 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200887 */
Ronald Cron5c522922020-11-14 16:35:34 +0100888static psa_status_t psa_get_and_lock_key_slot_with_policy(
889 mbedtls_svc_key_id_t key,
890 psa_key_slot_t **p_slot,
891 psa_key_usage_t usage,
892 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100893{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
895 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100896
Ronald Cron5c522922020-11-14 16:35:34 +0100897 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100898 if( status != PSA_SUCCESS )
899 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200900 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100901
902 /* Enforce that usage policy for the key slot contains all the flags
903 * required by the usage parameter. There is one exception: public
904 * keys can always be exported, so we treat public key objects as
905 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200906 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100907 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200908
Gilles Peskine8e338702019-07-30 20:06:31 +0200909 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100910 {
911 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200912 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914
915 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 if( alg != 0 )
917 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100918 status = psa_key_policy_permits( &slot->attr.policy,
919 slot->attr.type,
920 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100921 if( status != PSA_SUCCESS )
922 goto error;
923 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100924
Darryl Green06fd18d2018-07-16 11:21:11 +0100925 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926
927error:
928 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100929 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200930
931 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100932}
Darryl Green940d72c2018-07-13 13:18:51 +0100933
Ronald Cron5c522922020-11-14 16:35:34 +0100934/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200935 *
936 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200937 * available, as opposed to a key in a secure element and/or to be used
938 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200939 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * This is a temporary function that may be used instead of
941 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
942 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200943 *
Ronald Cron5c522922020-11-14 16:35:34 +0100944 * On success, the returned key slot is locked. It is the responsibility of the
945 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946 */
Ronald Cron5c522922020-11-14 16:35:34 +0100947static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
948 mbedtls_svc_key_id_t key,
949 psa_key_slot_t **p_slot,
950 psa_key_usage_t usage,
951 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200952{
Ronald Cron5c522922020-11-14 16:35:34 +0100953 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
954 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 if( status != PSA_SUCCESS )
956 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200957
Ronald Cronddae0f52021-08-24 15:39:44 +0200958 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 {
Ronald Cron5c522922020-11-14 16:35:34 +0100960 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961 *p_slot = NULL;
962 return( PSA_ERROR_NOT_SUPPORTED );
963 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200964
Gilles Peskine28f8f302019-07-24 13:30:31 +0200965 return( PSA_SUCCESS );
966}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200968psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000969{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100970 /* Data pointer will always be either a valid pointer or NULL in an
971 * initialized slot, so we can just free it. */
972 if( slot->key.data != NULL )
973 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
974
975 mbedtls_free( slot->key.data );
976 slot->key.data = NULL;
977 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000978
979 return( PSA_SUCCESS );
980}
981
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100982/** Completely wipe a slot in memory, including its policy.
983 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100984psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985{
986 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100987
TRodziewicz18cddc02021-07-13 12:19:15 +0200988 /*
989 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200990 * do our best to report an unexpected lock counter. Assert with
991 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
992 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
993 * function is called as part of the execution of a test suite, the
994 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200995 */
Ronald Cron5c522922020-11-14 16:35:34 +0100996 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100997 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200998 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100999 status = PSA_ERROR_CORRUPTION_DETECTED;
1000 }
1001
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001002 /* Multipart operations may still be using the key. This is safe
1003 * because all multipart operation objects are independent from
1004 * the key slot: if they need to access the key after the setup
1005 * phase, they have a copy of the key. Note that this means that
1006 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001007 /* At this point, key material and other type-specific content has
1008 * been wiped. Clear remaining metadata. We can call memset and not
1009 * zeroize because the metadata is not particularly sensitive. */
1010 memset( slot, 0, sizeof( *slot ) );
1011 return( status );
1012}
1013
Ronald Croncf56a0a2020-08-04 09:51:30 +02001014psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001015{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001016 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001017 psa_status_t status; /* status of the last operation */
1018 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001019#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1020 psa_se_drv_table_entry_t *driver;
1021#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022
Ronald Croncf56a0a2020-08-04 09:51:30 +02001023 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001024 return( PSA_SUCCESS );
1025
Ronald Cronf2911112020-10-29 17:51:10 +01001026 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001027 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001028 * key, this will load the key description from persistent memory if not
1029 * done yet. We cannot avoid this loading as without it we don't know if
1030 * the key is operated by an SE or not and this information is needed by
1031 * the current implementation.
1032 */
Ronald Cron5c522922020-11-14 16:35:34 +01001033 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001034 if( status != PSA_SUCCESS )
1035 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001036
Ronald Cronf2911112020-10-29 17:51:10 +01001037 /*
1038 * If the key slot containing the key description is under access by the
1039 * library (apart from the present access), the key cannot be destroyed
1040 * yet. For the time being, just return in error. Eventually (to be
1041 * implemented), the key should be destroyed when all accesses have
1042 * stopped.
1043 */
Ronald Cron5c522922020-11-14 16:35:34 +01001044 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001045 {
Ronald Cron5c522922020-11-14 16:35:34 +01001046 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001047 return( PSA_ERROR_GENERIC_ERROR );
1048 }
1049
Gilles Peskine6687cd02021-04-21 22:32:05 +02001050 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1051 {
1052 /* Refuse the destruction of a read-only key (which may or may not work
1053 * if we attempt it, depending on whether the key is merely read-only
1054 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001055 * Just do the best we can, which is to wipe the copy in memory
1056 * (done in this function's cleanup code). */
1057 overall_status = PSA_ERROR_NOT_PERMITTED;
1058 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001059 }
1060
Gilles Peskine354f7672019-07-12 23:46:38 +02001061#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001062 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001063 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001064 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001065 /* For a key in a secure element, we need to do three things:
1066 * remove the key file in internal storage, destroy the
1067 * key inside the secure element, and update the driver's
1068 * persistent data. Start a transaction that will encompass these
1069 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001070 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001071 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001072 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001073 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001074 status = psa_crypto_save_transaction( );
1075 if( status != PSA_SUCCESS )
1076 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001077 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001078 /* We should still try to destroy the key in the secure
1079 * element and the key metadata in storage. This is especially
1080 * important if the error is that the storage is full.
1081 * But how to do it exactly without risking an inconsistent
1082 * state after a reset?
1083 * https://github.com/ARMmbed/mbed-crypto/issues/215
1084 */
1085 overall_status = status;
1086 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001087 }
1088
Ronald Cronea0f8a62020-11-25 17:52:23 +01001089 status = psa_destroy_se_key( driver,
1090 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001091 if( overall_status == PSA_SUCCESS )
1092 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001093 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001094#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1095
Darryl Greend49a4992018-06-18 17:27:26 +01001096#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001097 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001098 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001099 status = psa_destroy_persistent_key( slot->attr.id );
1100 if( overall_status == PSA_SUCCESS )
1101 overall_status = status;
1102
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001103 /* TODO: other slots may have a copy of the same key. We should
1104 * invalidate them.
1105 * https://github.com/ARMmbed/mbed-crypto/issues/214
1106 */
Darryl Greend49a4992018-06-18 17:27:26 +01001107 }
1108#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001109
Gilles Peskinefc762652019-07-22 19:30:34 +02001110#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1111 if( driver != NULL )
1112 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001113 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
1116 status = psa_crypto_stop_transaction( );
1117 if( overall_status == PSA_SUCCESS )
1118 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001119 }
1120#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1121
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001122exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001123 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001124 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001125 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001126 overall_status = status;
1127 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001128}
1129
John Durkop07cc04a2020-11-16 22:08:34 -08001130#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001131 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001132static psa_status_t psa_get_rsa_public_exponent(
1133 const mbedtls_rsa_context *rsa,
1134 psa_key_attributes_t *attributes )
1135{
1136 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001138 uint8_t *buffer = NULL;
1139 size_t buflen;
1140 mbedtls_mpi_init( &mpi );
1141
1142 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1143 if( ret != 0 )
1144 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001145 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1146 {
1147 /* It's the default value, which is reported as an empty string,
1148 * so there's nothing to do. */
1149 goto exit;
1150 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001151
1152 buflen = mbedtls_mpi_size( &mpi );
1153 buffer = mbedtls_calloc( 1, buflen );
1154 if( buffer == NULL )
1155 {
1156 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1157 goto exit;
1158 }
1159 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1160 if( ret != 0 )
1161 goto exit;
1162 attributes->domain_parameters = buffer;
1163 attributes->domain_parameters_size = buflen;
1164
1165exit:
1166 mbedtls_mpi_free( &mpi );
1167 if( ret != 0 )
1168 mbedtls_free( buffer );
1169 return( mbedtls_to_psa_error( ret ) );
1170}
John Durkop07cc04a2020-11-16 22:08:34 -08001171#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001172 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001173
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001174/** Retrieve all the publicly-accessible attributes of a key.
1175 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001176psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001177 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001178{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001179 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001180 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001181 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001182
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001183 psa_reset_key_attributes( attributes );
1184
Ronald Cron5c522922020-11-14 16:35:34 +01001185 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001186 if( status != PSA_SUCCESS )
1187 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001188
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001189 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001190 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1191 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1192
1193#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001194 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001195 psa_set_key_slot_number( attributes,
1196 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001197#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001198
Gilles Peskine8e338702019-07-30 20:06:31 +02001199 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001200 {
John Durkop07cc04a2020-11-16 22:08:34 -08001201#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001202 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001203 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001204 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001205 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001206 * is not yet implemented.
1207 * https://github.com/ARMmbed/mbed-crypto/issues/216
1208 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001209 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001210 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001211 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001212
Ronald Cron90857082020-11-25 14:58:33 +01001213 status = mbedtls_psa_rsa_load_representation(
1214 slot->attr.type,
1215 slot->key.data,
1216 slot->key.bytes,
1217 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001218 if( status != PSA_SUCCESS )
1219 break;
1220
Steven Cooremana2371e52020-07-28 14:30:39 +02001221 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001222 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001223 mbedtls_rsa_free( rsa );
1224 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001226 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001227#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001228 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 default:
1230 /* Nothing else to do. */
1231 break;
1232 }
1233
1234 if( status != PSA_SUCCESS )
1235 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001236
Ronald Cron5c522922020-11-14 16:35:34 +01001237 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001238
Ronald Cron5c522922020-11-14 16:35:34 +01001239 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001240}
1241
Gilles Peskinec8000c02019-08-02 20:15:51 +02001242#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1243psa_status_t psa_get_key_slot_number(
1244 const psa_key_attributes_t *attributes,
1245 psa_key_slot_number_t *slot_number )
1246{
1247 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1248 {
1249 *slot_number = attributes->slot_number;
1250 return( PSA_SUCCESS );
1251 }
1252 else
1253 return( PSA_ERROR_INVALID_ARGUMENT );
1254}
1255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1256
Ronald Crond18b5f82020-11-25 16:46:05 +01001257static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1258 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001259 uint8_t *data,
1260 size_t data_size,
1261 size_t *data_length )
1262{
Ronald Crond18b5f82020-11-25 16:46:05 +01001263 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001264 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001265 memcpy( data, key_buffer, key_buffer_size );
1266 memset( data + key_buffer_size, 0,
1267 data_size - key_buffer_size );
1268 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 return( PSA_SUCCESS );
1270}
1271
Ronald Cron7285cda2020-11-26 14:46:37 +01001272psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 const psa_key_attributes_t *attributes,
1274 const uint8_t *key_buffer, size_t key_buffer_size,
1275 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001276{
Ronald Crond18b5f82020-11-25 16:46:05 +01001277 psa_key_type_t type = attributes->core.type;
1278
Ronald Crond18b5f82020-11-25 16:46:05 +01001279 if( key_type_is_raw_bytes( type ) ||
1280 PSA_KEY_TYPE_IS_RSA( type ) ||
1281 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001282 {
1283 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001284 key_buffer, key_buffer_size,
1285 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001286 }
1287 else
1288 {
1289 /* This shouldn't happen in the reference implementation, but
1290 it is valid for a special-purpose implementation to omit
1291 support for exporting certain key types. */
1292 return( PSA_ERROR_NOT_SUPPORTED );
1293 }
1294}
1295
1296psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1297 uint8_t *data,
1298 size_t data_size,
1299 size_t *data_length )
1300{
1301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1302 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1303 psa_key_slot_t *slot;
1304
Ronald Crone907e552021-01-18 13:22:38 +01001305 /* Reject a zero-length output buffer now, since this can never be a
1306 * valid key representation. This way we know that data must be a valid
1307 * pointer and we can do things like memset(data, ..., data_size). */
1308 if( data_size == 0 )
1309 return( PSA_ERROR_BUFFER_TOO_SMALL );
1310
Ronald Cron9486f9d2020-11-26 13:36:23 +01001311 /* Set the key to empty now, so that even when there are errors, we always
1312 * set data_length to a value between 0 and data_size. On error, setting
1313 * the key to empty is a good choice because an empty key representation is
1314 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001315 *data_length = 0;
1316
Ronald Cron9486f9d2020-11-26 13:36:23 +01001317 /* Export requires the EXPORT flag. There is an exception for public keys,
1318 * which don't require any flag, but
1319 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1320 */
1321 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1322 PSA_KEY_USAGE_EXPORT, 0 );
1323 if( status != PSA_SUCCESS )
1324 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001325
Ronald Crond18b5f82020-11-25 16:46:05 +01001326 psa_key_attributes_t attributes = {
1327 .core = slot->attr
1328 };
Ronald Cron67227982020-11-26 15:16:05 +01001329 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001330 slot->key.data, slot->key.bytes,
1331 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001332
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333 unlock_status = psa_unlock_key_slot( slot );
1334
1335 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1336}
1337
Ronald Cron7285cda2020-11-26 14:46:37 +01001338psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001339 const psa_key_attributes_t *attributes,
1340 const uint8_t *key_buffer,
1341 size_t key_buffer_size,
1342 uint8_t *data,
1343 size_t data_size,
1344 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001345{
Ronald Crond18b5f82020-11-25 16:46:05 +01001346 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001347
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001349 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001350 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001351 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001352 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 key_buffer, key_buffer_size,
1355 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001356 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001359 {
John Durkop0e005192020-10-31 22:06:54 -07001360#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1361 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001362 return( mbedtls_psa_rsa_export_public_key( attributes,
1363 key_buffer,
1364 key_buffer_size,
1365 data,
1366 data_size,
1367 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001368#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 /* We don't know how to convert a private RSA key to public. */
1370 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001371#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1372 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001373 }
1374 else
Moran Pekera998bc62018-04-16 18:16:20 +03001375 {
John Durkop6ba40d12020-11-10 08:50:04 -08001376#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1377 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001378 return( mbedtls_psa_ecp_export_public_key( attributes,
1379 key_buffer,
1380 key_buffer_size,
1381 data,
1382 data_size,
1383 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001384#else
1385 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001386 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001387#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1388 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001389 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001390 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001391 else
1392 {
1393 /* This shouldn't happen in the reference implementation, but
1394 it is valid for a special-purpose implementation to omit
1395 support for exporting certain key types. */
1396 return( PSA_ERROR_NOT_SUPPORTED );
1397 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001398}
Ronald Crond18b5f82020-11-25 16:46:05 +01001399
Ronald Croncf56a0a2020-08-04 09:51:30 +02001400psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001401 uint8_t *data,
1402 size_t data_size,
1403 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001404{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001406 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001407 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001408
Ronald Crone907e552021-01-18 13:22:38 +01001409 /* Reject a zero-length output buffer now, since this can never be a
1410 * valid key representation. This way we know that data must be a valid
1411 * pointer and we can do things like memset(data, ..., data_size). */
1412 if( data_size == 0 )
1413 return( PSA_ERROR_BUFFER_TOO_SMALL );
1414
Darryl Greendd8fb772018-11-07 16:00:44 +00001415 /* Set the key to empty now, so that even when there are errors, we always
1416 * set data_length to a value between 0 and data_size. On error, setting
1417 * the key to empty is a good choice because an empty key representation is
1418 * unlikely to be accepted anywhere. */
1419 *data_length = 0;
1420
1421 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001422 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001423 if( status != PSA_SUCCESS )
1424 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001425
Ronald Cron9486f9d2020-11-26 13:36:23 +01001426 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1427 {
1428 status = PSA_ERROR_INVALID_ARGUMENT;
1429 goto exit;
1430 }
1431
Ronald Crond18b5f82020-11-25 16:46:05 +01001432 psa_key_attributes_t attributes = {
1433 .core = slot->attr
1434 };
Ronald Cron67227982020-11-26 15:16:05 +01001435 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 &attributes, slot->key.data, slot->key.bytes,
1437 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001438
1439exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001440 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001441
Ronald Cron5c522922020-11-14 16:35:34 +01001442 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001443}
1444
Gilles Peskine91e8c332019-08-02 19:19:39 +02001445#if defined(static_assert)
1446static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1447 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001448static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001449 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001450static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001451 "One or more key attribute flag is listed as both internal-only and external-only" );
1452#endif
1453
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001454/** Validate that a key policy is internally well-formed.
1455 *
1456 * This function only rejects invalid policies. It does not validate the
1457 * consistency of the policy with respect to other attributes of the key
1458 * such as the key type.
1459 */
1460static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001461{
1462 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001463 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001464 PSA_KEY_USAGE_ENCRYPT |
1465 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001466 PSA_KEY_USAGE_SIGN_MESSAGE |
1467 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001468 PSA_KEY_USAGE_SIGN_HASH |
1469 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001470 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001471 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1472 return( PSA_ERROR_INVALID_ARGUMENT );
1473
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 return( PSA_SUCCESS );
1475}
1476
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001477/** Validate the internal consistency of key attributes.
1478 *
1479 * This function only rejects invalid attribute values. If does not
1480 * validate the consistency of the attributes with any key data that may
1481 * be involved in the creation of the key.
1482 *
1483 * Call this function early in the key creation process.
1484 *
1485 * \param[in] attributes Key attributes for the new key.
1486 * \param[out] p_drv On any return, the driver for the key, if any.
1487 * NULL for a transparent key.
1488 *
1489 */
1490static psa_status_t psa_validate_key_attributes(
1491 const psa_key_attributes_t *attributes,
1492 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001493{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001494 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001495 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001496 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001497
Ronald Cron54b90082020-10-29 15:26:43 +01001498 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001499 if( status != PSA_SUCCESS )
1500 return( status );
1501
Ronald Crond2ed4812020-07-17 16:11:30 +02001502 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001503 if( status != PSA_SUCCESS )
1504 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001505
Ronald Cron65f38a32020-10-23 17:11:13 +02001506 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1507 {
1508 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1509 return( PSA_ERROR_INVALID_ARGUMENT );
1510 }
1511 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001513 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1514 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001515 }
1516
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001517 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001518 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001519 return( status );
1520
1521 /* Refuse to create overly large keys.
1522 * Note that this doesn't trigger on import if the attributes don't
1523 * explicitly specify a size (so psa_get_key_bits returns 0), so
1524 * psa_import_key() needs its own checks. */
1525 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1526 return( PSA_ERROR_NOT_SUPPORTED );
1527
Gilles Peskine91e8c332019-08-02 19:19:39 +02001528 /* Reject invalid flags. These should not be reachable through the API. */
1529 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1530 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1531 return( PSA_ERROR_INVALID_ARGUMENT );
1532
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001533 return( PSA_SUCCESS );
1534}
1535
Gilles Peskine4747d192019-04-17 15:05:45 +02001536/** Prepare a key slot to receive key material.
1537 *
1538 * This function allocates a key slot and sets its metadata.
1539 *
1540 * If this function fails, call psa_fail_key_creation().
1541 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001542 * This function is intended to be used as follows:
1543 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001544 * it with the specified attributes, and in case of a volatile key assign it
1545 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001546 * -# Populate the slot with the key material.
1547 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1548 * In case of failure at any step, stop the sequence and call
1549 * psa_fail_key_creation().
1550 *
Ronald Cron5c522922020-11-14 16:35:34 +01001551 * On success, the key slot is locked. It is the responsibility of the caller
1552 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001553 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001554 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001555 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 * \param[out] p_slot On success, a pointer to the prepared slot.
1557 * \param[out] p_drv On any return, the driver for the key, if any.
1558 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001559 *
1560 * \retval #PSA_SUCCESS
1561 * The key slot is ready to receive key material.
1562 * \return If this function fails, the key slot is an invalid state.
1563 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001564 */
1565static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001566 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001567 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001568 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001569 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001570{
1571 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001572 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001573 psa_key_slot_t *slot;
1574
Gilles Peskinedf179142019-07-15 22:02:14 +02001575 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001576 *p_drv = NULL;
1577
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001578 status = psa_validate_key_attributes( attributes, p_drv );
1579 if( status != PSA_SUCCESS )
1580 return( status );
1581
Ronald Cronc4d1b512020-07-31 11:26:37 +02001582 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 if( status != PSA_SUCCESS )
1584 return( status );
1585 slot = *p_slot;
1586
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001587 /* We're storing the declared bit-size of the key. It's up to each
1588 * creation mechanism to verify that this information is correct.
1589 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001590 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001591 * is optional (import, copy). In case of a volatile key, assign it the
1592 * volatile key identifier associated to the slot returned to contain its
1593 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001594
1595 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001596 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1597 {
1598#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1599 slot->attr.id = volatile_key_id;
1600#else
1601 slot->attr.id.key_id = volatile_key_id;
1602#endif
1603 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001604
Gilles Peskine91e8c332019-08-02 19:19:39 +02001605 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001606 * external-only flags, query `attributes`. Thanks to the check
1607 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001608 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001609 * may have set. */
1610 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001611
Gilles Peskinecbaff462019-07-12 23:46:04 +02001612#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001613 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001614 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001615 * create the key file in internal storage, create the
1616 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001617 * persistent data. This is done by starting a transaction that will
1618 * encompass these three actions.
1619 * For registering a volatile key, we just need to find an appropriate
1620 * slot number inside the SE. Since the key is designated volatile, creating
1621 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001622 /* The first thing to do is to find a slot number for the new key.
1623 * We save the slot number in persistent storage as part of the
1624 * transaction data. It will be needed to recover if the power
1625 * fails during the key creation process, to clean up on the secure
1626 * element side after restarting. Obtaining a slot number from the
1627 * secure element driver updates its persistent state, but we do not yet
1628 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001629 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001630 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001631 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001632 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001633 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001634 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001635 if( status != PSA_SUCCESS )
1636 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001637
1638 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001639 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1641 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001642 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 psa_crypto_transaction.key.id = slot->attr.id;
1644 status = psa_crypto_save_transaction( );
1645 if( status != PSA_SUCCESS )
1646 {
1647 (void) psa_crypto_stop_transaction( );
1648 return( status );
1649 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001650 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651
1652 status = psa_copy_key_material_into_slot(
1653 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001654 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001655
1656 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1657 {
1658 /* Key registration only makes sense with a secure element. */
1659 return( PSA_ERROR_INVALID_ARGUMENT );
1660 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001661#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1662
Ronald Cronc4d1b512020-07-31 11:26:37 +02001663 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001664}
Gilles Peskine4747d192019-04-17 15:05:45 +02001665
1666/** Finalize the creation of a key once its key material has been set.
1667 *
1668 * This entails writing the key to persistent storage.
1669 *
1670 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001671 * See the documentation of psa_start_key_creation() for the intended use
1672 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001673 *
Ronald Cron5c522922020-11-14 16:35:34 +01001674 * If the finalization succeeds, the function unlocks the key slot (it was
1675 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1676 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001677 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001678 * \param[in,out] slot Pointer to the slot with key material.
1679 * \param[in] driver The secure element driver for the key,
1680 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001681 * \param[out] key On success, identifier of the key. Note that the
1682 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001683 *
1684 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001685 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001686 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1687 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1688 * \retval #PSA_ERROR_ALREADY_EXISTS
1689 * \retval #PSA_ERROR_DATA_INVALID
1690 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001691 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001692 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 * \return If this function fails, the key slot is an invalid state.
1694 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001695 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001696static psa_status_t psa_finish_key_creation(
1697 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001698 psa_se_drv_table_entry_t *driver,
1699 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001700{
1701 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001702 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001703 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001704
1705#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001706 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001707 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001708#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1709 if( driver != NULL )
1710 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001711 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001712 psa_key_slot_number_t slot_number =
1713 psa_key_slot_get_slot_number( slot ) ;
1714
Gilles Peskineb46bef22019-07-30 21:32:04 +02001715#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001716 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001717 sizeof( data.slot_number ),
1718 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001719#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001721 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001722 (uint8_t*) &data,
1723 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001724 }
1725 else
1726#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1727 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001728 /* Key material is saved in export representation in the slot, so
1729 * just pass the slot buffer for storage. */
1730 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 slot->key.data,
1732 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001733 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001734 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001735#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1736
Gilles Peskinecbaff462019-07-12 23:46:04 +02001737#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001738 /* Finish the transaction for a key creation. This does not
1739 * happen when registering an existing key. Detect this case
1740 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001741 * creation of a persistent key in a secure element requires a transaction,
1742 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001743 if( driver != NULL &&
1744 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001745 {
1746 status = psa_save_se_persistent_data( driver );
1747 if( status != PSA_SUCCESS )
1748 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001749 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001750 return( status );
1751 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001752 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001753 }
1754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755
Ronald Cron50972942020-11-14 11:28:25 +01001756 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001757 {
1758 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001759 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001760 if( status != PSA_SUCCESS )
1761 *key = MBEDTLS_SVC_KEY_ID_INIT;
1762 }
Ronald Cron50972942020-11-14 11:28:25 +01001763
Gilles Peskine4747d192019-04-17 15:05:45 +02001764 return( status );
1765}
1766
1767/** Abort the creation of a key.
1768 *
1769 * You may call this function after calling psa_start_key_creation(),
1770 * or after psa_finish_key_creation() fails. In other circumstances, this
1771 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001772 * See the documentation of psa_start_key_creation() for the intended use
1773 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in,out] slot Pointer to the slot with key material.
1776 * \param[in] driver The secure element driver for the key,
1777 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001779static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001780 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001781{
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 (void) driver;
1783
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 if( slot == NULL )
1785 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001786
1787#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001788 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001789 * element, and the failure happened later (when saving metadata
1790 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001791 * element.
1792 * https://github.com/ARMmbed/mbed-crypto/issues/217
1793 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001794
Gilles Peskined7729582019-08-05 15:55:54 +02001795 /* Abort the ongoing transaction if any (there may not be one if
1796 * the creation process failed before starting one, or if the
1797 * key creation is a registration of a key in a secure element).
1798 * Earlier functions must already have done what it takes to undo any
1799 * partial creation. All that's left is to update the transaction data
1800 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001801 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001802#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1803
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 psa_wipe_key_slot( slot );
1805}
1806
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001807/** Validate optional attributes during key creation.
1808 *
1809 * Some key attributes are optional during key creation. If they are
1810 * specified in the attributes structure, check that they are consistent
1811 * with the data in the slot.
1812 *
1813 * This function should be called near the end of key creation, after
1814 * the slot in memory is fully populated but before saving persistent data.
1815 */
1816static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001817 const psa_key_slot_t *slot,
1818 const psa_key_attributes_t *attributes )
1819{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001820 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001821 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001822 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001823 return( PSA_ERROR_INVALID_ARGUMENT );
1824 }
1825
1826 if( attributes->domain_parameters_size != 0 )
1827 {
John Durkop0e005192020-10-31 22:06:54 -07001828#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1829 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001830 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001832 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001833 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001835
Ronald Cron90857082020-11-25 14:58:33 +01001836 psa_status_t status = mbedtls_psa_rsa_load_representation(
1837 slot->attr.type,
1838 slot->key.data,
1839 slot->key.bytes,
1840 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001841 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001842 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001843
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844 mbedtls_mpi_init( &actual );
1845 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001846 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001848 mbedtls_rsa_free( rsa );
1849 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 if( ret != 0 )
1851 goto rsa_exit;
1852 ret = mbedtls_mpi_read_binary( &required,
1853 attributes->domain_parameters,
1854 attributes->domain_parameters_size );
1855 if( ret != 0 )
1856 goto rsa_exit;
1857 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1858 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1859 rsa_exit:
1860 mbedtls_mpi_free( &actual );
1861 mbedtls_mpi_free( &required );
1862 if( ret != 0)
1863 return( mbedtls_to_psa_error( ret ) );
1864 }
1865 else
John Durkop9814fa22020-11-04 12:28:15 -08001866#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1867 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001868 {
1869 return( PSA_ERROR_INVALID_ARGUMENT );
1870 }
1871 }
1872
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001873 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001875 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876 return( PSA_ERROR_INVALID_ARGUMENT );
1877 }
1878
1879 return( PSA_SUCCESS );
1880}
1881
Gilles Peskine4747d192019-04-17 15:05:45 +02001882psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001883 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001884 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001885 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001886{
1887 psa_status_t status;
1888 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001889 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001890 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301891 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001892
Ronald Cron81709fc2020-11-14 12:10:32 +01001893 *key = MBEDTLS_SVC_KEY_ID_INIT;
1894
Gilles Peskine0f84d622019-09-12 19:03:13 +02001895 /* Reject zero-length symmetric keys (including raw data key objects).
1896 * This also rejects any key which might be encoded as an empty string,
1897 * which is never valid. */
1898 if( data_length == 0 )
1899 return( PSA_ERROR_INVALID_ARGUMENT );
1900
Archana449608b2021-09-08 15:36:05 +05301901 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301902 if( data_length > SIZE_MAX / 8 )
1903 return( PSA_ERROR_NOT_SUPPORTED );
1904
Gilles Peskinedf179142019-07-15 22:02:14 +02001905 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001906 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001907 if( status != PSA_SUCCESS )
1908 goto exit;
1909
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001910 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301911 * storage ( thus not in the case of importing a key in a secure element
1912 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1913 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001914 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001915 {
Archanad8a83dc2021-06-14 10:04:16 +05301916 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1917 {
Archana449608b2021-09-08 15:36:05 +05301918 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1919 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301920 if( status != PSA_SUCCESS )
1921 goto exit;
1922 }
1923 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001924 if( status != PSA_SUCCESS )
1925 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001926 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001927
1928 bits = slot->attr.bits;
1929 status = psa_driver_wrapper_import_key( attributes,
1930 data, data_length,
1931 slot->key.data,
1932 slot->key.bytes,
1933 &slot->key.bytes, &bits );
1934 if( status != PSA_SUCCESS )
1935 goto exit;
1936
1937 if( slot->attr.bits == 0 )
1938 slot->attr.bits = (psa_key_bits_t) bits;
1939 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001940 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001941 status = PSA_ERROR_INVALID_ARGUMENT;
1942 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001943 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001944
Archana6ed4bda2021-08-04 10:47:15 +05301945 /* Enforce a size limit, and in particular ensure that the bit
1946 * size fits in its representation type.*/
1947 if( bits > PSA_MAX_KEY_BITS )
1948 {
1949 status = PSA_ERROR_NOT_SUPPORTED;
1950 goto exit;
1951 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001952 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001953 if( status != PSA_SUCCESS )
1954 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955
Ronald Cron81709fc2020-11-14 12:10:32 +01001956 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001957exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001959 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001960
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 return( status );
1962}
1963
Gilles Peskined7729582019-08-05 15:55:54 +02001964#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1965psa_status_t mbedtls_psa_register_se_key(
1966 const psa_key_attributes_t *attributes )
1967{
1968 psa_status_t status;
1969 psa_key_slot_t *slot = NULL;
1970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001972
1973 /* Leaving attributes unspecified is not currently supported.
1974 * It could make sense to query the key type and size from the
1975 * secure element, but not all secure elements support this
1976 * and the driver HAL doesn't currently support it. */
1977 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1978 return( PSA_ERROR_NOT_SUPPORTED );
1979 if( psa_get_key_bits( attributes ) == 0 )
1980 return( PSA_ERROR_NOT_SUPPORTED );
1981
1982 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001983 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001984 if( status != PSA_SUCCESS )
1985 goto exit;
1986
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001988
1989exit:
1990 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001991 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskined7729582019-08-05 15:55:54 +02001993 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001995 return( status );
1996}
1997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1998
Ronald Croncf56a0a2020-08-04 09:51:30 +02001999psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002000 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002001 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002002{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002004 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002005 psa_key_slot_t *source_slot = NULL;
2006 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002007 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002008 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302009 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002010
Ronald Cron81709fc2020-11-14 12:10:32 +01002011 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2012
Archana8a180362021-07-05 02:18:48 +05302013 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002014 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002015 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002016 goto exit;
2017
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002018 status = psa_validate_optional_attributes( source_slot,
2019 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002020 if( status != PSA_SUCCESS )
2021 goto exit;
2022
Archana9d17bf42021-09-10 06:22:44 +05302023 /* The target key type and number of bits have been validated by
2024 * psa_validate_optional_attributes() to be either equal to zero or
2025 * equal to the ones of the source key. So it is safe to inherit
2026 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302027 * */
Archana9d17bf42021-09-10 06:22:44 +05302028 actual_attributes.core.bits = source_slot->attr.bits;
2029 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302030
2031
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002032 status = psa_restrict_key_policy( source_slot->attr.type,
2033 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002034 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002035 if( status != PSA_SUCCESS )
2036 goto exit;
2037
Ronald Cron81709fc2020-11-14 12:10:32 +01002038 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2039 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040 if( status != PSA_SUCCESS )
2041 goto exit;
Archana8a180362021-07-05 02:18:48 +05302042 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2043 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002044 {
Archana8a180362021-07-05 02:18:48 +05302045 /*
Archana9d17bf42021-09-10 06:22:44 +05302046 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302047 * the source key would need to be exported as plaintext and re-imported
2048 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302049 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302050 * appropriate API invocations from the application, if needed.
2051 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002052 status = PSA_ERROR_NOT_SUPPORTED;
2053 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002054 }
Archana8a180362021-07-05 02:18:48 +05302055 /*
2056 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302057 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302058 * - For opaque keys this translates to an invocation of the drivers'
2059 * copy_key entry point through the dispatch layer.
2060 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002061 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2062 {
Archana8a180362021-07-05 02:18:48 +05302063 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302064 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302065 if( status != PSA_SUCCESS )
2066 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302067
Archana8a180362021-07-05 02:18:48 +05302068 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2069 if( status != PSA_SUCCESS )
2070 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302071
Archana8a180362021-07-05 02:18:48 +05302072 status = psa_driver_wrapper_copy_key( &actual_attributes,
2073 source_slot->key.data,
2074 source_slot->key.bytes,
2075 target_slot->key.data,
2076 target_slot->key.bytes,
2077 &target_slot->key.bytes );
2078 if( status != PSA_SUCCESS )
2079 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002080 }
Archana8a180362021-07-05 02:18:48 +05302081 else
2082 {
Archana9d17bf42021-09-10 06:22:44 +05302083 status = psa_copy_key_material_into_slot( target_slot,
2084 source_slot->key.data,
2085 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302086 if( status != PSA_SUCCESS )
2087 goto exit;
2088 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002089 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002090exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002091 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002092 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002093
Ronald Cron5c522922020-11-14 16:35:34 +01002094 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002095
Ronald Cron5c522922020-11-14 16:35:34 +01002096 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002097}
2098
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002099
2100
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002101/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002102/* Message digests */
2103/****************************************************************/
2104
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002105psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2106{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002107 /* Aborting a non-active operation is allowed */
2108 if( operation->id == 0 )
2109 return( PSA_SUCCESS );
2110
2111 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2112 operation->id = 0;
2113
2114 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115}
2116
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002117psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002118 psa_algorithm_t alg )
2119{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002120 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002121
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002122 /* A context must be freshly initialized before it can be set up. */
2123 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002124 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002125 status = PSA_ERROR_BAD_STATE;
2126 goto exit;
2127 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002128
2129 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002130 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002131 status = PSA_ERROR_INVALID_ARGUMENT;
2132 goto exit;
2133 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002134
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002135 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2136 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002137 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2138
Dave Rodgman685b6a72021-06-24 11:49:14 +01002139 status = psa_driver_wrapper_hash_setup( operation, alg );
2140
2141exit:
2142 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002143 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002144
2145 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146}
2147
2148psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2149 const uint8_t *input,
2150 size_t input_length )
2151{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2153
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002154 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002155 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002156 status = PSA_ERROR_BAD_STATE;
2157 goto exit;
2158 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002159
Steven Cooremanc8288352021-03-04 14:02:19 +01002160 /* Don't require hash implementations to behave correctly on a
2161 * zero-length input, which may have an invalid pointer. */
2162 if( input_length == 0 )
2163 return( PSA_SUCCESS );
2164
Dave Rodgman685b6a72021-06-24 11:49:14 +01002165 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2166
2167exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168 if( status != PSA_SUCCESS )
2169 psa_hash_abort( operation );
2170
2171 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172}
2173
2174psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2175 uint8_t *hash,
2176 size_t hash_size,
2177 size_t *hash_length )
2178{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002179 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002180 if( operation->id == 0 )
2181 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182
Steven Cooreman1e582352021-02-18 17:24:37 +01002183 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002184 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002185 psa_hash_abort( operation );
2186 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187}
2188
Gilles Peskine2d277862018-06-18 15:41:12 +02002189psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2190 const uint8_t *hash,
2191 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192{
Ronald Cron69a63422021-10-18 09:47:58 +02002193 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002195 psa_status_t status = psa_hash_finish(
2196 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002197 actual_hash, sizeof( actual_hash ),
2198 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002199
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002201 goto exit;
2202
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002204 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002205 status = PSA_ERROR_INVALID_SIGNATURE;
2206 goto exit;
2207 }
2208
Steven Cooreman36876a02021-04-29 16:37:59 +02002209 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002210 status = PSA_ERROR_INVALID_SIGNATURE;
2211
2212exit:
2213 if( status != PSA_SUCCESS )
2214 psa_hash_abort(operation);
2215
2216 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002217}
2218
Gilles Peskine0a749c82019-11-28 19:33:58 +01002219psa_status_t psa_hash_compute( psa_algorithm_t alg,
2220 const uint8_t *input, size_t input_length,
2221 uint8_t *hash, size_t hash_size,
2222 size_t *hash_length )
2223{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002224 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002225 if( !PSA_ALG_IS_HASH( alg ) )
2226 return( PSA_ERROR_INVALID_ARGUMENT );
2227
Steven Cooreman1e582352021-02-18 17:24:37 +01002228 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2229 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002230}
2231
2232psa_status_t psa_hash_compare( psa_algorithm_t alg,
2233 const uint8_t *input, size_t input_length,
2234 const uint8_t *hash, size_t hash_length )
2235{
Ronald Cron69a63422021-10-18 09:47:58 +02002236 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002237 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002238
2239 if( !PSA_ALG_IS_HASH( alg ) )
2240 return( PSA_ERROR_INVALID_ARGUMENT );
2241
Steven Cooreman1e582352021-02-18 17:24:37 +01002242 psa_status_t status = psa_driver_wrapper_hash_compute(
2243 alg, input, input_length,
2244 actual_hash, sizeof(actual_hash),
2245 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002246 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002247 return( status );
2248 if( actual_hash_length != hash_length )
2249 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002250 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002251 return( PSA_ERROR_INVALID_SIGNATURE );
2252 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002253}
2254
Gilles Peskineeb35d782019-01-22 17:56:16 +01002255psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2256 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002257{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002258 if( source_operation->id == 0 ||
2259 target_operation->id != 0 )
2260 {
2261 return( PSA_ERROR_BAD_STATE );
2262 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002263
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002264 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2265 target_operation );
2266 if( status != PSA_SUCCESS )
2267 psa_hash_abort( target_operation );
2268
2269 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002270}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002271
2272
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002273/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002274/* MAC */
2275/****************************************************************/
2276
Steven Cooremane6804192021-03-19 18:28:56 +01002277psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002278{
Steven Cooremane6804192021-03-19 18:28:56 +01002279 /* Aborting a non-active operation is allowed */
2280 if( operation->id == 0 )
2281 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002282
Steven Cooremane6804192021-03-19 18:28:56 +01002283 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002284 operation->mac_size = 0;
2285 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002286 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002287
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002288 return( status );
2289}
2290
Ronald Cron2dff3b22021-06-17 16:33:22 +02002291static psa_status_t psa_mac_finalize_alg_and_key_validation(
2292 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002293 const psa_key_attributes_t *attributes,
2294 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002295{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002297 psa_key_type_t key_type = psa_get_key_type( attributes );
2298 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002299
Ronald Cron28ea0502021-06-17 16:10:24 +02002300 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002302
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002303 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002304 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002305 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002306 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002307
Steven Cooremand1a68f12021-05-10 11:13:41 +02002308 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002310
Ronald Cron79bdd822021-06-17 16:46:44 +02002311 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002312 {
2313 /* A very short MAC is too short for security since it can be
2314 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2315 * so we make this our minimum, even though 32 bits is still
2316 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002317 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002318 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002319
Ronald Cron79bdd822021-06-17 16:46:44 +02002320 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2321 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002322 {
2323 /* It's impossible to "truncate" to a larger length than the full length
2324 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002325 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002326 }
2327
Ronald Cron79bdd822021-06-17 16:46:44 +02002328 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002329}
2330
Gilles Peskinee59236f2018-01-27 23:32:46 +01002331static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2332 mbedtls_svc_key_id_t key,
2333 psa_algorithm_t alg,
2334 int is_sign )
2335{
2336 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2337 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002338 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339
2340 /* A context must be freshly initialized before it can be set up. */
2341 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002342 {
Dave Rodgman54648242021-06-24 11:49:45 +01002343 status = PSA_ERROR_BAD_STATE;
2344 goto exit;
2345 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346
2347 status = psa_get_and_lock_key_slot_with_policy(
2348 key,
2349 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002350 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351 alg );
2352 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002353 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354
2355 psa_key_attributes_t attributes = {
2356 .core = slot->attr
2357 };
2358
Ronald Cron79bdd822021-06-17 16:46:44 +02002359 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2360 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361 if( status != PSA_SUCCESS )
2362 goto exit;
2363
2364 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002365 /* Dispatch the MAC setup call with validated input */
2366 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002367 {
Steven Cooremane6804192021-03-19 18:28:56 +01002368 status = psa_driver_wrapper_mac_sign_setup( operation,
2369 &attributes,
2370 slot->key.data,
2371 slot->key.bytes,
2372 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002373 }
2374 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002375 {
Steven Cooremane6804192021-03-19 18:28:56 +01002376 status = psa_driver_wrapper_mac_verify_setup( operation,
2377 &attributes,
2378 slot->key.data,
2379 slot->key.bytes,
2380 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002382
Gilles Peskinefbfac682018-07-08 20:51:54 +02002383exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002384 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002385 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002386
Ronald Cron5c522922020-11-14 16:35:34 +01002387 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002388
Ronald Cron5c522922020-11-14 16:35:34 +01002389 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002390}
2391
Gilles Peskine89167cb2018-07-08 20:12:23 +02002392psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002393 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002394 psa_algorithm_t alg )
2395{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002396 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002397}
2398
2399psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002400 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002401 psa_algorithm_t alg )
2402{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002403 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002404}
2405
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002406psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002407 const uint8_t *input,
2408 size_t input_length )
2409{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002410 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002411 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002413 /* Don't require hash implementations to behave correctly on a
2414 * zero-length input, which may have an invalid pointer. */
2415 if( input_length == 0 )
2416 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002417
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002418 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2419 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002420 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002421 psa_mac_abort( operation );
2422
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002423 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002424}
2425
Steven Cooremana5b860a2021-03-19 19:04:39 +01002426psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002427 uint8_t *mac,
2428 size_t mac_size,
2429 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002430{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2432 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002435 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002436 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002437 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002438 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002439
Steven Cooreman72f736a2021-05-07 14:14:37 +02002440 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002441 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002442 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002443 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002444 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002445
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002446 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2447 * once all the error checks are done. */
2448 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002449 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002450 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002451 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002452 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002453
2454 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002455 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002456 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002457 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002458 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002459
Steven Cooremana5b860a2021-03-19 19:04:39 +01002460 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002461 mac, operation->mac_size,
2462 mac_length );
2463
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002464exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002465 /* In case of success, set the potential excess room in the output buffer
2466 * to an invalid value, to avoid potentially leaking a longer MAC.
2467 * In case of error, set the output length and content to a safe default,
2468 * such that in case the caller misses an error check, the output would be
2469 * an unachievable MAC.
2470 */
2471 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002472 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002473 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002474 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002475 }
mohammad16036df908f2018-04-02 08:34:15 -07002476
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002477 if( mac_size > operation->mac_size )
2478 memset( &mac[operation->mac_size], '!',
2479 mac_size - operation->mac_size );
2480
Steven Cooremana5b860a2021-03-19 19:04:39 +01002481 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002482
Steven Cooremana5b860a2021-03-19 19:04:39 +01002483 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002484}
2485
Steven Cooremana5b860a2021-03-19 19:04:39 +01002486psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002487 const uint8_t *mac,
2488 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002489{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2491 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002492
Steven Cooremana5b860a2021-03-19 19:04:39 +01002493 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002494 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002495 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002496 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002497 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002498
Steven Cooreman72f736a2021-05-07 14:14:37 +02002499 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002500 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002501 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002502 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002503 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002504
2505 if( operation->mac_size != mac_length )
2506 {
2507 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002508 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002509 }
2510
Steven Cooremana5b860a2021-03-19 19:04:39 +01002511 status = psa_driver_wrapper_mac_verify_finish( operation,
2512 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002513
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002514exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002515 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002516
Steven Cooremana5b860a2021-03-19 19:04:39 +01002517 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002518}
2519
Ronald Croncd989b52021-06-18 14:23:33 +02002520static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2521 psa_algorithm_t alg,
2522 const uint8_t *input,
2523 size_t input_length,
2524 uint8_t *mac,
2525 size_t mac_size,
2526 size_t *mac_length,
2527 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002528{
2529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002530 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2531 psa_key_slot_t *slot;
2532 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002533
Ronald Cron51131b52021-06-17 17:17:20 +02002534 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002535 key,
2536 &slot,
2537 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002538 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002539 if( status != PSA_SUCCESS )
2540 goto exit;
2541
Ronald Cron51131b52021-06-17 17:17:20 +02002542 psa_key_attributes_t attributes = {
2543 .core = slot->attr
2544 };
2545
2546 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2547 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002548 if( status != PSA_SUCCESS )
2549 goto exit;
2550
Ronald Cron51131b52021-06-17 17:17:20 +02002551 if( mac_size < operation_mac_size )
2552 {
2553 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002554 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002555 }
2556
2557 status = psa_driver_wrapper_mac_compute(
2558 &attributes,
2559 slot->key.data, slot->key.bytes,
2560 alg,
2561 input, input_length,
2562 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002563
2564exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002565 /* In case of success, set the potential excess room in the output buffer
2566 * to an invalid value, to avoid potentially leaking a longer MAC.
2567 * In case of error, set the output length and content to a safe default,
2568 * such that in case the caller misses an error check, the output would be
2569 * an unachievable MAC.
2570 */
2571 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002572 {
Ronald Cron51131b52021-06-17 17:17:20 +02002573 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002574 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002575 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002576 if( mac_size > operation_mac_size )
2577 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002578
Ronald Cron51131b52021-06-17 17:17:20 +02002579 unlock_status = psa_unlock_key_slot( slot );
2580
2581 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002582}
2583
Ronald Croncd989b52021-06-18 14:23:33 +02002584psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2585 psa_algorithm_t alg,
2586 const uint8_t *input,
2587 size_t input_length,
2588 uint8_t *mac,
2589 size_t mac_size,
2590 size_t *mac_length)
2591{
2592 return( psa_mac_compute_internal( key, alg,
2593 input, input_length,
2594 mac, mac_size, mac_length, 1 ) );
2595}
2596
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002597psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2598 psa_algorithm_t alg,
2599 const uint8_t *input,
2600 size_t input_length,
2601 const uint8_t *mac,
2602 size_t mac_length)
2603{
2604 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002605 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2606 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002607
Ronald Crona587cbc2021-06-18 14:51:29 +02002608 status = psa_mac_compute_internal( key, alg,
2609 input, input_length,
2610 actual_mac, sizeof( actual_mac ),
2611 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612 if( status != PSA_SUCCESS )
2613 goto exit;
2614
Ronald Crona587cbc2021-06-18 14:51:29 +02002615 if( mac_length != actual_mac_length )
2616 {
2617 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002618 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002619 }
2620 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2621 {
2622 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002623 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002624 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002625
2626exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002627 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002628
2629 return ( status );
2630}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002631
Gilles Peskinee59236f2018-01-27 23:32:46 +01002632/****************************************************************/
2633/* Asymmetric cryptography */
2634/****************************************************************/
2635
gabor-mezei-armf0486182021-05-12 11:03:09 +02002636static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002637 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002638{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002639 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002640 {
2641 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2642 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002643
Gilles Peskinef7b41372021-09-22 16:15:05 +02002644 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002645 {
2646 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2647 return( PSA_ERROR_INVALID_ARGUMENT );
2648 }
2649 }
2650 else
2651 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002652 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002653 return( PSA_ERROR_INVALID_ARGUMENT );
2654 }
2655
2656 return( PSA_SUCCESS );
2657}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002658
2659static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002660 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002661 psa_algorithm_t alg,
2662 const uint8_t * input,
2663 size_t input_length,
2664 uint8_t * signature,
2665 size_t signature_size,
2666 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002667{
2668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2669 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2670 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002671
2672 *signature_length = 0;
2673
gabor-mezei-armf0486182021-05-12 11:03:09 +02002674 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002675 if( status != PSA_SUCCESS )
2676 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002677
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002678 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002679 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002680 * buffer can in principle be empty since it doesn't actually have
2681 * to be a hash.) */
2682 if( signature_size == 0 )
2683 return( PSA_ERROR_BUFFER_TOO_SMALL );
2684
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002685 status = psa_get_and_lock_key_slot_with_policy(
2686 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002687 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2688 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002689 alg );
2690
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002691 if( status != PSA_SUCCESS )
2692 goto exit;
2693
2694 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2695 {
2696 status = PSA_ERROR_INVALID_ARGUMENT;
2697 goto exit;
2698 }
2699
2700 psa_key_attributes_t attributes = {
2701 .core = slot->attr
2702 };
2703
gabor-mezei-armf0486182021-05-12 11:03:09 +02002704 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002705 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002706 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002708 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002709 signature, signature_size, signature_length );
2710 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002711 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712 {
2713
2714 status = psa_driver_wrapper_sign_hash(
2715 &attributes, slot->key.data, slot->key.bytes,
2716 alg, input, input_length,
2717 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002718 }
2719
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002720
2721exit:
2722 /* Fill the unused part of the output buffer (the whole buffer on error,
2723 * the trailing part on success) with something that isn't a valid signature
2724 * (barring an attack on the signature and deliberately-crafted input),
2725 * in case the caller doesn't check the return status properly. */
2726 if( status == PSA_SUCCESS )
2727 memset( signature + *signature_length, '!',
2728 signature_size - *signature_length );
2729 else
2730 memset( signature, '!', signature_size );
2731 /* If signature_size is 0 then we have nothing to do. We must not call
2732 * memset because signature may be NULL in this case. */
2733
2734 unlock_status = psa_unlock_key_slot( slot );
2735
2736 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2737}
2738
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002740 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002741 psa_algorithm_t alg,
2742 const uint8_t * input,
2743 size_t input_length,
2744 const uint8_t * signature,
2745 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002746{
2747 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2748 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2749 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002750
gabor-mezei-armf0486182021-05-12 11:03:09 +02002751 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002752 if( status != PSA_SUCCESS )
2753 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002754
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002755 status = psa_get_and_lock_key_slot_with_policy(
2756 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002757 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2758 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002760
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002761 if( status != PSA_SUCCESS )
2762 return( status );
2763
2764 psa_key_attributes_t attributes = {
2765 .core = slot->attr
2766 };
2767
gabor-mezei-armf0486182021-05-12 11:03:09 +02002768 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002769 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002770 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002771 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002772 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002773 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002774 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002775 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002776 {
2777 status = psa_driver_wrapper_verify_hash(
2778 &attributes, slot->key.data, slot->key.bytes,
2779 alg, input, input_length,
2780 signature, signature_length );
2781 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002782
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002783 unlock_status = psa_unlock_key_slot( slot );
2784
2785 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002786
2787}
2788
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002789psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002790 const psa_key_attributes_t *attributes,
2791 const uint8_t *key_buffer,
2792 size_t key_buffer_size,
2793 psa_algorithm_t alg,
2794 const uint8_t *input,
2795 size_t input_length,
2796 uint8_t *signature,
2797 size_t signature_size,
2798 size_t *signature_length )
2799{
2800 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002801
Gilles Peskinef7b41372021-09-22 16:15:05 +02002802 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002803 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002804 size_t hash_length;
2805 uint8_t hash[PSA_HASH_MAX_SIZE];
2806
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002807 status = psa_driver_wrapper_hash_compute(
2808 PSA_ALG_SIGN_GET_HASH( alg ),
2809 input, input_length,
2810 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002811
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002812 if( status != PSA_SUCCESS )
2813 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002814
2815 return psa_driver_wrapper_sign_hash(
2816 attributes, key_buffer, key_buffer_size,
2817 alg, hash, hash_length,
2818 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002819 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002820
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002821 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002822}
2823
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002824psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2825 psa_algorithm_t alg,
2826 const uint8_t * input,
2827 size_t input_length,
2828 uint8_t * signature,
2829 size_t signature_size,
2830 size_t * signature_length )
2831{
2832 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002833 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002834 signature, signature_size, signature_length );
2835}
2836
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002837psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002838 const psa_key_attributes_t *attributes,
2839 const uint8_t *key_buffer,
2840 size_t key_buffer_size,
2841 psa_algorithm_t alg,
2842 const uint8_t *input,
2843 size_t input_length,
2844 const uint8_t *signature,
2845 size_t signature_length )
2846{
2847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002848
Gilles Peskinef7b41372021-09-22 16:15:05 +02002849 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002850 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002851 size_t hash_length;
2852 uint8_t hash[PSA_HASH_MAX_SIZE];
2853
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002854 status = psa_driver_wrapper_hash_compute(
2855 PSA_ALG_SIGN_GET_HASH( alg ),
2856 input, input_length,
2857 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002858
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002859 if( status != PSA_SUCCESS )
2860 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002861
2862 return psa_driver_wrapper_verify_hash(
2863 attributes, key_buffer, key_buffer_size,
2864 alg, hash, hash_length,
2865 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002866 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002867
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002868 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002869}
2870
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002871psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2872 psa_algorithm_t alg,
2873 const uint8_t * input,
2874 size_t input_length,
2875 const uint8_t * signature,
2876 size_t signature_length )
2877{
2878 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002879 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002880 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002881}
2882
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002883psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002884 const psa_key_attributes_t *attributes,
2885 const uint8_t *key_buffer, size_t key_buffer_size,
2886 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2887 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002888{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002889 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002890 {
Ronald Cron4501c982021-03-19 20:09:32 +01002891 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2892 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002893 {
Ronald Cron4501c982021-03-19 20:09:32 +01002894#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2895 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2896 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002897 attributes,
2898 key_buffer, key_buffer_size,
2899 alg, hash, hash_length,
2900 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002901#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2902 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002903 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002904 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002905 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002906 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002907 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002908 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002909 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Ronald Cron4501c982021-03-19 20:09:32 +01002910 {
2911 if( PSA_ALG_IS_ECDSA( alg ) )
2912 {
2913#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2914 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2915 return( mbedtls_psa_ecdsa_sign_hash(
2916 attributes,
2917 key_buffer, key_buffer_size,
2918 alg, hash, hash_length,
2919 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002920#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2921 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002922 }
2923 else
2924 {
2925 return( PSA_ERROR_INVALID_ARGUMENT );
2926 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002927 }
Ronald Cron4501c982021-03-19 20:09:32 +01002928
2929 (void)key_buffer;
2930 (void)key_buffer_size;
2931 (void)hash;
2932 (void)hash_length;
2933 (void)signature;
2934 (void)signature_size;
2935 (void)signature_length;
2936
2937 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002938}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002939
2940psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2941 psa_algorithm_t alg,
2942 const uint8_t *hash,
2943 size_t hash_length,
2944 uint8_t *signature,
2945 size_t signature_size,
2946 size_t *signature_length )
2947{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002948 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002949 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002950 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002951}
2952
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002953psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002954 const psa_key_attributes_t *attributes,
2955 const uint8_t *key_buffer, size_t key_buffer_size,
2956 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2957 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002958{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002959 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002960 {
Ronald Cron4501c982021-03-19 20:09:32 +01002961 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2962 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002963 {
Ronald Cron4501c982021-03-19 20:09:32 +01002964#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2965 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2966 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002967 attributes,
2968 key_buffer, key_buffer_size,
2969 alg, hash, hash_length,
2970 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002971#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2972 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002973 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002974 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002975 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002976 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002977 }
itayzafrir5c753392018-05-08 11:18:38 +03002978 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002979 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002980 {
Ronald Cron4501c982021-03-19 20:09:32 +01002981 if( PSA_ALG_IS_ECDSA( alg ) )
2982 {
2983#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2984 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2985 return( mbedtls_psa_ecdsa_verify_hash(
2986 attributes,
2987 key_buffer, key_buffer_size,
2988 alg, hash, hash_length,
2989 signature, signature_length ) );
2990#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2991 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2992 }
2993 else
2994 {
2995 return( PSA_ERROR_INVALID_ARGUMENT );
2996 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002997 }
Ronald Cron4501c982021-03-19 20:09:32 +01002998
2999 (void)key_buffer;
3000 (void)key_buffer_size;
3001 (void)hash;
3002 (void)hash_length;
3003 (void)signature;
3004 (void)signature_length;
3005
3006 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003007}
3008
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003009psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3010 psa_algorithm_t alg,
3011 const uint8_t *hash,
3012 size_t hash_length,
3013 const uint8_t *signature,
3014 size_t signature_length )
3015{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003016 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003017 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003018 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003019}
3020
John Durkop0e005192020-10-31 22:06:54 -07003021#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003022static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3023 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003024{
3025 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3026 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3027 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003028
3029 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003030}
John Durkop0e005192020-10-31 22:06:54 -07003031#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003032
Ronald Croncf56a0a2020-08-04 09:51:30 +02003033psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003034 psa_algorithm_t alg,
3035 const uint8_t *input,
3036 size_t input_length,
3037 const uint8_t *salt,
3038 size_t salt_length,
3039 uint8_t *output,
3040 size_t output_size,
3041 size_t *output_length )
3042{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003043 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003044 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003045 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003046
Darryl Green5cc689a2018-07-24 15:34:10 +01003047 (void) input;
3048 (void) input_length;
3049 (void) salt;
3050 (void) output;
3051 (void) output_size;
3052
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003053 *output_length = 0;
3054
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003055 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3056 return( PSA_ERROR_INVALID_ARGUMENT );
3057
Ronald Cron5c522922020-11-14 16:35:34 +01003058 status = psa_get_and_lock_transparent_key_slot_with_policy(
3059 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003060 if( status != PSA_SUCCESS )
3061 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003062 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3063 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003064 {
3065 status = PSA_ERROR_INVALID_ARGUMENT;
3066 goto exit;
3067 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003068
Gilles Peskine8e338702019-07-30 20:06:31 +02003069 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003071#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3072 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003073 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003074 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3075 slot->key.data,
3076 slot->key.bytes,
3077 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003078 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003079 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003080
3081 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003082 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003083 status = PSA_ERROR_BUFFER_TOO_SMALL;
3084 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003085 }
Ronald Cron89b4aa72021-09-08 14:28:35 +02003086#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3087 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003088 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3089 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003090#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003091 status = mbedtls_to_psa_error(
3092 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003093 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003094 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003095 input_length,
3096 input,
3097 output ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003098#else
3099 status = PSA_ERROR_NOT_SUPPORTED;
3100#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101 }
3102 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3104 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003105#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003106 status = mbedtls_to_psa_error(
3107 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3108 if( status != PSA_SUCCESS )
3109 goto rsa_exit;
3110
Steven Cooreman4fed4552020-08-03 14:46:03 +02003111 status = mbedtls_to_psa_error(
3112 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003113 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003114 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003115 salt, salt_length,
3116 input_length,
3117 input,
3118 output ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003119#else
3120 status = PSA_ERROR_NOT_SUPPORTED;
3121#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122 }
3123 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003125 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126 }
Ronald Cron89b4aa72021-09-08 14:28:35 +02003127#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3128 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003129rsa_exit:
3130 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003131 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003132
Steven Cooremana2371e52020-07-28 14:30:39 +02003133 mbedtls_rsa_free( rsa );
3134 mbedtls_free( rsa );
John Durkop9814fa22020-11-04 12:28:15 -08003135#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003136 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Ronald Cron89b4aa72021-09-08 14:28:35 +02003137 }
3138 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003140 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003141 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003142
3143exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003144 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003145
Ronald Cron5c522922020-11-14 16:35:34 +01003146 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003147}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003148
Ronald Croncf56a0a2020-08-04 09:51:30 +02003149psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003150 psa_algorithm_t alg,
3151 const uint8_t *input,
3152 size_t input_length,
3153 const uint8_t *salt,
3154 size_t salt_length,
3155 uint8_t *output,
3156 size_t output_size,
3157 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003158{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003160 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003161 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003162
Darryl Green5cc689a2018-07-24 15:34:10 +01003163 (void) input;
3164 (void) input_length;
3165 (void) salt;
3166 (void) output;
3167 (void) output_size;
3168
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003169 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003171 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3172 return( PSA_ERROR_INVALID_ARGUMENT );
3173
Ronald Cron5c522922020-11-14 16:35:34 +01003174 status = psa_get_and_lock_transparent_key_slot_with_policy(
3175 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003176 if( status != PSA_SUCCESS )
3177 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003178 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179 {
3180 status = PSA_ERROR_INVALID_ARGUMENT;
3181 goto exit;
3182 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003183
Gilles Peskine8e338702019-07-30 20:06:31 +02003184 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003186#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3187 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003188 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003189 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3190 slot->key.data,
3191 slot->key.bytes,
3192 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003193 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003194 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195
Steven Cooremana2371e52020-07-28 14:30:39 +02003196 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003197 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003198 status = PSA_ERROR_INVALID_ARGUMENT;
3199 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003200 }
Ronald Cron89b4aa72021-09-08 14:28:35 +02003201#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3202 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003203
Gilles Peskine6afe7892018-05-31 13:16:08 +02003204 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003206#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003207 status = mbedtls_to_psa_error(
3208 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003209 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003210 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003211 output_length,
3212 input,
3213 output,
3214 output_size ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003215#else
3216 status = PSA_ERROR_NOT_SUPPORTED;
3217#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003218 }
3219 else
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003220 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 {
Ronald Cron89b4aa72021-09-08 14:28:35 +02003222#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003223 status = mbedtls_to_psa_error(
3224 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3225 if( status != PSA_SUCCESS )
3226 goto rsa_exit;
3227
Steven Cooreman4fed4552020-08-03 14:46:03 +02003228 status = mbedtls_to_psa_error(
3229 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003230 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003231 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003232 salt, salt_length,
3233 output_length,
3234 input,
3235 output,
3236 output_size ) );
Ronald Cron89b4aa72021-09-08 14:28:35 +02003237#else
3238 status = PSA_ERROR_NOT_SUPPORTED;
3239#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003240 }
3241 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003242 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003243 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003244 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003245
Ronald Cron89b4aa72021-09-08 14:28:35 +02003246#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3247 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003248rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003249 mbedtls_rsa_free( rsa );
3250 mbedtls_free( rsa );
John Durkop6ba40d12020-11-10 08:50:04 -08003251#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3252 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Ronald Cron89b4aa72021-09-08 14:28:35 +02003253 }
3254 else
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003255 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003256 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003257 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003258
3259exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003260 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003261
Ronald Cron5c522922020-11-14 16:35:34 +01003262 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003263}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003264
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003265
3266
mohammad1603503973b2018-03-12 15:59:30 +02003267/****************************************************************/
3268/* Symmetric cryptography */
3269/****************************************************************/
3270
Ronald Cronab99ac22020-10-01 16:38:28 +02003271static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3272 mbedtls_svc_key_id_t key,
3273 psa_algorithm_t alg,
3274 mbedtls_operation_t cipher_operation )
3275{
3276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3277 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003278 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003279 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3280 PSA_KEY_USAGE_ENCRYPT :
3281 PSA_KEY_USAGE_DECRYPT );
3282
3283 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003284 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003285 {
Dave Rodgman54648242021-06-24 11:49:45 +01003286 status = PSA_ERROR_BAD_STATE;
3287 goto exit;
3288 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003289
Ronald Cronab99ac22020-10-01 16:38:28 +02003290 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003291 {
Dave Rodgman54648242021-06-24 11:49:45 +01003292 status = PSA_ERROR_INVALID_ARGUMENT;
3293 goto exit;
3294 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003295
Ronald Cronab99ac22020-10-01 16:38:28 +02003296 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3297 if( status != PSA_SUCCESS )
3298 goto exit;
3299
Ronald Cron49fafa92021-03-10 08:34:23 +01003300 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003301 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003302 * so we only set it (in the driver wrapper) after resources have been
3303 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003304 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003305 if( alg == PSA_ALG_ECB_NO_PADDING )
3306 operation->iv_required = 0;
3307 else
3308 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003309 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003310
Ronald Crona4af55f2020-12-14 14:36:06 +01003311 psa_key_attributes_t attributes = {
3312 .core = slot->attr
3313 };
3314
Ronald Cronab99ac22020-10-01 16:38:28 +02003315 /* Try doing the operation through a driver before using software fallback. */
3316 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003317 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3318 &attributes,
3319 slot->key.data,
3320 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003321 alg );
3322 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003323 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3324 &attributes,
3325 slot->key.data,
3326 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003327 alg );
3328
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003329exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003330 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003331 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003332
Ronald Cron5c522922020-11-14 16:35:34 +01003333 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003334
Ronald Cron5c522922020-11-14 16:35:34 +01003335 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003336}
3337
Gilles Peskinefe119512018-07-08 21:39:34 +02003338psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003339 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003340 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003341{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003342 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003343}
3344
Gilles Peskinefe119512018-07-08 21:39:34 +02003345psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003346 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003347 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003348{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003349 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003350}
3351
Gilles Peskinefe119512018-07-08 21:39:34 +02003352psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003353 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003354 size_t iv_size,
3355 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003356{
Ronald Cron6d051732020-10-01 14:10:20 +02003357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003358
Ronald Cron5618a392021-03-26 09:52:26 +01003359 *iv_length = 0;
3360
Ronald Cron49fafa92021-03-10 08:34:23 +01003361 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003362 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003363 status = PSA_ERROR_BAD_STATE;
3364 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003365 }
3366
Steven Cooreman7df02922020-09-09 15:28:49 +02003367 if( operation->iv_set || ! operation->iv_required )
3368 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003369 status = PSA_ERROR_BAD_STATE;
3370 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003371 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003372
Ronald Cron5618a392021-03-26 09:52:26 +01003373 if( iv_size < operation->default_iv_length )
3374 {
3375 status = PSA_ERROR_BUFFER_TOO_SMALL;
3376 goto exit;
3377 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003378
Ronald Cron5618a392021-03-26 09:52:26 +01003379 status = psa_generate_random( iv, operation->default_iv_length );
3380 if( status != PSA_SUCCESS )
3381 goto exit;
3382
3383 status = psa_driver_wrapper_cipher_set_iv( operation,
3384 iv,
3385 operation->default_iv_length );
3386
3387exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003388 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003389 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003390 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003391 *iv_length = operation->default_iv_length;
3392 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003393 else
Moran Peker395db872018-05-31 14:07:14 +03003394 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003395
itayzafrir534bd7c2018-08-02 13:56:32 +03003396 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003397}
3398
Gilles Peskinefe119512018-07-08 21:39:34 +02003399psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003400 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003401 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003402{
Ronald Cron6d051732020-10-01 14:10:20 +02003403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003404
Ronald Cron49fafa92021-03-10 08:34:23 +01003405 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003406 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003407 status = PSA_ERROR_BAD_STATE;
3408 goto exit;
3409 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003410
Steven Cooreman7df02922020-09-09 15:28:49 +02003411 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003412 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003413 status = PSA_ERROR_BAD_STATE;
3414 goto exit;
3415 }
Ronald Crona0d68172021-03-26 10:15:08 +01003416
3417 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003418 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003419 status = PSA_ERROR_INVALID_ARGUMENT;
3420 goto exit;
3421 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003422
Ronald Crondd24c9b2020-12-15 14:10:01 +01003423 status = psa_driver_wrapper_cipher_set_iv( operation,
3424 iv,
3425 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003426
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003427exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003428 if( status == PSA_SUCCESS )
3429 operation->iv_set = 1;
3430 else
mohammad1603503973b2018-03-12 15:59:30 +02003431 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003432 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003433}
3434
Gilles Peskinee553c652018-06-04 16:22:46 +02003435psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3436 const uint8_t *input,
3437 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003438 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003439 size_t output_size,
3440 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003441{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003442 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003443
Ronald Cron49fafa92021-03-10 08:34:23 +01003444 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003445 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003446 status = PSA_ERROR_BAD_STATE;
3447 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003448 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003449
Steven Cooreman7df02922020-09-09 15:28:49 +02003450 if( operation->iv_required && ! operation->iv_set )
3451 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003452 status = PSA_ERROR_BAD_STATE;
3453 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003454 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003455
Ronald Crondd24c9b2020-12-15 14:10:01 +01003456 status = psa_driver_wrapper_cipher_update( operation,
3457 input,
3458 input_length,
3459 output,
3460 output_size,
3461 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003462
3463exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003464 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003465 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003466
itayzafrir534bd7c2018-08-02 13:56:32 +03003467 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003468}
3469
Gilles Peskinee553c652018-06-04 16:22:46 +02003470psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3471 uint8_t *output,
3472 size_t output_size,
3473 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003474{
David Saadab4ecc272019-02-14 13:48:10 +02003475 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003476
Ronald Cron49fafa92021-03-10 08:34:23 +01003477 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003478 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003479 status = PSA_ERROR_BAD_STATE;
3480 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003481 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003482
Steven Cooreman7df02922020-09-09 15:28:49 +02003483 if( operation->iv_required && ! operation->iv_set )
3484 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003485 status = PSA_ERROR_BAD_STATE;
3486 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003487 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003488
Ronald Crondd24c9b2020-12-15 14:10:01 +01003489 status = psa_driver_wrapper_cipher_finish( operation,
3490 output,
3491 output_size,
3492 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003493
3494exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003495 if( status == PSA_SUCCESS )
3496 return( psa_cipher_abort( operation ) );
3497 else
3498 {
3499 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003500 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003501
Steven Cooremanef8575e2020-09-11 11:44:50 +02003502 return( status );
3503 }
mohammad1603503973b2018-03-12 15:59:30 +02003504}
3505
Gilles Peskinee553c652018-06-04 16:22:46 +02003506psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3507{
Ronald Cron49fafa92021-03-10 08:34:23 +01003508 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003509 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003510 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003511 * in use. It's ok to call abort on such an object, and there's
3512 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003513 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003514 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003515
Ronald Crondd24c9b2020-12-15 14:10:01 +01003516 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003517
Ronald Cron49fafa92021-03-10 08:34:23 +01003518 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003519 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003520 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003521
Moran Peker395db872018-05-31 14:07:14 +03003522 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003523}
3524
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003525psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3526 psa_algorithm_t alg,
3527 const uint8_t *input,
3528 size_t input_length,
3529 uint8_t *output,
3530 size_t output_size,
3531 size_t *output_length )
3532{
3533 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003534 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3535 psa_key_slot_t *slot;
3536 psa_key_type_t key_type;
3537 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003538
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003539 *output_length = 0;
3540
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003541 if( ! PSA_ALG_IS_CIPHER( alg ) )
3542 return( PSA_ERROR_INVALID_ARGUMENT );
3543
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003544 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3545 PSA_KEY_USAGE_ENCRYPT,
3546 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003547 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003548 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003549
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003550 psa_key_attributes_t attributes = {
3551 .core = slot->attr
3552 };
3553
3554 key_type = slot->attr.type;
3555 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3556
3557 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003558 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003559 if( output_size < iv_length )
3560 {
3561 status = PSA_ERROR_BUFFER_TOO_SMALL;
3562 goto exit;
3563 }
3564
3565 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003566 if( status != PSA_SUCCESS )
3567 goto exit;
3568 }
3569
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003570 status = psa_driver_wrapper_cipher_encrypt(
3571 &attributes, slot->key.data, slot->key.bytes,
3572 alg, input, input_length,
3573 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003574
3575exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003576 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003577
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003578 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003579}
3580
3581psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3582 psa_algorithm_t alg,
3583 const uint8_t *input,
3584 size_t input_length,
3585 uint8_t *output,
3586 size_t output_size,
3587 size_t *output_length )
3588{
3589 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003590 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3591 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003592
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003593 *output_length = 0;
3594
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003595 if( ! PSA_ALG_IS_CIPHER( alg ) )
3596 return( PSA_ERROR_INVALID_ARGUMENT );
3597
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003598 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3599 PSA_KEY_USAGE_DECRYPT,
3600 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003601 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003602 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003603
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003604 psa_key_attributes_t attributes = {
3605 .core = slot->attr
3606 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003607
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003608 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3609 {
3610 status = PSA_ERROR_INVALID_ARGUMENT;
3611 goto exit;
3612 }
3613 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003614 {
3615 status = PSA_ERROR_INVALID_ARGUMENT;
3616 goto exit;
3617 }
3618
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003619 status = psa_driver_wrapper_cipher_decrypt(
3620 &attributes, slot->key.data, slot->key.bytes,
3621 alg, input, input_length,
3622 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003623
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003624exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003625 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003626
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003627 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003628}
3629
3630
mohammad16035955c982018-04-26 00:53:03 +03003631/****************************************************************/
3632/* AEAD */
3633/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003634
Paul Elliottbaff51c2021-09-28 17:44:45 +01003635/* Helper function to get the base algorithm from its variants. */
3636static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3637{
3638 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3639}
3640
3641/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003642static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3643 size_t nonce_length )
3644{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003645 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3646
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003647 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003648 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003649#if defined(PSA_WANT_ALG_GCM)
3650 case PSA_ALG_GCM:
3651 /* Not checking max nonce size here as GCM spec allows almost
3652 * arbitrarily large nonces. Please note that we do not generally
3653 * recommend the usage of nonces of greater length than
3654 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3655 * size, which can then lead to collisions if you encrypt a very
3656 * large number of messages.*/
3657 if( nonce_length != 0 )
3658 return( PSA_SUCCESS );
3659 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003660#endif /* PSA_WANT_ALG_GCM */
3661#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003662 case PSA_ALG_CCM:
3663 if( nonce_length >= 7 && nonce_length <= 13 )
3664 return( PSA_SUCCESS );
3665 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003666#endif /* PSA_WANT_ALG_CCM */
3667#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003668 case PSA_ALG_CHACHA20_POLY1305:
3669 if( nonce_length == 12 )
3670 return( PSA_SUCCESS );
Bence Szépkúti6d48e202021-11-15 20:04:15 +01003671 else if( nonce_length == 8 )
3672 return( PSA_ERROR_NOT_SUPPORTED );
3673 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003674#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003675 default:
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003676 return( PSA_ERROR_NOT_SUPPORTED );
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003677 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003678
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003679 return( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003680}
3681
Ronald Croncf56a0a2020-08-04 09:51:30 +02003682psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003683 psa_algorithm_t alg,
3684 const uint8_t *nonce,
3685 size_t nonce_length,
3686 const uint8_t *additional_data,
3687 size_t additional_data_length,
3688 const uint8_t *plaintext,
3689 size_t plaintext_length,
3690 uint8_t *ciphertext,
3691 size_t ciphertext_size,
3692 size_t *ciphertext_length )
3693{
Ronald Cron215633c2021-03-16 17:15:37 +01003694 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3695 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003696
mohammad1603f08a5502018-06-03 15:05:47 +03003697 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003698
Steven Cooremanea7ab132021-03-17 16:28:00 +01003699 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3700 return( PSA_ERROR_NOT_SUPPORTED );
3701
Ronald Cron9a986162021-03-26 12:40:07 +01003702 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003703 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003704 if( status != PSA_SUCCESS )
3705 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003706
Ronald Cron215633c2021-03-16 17:15:37 +01003707 psa_key_attributes_t attributes = {
3708 .core = slot->attr
3709 };
mohammad16035955c982018-04-26 00:53:03 +03003710
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003711 status = psa_aead_check_nonce_length( alg, nonce_length );
3712 if( status != PSA_SUCCESS )
3713 goto exit;
3714
Ronald Cronde822812021-03-17 16:08:20 +01003715 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003716 &attributes, slot->key.data, slot->key.bytes,
3717 alg,
3718 nonce, nonce_length,
3719 additional_data, additional_data_length,
3720 plaintext, plaintext_length,
3721 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003722
Gilles Peskineedf9a652018-08-17 18:11:56 +02003723 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3724 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003725
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003726exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003727 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003728
mohammad16035955c982018-04-26 00:53:03 +03003729 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003730}
3731
Ronald Croncf56a0a2020-08-04 09:51:30 +02003732psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003733 psa_algorithm_t alg,
3734 const uint8_t *nonce,
3735 size_t nonce_length,
3736 const uint8_t *additional_data,
3737 size_t additional_data_length,
3738 const uint8_t *ciphertext,
3739 size_t ciphertext_length,
3740 uint8_t *plaintext,
3741 size_t plaintext_size,
3742 size_t *plaintext_length )
3743{
Ronald Cron215633c2021-03-16 17:15:37 +01003744 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3745 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003746
Gilles Peskineee652a32018-06-01 19:23:52 +02003747 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003748
Steven Cooremanea7ab132021-03-17 16:28:00 +01003749 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3750 return( PSA_ERROR_NOT_SUPPORTED );
3751
Ronald Cron9a986162021-03-26 12:40:07 +01003752 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003753 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003754 if( status != PSA_SUCCESS )
3755 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003756
Ronald Cron215633c2021-03-16 17:15:37 +01003757 psa_key_attributes_t attributes = {
3758 .core = slot->attr
3759 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003760
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003761 status = psa_aead_check_nonce_length( alg, nonce_length );
3762 if( status != PSA_SUCCESS )
3763 goto exit;
3764
Ronald Cronde822812021-03-17 16:08:20 +01003765 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003766 &attributes, slot->key.data, slot->key.bytes,
3767 alg,
3768 nonce, nonce_length,
3769 additional_data, additional_data_length,
3770 ciphertext, ciphertext_length,
3771 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003772
Gilles Peskineedf9a652018-08-17 18:11:56 +02003773 if( status != PSA_SUCCESS && plaintext_size != 0 )
3774 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003775
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003776exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003777 psa_unlock_key_slot( slot );
3778
Gilles Peskineedf9a652018-08-17 18:11:56 +02003779 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003780}
3781
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003782/* Set the key for a multipart authenticated operation. */
3783static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003784 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003785 mbedtls_svc_key_id_t key,
3786 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003787{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003788 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3789 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3790 psa_key_slot_t *slot = NULL;
3791 psa_key_usage_t key_usage = 0;
3792
Paul Elliottc2b71442021-06-24 18:17:52 +01003793 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3794 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003795 status = PSA_ERROR_INVALID_ARGUMENT;
3796 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003797 }
3798
3799 if( operation->id != 0 )
3800 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003801 status = PSA_ERROR_BAD_STATE;
3802 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003803 }
3804
3805 if( operation->nonce_set || operation->lengths_set ||
3806 operation->ad_started || operation->body_started )
3807 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003808 status = PSA_ERROR_BAD_STATE;
3809 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003810 }
3811
Paul Elliottd9343f22021-08-23 18:59:49 +01003812 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003813 key_usage = PSA_KEY_USAGE_ENCRYPT;
3814 else
3815 key_usage = PSA_KEY_USAGE_DECRYPT;
3816
3817 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3818 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003819 if( status != PSA_SUCCESS )
3820 goto exit;
3821
3822 psa_key_attributes_t attributes = {
3823 .core = slot->attr
3824 };
3825
Paul Elliottd9343f22021-08-23 18:59:49 +01003826 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003827 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3828 &attributes,
3829 slot->key.data,
3830 slot->key.bytes,
3831 alg );
3832 else
3833 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3834 &attributes,
3835 slot->key.data,
3836 slot->key.bytes,
3837 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003838 if( status != PSA_SUCCESS )
3839 goto exit;
3840
3841 operation->key_type = psa_get_key_type( &attributes );
3842
3843exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003844 unlock_status = psa_unlock_key_slot( slot );
3845
3846 if( status == PSA_SUCCESS )
3847 {
3848 status = unlock_status;
3849 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003850 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003851 }
3852 else
3853 psa_aead_abort( operation );
3854
3855 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003856}
3857
Paul Elliott302ff6b2021-04-20 18:10:30 +01003858/* Set the key for a multipart authenticated encryption operation. */
3859psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3860 mbedtls_svc_key_id_t key,
3861 psa_algorithm_t alg )
3862{
Paul Elliottd9343f22021-08-23 18:59:49 +01003863 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003864}
3865
3866/* Set the key for a multipart authenticated decryption operation. */
3867psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3868 mbedtls_svc_key_id_t key,
3869 psa_algorithm_t alg )
3870{
Paul Elliottd9343f22021-08-23 18:59:49 +01003871 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003872}
3873
3874/* Generate a random nonce / IV for multipart AEAD operation */
3875psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3876 uint8_t *nonce,
3877 size_t nonce_size,
3878 size_t *nonce_length )
3879{
3880 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottb91da712021-05-20 14:43:47 +01003881 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003882
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003883 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003884
Paul Elliottcee785c2021-05-20 14:29:20 +01003885 if( operation->id == 0 )
3886 {
3887 status = PSA_ERROR_BAD_STATE;
3888 goto exit;
3889 }
3890
Paul Elliottdaf5c892021-08-25 16:24:58 +01003891 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003892 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003893 status = PSA_ERROR_BAD_STATE;
3894 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003895 }
3896
Paul Elliottbbe90b52021-05-11 22:22:42 +01003897 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003898 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003899 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003900 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003901 status = PSA_ERROR_BUFFER_TOO_SMALL;
3902 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003903 }
3904
3905 status = psa_generate_random( nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003906 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003907 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003908
Paul Elliott95271f12021-06-23 16:50:45 +01003909 status = psa_aead_set_nonce( operation, nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003910
Paul Elliott39dc6b82021-05-11 19:16:09 +01003911exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003912 if( status == PSA_SUCCESS )
3913 *nonce_length = required_nonce_size;
3914 else
3915 psa_aead_abort( operation );
3916
3917 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003918}
3919
3920/* Set the nonce for a multipart authenticated encryption or decryption
3921 operation.*/
3922psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3923 const uint8_t *nonce,
3924 size_t nonce_length )
3925{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3927
Paul Elliottcee785c2021-05-20 14:29:20 +01003928 if( operation->id == 0 )
3929 {
3930 status = PSA_ERROR_BAD_STATE;
3931 goto exit;
3932 }
3933
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003934 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003935 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003936 status = PSA_ERROR_BAD_STATE;
3937 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003938 }
3939
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003940 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003941 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003942 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003943 status = PSA_ERROR_INVALID_ARGUMENT;
3944 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003945 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003946
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003947 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3948 nonce_length );
3949
Paul Elliott39dc6b82021-05-11 19:16:09 +01003950exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003951 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003952 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003953 else
3954 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003955
3956 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003957}
3958
3959/* Declare the lengths of the message and additional data for multipart AEAD. */
3960psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3961 size_t ad_length,
3962 size_t plaintext_length )
3963{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003964 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3965
Paul Elliottcee785c2021-05-20 14:29:20 +01003966 if( operation->id == 0 )
3967 {
3968 status = PSA_ERROR_BAD_STATE;
3969 goto exit;
3970 }
3971
Paul Elliott6eb95982021-05-21 17:41:41 +01003972 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003973 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003974 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003975 status = PSA_ERROR_BAD_STATE;
3976 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003977 }
3978
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003979 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003980 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003981#if defined(PSA_WANT_ALG_GCM)
3982 case PSA_ALG_GCM:
3983 /* Lengths can only be too large for GCM if size_t is bigger than 32
3984 * bits. Without the guard this code will generate warnings on 32bit
3985 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003986#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003987 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3988 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3989 {
3990 status = PSA_ERROR_INVALID_ARGUMENT;
3991 goto exit;
3992 }
Paul Elliott325d3742021-09-27 17:56:28 +01003993#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003994 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003995#endif /* PSA_WANT_ALG_GCM */
3996#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003997 case PSA_ALG_CCM:
3998 if( ad_length > 0xFF00 )
3999 {
4000 status = PSA_ERROR_INVALID_ARGUMENT;
4001 goto exit;
4002 }
4003 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004004#endif /* PSA_WANT_ALG_CCM */
4005#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004006 case PSA_ALG_CHACHA20_POLY1305:
4007 /* No length restrictions for ChaChaPoly. */
4008 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004009#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004010 default:
4011 break;
4012 }
Paul Elliott325d3742021-09-27 17:56:28 +01004013
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004014 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
4015 plaintext_length );
4016
Paul Elliott39dc6b82021-05-11 19:16:09 +01004017exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004018 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004019 {
4020 operation->ad_remaining = ad_length;
4021 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004022 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01004023 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004024 else
4025 psa_aead_abort( operation );
4026
4027 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004028}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004029
4030/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004031psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4032 const uint8_t *input,
4033 size_t input_length )
4034{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004035 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4036
Paul Elliottcee785c2021-05-20 14:29:20 +01004037 if( operation->id == 0 )
4038 {
4039 status = PSA_ERROR_BAD_STATE;
4040 goto exit;
4041 }
4042
Paul Elliott6eb95982021-05-21 17:41:41 +01004043 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004044 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004045 status = PSA_ERROR_BAD_STATE;
4046 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004047 }
4048
Paul Elliottee4ffe02021-05-20 17:25:06 +01004049 if( operation->lengths_set )
4050 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004051 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004052 {
4053 status = PSA_ERROR_INVALID_ARGUMENT;
4054 goto exit;
4055 }
4056
4057 operation->ad_remaining -= input_length;
4058 }
4059
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004060 status = psa_driver_wrapper_aead_update_ad( operation, input,
4061 input_length );
4062
Paul Elliott39dc6b82021-05-11 19:16:09 +01004063exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004064 if( status == PSA_SUCCESS )
4065 operation->ad_started = 1;
4066 else
4067 psa_aead_abort( operation );
4068
4069 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004070}
4071
4072/* Encrypt or decrypt a message fragment in an active multipart AEAD
4073 operation.*/
4074psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4075 const uint8_t *input,
4076 size_t input_length,
4077 uint8_t *output,
4078 size_t output_size,
4079 size_t *output_length )
4080{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004081 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004082
4083 *output_length = 0;
4084
Paul Elliottcee785c2021-05-20 14:29:20 +01004085 if( operation->id == 0 )
4086 {
4087 status = PSA_ERROR_BAD_STATE;
4088 goto exit;
4089 }
4090
Paul Elliott6eb95982021-05-21 17:41:41 +01004091 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004092 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004093 status = PSA_ERROR_BAD_STATE;
4094 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004095 }
4096
Paul Elliottee4ffe02021-05-20 17:25:06 +01004097 if( operation->lengths_set )
4098 {
4099 /* Additional data length was supplied, but not all the additional
4100 data was supplied.*/
4101 if( operation->ad_remaining != 0 )
4102 {
4103 status = PSA_ERROR_INVALID_ARGUMENT;
4104 goto exit;
4105 }
4106
4107 /* Too much data provided. */
4108 if( operation->body_remaining < input_length )
4109 {
4110 status = PSA_ERROR_INVALID_ARGUMENT;
4111 goto exit;
4112 }
4113
4114 operation->body_remaining -= input_length;
4115 }
4116
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004117 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4118 output, output_size,
4119 output_length );
4120
Paul Elliott39dc6b82021-05-11 19:16:09 +01004121exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004122 if( status == PSA_SUCCESS )
4123 operation->body_started = 1;
4124 else
4125 psa_aead_abort( operation );
4126
4127 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004128}
4129
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004130static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004131{
Paul Elliott7f429b72021-06-24 18:08:54 +01004132 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004133 return( PSA_ERROR_BAD_STATE );
4134
Paul Elliotta5614442021-07-14 14:54:11 +01004135 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004136 operation->body_remaining != 0 ) )
4137 return( PSA_ERROR_INVALID_ARGUMENT );
4138
4139 return( PSA_SUCCESS );
4140}
4141
Paul Elliott302ff6b2021-04-20 18:10:30 +01004142/* Finish encrypting a message in a multipart AEAD operation. */
4143psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4144 uint8_t *ciphertext,
4145 size_t ciphertext_size,
4146 size_t *ciphertext_length,
4147 uint8_t *tag,
4148 size_t tag_size,
4149 size_t *tag_length )
4150{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4152
Paul Elliott302ff6b2021-04-20 18:10:30 +01004153 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004154 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004155
Paul Elliott814fffb2021-08-16 18:20:36 +01004156 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004157 if( status != PSA_SUCCESS )
4158 goto exit;
4159
Paul Elliott7f429b72021-06-24 18:08:54 +01004160 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004161 {
4162 status = PSA_ERROR_BAD_STATE;
4163 goto exit;
4164 }
4165
Paul Elliott39dc6b82021-05-11 19:16:09 +01004166 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4167 ciphertext_size,
4168 ciphertext_length,
4169 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004170
Paul Elliott39dc6b82021-05-11 19:16:09 +01004171exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004172 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004173 * the zero tag size, make sure the tag is set to something implausible.
4174 * Even if the operation succeeds, make sure we clear the rest of the
4175 * buffer to prevent potential leakage of anything previously placed in
4176 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004177 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004178 {
4179 if( status != PSA_SUCCESS )
4180 memset( tag, '!', tag_size );
4181 else if( *tag_length < tag_size )
4182 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4183 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004184
Paul Elliott39dc6b82021-05-11 19:16:09 +01004185 psa_aead_abort( operation );
4186
4187 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004188}
4189
4190/* Finish authenticating and decrypting a message in a multipart AEAD
4191 operation.*/
4192psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4193 uint8_t *plaintext,
4194 size_t plaintext_size,
4195 size_t *plaintext_length,
4196 const uint8_t *tag,
4197 size_t tag_length )
4198{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4200
Paul Elliott302ff6b2021-04-20 18:10:30 +01004201 *plaintext_length = 0;
4202
Paul Elliott814fffb2021-08-16 18:20:36 +01004203 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004204 if( status != PSA_SUCCESS )
4205 goto exit;
4206
Paul Elliott7f429b72021-06-24 18:08:54 +01004207 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004208 {
4209 status = PSA_ERROR_BAD_STATE;
4210 goto exit;
4211 }
4212
Paul Elliott39dc6b82021-05-11 19:16:09 +01004213 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4214 plaintext_size,
4215 plaintext_length,
4216 tag, tag_length );
4217
4218exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004219 psa_aead_abort( operation );
4220
4221 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004222}
4223
4224/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004225psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004226{
4227 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4228
4229 if( operation->id == 0 )
4230 {
4231 /* The object has (apparently) been initialized but it is not (yet)
4232 * in use. It's ok to call abort on such an object, and there's
4233 * nothing to do. */
4234 return( PSA_SUCCESS );
4235 }
4236
4237 status = psa_driver_wrapper_aead_abort( operation );
4238
Paul Elliott70618b22021-09-22 17:12:16 +01004239 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004240
4241 return( status );
4242}
4243
Gilles Peskinee59236f2018-01-27 23:32:46 +01004244/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004245/* Generators */
4246/****************************************************************/
4247
John Durkop07cc04a2020-11-16 22:08:34 -08004248#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4249 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4250 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4251#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004252#endif /* At least one builtin KDF */
4253
4254#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4255 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4256 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4257static psa_status_t psa_key_derivation_start_hmac(
4258 psa_mac_operation_t *operation,
4259 psa_algorithm_t hash_alg,
4260 const uint8_t *hmac_key,
4261 size_t hmac_key_length )
4262{
4263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4264 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4265 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4266 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4267 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4268
Steven Cooreman72f736a2021-05-07 14:14:37 +02004269 operation->is_sign = 1;
4270 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4271
Steven Cooreman094a77e2021-05-06 17:58:36 +02004272 status = psa_driver_wrapper_mac_sign_setup( operation,
4273 &attributes,
4274 hmac_key, hmac_key_length,
4275 PSA_ALG_HMAC( hash_alg ) );
4276
4277 psa_reset_key_attributes( &attributes );
4278 return( status );
4279}
4280#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004281
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004282#define HKDF_STATE_INIT 0 /* no input yet */
4283#define HKDF_STATE_STARTED 1 /* got salt */
4284#define HKDF_STATE_KEYED 2 /* got key */
4285#define HKDF_STATE_OUTPUT 3 /* output started */
4286
Gilles Peskinecbe66502019-05-16 16:59:18 +02004287static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004288 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004289{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004290 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4291 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004292 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004293 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004294}
4295
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004296psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004297{
4298 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004299 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004300 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004301 {
4302 /* The object has (apparently) been initialized but it is not
4303 * in use. It's ok to call abort on such an object, and there's
4304 * nothing to do. */
4305 }
4306 else
John Durkopd0321952020-10-29 21:37:36 -07004307#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004308 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004309 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004310 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004311 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004312 }
John Durkop07cc04a2020-11-16 22:08:34 -08004313 else
4314#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4315#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4316 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4317 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004318 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004319 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004320 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004321 if( operation->ctx.tls12_prf.secret != NULL )
4322 {
4323 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4324 operation->ctx.tls12_prf.secret_length );
4325 mbedtls_free( operation->ctx.tls12_prf.secret );
4326 }
4327
Janos Follath6a1d2622019-06-11 10:37:28 +01004328 if( operation->ctx.tls12_prf.seed != NULL )
4329 {
4330 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4331 operation->ctx.tls12_prf.seed_length );
4332 mbedtls_free( operation->ctx.tls12_prf.seed );
4333 }
4334
4335 if( operation->ctx.tls12_prf.label != NULL )
4336 {
4337 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4338 operation->ctx.tls12_prf.label_length );
4339 mbedtls_free( operation->ctx.tls12_prf.label );
4340 }
4341
Steven Cooremana6df6042021-04-29 19:32:25 +02004342 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004343
4344 /* We leave the fields Ai and output_block to be erased safely by the
4345 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004346 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004347 else
John Durkop07cc04a2020-11-16 22:08:34 -08004348#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4349 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004350 {
4351 status = PSA_ERROR_BAD_STATE;
4352 }
Janos Follath083036a2019-06-11 10:22:26 +01004353 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004354 return( status );
4355}
4356
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004357psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004358 size_t *capacity)
4359{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004360 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004361 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004362 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004363 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004364 }
4365
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004366 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004367 return( PSA_SUCCESS );
4368}
4369
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004370psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004371 size_t capacity )
4372{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004373 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004374 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004375 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004376 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004377 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004378 return( PSA_SUCCESS );
4379}
4380
John Durkopd0321952020-10-29 21:37:36 -07004381#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004382/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004383 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004384static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004385 psa_algorithm_t hash_alg,
4386 uint8_t *output,
4387 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004388{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004389 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004390 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004391 psa_status_t status;
4392
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004393 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4394 return( PSA_ERROR_BAD_STATE );
4395 hkdf->state = HKDF_STATE_OUTPUT;
4396
Gilles Peskinebef7f142018-07-12 17:22:21 +02004397 while( output_length != 0 )
4398 {
4399 /* Copy what remains of the current block */
4400 uint8_t n = hash_length - hkdf->offset_in_block;
4401 if( n > output_length )
4402 n = (uint8_t) output_length;
4403 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4404 output += n;
4405 output_length -= n;
4406 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004407 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004408 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004409 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004410 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004411 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004412 * object was corrupted or if this function is called directly
4413 * inside the library. */
4414 if( hkdf->block_number == 0xff )
4415 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004416
4417 /* We need a new block */
4418 ++hkdf->block_number;
4419 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004420
Steven Cooreman094a77e2021-05-06 17:58:36 +02004421 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4422 hash_alg,
4423 hkdf->prk,
4424 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004425 if( status != PSA_SUCCESS )
4426 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004427
Gilles Peskinebef7f142018-07-12 17:22:21 +02004428 if( hkdf->block_number != 1 )
4429 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004430 status = psa_mac_update( &hkdf->hmac,
4431 hkdf->output_block,
4432 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004433 if( status != PSA_SUCCESS )
4434 return( status );
4435 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004436 status = psa_mac_update( &hkdf->hmac,
4437 hkdf->info,
4438 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004439 if( status != PSA_SUCCESS )
4440 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004441 status = psa_mac_update( &hkdf->hmac,
4442 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004443 if( status != PSA_SUCCESS )
4444 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004445 status = psa_mac_sign_finish( &hkdf->hmac,
4446 hkdf->output_block,
4447 sizeof( hkdf->output_block ),
4448 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004449 if( status != PSA_SUCCESS )
4450 return( status );
4451 }
4452
4453 return( PSA_SUCCESS );
4454}
John Durkop07cc04a2020-11-16 22:08:34 -08004455#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004456
John Durkop07cc04a2020-11-16 22:08:34 -08004457#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4458 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004459static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4460 psa_tls12_prf_key_derivation_t *tls12_prf,
4461 psa_algorithm_t alg )
4462{
4463 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004464 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004465 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4466 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004467 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004468
Janos Follath7742fee2019-06-17 12:58:10 +01004469 /* We can't be wanting more output after block 0xff, otherwise
4470 * the capacity check in psa_key_derivation_output_bytes() would have
4471 * prevented this call. It could happen only if the operation
4472 * object was corrupted or if this function is called directly
4473 * inside the library. */
4474 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004475 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004476
4477 /* We need a new block */
4478 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004479 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004480
4481 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4482 *
4483 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4484 *
4485 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4486 * HMAC_hash(secret, A(2) + seed) +
4487 * HMAC_hash(secret, A(3) + seed) + ...
4488 *
4489 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004490 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004491 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004492 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004493 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004494 * is currently extracted as `output_block` and where i is
4495 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004496 */
4497
Steven Cooreman094a77e2021-05-06 17:58:36 +02004498 status = psa_key_derivation_start_hmac( &hmac,
4499 hash_alg,
4500 tls12_prf->secret,
4501 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004502 if( status != PSA_SUCCESS )
4503 goto cleanup;
4504
4505 /* Calculate A(i) where i = tls12_prf->block_number. */
4506 if( tls12_prf->block_number == 1 )
4507 {
4508 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4509 * the variable seed and in this instance means it in the context of the
4510 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004511 status = psa_mac_update( &hmac,
4512 tls12_prf->label,
4513 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004514 if( status != PSA_SUCCESS )
4515 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004516 status = psa_mac_update( &hmac,
4517 tls12_prf->seed,
4518 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004519 if( status != PSA_SUCCESS )
4520 goto cleanup;
4521 }
4522 else
4523 {
4524 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004525 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004526 if( status != PSA_SUCCESS )
4527 goto cleanup;
4528 }
4529
Steven Cooremana6df6042021-04-29 19:32:25 +02004530 status = psa_mac_sign_finish( &hmac,
4531 tls12_prf->Ai, hash_length,
4532 &hmac_output_length );
4533 if( hmac_output_length != hash_length )
4534 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004535 if( status != PSA_SUCCESS )
4536 goto cleanup;
4537
4538 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004539 status = psa_key_derivation_start_hmac( &hmac,
4540 hash_alg,
4541 tls12_prf->secret,
4542 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004543 if( status != PSA_SUCCESS )
4544 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004545 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004546 if( status != PSA_SUCCESS )
4547 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004548 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004549 if( status != PSA_SUCCESS )
4550 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004551 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004552 if( status != PSA_SUCCESS )
4553 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004554 status = psa_mac_sign_finish( &hmac,
4555 tls12_prf->output_block, hash_length,
4556 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004557 if( status != PSA_SUCCESS )
4558 goto cleanup;
4559
Janos Follath7742fee2019-06-17 12:58:10 +01004560
4561cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004562 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004563 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4564 status = cleanup_status;
4565
4566 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004567}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004568
Janos Follath844eb0e2019-06-19 12:10:49 +01004569static psa_status_t psa_key_derivation_tls12_prf_read(
4570 psa_tls12_prf_key_derivation_t *tls12_prf,
4571 psa_algorithm_t alg,
4572 uint8_t *output,
4573 size_t output_length )
4574{
4575 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004576 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004577 psa_status_t status;
4578 uint8_t offset, length;
4579
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004580 switch( tls12_prf->state )
4581 {
4582 case PSA_TLS12_PRF_STATE_LABEL_SET:
4583 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4584 break;
4585 case PSA_TLS12_PRF_STATE_OUTPUT:
4586 break;
4587 default:
4588 return( PSA_ERROR_BAD_STATE );
4589 }
4590
Janos Follath844eb0e2019-06-19 12:10:49 +01004591 while( output_length != 0 )
4592 {
4593 /* Check if we have fully processed the current block. */
4594 if( tls12_prf->left_in_block == 0 )
4595 {
4596 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4597 alg );
4598 if( status != PSA_SUCCESS )
4599 return( status );
4600
4601 continue;
4602 }
4603
4604 if( tls12_prf->left_in_block > output_length )
4605 length = (uint8_t) output_length;
4606 else
4607 length = tls12_prf->left_in_block;
4608
4609 offset = hash_length - tls12_prf->left_in_block;
4610 memcpy( output, tls12_prf->output_block + offset, length );
4611 output += length;
4612 output_length -= length;
4613 tls12_prf->left_in_block -= length;
4614 }
4615
4616 return( PSA_SUCCESS );
4617}
John Durkop07cc04a2020-11-16 22:08:34 -08004618#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4619 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004620
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004621psa_status_t psa_key_derivation_output_bytes(
4622 psa_key_derivation_operation_t *operation,
4623 uint8_t *output,
4624 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004625{
4626 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004627 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004628
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004629 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004630 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004631 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004632 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004633 }
4634
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004635 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004636 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004637 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004638 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004639 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004640 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004641 goto exit;
4642 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004643 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004644 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004645 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004646 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004647 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4648 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004649 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004650 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004651 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004652 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004653 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004654
John Durkopd0321952020-10-29 21:37:36 -07004655#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004656 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004657 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004658 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004659 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004660 output, output_length );
4661 }
Janos Follathadbec812019-06-14 11:05:39 +01004662 else
John Durkop07cc04a2020-11-16 22:08:34 -08004663#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4664#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4665 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004666 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004667 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004668 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004669 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004670 kdf_alg, output,
4671 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004672 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004673 else
John Durkop07cc04a2020-11-16 22:08:34 -08004674#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4675 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004676 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004677 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004678 return( PSA_ERROR_BAD_STATE );
4679 }
4680
4681exit:
4682 if( status != PSA_SUCCESS )
4683 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004684 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004685 * This allows us to differentiate between exhausted operations and
4686 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4687 * operations. */
4688 psa_algorithm_t alg = operation->alg;
4689 psa_key_derivation_abort( operation );
4690 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004691 memset( output, '!', output_length );
4692 }
4693 return( status );
4694}
4695
David Brown7807bf72021-02-09 16:28:23 -07004696#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004697static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4698{
4699 if( data_size >= 8 )
4700 mbedtls_des_key_set_parity( data );
4701 if( data_size >= 16 )
4702 mbedtls_des_key_set_parity( data + 8 );
4703 if( data_size >= 24 )
4704 mbedtls_des_key_set_parity( data + 16 );
4705}
David Brown7807bf72021-02-09 16:28:23 -07004706#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004707
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004708static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004709 psa_key_slot_t *slot,
4710 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004711 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004712{
4713 uint8_t *data = NULL;
4714 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304715 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004716 psa_status_t status;
4717
Gilles Peskine8e338702019-07-30 20:06:31 +02004718 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004719 return( PSA_ERROR_INVALID_ARGUMENT );
4720 if( bits % 8 != 0 )
4721 return( PSA_ERROR_INVALID_ARGUMENT );
4722 data = mbedtls_calloc( 1, bytes );
4723 if( data == NULL )
4724 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4725
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004726 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004727 if( status != PSA_SUCCESS )
4728 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004729#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004730 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004731 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004732#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004733
Ronald Cronbf33c932020-11-28 18:06:53 +01004734 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004735 psa_key_attributes_t attributes = {
4736 .core = slot->attr
4737 };
4738
Archanad8a83dc2021-06-14 10:04:16 +05304739 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4740 {
Archana449608b2021-09-08 15:36:05 +05304741 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4742 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304743 if( status != PSA_SUCCESS )
4744 goto exit;
4745 }
4746 status = psa_allocate_buffer_to_slot( slot, storage_size );
4747 if( status != PSA_SUCCESS )
4748 goto exit;
4749
Ronald Cronbf33c932020-11-28 18:06:53 +01004750 status = psa_driver_wrapper_import_key( &attributes,
4751 data, bytes,
4752 slot->key.data,
4753 slot->key.bytes,
4754 &slot->key.bytes, &bits );
4755 if( bits != slot->attr.bits )
4756 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004757
4758exit:
4759 mbedtls_free( data );
4760 return( status );
4761}
4762
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004763psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004764 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004765 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004766{
4767 psa_status_t status;
4768 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004769 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004770
Ronald Cron81709fc2020-11-14 12:10:32 +01004771 *key = MBEDTLS_SVC_KEY_ID_INIT;
4772
Gilles Peskine0f84d622019-09-12 19:03:13 +02004773 /* Reject any attempt to create a zero-length key so that we don't
4774 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4775 if( psa_get_key_bits( attributes ) == 0 )
4776 return( PSA_ERROR_INVALID_ARGUMENT );
4777
Dave Rodgmand69da6c2021-11-16 10:32:48 +00004778 if( operation->alg == PSA_ALG_NONE )
4779 return( PSA_ERROR_BAD_STATE );
4780
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004781 if( ! operation->can_output_key )
4782 return( PSA_ERROR_NOT_PERMITTED );
4783
Ronald Cron81709fc2020-11-14 12:10:32 +01004784 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4785 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004786#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4787 if( driver != NULL )
4788 {
4789 /* Deriving a key in a secure element is not implemented yet. */
4790 status = PSA_ERROR_NOT_SUPPORTED;
4791 }
4792#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004793 if( status == PSA_SUCCESS )
4794 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004795 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004796 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004797 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004798 }
4799 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004800 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004801 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004802 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004803
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004804 return( status );
4805}
4806
Gilles Peskineeab56e42018-07-12 17:12:33 +02004807
4808
4809/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004810/* Key derivation */
4811/****************************************************************/
4812
Steven Cooreman932ffb72021-02-15 12:14:32 +01004813#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004814static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004816 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817{
John Durkop07cc04a2020-11-16 22:08:34 -08004818 int is_kdf_alg_supported;
4819
Janos Follath5fe19732019-06-20 15:09:30 +01004820 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4821 * initialisers for this union leave some bytes unspecified.) */
4822 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4823
Gilles Peskine969c5d62019-01-16 15:53:06 +01004824 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004825#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004826 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4827 is_kdf_alg_supported = 1;
4828 else
4829#endif
4830#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4831 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4832 is_kdf_alg_supported = 1;
4833 else
4834#endif
4835#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4836 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4837 is_kdf_alg_supported = 1;
4838 else
4839#endif
4840 is_kdf_alg_supported = 0;
4841
4842 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004843 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004844 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004845 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004846 if( hash_size == 0 )
4847 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004848 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4849 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004850 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004851 {
4852 return( PSA_ERROR_NOT_SUPPORTED );
4853 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004854 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004855 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004856 }
John Durkop07cc04a2020-11-16 22:08:34 -08004857
4858 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004859}
John Durkop07cc04a2020-11-16 22:08:34 -08004860#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004861
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004862psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004863 psa_algorithm_t alg )
4864{
4865 psa_status_t status;
4866
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004867 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004868 return( PSA_ERROR_BAD_STATE );
4869
Gilles Peskine6843c292019-01-18 16:44:49 +01004870 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4871 return( PSA_ERROR_INVALID_ARGUMENT );
4872 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004873 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004874#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004875 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004876 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004877#else
4878 return( PSA_ERROR_NOT_SUPPORTED );
4879#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004880 }
4881 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4882 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004883#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004884 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004885#else
4886 return( PSA_ERROR_NOT_SUPPORTED );
4887#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004888 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004889 else
4890 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004891
4892 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004893 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004894 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004895}
4896
John Durkopd0321952020-10-29 21:37:36 -07004897#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004898static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004899 psa_algorithm_t hash_alg,
4900 psa_key_derivation_step_t step,
4901 const uint8_t *data,
4902 size_t data_length )
4903{
4904 psa_status_t status;
4905 switch( step )
4906 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004907 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004908 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004909 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004910 else
4911 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004912 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4913 hash_alg,
4914 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004915 if( status != PSA_SUCCESS )
4916 return( status );
4917 hkdf->state = HKDF_STATE_STARTED;
4918 return( PSA_SUCCESS );
4919 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004920 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004921 /* If no salt was provided, use an empty salt. */
4922 if( hkdf->state == HKDF_STATE_INIT )
4923 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004924 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4925 hash_alg,
4926 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004927 if( status != PSA_SUCCESS )
4928 return( status );
4929 hkdf->state = HKDF_STATE_STARTED;
4930 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004931 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004932 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004933 status = psa_mac_update( &hkdf->hmac,
4934 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004935 if( status != PSA_SUCCESS )
4936 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004937 status = psa_mac_sign_finish( &hkdf->hmac,
4938 hkdf->prk,
4939 sizeof( hkdf->prk ),
4940 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004941 if( status != PSA_SUCCESS )
4942 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004943 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004944 hkdf->block_number = 0;
4945 hkdf->state = HKDF_STATE_KEYED;
4946 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004947 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004948 if( hkdf->state == HKDF_STATE_OUTPUT )
4949 return( PSA_ERROR_BAD_STATE );
4950 if( hkdf->info_set )
4951 return( PSA_ERROR_BAD_STATE );
4952 hkdf->info_length = data_length;
4953 if( data_length != 0 )
4954 {
4955 hkdf->info = mbedtls_calloc( 1, data_length );
4956 if( hkdf->info == NULL )
4957 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4958 memcpy( hkdf->info, data, data_length );
4959 }
4960 hkdf->info_set = 1;
4961 return( PSA_SUCCESS );
4962 default:
4963 return( PSA_ERROR_INVALID_ARGUMENT );
4964 }
4965}
John Durkop07cc04a2020-11-16 22:08:34 -08004966#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004967
John Durkop07cc04a2020-11-16 22:08:34 -08004968#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4969 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004970static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4971 const uint8_t *data,
4972 size_t data_length )
4973{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004974 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004975 return( PSA_ERROR_BAD_STATE );
4976
Janos Follathd6dce9f2019-07-04 09:11:38 +01004977 if( data_length != 0 )
4978 {
4979 prf->seed = mbedtls_calloc( 1, data_length );
4980 if( prf->seed == NULL )
4981 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004982
Janos Follathd6dce9f2019-07-04 09:11:38 +01004983 memcpy( prf->seed, data, data_length );
4984 prf->seed_length = data_length;
4985 }
Janos Follathf08e2652019-06-13 09:05:41 +01004986
Gilles Peskine43f958b2020-12-13 14:55:14 +01004987 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004988
4989 return( PSA_SUCCESS );
4990}
4991
Janos Follath81550542019-06-13 14:26:34 +01004992static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004993 const uint8_t *data,
4994 size_t data_length )
4995{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004996 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004997 return( PSA_ERROR_BAD_STATE );
4998
Steven Cooremana6df6042021-04-29 19:32:25 +02004999 if( data_length != 0 )
5000 {
5001 prf->secret = mbedtls_calloc( 1, data_length );
5002 if( prf->secret == NULL )
5003 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5004
5005 memcpy( prf->secret, data, data_length );
5006 prf->secret_length = data_length;
5007 }
Janos Follath81550542019-06-13 14:26:34 +01005008
Gilles Peskine43f958b2020-12-13 14:55:14 +01005009 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005010
5011 return( PSA_SUCCESS );
5012}
5013
Janos Follath63028dd2019-06-13 09:15:47 +01005014static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5015 const uint8_t *data,
5016 size_t data_length )
5017{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005018 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005019 return( PSA_ERROR_BAD_STATE );
5020
Janos Follathd6dce9f2019-07-04 09:11:38 +01005021 if( data_length != 0 )
5022 {
5023 prf->label = mbedtls_calloc( 1, data_length );
5024 if( prf->label == NULL )
5025 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005026
Janos Follathd6dce9f2019-07-04 09:11:38 +01005027 memcpy( prf->label, data, data_length );
5028 prf->label_length = data_length;
5029 }
Janos Follath63028dd2019-06-13 09:15:47 +01005030
Gilles Peskine43f958b2020-12-13 14:55:14 +01005031 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005032
5033 return( PSA_SUCCESS );
5034}
5035
Janos Follathb03233e2019-06-11 15:30:30 +01005036static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005037 psa_key_derivation_step_t step,
5038 const uint8_t *data,
5039 size_t data_length )
5040{
Janos Follathb03233e2019-06-11 15:30:30 +01005041 switch( step )
5042 {
Janos Follathf08e2652019-06-13 09:05:41 +01005043 case PSA_KEY_DERIVATION_INPUT_SEED:
5044 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005045 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005046 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005047 case PSA_KEY_DERIVATION_INPUT_LABEL:
5048 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005049 default:
5050 return( PSA_ERROR_INVALID_ARGUMENT );
5051 }
5052}
John Durkop07cc04a2020-11-16 22:08:34 -08005053#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5054 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5055
5056#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5057static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5058 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005059 const uint8_t *data,
5060 size_t data_length )
5061{
5062 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005063 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005064 uint8_t *cur = pms;
5065
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005066 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005067 return( PSA_ERROR_INVALID_ARGUMENT );
5068
5069 /* Quoting RFC 4279, Section 2:
5070 *
5071 * The premaster secret is formed as follows: if the PSK is N octets
5072 * long, concatenate a uint16 with the value N, N zero octets, a second
5073 * uint16 with the value N, and the PSK itself.
5074 */
5075
Joe Subbiani5ecac212021-06-24 13:00:03 +01005076 *cur++ = MBEDTLS_BYTE_1( data_length );
5077 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005078 memset( cur, 0, data_length );
5079 cur += data_length;
5080 *cur++ = pms[0];
5081 *cur++ = pms[1];
5082 memcpy( cur, data, data_length );
5083 cur += data_length;
5084
Steven Cooremana6df6042021-04-29 19:32:25 +02005085 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005086
5087 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5088 return( status );
5089}
Janos Follath6660f0e2019-06-17 08:44:03 +01005090
5091static psa_status_t psa_tls12_prf_psk_to_ms_input(
5092 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005093 psa_key_derivation_step_t step,
5094 const uint8_t *data,
5095 size_t data_length )
5096{
5097 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005098 {
Steven Cooremana6df6042021-04-29 19:32:25 +02005099 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005100 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005101 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005102
Steven Cooremana6df6042021-04-29 19:32:25 +02005103 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01005104}
John Durkop07cc04a2020-11-16 22:08:34 -08005105#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005106
Gilles Peskineb8965192019-09-24 16:21:10 +02005107/** Check whether the given key type is acceptable for the given
5108 * input step of a key derivation.
5109 *
5110 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5111 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5112 * Both secret and non-secret inputs can alternatively have the type
5113 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5114 * that the input was passed as a buffer rather than via a key object.
5115 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005116static int psa_key_derivation_check_input_type(
5117 psa_key_derivation_step_t step,
5118 psa_key_type_t key_type )
5119{
5120 switch( step )
5121 {
5122 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005123 if( key_type == PSA_KEY_TYPE_DERIVE )
5124 return( PSA_SUCCESS );
5125 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005126 return( PSA_SUCCESS );
5127 break;
5128 case PSA_KEY_DERIVATION_INPUT_LABEL:
5129 case PSA_KEY_DERIVATION_INPUT_SALT:
5130 case PSA_KEY_DERIVATION_INPUT_INFO:
5131 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005132 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5133 return( PSA_SUCCESS );
5134 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005135 return( PSA_SUCCESS );
5136 break;
5137 }
5138 return( PSA_ERROR_INVALID_ARGUMENT );
5139}
5140
Janos Follathb80a94e2019-06-12 15:54:46 +01005141static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005142 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005143 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005144 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005145 const uint8_t *data,
5146 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005147{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005148 psa_status_t status;
5149 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5150
5151 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005152 if( status != PSA_SUCCESS )
5153 goto exit;
5154
John Durkopd0321952020-10-29 21:37:36 -07005155#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005156 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005157 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005158 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005159 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005160 step, data, data_length );
5161 }
John Durkop07cc04a2020-11-16 22:08:34 -08005162 else
5163#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5164#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5165 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005166 {
Janos Follathb03233e2019-06-11 15:30:30 +01005167 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005168 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005169 }
John Durkop07cc04a2020-11-16 22:08:34 -08005170 else
5171#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5172#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5173 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005174 {
5175 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005176 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005177 }
5178 else
John Durkop07cc04a2020-11-16 22:08:34 -08005179#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005180 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005181 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005182 (void) data;
5183 (void) data_length;
5184 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005185 return( PSA_ERROR_BAD_STATE );
5186 }
5187
Gilles Peskine224b0d62019-09-23 18:13:17 +02005188exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005189 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005190 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005191 return( status );
5192}
5193
Janos Follath51f4a0f2019-06-14 11:35:55 +01005194psa_status_t psa_key_derivation_input_bytes(
5195 psa_key_derivation_operation_t *operation,
5196 psa_key_derivation_step_t step,
5197 const uint8_t *data,
5198 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005199{
Gilles Peskineb8965192019-09-24 16:21:10 +02005200 return( psa_key_derivation_input_internal( operation, step,
5201 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005202 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005203}
5204
Janos Follath51f4a0f2019-06-14 11:35:55 +01005205psa_status_t psa_key_derivation_input_key(
5206 psa_key_derivation_operation_t *operation,
5207 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005208 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005209{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005210 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005211 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005212 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005213
Ronald Cron5c522922020-11-14 16:35:34 +01005214 status = psa_get_and_lock_transparent_key_slot_with_policy(
5215 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005216 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005217 {
5218 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005220 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005221
5222 /* Passing a key object as a SECRET input unlocks the permission
5223 * to output to a key object. */
5224 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5225 operation->can_output_key = 1;
5226
Ronald Cronf95a2b12020-10-22 15:24:49 +02005227 status = psa_key_derivation_input_internal( operation,
5228 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005229 slot->key.data,
5230 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005231
Ronald Cron5c522922020-11-14 16:35:34 +01005232 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005233
Ronald Cron5c522922020-11-14 16:35:34 +01005234 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005235}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005236
5237
5238
5239/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005240/* Key agreement */
5241/****************************************************************/
5242
John Durkop6ba40d12020-11-10 08:50:04 -08005243#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005244static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5245 size_t peer_key_length,
5246 const mbedtls_ecp_keypair *our_key,
5247 uint8_t *shared_secret,
5248 size_t shared_secret_size,
5249 size_t *shared_secret_length )
5250{
Steven Cooremand4867872020-08-05 16:31:39 +02005251 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005252 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005253 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005254 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005255 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005256 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005257
Ronald Cron90857082020-11-25 14:58:33 +01005258 status = mbedtls_psa_ecp_load_representation(
5259 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005260 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005261 peer_key,
5262 peer_key_length,
5263 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005264 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005265 goto exit;
5266
Jaeden Amero97271b32019-01-10 19:38:51 +00005267 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005268 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005269 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005270 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005271 status = mbedtls_to_psa_error(
5272 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5273 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005274 goto exit;
5275
Jaeden Amero97271b32019-01-10 19:38:51 +00005276 status = mbedtls_to_psa_error(
5277 mbedtls_ecdh_calc_secret( &ecdh,
5278 shared_secret_length,
5279 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005280 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005281 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005282 if( status != PSA_SUCCESS )
5283 goto exit;
5284 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5285 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005286
5287exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005288 if( status != PSA_SUCCESS )
5289 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005290 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005291 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005292 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005293
Jaeden Amero97271b32019-01-10 19:38:51 +00005294 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005295}
John Durkop6ba40d12020-11-10 08:50:04 -08005296#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005297
Gilles Peskine01d718c2018-09-18 12:01:02 +02005298#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5299
Gilles Peskine0216fe12019-04-11 21:23:21 +02005300static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5301 psa_key_slot_t *private_key,
5302 const uint8_t *peer_key,
5303 size_t peer_key_length,
5304 uint8_t *shared_secret,
5305 size_t shared_secret_size,
5306 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005307{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005308 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005309 {
John Durkop6ba40d12020-11-10 08:50:04 -08005310#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005311 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005312 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005313 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005314 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005315 psa_status_t status = mbedtls_psa_ecp_load_representation(
5316 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005317 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005318 private_key->key.data,
5319 private_key->key.bytes,
5320 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005321 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005322 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005323 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005324 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005325 shared_secret, shared_secret_size,
5326 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005327 mbedtls_ecp_keypair_free( ecp );
5328 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005329 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005330#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005331 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005332 (void) private_key;
5333 (void) peer_key;
5334 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005335 (void) shared_secret;
5336 (void) shared_secret_size;
5337 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005338 return( PSA_ERROR_NOT_SUPPORTED );
5339 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005340}
5341
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005342/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005343 * to potentially free embedded data structures and wipe confidential data.
5344 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005345static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005346 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005347 psa_key_slot_t *private_key,
5348 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005349 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005350{
5351 psa_status_t status;
5352 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5353 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005354 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005355
5356 /* Step 1: run the secret agreement algorithm to generate the shared
5357 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005358 status = psa_key_agreement_raw_internal( ka_alg,
5359 private_key,
5360 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005361 shared_secret,
5362 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005363 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005364 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005365 goto exit;
5366
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005367 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005368 * the shared secret. A shared secret is permitted wherever a key
5369 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005370 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005371 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005372 shared_secret,
5373 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005374exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005375 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005376 return( status );
5377}
5378
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005379psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005380 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005381 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005382 const uint8_t *peer_key,
5383 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005384{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005385 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005386 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005387 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005388
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005389 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005390 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005391 status = psa_get_and_lock_transparent_key_slot_with_policy(
5392 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005393 if( status != PSA_SUCCESS )
5394 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005395 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005396 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005397 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005398 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005399 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005400 else
5401 {
5402 /* If a private key has been added as SECRET, we allow the derived
5403 * key material to be used as a key in PSA Crypto. */
5404 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5405 operation->can_output_key = 1;
5406 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005407
Ronald Cron5c522922020-11-14 16:35:34 +01005408 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005409
Ronald Cron5c522922020-11-14 16:35:34 +01005410 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005411}
5412
Gilles Peskinebe697d82019-05-16 18:00:41 +02005413psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005414 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005415 const uint8_t *peer_key,
5416 size_t peer_key_length,
5417 uint8_t *output,
5418 size_t output_size,
5419 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005420{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005421 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005422 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005423 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005424
5425 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5426 {
5427 status = PSA_ERROR_INVALID_ARGUMENT;
5428 goto exit;
5429 }
Ronald Cron5c522922020-11-14 16:35:34 +01005430 status = psa_get_and_lock_transparent_key_slot_with_policy(
5431 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005432 if( status != PSA_SUCCESS )
5433 goto exit;
5434
5435 status = psa_key_agreement_raw_internal( alg, slot,
5436 peer_key, peer_key_length,
5437 output, output_size,
5438 output_length );
5439
5440exit:
5441 if( status != PSA_SUCCESS )
5442 {
5443 /* If an error happens and is not handled properly, the output
5444 * may be used as a key to protect sensitive data. Arrange for such
5445 * a key to be random, which is likely to result in decryption or
5446 * verification errors. This is better than filling the buffer with
5447 * some constant data such as zeros, which would result in the data
5448 * being protected with a reproducible, easily knowable key.
5449 */
5450 psa_generate_random( output, output_size );
5451 *output_length = output_size;
5452 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005453
Ronald Cron5c522922020-11-14 16:35:34 +01005454 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005455
Ronald Cron5c522922020-11-14 16:35:34 +01005456 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005457}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005458
5459
Gilles Peskine30524eb2020-11-13 17:02:26 +01005460
Gilles Peskine86a440b2018-11-12 18:39:40 +01005461/****************************************************************/
5462/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005463/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005464
Gilles Peskine30524eb2020-11-13 17:02:26 +01005465/** Initialize the PSA random generator.
5466 */
5467static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5468{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005469#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5470 memset( rng, 0, sizeof( *rng ) );
5471#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5472
Gilles Peskine30524eb2020-11-13 17:02:26 +01005473 /* Set default configuration if
5474 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5475 if( rng->entropy_init == NULL )
5476 rng->entropy_init = mbedtls_entropy_init;
5477 if( rng->entropy_free == NULL )
5478 rng->entropy_free = mbedtls_entropy_free;
5479
5480 rng->entropy_init( &rng->entropy );
5481#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5482 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5483 /* The PSA entropy injection feature depends on using NV seed as an entropy
5484 * source. Add NV seed as an entropy source for PSA entropy injection. */
5485 mbedtls_entropy_add_source( &rng->entropy,
5486 mbedtls_nv_seed_poll, NULL,
5487 MBEDTLS_ENTROPY_BLOCK_SIZE,
5488 MBEDTLS_ENTROPY_SOURCE_STRONG );
5489#endif
5490
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005491 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005492#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005493}
5494
5495/** Deinitialize the PSA random generator.
5496 */
5497static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5498{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005499#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5500 memset( rng, 0, sizeof( *rng ) );
5501#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005502 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005503 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005504#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005505}
5506
5507/** Seed the PSA random generator.
5508 */
5509static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5510{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005511#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5512 /* Do nothing: the external RNG seeds itself. */
5513 (void) rng;
5514 return( PSA_SUCCESS );
5515#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005516 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005517 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5518 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005519 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005520#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005521}
5522
Gilles Peskinee59236f2018-01-27 23:32:46 +01005523psa_status_t psa_generate_random( uint8_t *output,
5524 size_t output_size )
5525{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005526 GUARD_MODULE_INITIALIZED;
5527
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005528#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5529
5530 size_t output_length = 0;
5531 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5532 output, output_size,
5533 &output_length );
5534 if( status != PSA_SUCCESS )
5535 return( status );
5536 /* Breaking up a request into smaller chunks is currently not supported
5537 * for the extrernal RNG interface. */
5538 if( output_length != output_size )
5539 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5540 return( PSA_SUCCESS );
5541
5542#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5543
Gilles Peskine71ddab92021-01-04 21:01:07 +01005544 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005545 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005546 size_t request_size =
5547 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5548 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5549 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005550 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5551 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005552 if( ret != 0 )
5553 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005554 output_size -= request_size;
5555 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005556 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005557 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005558#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005559}
5560
Gilles Peskine8814fc42020-12-14 15:33:44 +01005561/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005562 *
5563 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5564 * `psa_generate_random(...)`. The state parameter is ignored since the
5565 * PSA API doesn't support passing an explicit state.
5566 *
5567 * In the non-external case, psa_generate_random() calls an
5568 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5569 * and semantics as mbedtls_psa_get_random(). As an optimization,
5570 * instead of doing this back-and-forth between the PSA API and the
5571 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5572 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005573 */
5574#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5575int mbedtls_psa_get_random( void *p_rng,
5576 unsigned char *output,
5577 size_t output_size )
5578{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005579 /* This function takes a pointer to the RNG state because that's what
5580 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5581 * its own state internally and doesn't let the caller access that state.
5582 * So we just ignore the state parameter, and in practice we'll pass
5583 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005584 (void) p_rng;
5585 psa_status_t status = psa_generate_random( output, output_size );
5586 if( status == PSA_SUCCESS )
5587 return( 0 );
5588 else
5589 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5590}
5591#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5592
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005593#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005594#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005595
Gilles Peskine7228da22019-07-15 11:06:15 +02005596psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005597 size_t seed_size )
5598{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005599 if( global_data.initialized )
5600 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005601
5602 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5603 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5604 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5605 return( PSA_ERROR_INVALID_ARGUMENT );
5606
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005607 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005608}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005609#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005610
Ronald Cron3772afe2021-02-08 16:10:05 +01005611/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005612 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005613 * \param type The key type
5614 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005615 *
5616 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005617 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005618 * \retval #PSA_ERROR_INVALID_ARGUMENT
5619 * The size in bits of the key is not valid.
5620 * \retval #PSA_ERROR_NOT_SUPPORTED
5621 * The type and/or the size in bits of the key or the combination of
5622 * the two is not supported.
5623 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005624static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5625 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005626{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005628
Gilles Peskinee59236f2018-01-27 23:32:46 +01005629 if( key_type_is_raw_bytes( type ) )
5630 {
Archana4d7ae1d2021-07-07 02:50:22 +05305631 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005632 if( status != PSA_SUCCESS )
5633 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005634 }
5635 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005636#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005637 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5638 {
5639 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5640 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005641
Ronald Cron01b2aba2020-10-05 09:42:02 +02005642 /* Accept only byte-aligned keys, for the same reasons as
5643 * in psa_import_rsa_key(). */
5644 if( bits % 8 != 0 )
5645 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005646 }
5647 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005648#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005649
Ronald Cron5c4d3862020-12-07 11:07:24 +01005650#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005651 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5652 {
Ronald Crond81ab562021-02-16 09:01:16 +01005653 /* To avoid empty block, return successfully here. */
5654 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005655 }
5656 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005657#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005658 {
5659 return( PSA_ERROR_NOT_SUPPORTED );
5660 }
5661
5662 return( PSA_SUCCESS );
5663}
5664
Ronald Cron55ed0592020-10-05 10:30:40 +02005665psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005666 const psa_key_attributes_t *attributes,
5667 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005668{
5669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005670 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005671
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005672 if( ( attributes->domain_parameters == NULL ) &&
5673 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005674 return( PSA_ERROR_INVALID_ARGUMENT );
5675
Ronald Cron01b2aba2020-10-05 09:42:02 +02005676 if( key_type_is_raw_bytes( type ) )
5677 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005678 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005679 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005680 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005681
David Brown12ca5032021-02-11 11:02:00 -07005682#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005683 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005684 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005685#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005686 }
5687 else
5688
Jaeden Amero424fa932021-05-14 08:34:32 +01005689#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5690 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005691 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005692 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005693 return( mbedtls_psa_rsa_generate_key( attributes,
5694 key_buffer,
5695 key_buffer_size,
5696 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005697 }
5698 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005699#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5700 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005701
John Durkop9814fa22020-11-04 12:28:15 -08005702#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005703 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005704 {
Ronald Cron7023db52020-11-20 18:17:42 +01005705 return( mbedtls_psa_ecp_generate_key( attributes,
5706 key_buffer,
5707 key_buffer_size,
5708 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005709 }
5710 else
John Durkop9814fa22020-11-04 12:28:15 -08005711#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005712 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005713 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005714 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005715 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005716
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005717 return( PSA_SUCCESS );
5718}
Darryl Green0c6575a2018-11-07 16:05:30 +00005719
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005720psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005721 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005722{
5723 psa_status_t status;
5724 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005725 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005726 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005727
Ronald Cron81709fc2020-11-14 12:10:32 +01005728 *key = MBEDTLS_SVC_KEY_ID_INIT;
5729
Gilles Peskine0f84d622019-09-12 19:03:13 +02005730 /* Reject any attempt to create a zero-length key so that we don't
5731 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5732 if( psa_get_key_bits( attributes ) == 0 )
5733 return( PSA_ERROR_INVALID_ARGUMENT );
5734
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02005735 /* Reject any attempt to create a public key. */
5736 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5737 return( PSA_ERROR_INVALID_ARGUMENT );
5738
Ronald Cron81709fc2020-11-14 12:10:32 +01005739 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5740 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005741 if( status != PSA_SUCCESS )
5742 goto exit;
5743
Ronald Cron977c2472020-10-13 08:32:21 +02005744 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305745 * storage ( thus not in the case of generating a key in a secure element
5746 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5747 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005748 if( slot->key.data == NULL )
5749 {
5750 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5751 PSA_KEY_LOCATION_LOCAL_STORAGE )
5752 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005753 status = psa_validate_key_type_and_size_for_key_generation(
5754 attributes->core.type, attributes->core.bits );
5755 if( status != PSA_SUCCESS )
5756 goto exit;
5757
5758 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5759 attributes->core.type,
5760 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005761 }
5762 else
5763 {
5764 status = psa_driver_wrapper_get_key_buffer_size(
5765 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005766 if( status != PSA_SUCCESS )
5767 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005768 }
Ronald Cron977c2472020-10-13 08:32:21 +02005769
5770 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5771 if( status != PSA_SUCCESS )
5772 goto exit;
5773 }
5774
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005775 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005776 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005777
Ronald Cron2b56bc82020-10-05 10:02:26 +02005778 if( status != PSA_SUCCESS )
5779 psa_remove_key_data_from_memory( slot );
5780
Gilles Peskine11792082019-08-06 18:36:36 +02005781exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005782 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005783 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005784 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005785 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005786
Darryl Green0c6575a2018-11-07 16:05:30 +00005787 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005788}
5789
Gilles Peskinee59236f2018-01-27 23:32:46 +01005790/****************************************************************/
5791/* Module setup */
5792/****************************************************************/
5793
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005794#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005795psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5796 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5797 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5798{
5799 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5800 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005801 global_data.rng.entropy_init = entropy_init;
5802 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005803 return( PSA_SUCCESS );
5804}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005805#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005806
Gilles Peskinee59236f2018-01-27 23:32:46 +01005807void mbedtls_psa_crypto_free( void )
5808{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005809 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005810 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5811 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005812 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005813 }
5814 /* Wipe all remaining data, including configuration.
5815 * In particular, this sets all state indicator to the value
5816 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005817 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Ronald Cron9ba76912021-04-10 16:57:30 +02005818
5819 /* Terminate drivers */
5820 psa_driver_wrapper_free( );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005821}
5822
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005823#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5824/** Recover a transaction that was interrupted by a power failure.
5825 *
5826 * This function is called during initialization, before psa_crypto_init()
5827 * returns. If this function returns a failure status, the initialization
5828 * fails.
5829 */
5830static psa_status_t psa_crypto_recover_transaction(
5831 const psa_crypto_transaction_t *transaction )
5832{
5833 switch( transaction->unknown.type )
5834 {
5835 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5836 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005837 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005838 * is implemented.
5839 * https://github.com/ARMmbed/mbed-crypto/issues/218
5840 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005841 default:
5842 /* We found an unsupported transaction in the storage.
5843 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005844 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005845 }
5846}
5847#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5848
Gilles Peskinee59236f2018-01-27 23:32:46 +01005849psa_status_t psa_crypto_init( void )
5850{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005851 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005852
Gilles Peskinec6b69072018-11-20 21:42:52 +01005853 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005854 if( global_data.initialized != 0 )
5855 return( PSA_SUCCESS );
5856
Gilles Peskine30524eb2020-11-13 17:02:26 +01005857 /* Initialize and seed the random generator. */
5858 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005859 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005860 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005861 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005862 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005863 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005864
Gilles Peskine66fb1262018-12-10 16:29:04 +01005865 status = psa_initialize_key_slots( );
5866 if( status != PSA_SUCCESS )
5867 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005868
Ronald Cron9ba76912021-04-10 16:57:30 +02005869 /* Init drivers */
5870 status = psa_driver_wrapper_init( );
Gilles Peskined9348f22019-10-01 15:22:29 +02005871 if( status != PSA_SUCCESS )
5872 goto exit;
Gilles Peskined9348f22019-10-01 15:22:29 +02005873
Gilles Peskine4b734222019-07-24 15:56:31 +02005874#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005875 status = psa_crypto_load_transaction( );
5876 if( status == PSA_SUCCESS )
5877 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005878 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5879 if( status != PSA_SUCCESS )
5880 goto exit;
5881 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005882 }
5883 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5884 {
5885 /* There's no transaction to complete. It's all good. */
5886 status = PSA_SUCCESS;
5887 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005888#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005889
Gilles Peskinec6b69072018-11-20 21:42:52 +01005890 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005891 global_data.initialized = 1;
5892
5893exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005894 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005895 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005896 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005897}
5898
5899#endif /* MBEDTLS_PSA_CRYPTO_C */