blob: 7591b6bb1acef495141e4a418a24de630527fac8 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020060#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000061#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020062#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020064#include "mbedtls/chacha20.h"
65#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010066#include "mbedtls/cipher.h"
67#include "mbedtls/ccm.h"
68#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020070#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010071#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010072#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010073#include "mbedtls/error.h"
74#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010076#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000077#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000079#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010080#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000081#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010082#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010084#include "mbedtls/sha1.h"
85#include "mbedtls/sha256.h"
86#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087
Gilles Peskine996deb12018-08-01 15:45:45 +020088#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
89
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010090/****************************************************************/
91/* Global data, support functions and library management */
92/****************************************************************/
93
Gilles Peskine48c0ea12018-06-21 14:15:31 +020094static int key_type_is_raw_bytes( psa_key_type_t type )
95{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020096 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020097}
98
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010099/* Values for psa_global_data_t::rng_state */
100#define RNG_NOT_INITIALIZED 0
101#define RNG_INITIALIZED 1
102#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100103
Gilles Peskine2d277862018-06-18 15:41:12 +0200104typedef struct
105{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100106 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100109} psa_global_data_t;
110
111static psa_global_data_t global_data;
112
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100113#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
114mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
115 &global_data.rng.drbg;
116#endif
117
itayzafrir0adf0fc2018-09-06 16:24:41 +0300118#define GUARD_MODULE_INITIALIZED \
119 if( global_data.initialized == 0 ) \
120 return( PSA_ERROR_BAD_STATE );
121
Steven Cooreman01164162020-07-20 15:31:37 +0200122psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100123{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100124 /* Mbed TLS error codes can combine a high-level error code and a
125 * low-level error code. The low-level error usually reflects the
126 * root cause better, so dispatch on that preferably. */
127 int low_level_ret = - ( -ret & 0x007f );
128 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129 {
130 case 0:
131 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100132
133 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
134 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100135 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200136 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
137 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
138 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
139 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
140 case MBEDTLS_ERR_ASN1_INVALID_DATA:
141 return( PSA_ERROR_INVALID_ARGUMENT );
142 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
143 return( PSA_ERROR_INSUFFICIENT_MEMORY );
144 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
145 return( PSA_ERROR_BUFFER_TOO_SMALL );
146
Jaeden Amero93e21112019-02-20 13:57:28 +0000147#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000148 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000149#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100150 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
151 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_CCM_BAD_INPUT:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_CCM_AUTH_FAILED:
156 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100157
Gilles Peskine26869f22019-05-06 15:25:00 +0200158 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
159 return( PSA_ERROR_INVALID_ARGUMENT );
160
161 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
162 return( PSA_ERROR_BAD_STATE );
163 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
164 return( PSA_ERROR_INVALID_SIGNATURE );
165
Gilles Peskinea5905292018-02-07 20:59:33 +0100166 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
167 return( PSA_ERROR_NOT_SUPPORTED );
168 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
169 return( PSA_ERROR_INVALID_ARGUMENT );
170 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
171 return( PSA_ERROR_INSUFFICIENT_MEMORY );
172 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
173 return( PSA_ERROR_INVALID_PADDING );
174 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200175 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
177 return( PSA_ERROR_INVALID_SIGNATURE );
178 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200179 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100180
Gilles Peskine82e57d12020-11-13 21:31:17 +0100181#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
182 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100183 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
184 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
186 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
187 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
188 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
189 return( PSA_ERROR_NOT_SUPPORTED );
190 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
191 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100192#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100193
194 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
195 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100196
Gilles Peskinee59236f2018-01-27 23:32:46 +0100197 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
198 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
199 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100201
202 case MBEDTLS_ERR_GCM_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200204 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
205 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200207 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208
Gilles Peskine82e57d12020-11-13 21:31:17 +0100209#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
210 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100211 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
212 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100213 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
214 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
215 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
216 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
217 return( PSA_ERROR_NOT_SUPPORTED );
218 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220#endif
221
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
223 return( PSA_ERROR_NOT_SUPPORTED );
224 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
225 return( PSA_ERROR_INVALID_ARGUMENT );
226 case MBEDTLS_ERR_MD_ALLOC_FAILED:
227 return( PSA_ERROR_INSUFFICIENT_MEMORY );
228 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
229 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100230
Gilles Peskinef76aa772018-10-29 19:24:33 +0100231 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
232 return( PSA_ERROR_STORAGE_FAILURE );
233 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
234 return( PSA_ERROR_INVALID_ARGUMENT );
235 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
236 return( PSA_ERROR_INVALID_ARGUMENT );
237 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
238 return( PSA_ERROR_BUFFER_TOO_SMALL );
239 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
240 return( PSA_ERROR_INVALID_ARGUMENT );
241 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
242 return( PSA_ERROR_INVALID_ARGUMENT );
243 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
244 return( PSA_ERROR_INVALID_ARGUMENT );
245 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
246 return( PSA_ERROR_INSUFFICIENT_MEMORY );
247
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100248 case MBEDTLS_ERR_PK_ALLOC_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_MEMORY );
250 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
251 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
252 return( PSA_ERROR_INVALID_ARGUMENT );
253 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100254 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100255 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
256 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
257 return( PSA_ERROR_INVALID_ARGUMENT );
258 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
259 return( PSA_ERROR_NOT_SUPPORTED );
260 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
261 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
262 return( PSA_ERROR_NOT_PERMITTED );
263 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_PK_INVALID_ALG:
266 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
267 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
268 return( PSA_ERROR_NOT_SUPPORTED );
269 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
270 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200271 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
272 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100273
Gilles Peskineff2d2002019-05-06 15:26:23 +0200274 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
275 return( PSA_ERROR_HARDWARE_FAILURE );
276 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
277 return( PSA_ERROR_NOT_SUPPORTED );
278
Gilles Peskinea5905292018-02-07 20:59:33 +0100279 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
280 return( PSA_ERROR_INVALID_ARGUMENT );
281 case MBEDTLS_ERR_RSA_INVALID_PADDING:
282 return( PSA_ERROR_INVALID_PADDING );
283 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
284 return( PSA_ERROR_HARDWARE_FAILURE );
285 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
286 return( PSA_ERROR_INVALID_ARGUMENT );
287 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
288 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200289 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100290 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
291 return( PSA_ERROR_INVALID_SIGNATURE );
292 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
293 return( PSA_ERROR_BUFFER_TOO_SMALL );
294 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100295 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200296
itayzafrir5c753392018-05-08 11:18:38 +0300297 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300298 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300299 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300300 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
301 return( PSA_ERROR_BUFFER_TOO_SMALL );
302 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
303 return( PSA_ERROR_NOT_SUPPORTED );
304 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
305 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
306 return( PSA_ERROR_INVALID_SIGNATURE );
307 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
308 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100309 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
310 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100311
Janos Follatha13b9052019-11-22 12:48:59 +0000312 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
313 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300314
Gilles Peskinee59236f2018-01-27 23:32:46 +0100315 default:
David Saadab4ecc272019-02-14 13:48:10 +0200316 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100317 }
318}
319
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200320
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200321
322
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100323/****************************************************************/
324/* Key management */
325/****************************************************************/
326
John Durkop07cc04a2020-11-16 22:08:34 -0800327/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
328 * current test driver in key_management.c is using this function
329 * when accelerators are used for ECC key pair and public key.
330 * Once that dependency is resolved these guards can be removed.
331 */
John Durkop9814fa22020-11-04 12:28:15 -0800332#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800333 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
334 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
335 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100336mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100337 size_t bits,
338 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200339{
340 switch( curve )
341 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100342 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100343 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100344 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100345#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100346 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100347 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100348#endif
349#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100350 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100351 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100352#endif
353#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100354 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100355 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100356#endif
357#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100358 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100359 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100360#endif
361#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100363 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100364 case 528:
365 if( bits_is_sloppy )
366 return( MBEDTLS_ECP_DP_SECP521R1 );
367 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100368#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 }
370 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100371
Paul Elliott8ff510a2020-06-02 17:19:28 +0100372 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100373 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100375#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100382#endif
383#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100384 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100386#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 }
388 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100389
Paul Elliott8ff510a2020-06-02 17:19:28 +0100390 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100393#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 case 256:
397 if( bits_is_sloppy )
398 return( MBEDTLS_ECP_DP_CURVE25519 );
399 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
401#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100402 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100404#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 }
406 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100407
Paul Elliott8ff510a2020-06-02 17:19:28 +0100408 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 }
424 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200425 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100427 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200429}
John Durkop9814fa22020-11-04 12:28:15 -0800430#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800431 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
432 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
433 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200434
Archana4d7ae1d2021-07-07 02:50:22 +0530435psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530436 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200437{
438 /* Check that the bit size is acceptable for the key type */
439 switch( type )
440 {
441 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200442 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200443 case PSA_KEY_TYPE_DERIVE:
444 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100445#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446 case PSA_KEY_TYPE_AES:
447 if( bits != 128 && bits != 192 && bits != 256 )
448 return( PSA_ERROR_INVALID_ARGUMENT );
449 break;
450#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200451#if defined(PSA_WANT_KEY_TYPE_ARIA)
452 case PSA_KEY_TYPE_ARIA:
453 if( bits != 128 && bits != 192 && bits != 256 )
454 return( PSA_ERROR_INVALID_ARGUMENT );
455 break;
456#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100457#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200458 case PSA_KEY_TYPE_CAMELLIA:
459 if( bits != 128 && bits != 192 && bits != 256 )
460 return( PSA_ERROR_INVALID_ARGUMENT );
461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_DES:
465 if( bits != 64 && bits != 128 && bits != 192 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200470 case PSA_KEY_TYPE_CHACHA20:
471 if( bits != 256 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 default:
476 return( PSA_ERROR_NOT_SUPPORTED );
477 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200478 if( bits % 8 != 0 )
479 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200481 return( PSA_SUCCESS );
482}
483
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100484/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100485 *
Steven Cooremancd640932021-03-08 12:00:27 +0100486 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
487 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 *
489 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 * \param[in] key_type The key type of the key to be used with the
491 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100492 *
493 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100497 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100499 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100500 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501{
Steven Cooremancd640932021-03-08 12:00:27 +0100502 if( PSA_ALG_IS_HMAC( algorithm ) )
503 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 if( key_type == PSA_KEY_TYPE_HMAC )
505 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100506 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100507
508 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100509 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100510 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
511 * key. */
512 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
513 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
514 {
515 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
516 * the block length (larger than 1) for block ciphers. */
517 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
518 return( PSA_SUCCESS );
519 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100520 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100521
522 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100523}
524
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200525psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
526 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200527{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100528 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200529 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200530
Ronald Cronea0f8a62020-11-25 17:52:23 +0100531 slot->key.data = mbedtls_calloc( 1, buffer_length );
532 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200533 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200534
Ronald Cronea0f8a62020-11-25 17:52:23 +0100535 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200536 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200537}
538
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200539psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
540 const uint8_t* data,
541 size_t data_length )
542{
543 psa_status_t status = psa_allocate_buffer_to_slot( slot,
544 data_length );
545 if( status != PSA_SUCCESS )
546 return( status );
547
Ronald Cronea0f8a62020-11-25 17:52:23 +0100548 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200549 return( PSA_SUCCESS );
550}
551
Ronald Crona0fe59f2020-11-29 11:14:53 +0100552psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100553 const psa_key_attributes_t *attributes,
554 const uint8_t *data, size_t data_length,
555 uint8_t *key_buffer, size_t key_buffer_size,
556 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100557{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100558 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
559 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100560
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200561 /* zero-length keys are never supported. */
562 if( data_length == 0 )
563 return( PSA_ERROR_NOT_SUPPORTED );
564
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100566 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100567 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200568
Archana449608b2021-09-08 15:36:05 +0530569 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
570 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200571 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200572 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573
Ronald Crondd04d422020-11-28 15:14:42 +0100574 /* Copy the key material. */
575 memcpy( key_buffer, data, data_length );
576 *key_buffer_length = data_length;
577 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200578
Steven Cooreman40120f62020-10-29 11:42:22 +0100579 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100580 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100581 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200582 {
John Durkop9814fa22020-11-04 12:28:15 -0800583#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
584 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200586 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100587 return( mbedtls_psa_ecp_import_key( attributes,
588 data, data_length,
589 key_buffer, key_buffer_size,
590 key_buffer_length,
591 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100592 }
John Durkop9814fa22020-11-04 12:28:15 -0800593#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
594 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700595#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
596 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200598 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 return( mbedtls_psa_rsa_import_key( attributes,
600 data, data_length,
601 key_buffer, key_buffer_size,
602 key_buffer_length,
603 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200604 }
John Durkop9814fa22020-11-04 12:28:15 -0800605#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
606 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100608
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100609 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100610}
611
Gilles Peskinef603c712019-01-19 13:40:11 +0100612/** Calculate the intersection of two algorithm usage policies.
613 *
614 * Return 0 (which allows no operation) on incompatibility.
615 */
616static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100617 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100618 psa_algorithm_t alg1,
619 psa_algorithm_t alg2 )
620{
Gilles Peskine549ea862019-05-22 11:45:59 +0200621 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100622 if( alg1 == alg2 )
623 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100624 /* If the policies are from the same hash-and-sign family, check
625 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200626 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
627 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100628 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100629 {
Steven Cooreman03488022021-02-18 12:07:20 +0100630 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
631 return( alg2 );
632 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
633 return( alg1 );
634 }
635 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100636 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100637 * restrictive tag length. */
638 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
639 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
640 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
641 {
642 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
643 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100644 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100645
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100646 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100647 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
648 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100649 {
Steven Cooremancd640932021-03-08 12:00:27 +0100650 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
651 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100652 }
653 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100654 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100655 ( alg1_len <= alg2_len ) )
656 {
657 return( alg2 );
658 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100659 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100660 ( alg2_len <= alg1_len ) )
661 {
662 return( alg1 );
663 }
664 }
665 /* If the policies are from the same MAC family, check whether one
666 * of them is a minimum-MAC-length policy. Calculate the most
667 * restrictive tag length. */
668 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
669 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
670 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
671 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100672 /* Validate the combination of key type and algorithm. Since the base
673 * algorithm of alg1 and alg2 are the same, we only need this once. */
674 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100675 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100676
Steven Cooreman31a876d2021-03-03 20:47:40 +0100677 /* Get the (exact or at-least) output lengths for both sides of the
678 * requested intersection. None of the currently supported algorithms
679 * have an output length dependent on the actual key size, so setting it
680 * to a bogus value of 0 is currently OK.
681 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100682 * Note that for at-least-this-length wildcard algorithms, the output
683 * length is set to the shortest allowed length, which allows us to
684 * calculate the most restrictive tag length for the intersection. */
685 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
686 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100687 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100688
Steven Cooremana1d83222021-02-25 10:20:29 +0100689 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100690 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
691 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100692 {
Steven Cooremancd640932021-03-08 12:00:27 +0100693 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100694 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100695
696 /* If only one is an at-least-this-length policy, the intersection would
697 * be the other (fixed-length) policy as long as said fixed length is
698 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100700 {
Steven Cooremancd640932021-03-08 12:00:27 +0100701 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100702 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100703 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100704 {
Steven Cooremancd640932021-03-08 12:00:27 +0100705 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100706 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100707
Steven Cooremancd640932021-03-08 12:00:27 +0100708 /* If none of them are wildcards, check whether they define the same tag
709 * length. This is still possible here when one is default-length and
710 * the other specific-length. Ensure to always return the
711 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100712 if( alg1_len == alg2_len )
713 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100714 }
715 /* If the policies are incompatible, allow nothing. */
716 return( 0 );
717}
718
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100719static int psa_key_algorithm_permits( psa_key_type_t key_type,
720 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200721 psa_algorithm_t requested_alg )
722{
Gilles Peskine549ea862019-05-22 11:45:59 +0200723 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200724 if( requested_alg == policy_alg )
725 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100726 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
727 * and requested_alg is the same hash-and-sign family with any hash,
728 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200729 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100730 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200731 {
Steven Cooreman03488022021-02-18 12:07:20 +0100732 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
733 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
734 }
735 /* If policy_alg is a wildcard AEAD algorithm of the same base as
736 * the requested algorithm, check the requested tag length to be
737 * equal-length or longer than the wildcard-specified length. */
738 if( PSA_ALG_IS_AEAD( policy_alg ) &&
739 PSA_ALG_IS_AEAD( requested_alg ) &&
740 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
741 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100742 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100743 {
744 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
745 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
746 }
Steven Cooremancd640932021-03-08 12:00:27 +0100747 /* If policy_alg is a MAC algorithm of the same base as the requested
748 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100749 if( PSA_ALG_IS_MAC( policy_alg ) &&
750 PSA_ALG_IS_MAC( requested_alg ) &&
751 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100752 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100753 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100754 /* Validate the combination of key type and algorithm. Since the policy
755 * and requested algorithms are the same, we only need this once. */
756 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100757 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100758
Steven Cooreman31a876d2021-03-03 20:47:40 +0100759 /* Get both the requested output length for the algorithm which is to be
760 * verified, and the default output length for the base algorithm.
761 * Note that none of the currently supported algorithms have an output
762 * length dependent on actual key size, so setting it to a bogus value
763 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764 size_t requested_output_length = PSA_MAC_LENGTH(
765 key_type, 0, requested_alg );
766 size_t default_output_length = PSA_MAC_LENGTH(
767 key_type, 0,
768 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100769
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100770 /* If the policy is default-length, only allow an algorithm with
771 * a declared exact-length matching the default. */
772 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100774
775 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100776 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
778 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
779 {
780 return( 1 );
781 }
782
Steven Cooremancd640932021-03-08 12:00:27 +0100783 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
784 * check for the requested MAC length to be equal to or longer than the
785 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100786 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
787 {
788 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100789 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200791 }
Steven Cooremance48e852020-10-05 16:02:45 +0200792 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200793 * a key derivation with that key agreement should also be allowed. This
794 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200795 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
796 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
797 {
798 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
799 policy_alg );
800 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100801 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200802 return( 0 );
803}
804
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100805/** Test whether a policy permits an algorithm.
806 *
807 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100808 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100809 * \note This function requires providing the key type for which the policy is
810 * being validated, since some algorithm policy definitions (e.g. MAC)
811 * have different properties depending on what kind of cipher it is
812 * combined with.
813 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 * \retval PSA_SUCCESS When \p alg is a specific algorithm
815 * allowed by the \p policy.
816 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
817 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
818 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100819 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100821 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100822 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823{
Steven Cooremand788fab2021-02-25 11:29:17 +0100824 /* '0' is not a valid algorithm */
825 if( alg == 0 )
826 return( PSA_ERROR_INVALID_ARGUMENT );
827
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828 /* A requested algorithm cannot be a wildcard. */
829 if( PSA_ALG_IS_WILDCARD( alg ) )
830 return( PSA_ERROR_INVALID_ARGUMENT );
831
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100832 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
833 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 return( PSA_SUCCESS );
835 else
836 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837}
838
Gilles Peskinef603c712019-01-19 13:40:11 +0100839/** Restrict a key policy based on a constraint.
840 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100841 * \note This function requires providing the key type for which the policy is
842 * being restricted, since some algorithm policy definitions (e.g. MAC)
843 * have different properties depending on what kind of cipher it is
844 * combined with.
845 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100846 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100847 * \param[in,out] policy The policy to restrict.
848 * \param[in] constraint The policy constraint to apply.
849 *
850 * \retval #PSA_SUCCESS
851 * \c *policy contains the intersection of the original value of
852 * \c *policy and \c *constraint.
853 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100854 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100855 * \c *policy is unchanged.
856 */
857static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100858 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100859 psa_key_policy_t *policy,
860 const psa_key_policy_t *constraint )
861{
862 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100863 psa_key_policy_algorithm_intersection( key_type, policy->alg,
864 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200865 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100866 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
867 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200870 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
871 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100872 policy->usage &= constraint->usage;
873 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200874 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100875 return( PSA_SUCCESS );
876}
877
Ronald Cron5c522922020-11-14 16:35:34 +0100878/** Get the description of a key given its identifier and policy constraints
879 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200880 *
Ronald Cron5c522922020-11-14 16:35:34 +0100881 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100882 * nonzero, the key must allow operations with this algorithm. If \p alg is
883 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100884 *
Ronald Cron5c522922020-11-14 16:35:34 +0100885 * In case of a persistent key, the function loads the description of the key
886 * into a key slot if not already done.
887 *
888 * On success, the returned key slot is locked. It is the responsibility of
889 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200890 */
Ronald Cron5c522922020-11-14 16:35:34 +0100891static psa_status_t psa_get_and_lock_key_slot_with_policy(
892 mbedtls_svc_key_id_t key,
893 psa_key_slot_t **p_slot,
894 psa_key_usage_t usage,
895 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100896{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200897 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
898 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100899
Ronald Cron5c522922020-11-14 16:35:34 +0100900 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100901 if( status != PSA_SUCCESS )
902 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100904
905 /* Enforce that usage policy for the key slot contains all the flags
906 * required by the usage parameter. There is one exception: public
907 * keys can always be exported, so we treat public key objects as
908 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200909 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100910 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200911
Gilles Peskine8e338702019-07-30 20:06:31 +0200912 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100913 {
914 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200915 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100916 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100917
918 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100919 if( alg != 0 )
920 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100921 status = psa_key_policy_permits( &slot->attr.policy,
922 slot->attr.type,
923 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100924 if( status != PSA_SUCCESS )
925 goto error;
926 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100927
Darryl Green06fd18d2018-07-16 11:21:11 +0100928 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929
930error:
931 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100932 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200933
934 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100935}
Darryl Green940d72c2018-07-13 13:18:51 +0100936
Ronald Cron5c522922020-11-14 16:35:34 +0100937/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200938 *
939 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200940 * available, as opposed to a key in a secure element and/or to be used
941 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200942 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200943 * This is a temporary function that may be used instead of
944 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
945 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200946 *
Ronald Cron5c522922020-11-14 16:35:34 +0100947 * On success, the returned key slot is locked. It is the responsibility of the
948 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200949 */
Ronald Cron5c522922020-11-14 16:35:34 +0100950static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
951 mbedtls_svc_key_id_t key,
952 psa_key_slot_t **p_slot,
953 psa_key_usage_t usage,
954 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955{
Ronald Cron5c522922020-11-14 16:35:34 +0100956 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
957 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200958 if( status != PSA_SUCCESS )
959 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Ronald Cronddae0f52021-08-24 15:39:44 +0200961 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 {
Ronald Cron5c522922020-11-14 16:35:34 +0100963 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 *p_slot = NULL;
965 return( PSA_ERROR_NOT_SUPPORTED );
966 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 return( PSA_SUCCESS );
969}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200970
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200971psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000972{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100973 /* Data pointer will always be either a valid pointer or NULL in an
974 * initialized slot, so we can just free it. */
975 if( slot->key.data != NULL )
976 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
977
978 mbedtls_free( slot->key.data );
979 slot->key.data = NULL;
980 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000981
982 return( PSA_SUCCESS );
983}
984
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100985/** Completely wipe a slot in memory, including its policy.
986 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100987psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100988{
989 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100990
TRodziewicz18cddc02021-07-13 12:19:15 +0200991 /*
992 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200993 * do our best to report an unexpected lock counter. Assert with
994 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
995 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
996 * function is called as part of the execution of a test suite, the
997 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200998 */
Ronald Cron5c522922020-11-14 16:35:34 +0100999 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001001 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001002 status = PSA_ERROR_CORRUPTION_DETECTED;
1003 }
1004
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001005 /* Multipart operations may still be using the key. This is safe
1006 * because all multipart operation objects are independent from
1007 * the key slot: if they need to access the key after the setup
1008 * phase, they have a copy of the key. Note that this means that
1009 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001010 /* At this point, key material and other type-specific content has
1011 * been wiped. Clear remaining metadata. We can call memset and not
1012 * zeroize because the metadata is not particularly sensitive. */
1013 memset( slot, 0, sizeof( *slot ) );
1014 return( status );
1015}
1016
Ronald Croncf56a0a2020-08-04 09:51:30 +02001017psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Ronald Croncf56a0a2020-08-04 09:51:30 +02001026 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001027 return( PSA_SUCCESS );
1028
Ronald Cronf2911112020-10-29 17:51:10 +01001029 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001030 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001031 * key, this will load the key description from persistent memory if not
1032 * done yet. We cannot avoid this loading as without it we don't know if
1033 * the key is operated by an SE or not and this information is needed by
1034 * the current implementation.
1035 */
Ronald Cron5c522922020-11-14 16:35:34 +01001036 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001037 if( status != PSA_SUCCESS )
1038 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001039
Ronald Cronf2911112020-10-29 17:51:10 +01001040 /*
1041 * If the key slot containing the key description is under access by the
1042 * library (apart from the present access), the key cannot be destroyed
1043 * yet. For the time being, just return in error. Eventually (to be
1044 * implemented), the key should be destroyed when all accesses have
1045 * stopped.
1046 */
Ronald Cron5c522922020-11-14 16:35:34 +01001047 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001048 {
Ronald Cron5c522922020-11-14 16:35:34 +01001049 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001050 return( PSA_ERROR_GENERIC_ERROR );
1051 }
1052
Gilles Peskine6687cd02021-04-21 22:32:05 +02001053 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1054 {
1055 /* Refuse the destruction of a read-only key (which may or may not work
1056 * if we attempt it, depending on whether the key is merely read-only
1057 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001058 * Just do the best we can, which is to wipe the copy in memory
1059 * (done in this function's cleanup code). */
1060 overall_status = PSA_ERROR_NOT_PERMITTED;
1061 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001062 }
1063
Gilles Peskine354f7672019-07-12 23:46:38 +02001064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001065 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001066 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001067 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001068 /* For a key in a secure element, we need to do three things:
1069 * remove the key file in internal storage, destroy the
1070 * key inside the secure element, and update the driver's
1071 * persistent data. Start a transaction that will encompass these
1072 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001073 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001074 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001075 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001077 status = psa_crypto_save_transaction( );
1078 if( status != PSA_SUCCESS )
1079 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001080 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001081 /* We should still try to destroy the key in the secure
1082 * element and the key metadata in storage. This is especially
1083 * important if the error is that the storage is full.
1084 * But how to do it exactly without risking an inconsistent
1085 * state after a reset?
1086 * https://github.com/ARMmbed/mbed-crypto/issues/215
1087 */
1088 overall_status = status;
1089 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001090 }
1091
Ronald Cronea0f8a62020-11-25 17:52:23 +01001092 status = psa_destroy_se_key( driver,
1093 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001094 if( overall_status == PSA_SUCCESS )
1095 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001096 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001097#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1098
Darryl Greend49a4992018-06-18 17:27:26 +01001099#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001100 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001101 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 status = psa_destroy_persistent_key( slot->attr.id );
1103 if( overall_status == PSA_SUCCESS )
1104 overall_status = status;
1105
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001106 /* TODO: other slots may have a copy of the same key. We should
1107 * invalidate them.
1108 * https://github.com/ARMmbed/mbed-crypto/issues/214
1109 */
Darryl Greend49a4992018-06-18 17:27:26 +01001110 }
1111#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001112
Gilles Peskinefc762652019-07-22 19:30:34 +02001113#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1114 if( driver != NULL )
1115 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001116 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001117 if( overall_status == PSA_SUCCESS )
1118 overall_status = status;
1119 status = psa_crypto_stop_transaction( );
1120 if( overall_status == PSA_SUCCESS )
1121 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001122 }
1123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1124
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001126 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001128 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 overall_status = status;
1130 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001131}
1132
John Durkop07cc04a2020-11-16 22:08:34 -08001133#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001134 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001135static psa_status_t psa_get_rsa_public_exponent(
1136 const mbedtls_rsa_context *rsa,
1137 psa_key_attributes_t *attributes )
1138{
1139 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001141 uint8_t *buffer = NULL;
1142 size_t buflen;
1143 mbedtls_mpi_init( &mpi );
1144
1145 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1146 if( ret != 0 )
1147 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001148 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1149 {
1150 /* It's the default value, which is reported as an empty string,
1151 * so there's nothing to do. */
1152 goto exit;
1153 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001154
1155 buflen = mbedtls_mpi_size( &mpi );
1156 buffer = mbedtls_calloc( 1, buflen );
1157 if( buffer == NULL )
1158 {
1159 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1160 goto exit;
1161 }
1162 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1163 if( ret != 0 )
1164 goto exit;
1165 attributes->domain_parameters = buffer;
1166 attributes->domain_parameters_size = buflen;
1167
1168exit:
1169 mbedtls_mpi_free( &mpi );
1170 if( ret != 0 )
1171 mbedtls_free( buffer );
1172 return( mbedtls_to_psa_error( ret ) );
1173}
John Durkop07cc04a2020-11-16 22:08:34 -08001174#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001175 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001176
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001177/** Retrieve all the publicly-accessible attributes of a key.
1178 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001179psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001180 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001181{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001183 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001184 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001186 psa_reset_key_attributes( attributes );
1187
Ronald Cron5c522922020-11-14 16:35:34 +01001188 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001189 if( status != PSA_SUCCESS )
1190 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001191
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001192 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001193 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1194 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1195
1196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001197 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001198 psa_set_key_slot_number( attributes,
1199 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001200#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001201
Gilles Peskine8e338702019-07-30 20:06:31 +02001202 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001203 {
John Durkop07cc04a2020-11-16 22:08:34 -08001204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001205 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001206 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001208 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001209 * is not yet implemented.
1210 * https://github.com/ARMmbed/mbed-crypto/issues/216
1211 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001212 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001214 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001215
Ronald Cron90857082020-11-25 14:58:33 +01001216 status = mbedtls_psa_rsa_load_representation(
1217 slot->attr.type,
1218 slot->key.data,
1219 slot->key.bytes,
1220 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001221 if( status != PSA_SUCCESS )
1222 break;
1223
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001225 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001226 mbedtls_rsa_free( rsa );
1227 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001230#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001231 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001232 default:
1233 /* Nothing else to do. */
1234 break;
1235 }
1236
1237 if( status != PSA_SUCCESS )
1238 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001241
Ronald Cron5c522922020-11-14 16:35:34 +01001242 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001243}
1244
Gilles Peskinec8000c02019-08-02 20:15:51 +02001245#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1246psa_status_t psa_get_key_slot_number(
1247 const psa_key_attributes_t *attributes,
1248 psa_key_slot_number_t *slot_number )
1249{
1250 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1251 {
1252 *slot_number = attributes->slot_number;
1253 return( PSA_SUCCESS );
1254 }
1255 else
1256 return( PSA_ERROR_INVALID_ARGUMENT );
1257}
1258#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1259
Ronald Crond18b5f82020-11-25 16:46:05 +01001260static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1261 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001262 uint8_t *data,
1263 size_t data_size,
1264 size_t *data_length )
1265{
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001267 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001268 memcpy( data, key_buffer, key_buffer_size );
1269 memset( data + key_buffer_size, 0,
1270 data_size - key_buffer_size );
1271 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001272 return( PSA_SUCCESS );
1273}
1274
Ronald Cron7285cda2020-11-26 14:46:37 +01001275psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 const psa_key_attributes_t *attributes,
1277 const uint8_t *key_buffer, size_t key_buffer_size,
1278 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001279{
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 psa_key_type_t type = attributes->core.type;
1281
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 if( key_type_is_raw_bytes( type ) ||
1283 PSA_KEY_TYPE_IS_RSA( type ) ||
1284 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001285 {
1286 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 key_buffer, key_buffer_size,
1288 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001289 }
1290 else
1291 {
1292 /* This shouldn't happen in the reference implementation, but
1293 it is valid for a special-purpose implementation to omit
1294 support for exporting certain key types. */
1295 return( PSA_ERROR_NOT_SUPPORTED );
1296 }
1297}
1298
1299psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1300 uint8_t *data,
1301 size_t data_size,
1302 size_t *data_length )
1303{
1304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1305 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1306 psa_key_slot_t *slot;
1307
Ronald Crone907e552021-01-18 13:22:38 +01001308 /* Reject a zero-length output buffer now, since this can never be a
1309 * valid key representation. This way we know that data must be a valid
1310 * pointer and we can do things like memset(data, ..., data_size). */
1311 if( data_size == 0 )
1312 return( PSA_ERROR_BUFFER_TOO_SMALL );
1313
Ronald Cron9486f9d2020-11-26 13:36:23 +01001314 /* Set the key to empty now, so that even when there are errors, we always
1315 * set data_length to a value between 0 and data_size. On error, setting
1316 * the key to empty is a good choice because an empty key representation is
1317 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001318 *data_length = 0;
1319
Ronald Cron9486f9d2020-11-26 13:36:23 +01001320 /* Export requires the EXPORT flag. There is an exception for public keys,
1321 * which don't require any flag, but
1322 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1323 */
1324 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1325 PSA_KEY_USAGE_EXPORT, 0 );
1326 if( status != PSA_SUCCESS )
1327 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001328
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 psa_key_attributes_t attributes = {
1330 .core = slot->attr
1331 };
Ronald Cron67227982020-11-26 15:16:05 +01001332 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001333 slot->key.data, slot->key.bytes,
1334 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001335
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 unlock_status = psa_unlock_key_slot( slot );
1337
1338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1339}
1340
Ronald Cron7285cda2020-11-26 14:46:37 +01001341psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 const psa_key_attributes_t *attributes,
1343 const uint8_t *key_buffer,
1344 size_t key_buffer_size,
1345 uint8_t *data,
1346 size_t data_size,
1347 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001348{
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001350
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001352 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001354 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001355 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001356 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 key_buffer, key_buffer_size,
1358 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001359 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001360
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001362 {
John Durkop0e005192020-10-31 22:06:54 -07001363#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1364 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001365 return( mbedtls_psa_rsa_export_public_key( attributes,
1366 key_buffer,
1367 key_buffer_size,
1368 data,
1369 data_size,
1370 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001371#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001372 /* We don't know how to convert a private RSA key to public. */
1373 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001374#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1375 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001376 }
1377 else
Moran Pekera998bc62018-04-16 18:16:20 +03001378 {
John Durkop6ba40d12020-11-10 08:50:04 -08001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001381 return( mbedtls_psa_ecp_export_public_key( attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001387#else
1388 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001389 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001392 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001393 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394 else
1395 {
1396 /* This shouldn't happen in the reference implementation, but
1397 it is valid for a special-purpose implementation to omit
1398 support for exporting certain key types. */
1399 return( PSA_ERROR_NOT_SUPPORTED );
1400 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001401}
Ronald Crond18b5f82020-11-25 16:46:05 +01001402
Ronald Croncf56a0a2020-08-04 09:51:30 +02001403psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001404 uint8_t *data,
1405 size_t data_size,
1406 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001407{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001409 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001410 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001411
Ronald Crone907e552021-01-18 13:22:38 +01001412 /* Reject a zero-length output buffer now, since this can never be a
1413 * valid key representation. This way we know that data must be a valid
1414 * pointer and we can do things like memset(data, ..., data_size). */
1415 if( data_size == 0 )
1416 return( PSA_ERROR_BUFFER_TOO_SMALL );
1417
Darryl Greendd8fb772018-11-07 16:00:44 +00001418 /* Set the key to empty now, so that even when there are errors, we always
1419 * set data_length to a value between 0 and data_size. On error, setting
1420 * the key to empty is a good choice because an empty key representation is
1421 * unlikely to be accepted anywhere. */
1422 *data_length = 0;
1423
1424 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001425 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001426 if( status != PSA_SUCCESS )
1427 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001428
Ronald Cron9486f9d2020-11-26 13:36:23 +01001429 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1430 {
1431 status = PSA_ERROR_INVALID_ARGUMENT;
1432 goto exit;
1433 }
1434
Ronald Crond18b5f82020-11-25 16:46:05 +01001435 psa_key_attributes_t attributes = {
1436 .core = slot->attr
1437 };
Ronald Cron67227982020-11-26 15:16:05 +01001438 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 &attributes, slot->key.data, slot->key.bytes,
1440 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441
1442exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001443 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001444
Ronald Cron5c522922020-11-14 16:35:34 +01001445 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001446}
1447
Gilles Peskine91e8c332019-08-02 19:19:39 +02001448#if defined(static_assert)
1449static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1450 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001452 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001453static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454 "One or more key attribute flag is listed as both internal-only and external-only" );
1455#endif
1456
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001457/** Validate that a key policy is internally well-formed.
1458 *
1459 * This function only rejects invalid policies. It does not validate the
1460 * consistency of the policy with respect to other attributes of the key
1461 * such as the key type.
1462 */
1463static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001464{
1465 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001466 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001467 PSA_KEY_USAGE_ENCRYPT |
1468 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001469 PSA_KEY_USAGE_SIGN_MESSAGE |
1470 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001471 PSA_KEY_USAGE_SIGN_HASH |
1472 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001473 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1475 return( PSA_ERROR_INVALID_ARGUMENT );
1476
Gilles Peskine4747d192019-04-17 15:05:45 +02001477 return( PSA_SUCCESS );
1478}
1479
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001480/** Validate the internal consistency of key attributes.
1481 *
1482 * This function only rejects invalid attribute values. If does not
1483 * validate the consistency of the attributes with any key data that may
1484 * be involved in the creation of the key.
1485 *
1486 * Call this function early in the key creation process.
1487 *
1488 * \param[in] attributes Key attributes for the new key.
1489 * \param[out] p_drv On any return, the driver for the key, if any.
1490 * NULL for a transparent key.
1491 *
1492 */
1493static psa_status_t psa_validate_key_attributes(
1494 const psa_key_attributes_t *attributes,
1495 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001496{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001497 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001498 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001499 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001500
Ronald Cron54b90082020-10-29 15:26:43 +01001501 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001502 if( status != PSA_SUCCESS )
1503 return( status );
1504
Ronald Crond2ed4812020-07-17 16:11:30 +02001505 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001506 if( status != PSA_SUCCESS )
1507 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001508
Ronald Cron65f38a32020-10-23 17:11:13 +02001509 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1510 {
1511 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1512 return( PSA_ERROR_INVALID_ARGUMENT );
1513 }
1514 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001515 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001516 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1517 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001518 }
1519
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001520 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001521 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001522 return( status );
1523
1524 /* Refuse to create overly large keys.
1525 * Note that this doesn't trigger on import if the attributes don't
1526 * explicitly specify a size (so psa_get_key_bits returns 0), so
1527 * psa_import_key() needs its own checks. */
1528 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1529 return( PSA_ERROR_NOT_SUPPORTED );
1530
Gilles Peskine91e8c332019-08-02 19:19:39 +02001531 /* Reject invalid flags. These should not be reachable through the API. */
1532 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1533 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1534 return( PSA_ERROR_INVALID_ARGUMENT );
1535
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 return( PSA_SUCCESS );
1537}
1538
Gilles Peskine4747d192019-04-17 15:05:45 +02001539/** Prepare a key slot to receive key material.
1540 *
1541 * This function allocates a key slot and sets its metadata.
1542 *
1543 * If this function fails, call psa_fail_key_creation().
1544 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001545 * This function is intended to be used as follows:
1546 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001547 * it with the specified attributes, and in case of a volatile key assign it
1548 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001549 * -# Populate the slot with the key material.
1550 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1551 * In case of failure at any step, stop the sequence and call
1552 * psa_fail_key_creation().
1553 *
Ronald Cron5c522922020-11-14 16:35:34 +01001554 * On success, the key slot is locked. It is the responsibility of the caller
1555 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001556 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001557 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001558 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001559 * \param[out] p_slot On success, a pointer to the prepared slot.
1560 * \param[out] p_drv On any return, the driver for the key, if any.
1561 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001562 *
1563 * \retval #PSA_SUCCESS
1564 * The key slot is ready to receive key material.
1565 * \return If this function fails, the key slot is an invalid state.
1566 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001567 */
1568static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001569 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001570 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001571 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001572 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001573{
1574 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001575 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001576 psa_key_slot_t *slot;
1577
Gilles Peskinedf179142019-07-15 22:02:14 +02001578 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001579 *p_drv = NULL;
1580
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001581 status = psa_validate_key_attributes( attributes, p_drv );
1582 if( status != PSA_SUCCESS )
1583 return( status );
1584
Ronald Cronc4d1b512020-07-31 11:26:37 +02001585 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 if( status != PSA_SUCCESS )
1587 return( status );
1588 slot = *p_slot;
1589
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001590 /* We're storing the declared bit-size of the key. It's up to each
1591 * creation mechanism to verify that this information is correct.
1592 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001593 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001594 * is optional (import, copy). In case of a volatile key, assign it the
1595 * volatile key identifier associated to the slot returned to contain its
1596 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001597
1598 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001599 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1600 {
1601#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1602 slot->attr.id = volatile_key_id;
1603#else
1604 slot->attr.id.key_id = volatile_key_id;
1605#endif
1606 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001607
Gilles Peskine91e8c332019-08-02 19:19:39 +02001608 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001609 * external-only flags, query `attributes`. Thanks to the check
1610 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001611 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001612 * may have set. */
1613 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614
Gilles Peskinecbaff462019-07-12 23:46:04 +02001615#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001616 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001617 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001618 * create the key file in internal storage, create the
1619 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001620 * persistent data. This is done by starting a transaction that will
1621 * encompass these three actions.
1622 * For registering a volatile key, we just need to find an appropriate
1623 * slot number inside the SE. Since the key is designated volatile, creating
1624 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 /* The first thing to do is to find a slot number for the new key.
1626 * We save the slot number in persistent storage as part of the
1627 * transaction data. It will be needed to recover if the power
1628 * fails during the key creation process, to clean up on the secure
1629 * element side after restarting. Obtaining a slot number from the
1630 * secure element driver updates its persistent state, but we do not yet
1631 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001632 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001633 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001634 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001636 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001637 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001638 if( status != PSA_SUCCESS )
1639 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001640
1641 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001642 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1644 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001645 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 psa_crypto_transaction.key.id = slot->attr.id;
1647 status = psa_crypto_save_transaction( );
1648 if( status != PSA_SUCCESS )
1649 {
1650 (void) psa_crypto_stop_transaction( );
1651 return( status );
1652 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001653 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001654
1655 status = psa_copy_key_material_into_slot(
1656 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001657 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001658
1659 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1660 {
1661 /* Key registration only makes sense with a secure element. */
1662 return( PSA_ERROR_INVALID_ARGUMENT );
1663 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001664#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1665
Ronald Cronc4d1b512020-07-31 11:26:37 +02001666 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001667}
Gilles Peskine4747d192019-04-17 15:05:45 +02001668
1669/** Finalize the creation of a key once its key material has been set.
1670 *
1671 * This entails writing the key to persistent storage.
1672 *
1673 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001674 * See the documentation of psa_start_key_creation() for the intended use
1675 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001676 *
Ronald Cron5c522922020-11-14 16:35:34 +01001677 * If the finalization succeeds, the function unlocks the key slot (it was
1678 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1679 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001680 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001681 * \param[in,out] slot Pointer to the slot with key material.
1682 * \param[in] driver The secure element driver for the key,
1683 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001684 * \param[out] key On success, identifier of the key. Note that the
1685 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001686 *
1687 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001688 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001689 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1690 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1691 * \retval #PSA_ERROR_ALREADY_EXISTS
1692 * \retval #PSA_ERROR_DATA_INVALID
1693 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001694 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001695 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001696 * \return If this function fails, the key slot is an invalid state.
1697 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001698 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001699static psa_status_t psa_finish_key_creation(
1700 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001701 psa_se_drv_table_entry_t *driver,
1702 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001703{
1704 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001705 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001706 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001707
1708#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001709 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001710 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001711#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1712 if( driver != NULL )
1713 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 psa_key_slot_number_t slot_number =
1716 psa_key_slot_get_slot_number( slot ) ;
1717
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720 sizeof( data.slot_number ),
1721 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001722#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001723 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001724 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725 (uint8_t*) &data,
1726 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727 }
1728 else
1729#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1730 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001731 /* Key material is saved in export representation in the slot, so
1732 * just pass the slot buffer for storage. */
1733 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001734 slot->key.data,
1735 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001736 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001737 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001738#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1739
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001741 /* Finish the transaction for a key creation. This does not
1742 * happen when registering an existing key. Detect this case
1743 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001744 * creation of a persistent key in a secure element requires a transaction,
1745 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001746 if( driver != NULL &&
1747 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748 {
1749 status = psa_save_se_persistent_data( driver );
1750 if( status != PSA_SUCCESS )
1751 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001752 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001753 return( status );
1754 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001755 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001756 }
1757#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1758
Ronald Cron50972942020-11-14 11:28:25 +01001759 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001760 {
1761 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001762 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001763 if( status != PSA_SUCCESS )
1764 *key = MBEDTLS_SVC_KEY_ID_INIT;
1765 }
Ronald Cron50972942020-11-14 11:28:25 +01001766
Gilles Peskine4747d192019-04-17 15:05:45 +02001767 return( status );
1768}
1769
1770/** Abort the creation of a key.
1771 *
1772 * You may call this function after calling psa_start_key_creation(),
1773 * or after psa_finish_key_creation() fails. In other circumstances, this
1774 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001775 * See the documentation of psa_start_key_creation() for the intended use
1776 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001778 * \param[in,out] slot Pointer to the slot with key material.
1779 * \param[in] driver The secure element driver for the key,
1780 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001781 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001782static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001783 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001784{
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 (void) driver;
1786
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 if( slot == NULL )
1788 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001789
1790#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001791 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 * element, and the failure happened later (when saving metadata
1793 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001794 * element.
1795 * https://github.com/ARMmbed/mbed-crypto/issues/217
1796 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001797
Gilles Peskined7729582019-08-05 15:55:54 +02001798 /* Abort the ongoing transaction if any (there may not be one if
1799 * the creation process failed before starting one, or if the
1800 * key creation is a registration of a key in a secure element).
1801 * Earlier functions must already have done what it takes to undo any
1802 * partial creation. All that's left is to update the transaction data
1803 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001804 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001805#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1806
Gilles Peskine4747d192019-04-17 15:05:45 +02001807 psa_wipe_key_slot( slot );
1808}
1809
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001810/** Validate optional attributes during key creation.
1811 *
1812 * Some key attributes are optional during key creation. If they are
1813 * specified in the attributes structure, check that they are consistent
1814 * with the data in the slot.
1815 *
1816 * This function should be called near the end of key creation, after
1817 * the slot in memory is fully populated but before saving persistent data.
1818 */
1819static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001820 const psa_key_slot_t *slot,
1821 const psa_key_attributes_t *attributes )
1822{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001823 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001825 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 return( PSA_ERROR_INVALID_ARGUMENT );
1827 }
1828
1829 if( attributes->domain_parameters_size != 0 )
1830 {
John Durkop0e005192020-10-31 22:06:54 -07001831#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1832 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001833 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001834 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001835 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001836 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001838
Ronald Cron90857082020-11-25 14:58:33 +01001839 psa_status_t status = mbedtls_psa_rsa_load_representation(
1840 slot->attr.type,
1841 slot->key.data,
1842 slot->key.bytes,
1843 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001844 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001845 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001846
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001847 mbedtls_mpi_init( &actual );
1848 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001851 mbedtls_rsa_free( rsa );
1852 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 if( ret != 0 )
1854 goto rsa_exit;
1855 ret = mbedtls_mpi_read_binary( &required,
1856 attributes->domain_parameters,
1857 attributes->domain_parameters_size );
1858 if( ret != 0 )
1859 goto rsa_exit;
1860 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1861 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1862 rsa_exit:
1863 mbedtls_mpi_free( &actual );
1864 mbedtls_mpi_free( &required );
1865 if( ret != 0)
1866 return( mbedtls_to_psa_error( ret ) );
1867 }
1868 else
John Durkop9814fa22020-11-04 12:28:15 -08001869#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1870 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 {
1872 return( PSA_ERROR_INVALID_ARGUMENT );
1873 }
1874 }
1875
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001876 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001878 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001879 return( PSA_ERROR_INVALID_ARGUMENT );
1880 }
1881
1882 return( PSA_SUCCESS );
1883}
1884
Gilles Peskine4747d192019-04-17 15:05:45 +02001885psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001886 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001887 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001889{
1890 psa_status_t status;
1891 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001892 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001893 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301894 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895
Ronald Cron81709fc2020-11-14 12:10:32 +01001896 *key = MBEDTLS_SVC_KEY_ID_INIT;
1897
Gilles Peskine0f84d622019-09-12 19:03:13 +02001898 /* Reject zero-length symmetric keys (including raw data key objects).
1899 * This also rejects any key which might be encoded as an empty string,
1900 * which is never valid. */
1901 if( data_length == 0 )
1902 return( PSA_ERROR_INVALID_ARGUMENT );
1903
Archana449608b2021-09-08 15:36:05 +05301904 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301905 if( data_length > SIZE_MAX / 8 )
1906 return( PSA_ERROR_NOT_SUPPORTED );
1907
Gilles Peskinedf179142019-07-15 22:02:14 +02001908 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001909 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 if( status != PSA_SUCCESS )
1911 goto exit;
1912
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001913 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301914 * storage ( thus not in the case of importing a key in a secure element
1915 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1916 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001917 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001918 {
Archanad8a83dc2021-06-14 10:04:16 +05301919 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1920 {
Archana449608b2021-09-08 15:36:05 +05301921 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1922 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301923 if( status != PSA_SUCCESS )
1924 goto exit;
1925 }
1926 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001927 if( status != PSA_SUCCESS )
1928 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001929 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930
1931 bits = slot->attr.bits;
1932 status = psa_driver_wrapper_import_key( attributes,
1933 data, data_length,
1934 slot->key.data,
1935 slot->key.bytes,
1936 &slot->key.bytes, &bits );
1937 if( status != PSA_SUCCESS )
1938 goto exit;
1939
1940 if( slot->attr.bits == 0 )
1941 slot->attr.bits = (psa_key_bits_t) bits;
1942 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001943 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001944 status = PSA_ERROR_INVALID_ARGUMENT;
1945 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001946 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001947
Archana6ed4bda2021-08-04 10:47:15 +05301948 /* Enforce a size limit, and in particular ensure that the bit
1949 * size fits in its representation type.*/
1950 if( bits > PSA_MAX_KEY_BITS )
1951 {
1952 status = PSA_ERROR_NOT_SUPPORTED;
1953 goto exit;
1954 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001955 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001956 if( status != PSA_SUCCESS )
1957 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958
Ronald Cron81709fc2020-11-14 12:10:32 +01001959 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001962 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001963
Gilles Peskine4747d192019-04-17 15:05:45 +02001964 return( status );
1965}
1966
Gilles Peskined7729582019-08-05 15:55:54 +02001967#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1968psa_status_t mbedtls_psa_register_se_key(
1969 const psa_key_attributes_t *attributes )
1970{
1971 psa_status_t status;
1972 psa_key_slot_t *slot = NULL;
1973 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001974 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001975
1976 /* Leaving attributes unspecified is not currently supported.
1977 * It could make sense to query the key type and size from the
1978 * secure element, but not all secure elements support this
1979 * and the driver HAL doesn't currently support it. */
1980 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1981 return( PSA_ERROR_NOT_SUPPORTED );
1982 if( psa_get_key_bits( attributes ) == 0 )
1983 return( PSA_ERROR_NOT_SUPPORTED );
1984
1985 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001986 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001987 if( status != PSA_SUCCESS )
1988 goto exit;
1989
Ronald Cron81709fc2020-11-14 12:10:32 +01001990 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001991
1992exit:
1993 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001994 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001995
Gilles Peskined7729582019-08-05 15:55:54 +02001996 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001997 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001998 return( status );
1999}
2000#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2001
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002004 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002005{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002006 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002007 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002008 psa_key_slot_t *source_slot = NULL;
2009 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002010 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002011 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302012 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002013
Ronald Cron81709fc2020-11-14 12:10:32 +01002014 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2015
Archana8a180362021-07-05 02:18:48 +05302016 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002017 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002018 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002019 goto exit;
2020
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002021 status = psa_validate_optional_attributes( source_slot,
2022 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 if( status != PSA_SUCCESS )
2024 goto exit;
2025
Archana9d17bf42021-09-10 06:22:44 +05302026 /* The target key type and number of bits have been validated by
2027 * psa_validate_optional_attributes() to be either equal to zero or
2028 * equal to the ones of the source key. So it is safe to inherit
2029 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302030 * */
Archana9d17bf42021-09-10 06:22:44 +05302031 actual_attributes.core.bits = source_slot->attr.bits;
2032 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302033
2034
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002035 status = psa_restrict_key_policy( source_slot->attr.type,
2036 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002037 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002038 if( status != PSA_SUCCESS )
2039 goto exit;
2040
Ronald Cron81709fc2020-11-14 12:10:32 +01002041 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2042 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002043 if( status != PSA_SUCCESS )
2044 goto exit;
Archana8a180362021-07-05 02:18:48 +05302045 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2046 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002047 {
Archana8a180362021-07-05 02:18:48 +05302048 /*
Archana9d17bf42021-09-10 06:22:44 +05302049 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302050 * the source key would need to be exported as plaintext and re-imported
2051 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302052 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302053 * appropriate API invocations from the application, if needed.
2054 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002055 status = PSA_ERROR_NOT_SUPPORTED;
2056 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002057 }
Archana8a180362021-07-05 02:18:48 +05302058 /*
2059 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302060 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302061 * - For opaque keys this translates to an invocation of the drivers'
2062 * copy_key entry point through the dispatch layer.
2063 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002064 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2065 {
Archana8a180362021-07-05 02:18:48 +05302066 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302067 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302068 if( status != PSA_SUCCESS )
2069 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302070
Archana8a180362021-07-05 02:18:48 +05302071 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2072 if( status != PSA_SUCCESS )
2073 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302074
Archana8a180362021-07-05 02:18:48 +05302075 status = psa_driver_wrapper_copy_key( &actual_attributes,
2076 source_slot->key.data,
2077 source_slot->key.bytes,
2078 target_slot->key.data,
2079 target_slot->key.bytes,
2080 &target_slot->key.bytes );
2081 if( status != PSA_SUCCESS )
2082 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002083 }
Archana8a180362021-07-05 02:18:48 +05302084 else
2085 {
Archana9d17bf42021-09-10 06:22:44 +05302086 status = psa_copy_key_material_into_slot( target_slot,
2087 source_slot->key.data,
2088 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302089 if( status != PSA_SUCCESS )
2090 goto exit;
2091 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002092 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002093exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002095 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002096
Ronald Cron5c522922020-11-14 16:35:34 +01002097 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002098
Ronald Cron5c522922020-11-14 16:35:34 +01002099 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002100}
2101
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002102
2103
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002104/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002105/* Message digests */
2106/****************************************************************/
2107
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002108psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2109{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002110 /* Aborting a non-active operation is allowed */
2111 if( operation->id == 0 )
2112 return( PSA_SUCCESS );
2113
2114 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2115 operation->id = 0;
2116
2117 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002118}
2119
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002120psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002121 psa_algorithm_t alg )
2122{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002123 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002124
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002125 /* A context must be freshly initialized before it can be set up. */
2126 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002127 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002128 status = PSA_ERROR_BAD_STATE;
2129 goto exit;
2130 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131
2132 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002133 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002134 status = PSA_ERROR_INVALID_ARGUMENT;
2135 goto exit;
2136 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002137
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002138 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2139 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002140 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2141
Dave Rodgman685b6a72021-06-24 11:49:14 +01002142 status = psa_driver_wrapper_hash_setup( operation, alg );
2143
2144exit:
2145 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002146 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002147
2148 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149}
2150
2151psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2152 const uint8_t *input,
2153 size_t input_length )
2154{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2156
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002158 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002159 status = PSA_ERROR_BAD_STATE;
2160 goto exit;
2161 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002162
Steven Cooremanc8288352021-03-04 14:02:19 +01002163 /* Don't require hash implementations to behave correctly on a
2164 * zero-length input, which may have an invalid pointer. */
2165 if( input_length == 0 )
2166 return( PSA_SUCCESS );
2167
Dave Rodgman685b6a72021-06-24 11:49:14 +01002168 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2169
2170exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002171 if( status != PSA_SUCCESS )
2172 psa_hash_abort( operation );
2173
2174 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175}
2176
2177psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2178 uint8_t *hash,
2179 size_t hash_size,
2180 size_t *hash_length )
2181{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002182 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002183 if( operation->id == 0 )
2184 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002185
Steven Cooreman1e582352021-02-18 17:24:37 +01002186 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002187 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002188 psa_hash_abort( operation );
2189 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002190}
2191
Gilles Peskine2d277862018-06-18 15:41:12 +02002192psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2193 const uint8_t *hash,
2194 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195{
2196 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2197 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002198 psa_status_t status = psa_hash_finish(
2199 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002200 actual_hash, sizeof( actual_hash ),
2201 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002204 goto exit;
2205
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002206 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002207 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002208 status = PSA_ERROR_INVALID_SIGNATURE;
2209 goto exit;
2210 }
2211
Steven Cooreman36876a02021-04-29 16:37:59 +02002212 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002213 status = PSA_ERROR_INVALID_SIGNATURE;
2214
2215exit:
2216 if( status != PSA_SUCCESS )
2217 psa_hash_abort(operation);
2218
2219 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002220}
2221
Gilles Peskine0a749c82019-11-28 19:33:58 +01002222psa_status_t psa_hash_compute( psa_algorithm_t alg,
2223 const uint8_t *input, size_t input_length,
2224 uint8_t *hash, size_t hash_size,
2225 size_t *hash_length )
2226{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002227 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002228 if( !PSA_ALG_IS_HASH( alg ) )
2229 return( PSA_ERROR_INVALID_ARGUMENT );
2230
Steven Cooreman1e582352021-02-18 17:24:37 +01002231 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2232 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002233}
2234
2235psa_status_t psa_hash_compare( psa_algorithm_t alg,
2236 const uint8_t *input, size_t input_length,
2237 const uint8_t *hash, size_t hash_length )
2238{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002239 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2240 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002241
2242 if( !PSA_ALG_IS_HASH( alg ) )
2243 return( PSA_ERROR_INVALID_ARGUMENT );
2244
Steven Cooreman1e582352021-02-18 17:24:37 +01002245 psa_status_t status = psa_driver_wrapper_hash_compute(
2246 alg, input, input_length,
2247 actual_hash, sizeof(actual_hash),
2248 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002249 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002250 return( status );
2251 if( actual_hash_length != hash_length )
2252 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002253 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002254 return( PSA_ERROR_INVALID_SIGNATURE );
2255 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002256}
2257
Gilles Peskineeb35d782019-01-22 17:56:16 +01002258psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2259 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002260{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002261 if( source_operation->id == 0 ||
2262 target_operation->id != 0 )
2263 {
2264 return( PSA_ERROR_BAD_STATE );
2265 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002266
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002267 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2268 target_operation );
2269 if( status != PSA_SUCCESS )
2270 psa_hash_abort( target_operation );
2271
2272 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002273}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002274
2275
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002277/* MAC */
2278/****************************************************************/
2279
Steven Cooremane6804192021-03-19 18:28:56 +01002280psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002281{
Steven Cooremane6804192021-03-19 18:28:56 +01002282 /* Aborting a non-active operation is allowed */
2283 if( operation->id == 0 )
2284 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002285
Steven Cooremane6804192021-03-19 18:28:56 +01002286 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002287 operation->mac_size = 0;
2288 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002289 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002290
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002291 return( status );
2292}
2293
Ronald Cron2dff3b22021-06-17 16:33:22 +02002294static psa_status_t psa_mac_finalize_alg_and_key_validation(
2295 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002296 const psa_key_attributes_t *attributes,
2297 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002298{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002300 psa_key_type_t key_type = psa_get_key_type( attributes );
2301 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002302
Ronald Cron28ea0502021-06-17 16:10:24 +02002303 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002304 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002305
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002306 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002307 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002308 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002310
Steven Cooremand1a68f12021-05-10 11:13:41 +02002311 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002312 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002313
Ronald Cron79bdd822021-06-17 16:46:44 +02002314 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002315 {
2316 /* A very short MAC is too short for security since it can be
2317 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2318 * so we make this our minimum, even though 32 bits is still
2319 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002320 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002321 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002322
Ronald Cron79bdd822021-06-17 16:46:44 +02002323 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2324 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002325 {
2326 /* It's impossible to "truncate" to a larger length than the full length
2327 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002328 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002329 }
2330
Ronald Cron79bdd822021-06-17 16:46:44 +02002331 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002332}
2333
Gilles Peskinee59236f2018-01-27 23:32:46 +01002334static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2335 mbedtls_svc_key_id_t key,
2336 psa_algorithm_t alg,
2337 int is_sign )
2338{
2339 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2340 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002341 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002342
2343 /* A context must be freshly initialized before it can be set up. */
2344 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002345 {
Dave Rodgman54648242021-06-24 11:49:45 +01002346 status = PSA_ERROR_BAD_STATE;
2347 goto exit;
2348 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002349
2350 status = psa_get_and_lock_key_slot_with_policy(
2351 key,
2352 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002353 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354 alg );
2355 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002356 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002357
2358 psa_key_attributes_t attributes = {
2359 .core = slot->attr
2360 };
2361
Ronald Cron79bdd822021-06-17 16:46:44 +02002362 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2363 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002364 if( status != PSA_SUCCESS )
2365 goto exit;
2366
2367 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002368 /* Dispatch the MAC setup call with validated input */
2369 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002370 {
Steven Cooremane6804192021-03-19 18:28:56 +01002371 status = psa_driver_wrapper_mac_sign_setup( operation,
2372 &attributes,
2373 slot->key.data,
2374 slot->key.bytes,
2375 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002376 }
2377 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002378 {
Steven Cooremane6804192021-03-19 18:28:56 +01002379 status = psa_driver_wrapper_mac_verify_setup( operation,
2380 &attributes,
2381 slot->key.data,
2382 slot->key.bytes,
2383 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002384 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002385
Gilles Peskinefbfac682018-07-08 20:51:54 +02002386exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002387 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002388 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002389
Ronald Cron5c522922020-11-14 16:35:34 +01002390 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002391
Ronald Cron5c522922020-11-14 16:35:34 +01002392 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002393}
2394
Gilles Peskine89167cb2018-07-08 20:12:23 +02002395psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002396 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002397 psa_algorithm_t alg )
2398{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002399 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002400}
2401
2402psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002403 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002404 psa_algorithm_t alg )
2405{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002406 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002407}
2408
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002409psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002410 const uint8_t *input,
2411 size_t input_length )
2412{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002413 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002414 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002416 /* Don't require hash implementations to behave correctly on a
2417 * zero-length input, which may have an invalid pointer. */
2418 if( input_length == 0 )
2419 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002420
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002421 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2422 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002423 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002424 psa_mac_abort( operation );
2425
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002426 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002427}
2428
Steven Cooremana5b860a2021-03-19 19:04:39 +01002429psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002430 uint8_t *mac,
2431 size_t mac_size,
2432 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002433{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2435 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002436
Steven Cooremana5b860a2021-03-19 19:04:39 +01002437 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002438 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002439 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002440 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002441 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002442
Steven Cooreman72f736a2021-05-07 14:14:37 +02002443 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002444 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002445 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002446 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002447 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002448
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002449 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2450 * once all the error checks are done. */
2451 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002452 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002453 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002454 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002455 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002456
2457 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002458 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002459 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002460 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002461 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002462
Steven Cooremana5b860a2021-03-19 19:04:39 +01002463 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002464 mac, operation->mac_size,
2465 mac_length );
2466
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002467exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002468 /* In case of success, set the potential excess room in the output buffer
2469 * to an invalid value, to avoid potentially leaking a longer MAC.
2470 * In case of error, set the output length and content to a safe default,
2471 * such that in case the caller misses an error check, the output would be
2472 * an unachievable MAC.
2473 */
2474 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002475 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002476 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002477 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002478 }
mohammad16036df908f2018-04-02 08:34:15 -07002479
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002480 if( mac_size > operation->mac_size )
2481 memset( &mac[operation->mac_size], '!',
2482 mac_size - operation->mac_size );
2483
Steven Cooremana5b860a2021-03-19 19:04:39 +01002484 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002485
Steven Cooremana5b860a2021-03-19 19:04:39 +01002486 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002487}
2488
Steven Cooremana5b860a2021-03-19 19:04:39 +01002489psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002490 const uint8_t *mac,
2491 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002492{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2494 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002495
Steven Cooremana5b860a2021-03-19 19:04:39 +01002496 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002497 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002498 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002499 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002500 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002501
Steven Cooreman72f736a2021-05-07 14:14:37 +02002502 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002503 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002504 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002505 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002506 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002507
2508 if( operation->mac_size != mac_length )
2509 {
2510 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002511 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002512 }
2513
Steven Cooremana5b860a2021-03-19 19:04:39 +01002514 status = psa_driver_wrapper_mac_verify_finish( operation,
2515 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002516
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002517exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002518 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002519
Steven Cooremana5b860a2021-03-19 19:04:39 +01002520 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521}
2522
Ronald Croncd989b52021-06-18 14:23:33 +02002523static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2524 psa_algorithm_t alg,
2525 const uint8_t *input,
2526 size_t input_length,
2527 uint8_t *mac,
2528 size_t mac_size,
2529 size_t *mac_length,
2530 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002531{
2532 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002533 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2534 psa_key_slot_t *slot;
2535 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002536
Ronald Cron51131b52021-06-17 17:17:20 +02002537 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002538 key,
2539 &slot,
2540 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002541 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002542 if( status != PSA_SUCCESS )
2543 goto exit;
2544
Ronald Cron51131b52021-06-17 17:17:20 +02002545 psa_key_attributes_t attributes = {
2546 .core = slot->attr
2547 };
2548
2549 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2550 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002551 if( status != PSA_SUCCESS )
2552 goto exit;
2553
Ronald Cron51131b52021-06-17 17:17:20 +02002554 if( mac_size < operation_mac_size )
2555 {
2556 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002557 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002558 }
2559
2560 status = psa_driver_wrapper_mac_compute(
2561 &attributes,
2562 slot->key.data, slot->key.bytes,
2563 alg,
2564 input, input_length,
2565 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002566
2567exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002568 /* In case of success, set the potential excess room in the output buffer
2569 * to an invalid value, to avoid potentially leaking a longer MAC.
2570 * In case of error, set the output length and content to a safe default,
2571 * such that in case the caller misses an error check, the output would be
2572 * an unachievable MAC.
2573 */
2574 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002575 {
Ronald Cron51131b52021-06-17 17:17:20 +02002576 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002577 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002578 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002579 if( mac_size > operation_mac_size )
2580 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002581
Ronald Cron51131b52021-06-17 17:17:20 +02002582 unlock_status = psa_unlock_key_slot( slot );
2583
2584 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002585}
2586
Ronald Croncd989b52021-06-18 14:23:33 +02002587psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2588 psa_algorithm_t alg,
2589 const uint8_t *input,
2590 size_t input_length,
2591 uint8_t *mac,
2592 size_t mac_size,
2593 size_t *mac_length)
2594{
2595 return( psa_mac_compute_internal( key, alg,
2596 input, input_length,
2597 mac, mac_size, mac_length, 1 ) );
2598}
2599
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002600psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2601 psa_algorithm_t alg,
2602 const uint8_t *input,
2603 size_t input_length,
2604 const uint8_t *mac,
2605 size_t mac_length)
2606{
2607 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002608 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2609 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002610
Ronald Crona587cbc2021-06-18 14:51:29 +02002611 status = psa_mac_compute_internal( key, alg,
2612 input, input_length,
2613 actual_mac, sizeof( actual_mac ),
2614 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002615 if( status != PSA_SUCCESS )
2616 goto exit;
2617
Ronald Crona587cbc2021-06-18 14:51:29 +02002618 if( mac_length != actual_mac_length )
2619 {
2620 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002621 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002622 }
2623 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2624 {
2625 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002626 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002627 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002628
2629exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002630 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002631
2632 return ( status );
2633}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002634
Gilles Peskinee59236f2018-01-27 23:32:46 +01002635/****************************************************************/
2636/* Asymmetric cryptography */
2637/****************************************************************/
2638
gabor-mezei-armf0486182021-05-12 11:03:09 +02002639static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002640 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002641{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002642 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002643 {
2644 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2645 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002646
Gilles Peskinef7b41372021-09-22 16:15:05 +02002647 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002648 {
2649 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2650 return( PSA_ERROR_INVALID_ARGUMENT );
2651 }
2652 }
2653 else
2654 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002655 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002656 return( PSA_ERROR_INVALID_ARGUMENT );
2657 }
2658
2659 return( PSA_SUCCESS );
2660}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002661
2662static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002663 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002664 psa_algorithm_t alg,
2665 const uint8_t * input,
2666 size_t input_length,
2667 uint8_t * signature,
2668 size_t signature_size,
2669 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002670{
2671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2672 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2673 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002674
2675 *signature_length = 0;
2676
gabor-mezei-armf0486182021-05-12 11:03:09 +02002677 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002678 if( status != PSA_SUCCESS )
2679 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002680
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002681 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002682 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002683 * buffer can in principle be empty since it doesn't actually have
2684 * to be a hash.) */
2685 if( signature_size == 0 )
2686 return( PSA_ERROR_BUFFER_TOO_SMALL );
2687
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002688 status = psa_get_and_lock_key_slot_with_policy(
2689 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002690 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2691 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002692 alg );
2693
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002694 if( status != PSA_SUCCESS )
2695 goto exit;
2696
2697 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2698 {
2699 status = PSA_ERROR_INVALID_ARGUMENT;
2700 goto exit;
2701 }
2702
2703 psa_key_attributes_t attributes = {
2704 .core = slot->attr
2705 };
2706
gabor-mezei-armf0486182021-05-12 11:03:09 +02002707 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002708 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002709 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002710 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002711 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712 signature, signature_size, signature_length );
2713 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002714 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002715 {
2716
2717 status = psa_driver_wrapper_sign_hash(
2718 &attributes, slot->key.data, slot->key.bytes,
2719 alg, input, input_length,
2720 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002721 }
2722
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002723
2724exit:
2725 /* Fill the unused part of the output buffer (the whole buffer on error,
2726 * the trailing part on success) with something that isn't a valid signature
2727 * (barring an attack on the signature and deliberately-crafted input),
2728 * in case the caller doesn't check the return status properly. */
2729 if( status == PSA_SUCCESS )
2730 memset( signature + *signature_length, '!',
2731 signature_size - *signature_length );
2732 else
2733 memset( signature, '!', signature_size );
2734 /* If signature_size is 0 then we have nothing to do. We must not call
2735 * memset because signature may be NULL in this case. */
2736
2737 unlock_status = psa_unlock_key_slot( slot );
2738
2739 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2740}
2741
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002742static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002743 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002744 psa_algorithm_t alg,
2745 const uint8_t * input,
2746 size_t input_length,
2747 const uint8_t * signature,
2748 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002749{
2750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2751 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2752 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002753
gabor-mezei-armf0486182021-05-12 11:03:09 +02002754 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002755 if( status != PSA_SUCCESS )
2756 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002757
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002758 status = psa_get_and_lock_key_slot_with_policy(
2759 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002760 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2761 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002762 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002763
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002764 if( status != PSA_SUCCESS )
2765 return( status );
2766
2767 psa_key_attributes_t attributes = {
2768 .core = slot->attr
2769 };
2770
gabor-mezei-armf0486182021-05-12 11:03:09 +02002771 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002772 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002773 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002774 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002775 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002776 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002777 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002778 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002779 {
2780 status = psa_driver_wrapper_verify_hash(
2781 &attributes, slot->key.data, slot->key.bytes,
2782 alg, input, input_length,
2783 signature, signature_length );
2784 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002785
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786 unlock_status = psa_unlock_key_slot( slot );
2787
2788 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002789
2790}
2791
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002792psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002793 const psa_key_attributes_t *attributes,
2794 const uint8_t *key_buffer,
2795 size_t key_buffer_size,
2796 psa_algorithm_t alg,
2797 const uint8_t *input,
2798 size_t input_length,
2799 uint8_t *signature,
2800 size_t signature_size,
2801 size_t *signature_length )
2802{
2803 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002804
Gilles Peskinef7b41372021-09-22 16:15:05 +02002805 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002806 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002807 size_t hash_length;
2808 uint8_t hash[PSA_HASH_MAX_SIZE];
2809
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002810 status = psa_driver_wrapper_hash_compute(
2811 PSA_ALG_SIGN_GET_HASH( alg ),
2812 input, input_length,
2813 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002814
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002815 if( status != PSA_SUCCESS )
2816 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002817
2818 return psa_driver_wrapper_sign_hash(
2819 attributes, key_buffer, key_buffer_size,
2820 alg, hash, hash_length,
2821 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002822 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002823
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002824 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002825}
2826
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002827psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2828 psa_algorithm_t alg,
2829 const uint8_t * input,
2830 size_t input_length,
2831 uint8_t * signature,
2832 size_t signature_size,
2833 size_t * signature_length )
2834{
2835 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002836 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837 signature, signature_size, signature_length );
2838}
2839
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002840psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002841 const psa_key_attributes_t *attributes,
2842 const uint8_t *key_buffer,
2843 size_t key_buffer_size,
2844 psa_algorithm_t alg,
2845 const uint8_t *input,
2846 size_t input_length,
2847 const uint8_t *signature,
2848 size_t signature_length )
2849{
2850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002851
Gilles Peskinef7b41372021-09-22 16:15:05 +02002852 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002853 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002854 size_t hash_length;
2855 uint8_t hash[PSA_HASH_MAX_SIZE];
2856
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002857 status = psa_driver_wrapper_hash_compute(
2858 PSA_ALG_SIGN_GET_HASH( alg ),
2859 input, input_length,
2860 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002861
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002862 if( status != PSA_SUCCESS )
2863 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002864
2865 return psa_driver_wrapper_verify_hash(
2866 attributes, key_buffer, key_buffer_size,
2867 alg, hash, hash_length,
2868 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002869 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002871 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002872}
2873
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002874psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2875 psa_algorithm_t alg,
2876 const uint8_t * input,
2877 size_t input_length,
2878 const uint8_t * signature,
2879 size_t signature_length )
2880{
2881 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002882 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002883 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002884}
2885
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002886psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002887 const psa_key_attributes_t *attributes,
2888 const uint8_t *key_buffer, size_t key_buffer_size,
2889 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2890 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002891{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002892 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002893 {
Ronald Cron4501c982021-03-19 20:09:32 +01002894 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2895 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002896 {
Ronald Cron4501c982021-03-19 20:09:32 +01002897#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2898 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2899 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002900 attributes,
2901 key_buffer, key_buffer_size,
2902 alg, hash, hash_length,
2903 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002904#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2905 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002906 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002907 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002908 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002909 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002910 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002911 }
2912 else
Ronald Cron4501c982021-03-19 20:09:32 +01002913 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2914 {
2915 if( PSA_ALG_IS_ECDSA( alg ) )
2916 {
2917#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2918 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2919 return( mbedtls_psa_ecdsa_sign_hash(
2920 attributes,
2921 key_buffer, key_buffer_size,
2922 alg, hash, hash_length,
2923 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002924#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2925 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002926 }
2927 else
2928 {
2929 return( PSA_ERROR_INVALID_ARGUMENT );
2930 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002931 }
Ronald Cron4501c982021-03-19 20:09:32 +01002932
2933 (void)key_buffer;
2934 (void)key_buffer_size;
2935 (void)hash;
2936 (void)hash_length;
2937 (void)signature;
2938 (void)signature_size;
2939 (void)signature_length;
2940
2941 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002942}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002943
2944psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2945 psa_algorithm_t alg,
2946 const uint8_t *hash,
2947 size_t hash_length,
2948 uint8_t *signature,
2949 size_t signature_size,
2950 size_t *signature_length )
2951{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002952 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002953 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002954 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002955}
2956
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002957psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002958 const psa_key_attributes_t *attributes,
2959 const uint8_t *key_buffer, size_t key_buffer_size,
2960 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2961 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002962{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002963 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002964 {
Ronald Cron4501c982021-03-19 20:09:32 +01002965 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2966 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002967 {
Ronald Cron4501c982021-03-19 20:09:32 +01002968#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2969 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2970 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002971 attributes,
2972 key_buffer, key_buffer_size,
2973 alg, hash, hash_length,
2974 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002975#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2976 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002977 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002978 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002979 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002980 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002981 }
itayzafrir5c753392018-05-08 11:18:38 +03002982 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002983 else
Ronald Cron4501c982021-03-19 20:09:32 +01002984 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002985 {
Ronald Cron4501c982021-03-19 20:09:32 +01002986 if( PSA_ALG_IS_ECDSA( alg ) )
2987 {
2988#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2989 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2990 return( mbedtls_psa_ecdsa_verify_hash(
2991 attributes,
2992 key_buffer, key_buffer_size,
2993 alg, hash, hash_length,
2994 signature, signature_length ) );
2995#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2996 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2997 }
2998 else
2999 {
3000 return( PSA_ERROR_INVALID_ARGUMENT );
3001 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003002 }
Ronald Cron4501c982021-03-19 20:09:32 +01003003
3004 (void)key_buffer;
3005 (void)key_buffer_size;
3006 (void)hash;
3007 (void)hash_length;
3008 (void)signature;
3009 (void)signature_length;
3010
3011 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003012}
3013
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003014psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3015 psa_algorithm_t alg,
3016 const uint8_t *hash,
3017 size_t hash_length,
3018 const uint8_t *signature,
3019 size_t signature_length )
3020{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003021 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003022 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003023 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003024}
3025
John Durkop0e005192020-10-31 22:06:54 -07003026#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02003027static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3028 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02003029{
3030 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3031 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3032 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02003033
3034 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02003035}
John Durkop0e005192020-10-31 22:06:54 -07003036#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003037
Ronald Croncf56a0a2020-08-04 09:51:30 +02003038psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003039 psa_algorithm_t alg,
3040 const uint8_t *input,
3041 size_t input_length,
3042 const uint8_t *salt,
3043 size_t salt_length,
3044 uint8_t *output,
3045 size_t output_size,
3046 size_t *output_length )
3047{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003048 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003049 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003050 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003051
Darryl Green5cc689a2018-07-24 15:34:10 +01003052 (void) input;
3053 (void) input_length;
3054 (void) salt;
3055 (void) output;
3056 (void) output_size;
3057
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003058 *output_length = 0;
3059
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003060 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3061 return( PSA_ERROR_INVALID_ARGUMENT );
3062
Ronald Cron5c522922020-11-14 16:35:34 +01003063 status = psa_get_and_lock_transparent_key_slot_with_policy(
3064 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003065 if( status != PSA_SUCCESS )
3066 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003067 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3068 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003069 {
3070 status = PSA_ERROR_INVALID_ARGUMENT;
3071 goto exit;
3072 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003073
John Durkop6ba40d12020-11-10 08:50:04 -08003074#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3075 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003076 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003077 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003078 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003079 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3080 slot->key.data,
3081 slot->key.bytes,
3082 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003083 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003084 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003085
3086 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003087 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003088 status = PSA_ERROR_BUFFER_TOO_SMALL;
3089 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003090 }
John Durkop0e005192020-10-31 22:06:54 -07003091#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003092 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3093 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003094 status = mbedtls_to_psa_error(
3095 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003096 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003097 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003098 input_length,
3099 input,
3100 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101 }
3102 else
John Durkop0e005192020-10-31 22:06:54 -07003103#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3104#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3106 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003107 status = mbedtls_to_psa_error(
3108 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3109 if( status != PSA_SUCCESS )
3110 goto rsa_exit;
3111
Steven Cooreman4fed4552020-08-03 14:46:03 +02003112 status = mbedtls_to_psa_error(
3113 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003114 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003115 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003116 salt, salt_length,
3117 input_length,
3118 input,
3119 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120 }
3121 else
John Durkop0e005192020-10-31 22:06:54 -07003122#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003123 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003124 status = PSA_ERROR_INVALID_ARGUMENT;
3125 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003127rsa_exit:
3128 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003129 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003130
Steven Cooremana2371e52020-07-28 14:30:39 +02003131 mbedtls_rsa_free( rsa );
3132 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003134 else
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) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003137 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003138 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003140
3141exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003142 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003143
Ronald Cron5c522922020-11-14 16:35:34 +01003144 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003145}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003146
Ronald Croncf56a0a2020-08-04 09:51:30 +02003147psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003148 psa_algorithm_t alg,
3149 const uint8_t *input,
3150 size_t input_length,
3151 const uint8_t *salt,
3152 size_t salt_length,
3153 uint8_t *output,
3154 size_t output_size,
3155 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003157 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003158 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003159 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003160
Darryl Green5cc689a2018-07-24 15:34:10 +01003161 (void) input;
3162 (void) input_length;
3163 (void) salt;
3164 (void) output;
3165 (void) output_size;
3166
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003167 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003169 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3170 return( PSA_ERROR_INVALID_ARGUMENT );
3171
Ronald Cron5c522922020-11-14 16:35:34 +01003172 status = psa_get_and_lock_transparent_key_slot_with_policy(
3173 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003174 if( status != PSA_SUCCESS )
3175 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003176 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003177 {
3178 status = PSA_ERROR_INVALID_ARGUMENT;
3179 goto exit;
3180 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181
John Durkop6ba40d12020-11-10 08:50:04 -08003182#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3183 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
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 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003186 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003187 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3188 slot->key.data,
3189 slot->key.bytes,
3190 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003191 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003192 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003193
Steven Cooremana2371e52020-07-28 14:30:39 +02003194 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003195 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003196 status = PSA_ERROR_INVALID_ARGUMENT;
3197 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003198 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003199
John Durkop0e005192020-10-31 22:06:54 -07003200#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003201 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003202 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003203 status = mbedtls_to_psa_error(
3204 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003205 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003206 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003207 output_length,
3208 input,
3209 output,
3210 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211 }
3212 else
John Durkop0e005192020-10-31 22:06:54 -07003213#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3214#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003215 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003216 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003217 status = mbedtls_to_psa_error(
3218 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3219 if( status != PSA_SUCCESS )
3220 goto rsa_exit;
3221
Steven Cooreman4fed4552020-08-03 14:46:03 +02003222 status = mbedtls_to_psa_error(
3223 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003224 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003225 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003226 salt, salt_length,
3227 output_length,
3228 input,
3229 output,
3230 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003231 }
3232 else
John Durkop0e005192020-10-31 22:06:54 -07003233#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003234 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003235 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003236 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003237
Steven Cooreman4fed4552020-08-03 14:46:03 +02003238rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003239 mbedtls_rsa_free( rsa );
3240 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003241 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003242 else
John Durkop6ba40d12020-11-10 08:50:04 -08003243#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3244 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003246 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003247 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003248
3249exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003250 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003251
Ronald Cron5c522922020-11-14 16:35:34 +01003252 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003253}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003254
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003255
3256
mohammad1603503973b2018-03-12 15:59:30 +02003257/****************************************************************/
3258/* Symmetric cryptography */
3259/****************************************************************/
3260
Ronald Cronab99ac22020-10-01 16:38:28 +02003261static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3262 mbedtls_svc_key_id_t key,
3263 psa_algorithm_t alg,
3264 mbedtls_operation_t cipher_operation )
3265{
3266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3267 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003268 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003269 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3270 PSA_KEY_USAGE_ENCRYPT :
3271 PSA_KEY_USAGE_DECRYPT );
3272
3273 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003274 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003275 {
Dave Rodgman54648242021-06-24 11:49:45 +01003276 status = PSA_ERROR_BAD_STATE;
3277 goto exit;
3278 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003279
Ronald Cronab99ac22020-10-01 16:38:28 +02003280 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003281 {
Dave Rodgman54648242021-06-24 11:49:45 +01003282 status = PSA_ERROR_INVALID_ARGUMENT;
3283 goto exit;
3284 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003285
Ronald Cronab99ac22020-10-01 16:38:28 +02003286 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3287 if( status != PSA_SUCCESS )
3288 goto exit;
3289
Ronald Cron49fafa92021-03-10 08:34:23 +01003290 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003291 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003292 * so we only set it (in the driver wrapper) after resources have been
3293 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003294 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003295 if( alg == PSA_ALG_ECB_NO_PADDING )
3296 operation->iv_required = 0;
3297 else
3298 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003299 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003300
Ronald Crona4af55f2020-12-14 14:36:06 +01003301 psa_key_attributes_t attributes = {
3302 .core = slot->attr
3303 };
3304
Ronald Cronab99ac22020-10-01 16:38:28 +02003305 /* Try doing the operation through a driver before using software fallback. */
3306 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003307 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3308 &attributes,
3309 slot->key.data,
3310 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003311 alg );
3312 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003313 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3314 &attributes,
3315 slot->key.data,
3316 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003317 alg );
3318
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003319exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003320 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003321 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003322
Ronald Cron5c522922020-11-14 16:35:34 +01003323 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003324
Ronald Cron5c522922020-11-14 16:35:34 +01003325 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003326}
3327
Gilles Peskinefe119512018-07-08 21:39:34 +02003328psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003329 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003330 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003331{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003332 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003333}
3334
Gilles Peskinefe119512018-07-08 21:39:34 +02003335psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003336 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003337 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003338{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003339 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003340}
3341
Gilles Peskinefe119512018-07-08 21:39:34 +02003342psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003343 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003344 size_t iv_size,
3345 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003346{
Ronald Cron6d051732020-10-01 14:10:20 +02003347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003348
Ronald Cron5618a392021-03-26 09:52:26 +01003349 *iv_length = 0;
3350
Ronald Cron49fafa92021-03-10 08:34:23 +01003351 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003352 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003353 status = PSA_ERROR_BAD_STATE;
3354 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003355 }
3356
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 if( operation->iv_set || ! operation->iv_required )
3358 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003359 status = PSA_ERROR_BAD_STATE;
3360 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003361 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003362
Ronald Cron5618a392021-03-26 09:52:26 +01003363 if( iv_size < operation->default_iv_length )
3364 {
3365 status = PSA_ERROR_BUFFER_TOO_SMALL;
3366 goto exit;
3367 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003368
Ronald Cron5618a392021-03-26 09:52:26 +01003369 status = psa_generate_random( iv, operation->default_iv_length );
3370 if( status != PSA_SUCCESS )
3371 goto exit;
3372
3373 status = psa_driver_wrapper_cipher_set_iv( operation,
3374 iv,
3375 operation->default_iv_length );
3376
3377exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003379 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003380 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003381 *iv_length = operation->default_iv_length;
3382 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003383 else
Moran Peker395db872018-05-31 14:07:14 +03003384 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003385
itayzafrir534bd7c2018-08-02 13:56:32 +03003386 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003387}
3388
Gilles Peskinefe119512018-07-08 21:39:34 +02003389psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003390 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003391 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003392{
Ronald Cron6d051732020-10-01 14:10:20 +02003393 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003394
Ronald Cron49fafa92021-03-10 08:34:23 +01003395 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003396 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003397 status = PSA_ERROR_BAD_STATE;
3398 goto exit;
3399 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003400
Steven Cooreman7df02922020-09-09 15:28:49 +02003401 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003402 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003403 status = PSA_ERROR_BAD_STATE;
3404 goto exit;
3405 }
Ronald Crona0d68172021-03-26 10:15:08 +01003406
3407 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003408 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003409 status = PSA_ERROR_INVALID_ARGUMENT;
3410 goto exit;
3411 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003412
Ronald Crondd24c9b2020-12-15 14:10:01 +01003413 status = psa_driver_wrapper_cipher_set_iv( operation,
3414 iv,
3415 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003416
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003417exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003418 if( status == PSA_SUCCESS )
3419 operation->iv_set = 1;
3420 else
mohammad1603503973b2018-03-12 15:59:30 +02003421 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003422 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003423}
3424
Gilles Peskinee553c652018-06-04 16:22:46 +02003425psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3426 const uint8_t *input,
3427 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003428 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003429 size_t output_size,
3430 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003431{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003432 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003433
Ronald Cron49fafa92021-03-10 08:34:23 +01003434 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003435 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003436 status = PSA_ERROR_BAD_STATE;
3437 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003438 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003439
Steven Cooreman7df02922020-09-09 15:28:49 +02003440 if( operation->iv_required && ! operation->iv_set )
3441 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003442 status = PSA_ERROR_BAD_STATE;
3443 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003444 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003445
Ronald Crondd24c9b2020-12-15 14:10:01 +01003446 status = psa_driver_wrapper_cipher_update( operation,
3447 input,
3448 input_length,
3449 output,
3450 output_size,
3451 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003452
3453exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003454 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003455 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003456
itayzafrir534bd7c2018-08-02 13:56:32 +03003457 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003458}
3459
Gilles Peskinee553c652018-06-04 16:22:46 +02003460psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3461 uint8_t *output,
3462 size_t output_size,
3463 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003464{
David Saadab4ecc272019-02-14 13:48:10 +02003465 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003466
Ronald Cron49fafa92021-03-10 08:34:23 +01003467 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003468 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003469 status = PSA_ERROR_BAD_STATE;
3470 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003471 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003472
Steven Cooreman7df02922020-09-09 15:28:49 +02003473 if( operation->iv_required && ! operation->iv_set )
3474 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003475 status = PSA_ERROR_BAD_STATE;
3476 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003477 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003478
Ronald Crondd24c9b2020-12-15 14:10:01 +01003479 status = psa_driver_wrapper_cipher_finish( operation,
3480 output,
3481 output_size,
3482 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003483
3484exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003485 if( status == PSA_SUCCESS )
3486 return( psa_cipher_abort( operation ) );
3487 else
3488 {
3489 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003490 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003491
Steven Cooremanef8575e2020-09-11 11:44:50 +02003492 return( status );
3493 }
mohammad1603503973b2018-03-12 15:59:30 +02003494}
3495
Gilles Peskinee553c652018-06-04 16:22:46 +02003496psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3497{
Ronald Cron49fafa92021-03-10 08:34:23 +01003498 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003499 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003500 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003501 * in use. It's ok to call abort on such an object, and there's
3502 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003503 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003504 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003505
Ronald Crondd24c9b2020-12-15 14:10:01 +01003506 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003507
Ronald Cron49fafa92021-03-10 08:34:23 +01003508 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003509 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003510 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003511
Moran Peker395db872018-05-31 14:07:14 +03003512 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003513}
3514
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003515psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3516 psa_algorithm_t alg,
3517 const uint8_t *input,
3518 size_t input_length,
3519 uint8_t *output,
3520 size_t output_size,
3521 size_t *output_length )
3522{
3523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003524 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3525 psa_key_slot_t *slot;
3526 psa_key_type_t key_type;
3527 size_t iv_length;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003528
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003529 *output_length = 0;
3530
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003531 if( ! PSA_ALG_IS_CIPHER( alg ) )
3532 return( PSA_ERROR_INVALID_ARGUMENT );
3533
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003534 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3535 PSA_KEY_USAGE_ENCRYPT,
3536 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003537 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003538 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003539
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003540 psa_key_attributes_t attributes = {
3541 .core = slot->attr
3542 };
3543
3544 key_type = slot->attr.type;
3545 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3546
3547 if( iv_length > 0 )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003548 {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003549 if( output_size < iv_length )
3550 {
3551 status = PSA_ERROR_BUFFER_TOO_SMALL;
3552 goto exit;
3553 }
3554
3555 status = psa_generate_random( output, iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003556 if( status != PSA_SUCCESS )
3557 goto exit;
3558 }
3559
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003560 status = psa_driver_wrapper_cipher_encrypt(
3561 &attributes, slot->key.data, slot->key.bytes,
3562 alg, input, input_length,
3563 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003564
3565exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003566 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003567
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003568 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003569}
3570
3571psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3572 psa_algorithm_t alg,
3573 const uint8_t *input,
3574 size_t input_length,
3575 uint8_t *output,
3576 size_t output_size,
3577 size_t *output_length )
3578{
3579 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003580 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3581 psa_key_slot_t *slot;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003582
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003583 *output_length = 0;
3584
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003585 if( ! PSA_ALG_IS_CIPHER( alg ) )
3586 return( PSA_ERROR_INVALID_ARGUMENT );
3587
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003588 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3589 PSA_KEY_USAGE_DECRYPT,
3590 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003591 if( status != PSA_SUCCESS )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003592 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003593
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003594 psa_key_attributes_t attributes = {
3595 .core = slot->attr
3596 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003597
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003598 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3599 {
3600 status = PSA_ERROR_INVALID_ARGUMENT;
3601 goto exit;
3602 }
3603 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003604 {
3605 status = PSA_ERROR_INVALID_ARGUMENT;
3606 goto exit;
3607 }
3608
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003609 status = psa_driver_wrapper_cipher_decrypt(
3610 &attributes, slot->key.data, slot->key.bytes,
3611 alg, input, input_length,
3612 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003613
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003614exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003615 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003616
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003617 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003618}
3619
3620
mohammad16035955c982018-04-26 00:53:03 +03003621/****************************************************************/
3622/* AEAD */
3623/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003624
Paul Elliottbaff51c2021-09-28 17:44:45 +01003625/* Helper function to get the base algorithm from its variants. */
3626static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3627{
3628 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3629}
3630
3631/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003632static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3633 size_t nonce_length )
3634{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003635 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3636
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003637 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003638 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003639#if defined(PSA_WANT_ALG_GCM)
3640 case PSA_ALG_GCM:
3641 /* Not checking max nonce size here as GCM spec allows almost
3642 * arbitrarily large nonces. Please note that we do not generally
3643 * recommend the usage of nonces of greater length than
3644 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3645 * size, which can then lead to collisions if you encrypt a very
3646 * large number of messages.*/
3647 if( nonce_length != 0 )
3648 return( PSA_SUCCESS );
3649 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003650#endif /* PSA_WANT_ALG_GCM */
3651#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003652 case PSA_ALG_CCM:
3653 if( nonce_length >= 7 && nonce_length <= 13 )
3654 return( PSA_SUCCESS );
3655 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003656#endif /* PSA_WANT_ALG_CCM */
3657#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003658 case PSA_ALG_CHACHA20_POLY1305:
3659 if( nonce_length == 12 )
3660 return( PSA_SUCCESS );
3661 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003662#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003663 default:
3664 break;
3665 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003666
Paul Elliott60116ae2021-09-29 14:19:11 +01003667 return( PSA_ERROR_NOT_SUPPORTED );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003668}
3669
Ronald Croncf56a0a2020-08-04 09:51:30 +02003670psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003671 psa_algorithm_t alg,
3672 const uint8_t *nonce,
3673 size_t nonce_length,
3674 const uint8_t *additional_data,
3675 size_t additional_data_length,
3676 const uint8_t *plaintext,
3677 size_t plaintext_length,
3678 uint8_t *ciphertext,
3679 size_t ciphertext_size,
3680 size_t *ciphertext_length )
3681{
Ronald Cron215633c2021-03-16 17:15:37 +01003682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3683 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003684
mohammad1603f08a5502018-06-03 15:05:47 +03003685 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003686
Steven Cooremanea7ab132021-03-17 16:28:00 +01003687 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3688 return( PSA_ERROR_NOT_SUPPORTED );
3689
Ronald Cron9a986162021-03-26 12:40:07 +01003690 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003691 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003692 if( status != PSA_SUCCESS )
3693 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003694
Ronald Cron215633c2021-03-16 17:15:37 +01003695 psa_key_attributes_t attributes = {
3696 .core = slot->attr
3697 };
mohammad16035955c982018-04-26 00:53:03 +03003698
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003699 status = psa_aead_check_nonce_length( alg, nonce_length );
3700 if( status != PSA_SUCCESS )
3701 goto exit;
3702
Ronald Cronde822812021-03-17 16:08:20 +01003703 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003704 &attributes, slot->key.data, slot->key.bytes,
3705 alg,
3706 nonce, nonce_length,
3707 additional_data, additional_data_length,
3708 plaintext, plaintext_length,
3709 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003710
Gilles Peskineedf9a652018-08-17 18:11:56 +02003711 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3712 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003713
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003714exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003715 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003716
mohammad16035955c982018-04-26 00:53:03 +03003717 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003718}
3719
Ronald Croncf56a0a2020-08-04 09:51:30 +02003720psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003721 psa_algorithm_t alg,
3722 const uint8_t *nonce,
3723 size_t nonce_length,
3724 const uint8_t *additional_data,
3725 size_t additional_data_length,
3726 const uint8_t *ciphertext,
3727 size_t ciphertext_length,
3728 uint8_t *plaintext,
3729 size_t plaintext_size,
3730 size_t *plaintext_length )
3731{
Ronald Cron215633c2021-03-16 17:15:37 +01003732 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3733 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003734
Gilles Peskineee652a32018-06-01 19:23:52 +02003735 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003736
Steven Cooremanea7ab132021-03-17 16:28:00 +01003737 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3738 return( PSA_ERROR_NOT_SUPPORTED );
3739
Ronald Cron9a986162021-03-26 12:40:07 +01003740 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003741 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003742 if( status != PSA_SUCCESS )
3743 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003744
Ronald Cron215633c2021-03-16 17:15:37 +01003745 psa_key_attributes_t attributes = {
3746 .core = slot->attr
3747 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003748
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003749 status = psa_aead_check_nonce_length( alg, nonce_length );
3750 if( status != PSA_SUCCESS )
3751 goto exit;
3752
Ronald Cronde822812021-03-17 16:08:20 +01003753 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003754 &attributes, slot->key.data, slot->key.bytes,
3755 alg,
3756 nonce, nonce_length,
3757 additional_data, additional_data_length,
3758 ciphertext, ciphertext_length,
3759 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003760
Gilles Peskineedf9a652018-08-17 18:11:56 +02003761 if( status != PSA_SUCCESS && plaintext_size != 0 )
3762 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003763
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003764exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003765 psa_unlock_key_slot( slot );
3766
Gilles Peskineedf9a652018-08-17 18:11:56 +02003767 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003768}
3769
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003770/* Set the key for a multipart authenticated operation. */
3771static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003772 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003773 mbedtls_svc_key_id_t key,
3774 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003775{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003776 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3777 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3778 psa_key_slot_t *slot = NULL;
3779 psa_key_usage_t key_usage = 0;
3780
Paul Elliottc2b71442021-06-24 18:17:52 +01003781 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3782 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003783 status = PSA_ERROR_INVALID_ARGUMENT;
3784 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003785 }
3786
3787 if( operation->id != 0 )
3788 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003789 status = PSA_ERROR_BAD_STATE;
3790 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003791 }
3792
3793 if( operation->nonce_set || operation->lengths_set ||
3794 operation->ad_started || operation->body_started )
3795 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003796 status = PSA_ERROR_BAD_STATE;
3797 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003798 }
3799
Paul Elliottd9343f22021-08-23 18:59:49 +01003800 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003801 key_usage = PSA_KEY_USAGE_ENCRYPT;
3802 else
3803 key_usage = PSA_KEY_USAGE_DECRYPT;
3804
3805 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3806 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003807 if( status != PSA_SUCCESS )
3808 goto exit;
3809
3810 psa_key_attributes_t attributes = {
3811 .core = slot->attr
3812 };
3813
Paul Elliottd9343f22021-08-23 18:59:49 +01003814 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003815 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3816 &attributes,
3817 slot->key.data,
3818 slot->key.bytes,
3819 alg );
3820 else
3821 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3822 &attributes,
3823 slot->key.data,
3824 slot->key.bytes,
3825 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003826 if( status != PSA_SUCCESS )
3827 goto exit;
3828
3829 operation->key_type = psa_get_key_type( &attributes );
3830
3831exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003832 unlock_status = psa_unlock_key_slot( slot );
3833
3834 if( status == PSA_SUCCESS )
3835 {
3836 status = unlock_status;
3837 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003838 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003839 }
3840 else
3841 psa_aead_abort( operation );
3842
3843 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003844}
3845
Paul Elliott302ff6b2021-04-20 18:10:30 +01003846/* Set the key for a multipart authenticated encryption operation. */
3847psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3848 mbedtls_svc_key_id_t key,
3849 psa_algorithm_t alg )
3850{
Paul Elliottd9343f22021-08-23 18:59:49 +01003851 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003852}
3853
3854/* Set the key for a multipart authenticated decryption operation. */
3855psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3856 mbedtls_svc_key_id_t key,
3857 psa_algorithm_t alg )
3858{
Paul Elliottd9343f22021-08-23 18:59:49 +01003859 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003860}
3861
3862/* Generate a random nonce / IV for multipart AEAD operation */
3863psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3864 uint8_t *nonce,
3865 size_t nonce_size,
3866 size_t *nonce_length )
3867{
3868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottb91da712021-05-20 14:43:47 +01003869 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003870
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003871 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003872
Paul Elliottcee785c2021-05-20 14:29:20 +01003873 if( operation->id == 0 )
3874 {
3875 status = PSA_ERROR_BAD_STATE;
3876 goto exit;
3877 }
3878
Paul Elliottdaf5c892021-08-25 16:24:58 +01003879 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003880 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003881 status = PSA_ERROR_BAD_STATE;
3882 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003883 }
3884
Paul Elliottbbe90b52021-05-11 22:22:42 +01003885 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003886 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003887 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003888 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003889 status = PSA_ERROR_BUFFER_TOO_SMALL;
3890 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003891 }
3892
3893 status = psa_generate_random( nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003894 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003895 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003896
Paul Elliott95271f12021-06-23 16:50:45 +01003897 status = psa_aead_set_nonce( operation, nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003898
Paul Elliott39dc6b82021-05-11 19:16:09 +01003899exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003900 if( status == PSA_SUCCESS )
3901 *nonce_length = required_nonce_size;
3902 else
3903 psa_aead_abort( operation );
3904
3905 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003906}
3907
3908/* Set the nonce for a multipart authenticated encryption or decryption
3909 operation.*/
3910psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3911 const uint8_t *nonce,
3912 size_t nonce_length )
3913{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003914 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3915
Paul Elliottcee785c2021-05-20 14:29:20 +01003916 if( operation->id == 0 )
3917 {
3918 status = PSA_ERROR_BAD_STATE;
3919 goto exit;
3920 }
3921
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003922 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003923 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003924 status = PSA_ERROR_BAD_STATE;
3925 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003926 }
3927
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003928 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003929 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003930 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003931 status = PSA_ERROR_INVALID_ARGUMENT;
3932 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003933 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003934
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003935 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3936 nonce_length );
3937
Paul Elliott39dc6b82021-05-11 19:16:09 +01003938exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003939 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003940 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003941 else
3942 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003943
3944 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003945}
3946
3947/* Declare the lengths of the message and additional data for multipart AEAD. */
3948psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3949 size_t ad_length,
3950 size_t plaintext_length )
3951{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003952 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3953
Paul Elliottcee785c2021-05-20 14:29:20 +01003954 if( operation->id == 0 )
3955 {
3956 status = PSA_ERROR_BAD_STATE;
3957 goto exit;
3958 }
3959
Paul Elliott6eb95982021-05-21 17:41:41 +01003960 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003961 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003962 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003963 status = PSA_ERROR_BAD_STATE;
3964 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003965 }
3966
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003967 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003968 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003969#if defined(PSA_WANT_ALG_GCM)
3970 case PSA_ALG_GCM:
3971 /* Lengths can only be too large for GCM if size_t is bigger than 32
3972 * bits. Without the guard this code will generate warnings on 32bit
3973 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003974#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003975 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3976 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3977 {
3978 status = PSA_ERROR_INVALID_ARGUMENT;
3979 goto exit;
3980 }
Paul Elliott325d3742021-09-27 17:56:28 +01003981#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003982 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003983#endif /* PSA_WANT_ALG_GCM */
3984#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003985 case PSA_ALG_CCM:
3986 if( ad_length > 0xFF00 )
3987 {
3988 status = PSA_ERROR_INVALID_ARGUMENT;
3989 goto exit;
3990 }
3991 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003992#endif /* PSA_WANT_ALG_CCM */
3993#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003994 case PSA_ALG_CHACHA20_POLY1305:
3995 /* No length restrictions for ChaChaPoly. */
3996 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003997#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003998 default:
3999 break;
4000 }
Paul Elliott325d3742021-09-27 17:56:28 +01004001
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004002 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
4003 plaintext_length );
4004
Paul Elliott39dc6b82021-05-11 19:16:09 +01004005exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004006 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004007 {
4008 operation->ad_remaining = ad_length;
4009 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004010 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01004011 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004012 else
4013 psa_aead_abort( operation );
4014
4015 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004016}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004017
4018/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004019psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4020 const uint8_t *input,
4021 size_t input_length )
4022{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004023 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4024
Paul Elliottcee785c2021-05-20 14:29:20 +01004025 if( operation->id == 0 )
4026 {
4027 status = PSA_ERROR_BAD_STATE;
4028 goto exit;
4029 }
4030
Paul Elliott6eb95982021-05-21 17:41:41 +01004031 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004032 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004033 status = PSA_ERROR_BAD_STATE;
4034 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004035 }
4036
Paul Elliottee4ffe02021-05-20 17:25:06 +01004037 if( operation->lengths_set )
4038 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004039 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004040 {
4041 status = PSA_ERROR_INVALID_ARGUMENT;
4042 goto exit;
4043 }
4044
4045 operation->ad_remaining -= input_length;
4046 }
4047
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004048 status = psa_driver_wrapper_aead_update_ad( operation, input,
4049 input_length );
4050
Paul Elliott39dc6b82021-05-11 19:16:09 +01004051exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004052 if( status == PSA_SUCCESS )
4053 operation->ad_started = 1;
4054 else
4055 psa_aead_abort( operation );
4056
4057 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004058}
4059
4060/* Encrypt or decrypt a message fragment in an active multipart AEAD
4061 operation.*/
4062psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4063 const uint8_t *input,
4064 size_t input_length,
4065 uint8_t *output,
4066 size_t output_size,
4067 size_t *output_length )
4068{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004069 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004070
4071 *output_length = 0;
4072
Paul Elliottcee785c2021-05-20 14:29:20 +01004073 if( operation->id == 0 )
4074 {
4075 status = PSA_ERROR_BAD_STATE;
4076 goto exit;
4077 }
4078
Paul Elliott6eb95982021-05-21 17:41:41 +01004079 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004080 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004081 status = PSA_ERROR_BAD_STATE;
4082 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004083 }
4084
Paul Elliottee4ffe02021-05-20 17:25:06 +01004085 if( operation->lengths_set )
4086 {
4087 /* Additional data length was supplied, but not all the additional
4088 data was supplied.*/
4089 if( operation->ad_remaining != 0 )
4090 {
4091 status = PSA_ERROR_INVALID_ARGUMENT;
4092 goto exit;
4093 }
4094
4095 /* Too much data provided. */
4096 if( operation->body_remaining < input_length )
4097 {
4098 status = PSA_ERROR_INVALID_ARGUMENT;
4099 goto exit;
4100 }
4101
4102 operation->body_remaining -= input_length;
4103 }
4104
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004105 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4106 output, output_size,
4107 output_length );
4108
Paul Elliott39dc6b82021-05-11 19:16:09 +01004109exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004110 if( status == PSA_SUCCESS )
4111 operation->body_started = 1;
4112 else
4113 psa_aead_abort( operation );
4114
4115 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004116}
4117
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004118static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004119{
Paul Elliott7f429b72021-06-24 18:08:54 +01004120 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004121 return( PSA_ERROR_BAD_STATE );
4122
Paul Elliotta5614442021-07-14 14:54:11 +01004123 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004124 operation->body_remaining != 0 ) )
4125 return( PSA_ERROR_INVALID_ARGUMENT );
4126
4127 return( PSA_SUCCESS );
4128}
4129
Paul Elliott302ff6b2021-04-20 18:10:30 +01004130/* Finish encrypting a message in a multipart AEAD operation. */
4131psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4132 uint8_t *ciphertext,
4133 size_t ciphertext_size,
4134 size_t *ciphertext_length,
4135 uint8_t *tag,
4136 size_t tag_size,
4137 size_t *tag_length )
4138{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4140
Paul Elliott302ff6b2021-04-20 18:10:30 +01004141 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004142 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004143
Paul Elliott814fffb2021-08-16 18:20:36 +01004144 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004145 if( status != PSA_SUCCESS )
4146 goto exit;
4147
Paul Elliott7f429b72021-06-24 18:08:54 +01004148 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004149 {
4150 status = PSA_ERROR_BAD_STATE;
4151 goto exit;
4152 }
4153
Paul Elliott39dc6b82021-05-11 19:16:09 +01004154 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4155 ciphertext_size,
4156 ciphertext_length,
4157 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004158
Paul Elliott39dc6b82021-05-11 19:16:09 +01004159exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004160 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004161 * the zero tag size, make sure the tag is set to something implausible.
4162 * Even if the operation succeeds, make sure we clear the rest of the
4163 * buffer to prevent potential leakage of anything previously placed in
4164 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004165 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004166 {
4167 if( status != PSA_SUCCESS )
4168 memset( tag, '!', tag_size );
4169 else if( *tag_length < tag_size )
4170 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4171 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004172
Paul Elliott39dc6b82021-05-11 19:16:09 +01004173 psa_aead_abort( operation );
4174
4175 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004176}
4177
4178/* Finish authenticating and decrypting a message in a multipart AEAD
4179 operation.*/
4180psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4181 uint8_t *plaintext,
4182 size_t plaintext_size,
4183 size_t *plaintext_length,
4184 const uint8_t *tag,
4185 size_t tag_length )
4186{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004187 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4188
Paul Elliott302ff6b2021-04-20 18:10:30 +01004189 *plaintext_length = 0;
4190
Paul Elliott814fffb2021-08-16 18:20:36 +01004191 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004192 if( status != PSA_SUCCESS )
4193 goto exit;
4194
Paul Elliott7f429b72021-06-24 18:08:54 +01004195 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004196 {
4197 status = PSA_ERROR_BAD_STATE;
4198 goto exit;
4199 }
4200
Paul Elliott39dc6b82021-05-11 19:16:09 +01004201 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4202 plaintext_size,
4203 plaintext_length,
4204 tag, tag_length );
4205
4206exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004207 psa_aead_abort( operation );
4208
4209 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004210}
4211
4212/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004213psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004214{
4215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4216
4217 if( operation->id == 0 )
4218 {
4219 /* The object has (apparently) been initialized but it is not (yet)
4220 * in use. It's ok to call abort on such an object, and there's
4221 * nothing to do. */
4222 return( PSA_SUCCESS );
4223 }
4224
4225 status = psa_driver_wrapper_aead_abort( operation );
4226
Paul Elliott70618b22021-09-22 17:12:16 +01004227 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004228
4229 return( status );
4230}
4231
Gilles Peskinee59236f2018-01-27 23:32:46 +01004232/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004233/* Generators */
4234/****************************************************************/
4235
John Durkop07cc04a2020-11-16 22:08:34 -08004236#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4237 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4238 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4239#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004240#endif /* At least one builtin KDF */
4241
4242#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4243 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4244 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4245static psa_status_t psa_key_derivation_start_hmac(
4246 psa_mac_operation_t *operation,
4247 psa_algorithm_t hash_alg,
4248 const uint8_t *hmac_key,
4249 size_t hmac_key_length )
4250{
4251 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4252 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4253 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4254 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4255 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4256
Steven Cooreman72f736a2021-05-07 14:14:37 +02004257 operation->is_sign = 1;
4258 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4259
Steven Cooreman094a77e2021-05-06 17:58:36 +02004260 status = psa_driver_wrapper_mac_sign_setup( operation,
4261 &attributes,
4262 hmac_key, hmac_key_length,
4263 PSA_ALG_HMAC( hash_alg ) );
4264
4265 psa_reset_key_attributes( &attributes );
4266 return( status );
4267}
4268#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004269
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004270#define HKDF_STATE_INIT 0 /* no input yet */
4271#define HKDF_STATE_STARTED 1 /* got salt */
4272#define HKDF_STATE_KEYED 2 /* got key */
4273#define HKDF_STATE_OUTPUT 3 /* output started */
4274
Gilles Peskinecbe66502019-05-16 16:59:18 +02004275static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004276 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004277{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004278 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4279 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004280 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004281 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004282}
4283
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004284psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004285{
4286 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004287 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004288 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004289 {
4290 /* The object has (apparently) been initialized but it is not
4291 * in use. It's ok to call abort on such an object, and there's
4292 * nothing to do. */
4293 }
4294 else
John Durkopd0321952020-10-29 21:37:36 -07004295#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004296 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004297 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004298 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004299 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004300 }
John Durkop07cc04a2020-11-16 22:08:34 -08004301 else
4302#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4303#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4304 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4305 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004306 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004307 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004308 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004309 if( operation->ctx.tls12_prf.secret != NULL )
4310 {
4311 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4312 operation->ctx.tls12_prf.secret_length );
4313 mbedtls_free( operation->ctx.tls12_prf.secret );
4314 }
4315
Janos Follath6a1d2622019-06-11 10:37:28 +01004316 if( operation->ctx.tls12_prf.seed != NULL )
4317 {
4318 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4319 operation->ctx.tls12_prf.seed_length );
4320 mbedtls_free( operation->ctx.tls12_prf.seed );
4321 }
4322
4323 if( operation->ctx.tls12_prf.label != NULL )
4324 {
4325 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4326 operation->ctx.tls12_prf.label_length );
4327 mbedtls_free( operation->ctx.tls12_prf.label );
4328 }
4329
Steven Cooremana6df6042021-04-29 19:32:25 +02004330 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004331
4332 /* We leave the fields Ai and output_block to be erased safely by the
4333 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004334 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004335 else
John Durkop07cc04a2020-11-16 22:08:34 -08004336#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4337 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004338 {
4339 status = PSA_ERROR_BAD_STATE;
4340 }
Janos Follath083036a2019-06-11 10:22:26 +01004341 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004342 return( status );
4343}
4344
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004345psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004346 size_t *capacity)
4347{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004348 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004349 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004350 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004351 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004352 }
4353
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004354 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004355 return( PSA_SUCCESS );
4356}
4357
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004358psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004359 size_t capacity )
4360{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004361 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004362 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004363 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004364 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004365 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004366 return( PSA_SUCCESS );
4367}
4368
John Durkopd0321952020-10-29 21:37:36 -07004369#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004370/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004371 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004372static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004373 psa_algorithm_t hash_alg,
4374 uint8_t *output,
4375 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004376{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004377 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004378 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004379 psa_status_t status;
4380
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004381 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4382 return( PSA_ERROR_BAD_STATE );
4383 hkdf->state = HKDF_STATE_OUTPUT;
4384
Gilles Peskinebef7f142018-07-12 17:22:21 +02004385 while( output_length != 0 )
4386 {
4387 /* Copy what remains of the current block */
4388 uint8_t n = hash_length - hkdf->offset_in_block;
4389 if( n > output_length )
4390 n = (uint8_t) output_length;
4391 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4392 output += n;
4393 output_length -= n;
4394 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004395 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004396 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004397 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004398 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004399 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004400 * object was corrupted or if this function is called directly
4401 * inside the library. */
4402 if( hkdf->block_number == 0xff )
4403 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004404
4405 /* We need a new block */
4406 ++hkdf->block_number;
4407 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004408
Steven Cooreman094a77e2021-05-06 17:58:36 +02004409 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4410 hash_alg,
4411 hkdf->prk,
4412 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004413 if( status != PSA_SUCCESS )
4414 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004415
Gilles Peskinebef7f142018-07-12 17:22:21 +02004416 if( hkdf->block_number != 1 )
4417 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004418 status = psa_mac_update( &hkdf->hmac,
4419 hkdf->output_block,
4420 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004421 if( status != PSA_SUCCESS )
4422 return( status );
4423 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004424 status = psa_mac_update( &hkdf->hmac,
4425 hkdf->info,
4426 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004427 if( status != PSA_SUCCESS )
4428 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004429 status = psa_mac_update( &hkdf->hmac,
4430 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004431 if( status != PSA_SUCCESS )
4432 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004433 status = psa_mac_sign_finish( &hkdf->hmac,
4434 hkdf->output_block,
4435 sizeof( hkdf->output_block ),
4436 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004437 if( status != PSA_SUCCESS )
4438 return( status );
4439 }
4440
4441 return( PSA_SUCCESS );
4442}
John Durkop07cc04a2020-11-16 22:08:34 -08004443#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004444
John Durkop07cc04a2020-11-16 22:08:34 -08004445#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4446 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004447static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4448 psa_tls12_prf_key_derivation_t *tls12_prf,
4449 psa_algorithm_t alg )
4450{
4451 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004452 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004453 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4454 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004455 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004456
Janos Follath7742fee2019-06-17 12:58:10 +01004457 /* We can't be wanting more output after block 0xff, otherwise
4458 * the capacity check in psa_key_derivation_output_bytes() would have
4459 * prevented this call. It could happen only if the operation
4460 * object was corrupted or if this function is called directly
4461 * inside the library. */
4462 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004463 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004464
4465 /* We need a new block */
4466 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004467 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004468
4469 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4470 *
4471 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4472 *
4473 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4474 * HMAC_hash(secret, A(2) + seed) +
4475 * HMAC_hash(secret, A(3) + seed) + ...
4476 *
4477 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004478 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004479 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004480 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004481 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004482 * is currently extracted as `output_block` and where i is
4483 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004484 */
4485
Steven Cooreman094a77e2021-05-06 17:58:36 +02004486 status = psa_key_derivation_start_hmac( &hmac,
4487 hash_alg,
4488 tls12_prf->secret,
4489 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004490 if( status != PSA_SUCCESS )
4491 goto cleanup;
4492
4493 /* Calculate A(i) where i = tls12_prf->block_number. */
4494 if( tls12_prf->block_number == 1 )
4495 {
4496 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4497 * the variable seed and in this instance means it in the context of the
4498 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004499 status = psa_mac_update( &hmac,
4500 tls12_prf->label,
4501 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004502 if( status != PSA_SUCCESS )
4503 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004504 status = psa_mac_update( &hmac,
4505 tls12_prf->seed,
4506 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004507 if( status != PSA_SUCCESS )
4508 goto cleanup;
4509 }
4510 else
4511 {
4512 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004513 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004514 if( status != PSA_SUCCESS )
4515 goto cleanup;
4516 }
4517
Steven Cooremana6df6042021-04-29 19:32:25 +02004518 status = psa_mac_sign_finish( &hmac,
4519 tls12_prf->Ai, hash_length,
4520 &hmac_output_length );
4521 if( hmac_output_length != hash_length )
4522 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004523 if( status != PSA_SUCCESS )
4524 goto cleanup;
4525
4526 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004527 status = psa_key_derivation_start_hmac( &hmac,
4528 hash_alg,
4529 tls12_prf->secret,
4530 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004531 if( status != PSA_SUCCESS )
4532 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004533 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004534 if( status != PSA_SUCCESS )
4535 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004536 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004537 if( status != PSA_SUCCESS )
4538 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004539 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004540 if( status != PSA_SUCCESS )
4541 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004542 status = psa_mac_sign_finish( &hmac,
4543 tls12_prf->output_block, hash_length,
4544 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004545 if( status != PSA_SUCCESS )
4546 goto cleanup;
4547
Janos Follath7742fee2019-06-17 12:58:10 +01004548
4549cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004550 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004551 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4552 status = cleanup_status;
4553
4554 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004555}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004556
Janos Follath844eb0e2019-06-19 12:10:49 +01004557static psa_status_t psa_key_derivation_tls12_prf_read(
4558 psa_tls12_prf_key_derivation_t *tls12_prf,
4559 psa_algorithm_t alg,
4560 uint8_t *output,
4561 size_t output_length )
4562{
4563 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004564 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004565 psa_status_t status;
4566 uint8_t offset, length;
4567
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004568 switch( tls12_prf->state )
4569 {
4570 case PSA_TLS12_PRF_STATE_LABEL_SET:
4571 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4572 break;
4573 case PSA_TLS12_PRF_STATE_OUTPUT:
4574 break;
4575 default:
4576 return( PSA_ERROR_BAD_STATE );
4577 }
4578
Janos Follath844eb0e2019-06-19 12:10:49 +01004579 while( output_length != 0 )
4580 {
4581 /* Check if we have fully processed the current block. */
4582 if( tls12_prf->left_in_block == 0 )
4583 {
4584 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4585 alg );
4586 if( status != PSA_SUCCESS )
4587 return( status );
4588
4589 continue;
4590 }
4591
4592 if( tls12_prf->left_in_block > output_length )
4593 length = (uint8_t) output_length;
4594 else
4595 length = tls12_prf->left_in_block;
4596
4597 offset = hash_length - tls12_prf->left_in_block;
4598 memcpy( output, tls12_prf->output_block + offset, length );
4599 output += length;
4600 output_length -= length;
4601 tls12_prf->left_in_block -= length;
4602 }
4603
4604 return( PSA_SUCCESS );
4605}
John Durkop07cc04a2020-11-16 22:08:34 -08004606#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4607 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004608
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004609psa_status_t psa_key_derivation_output_bytes(
4610 psa_key_derivation_operation_t *operation,
4611 uint8_t *output,
4612 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004613{
4614 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004615 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004616
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004617 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004618 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004619 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004620 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004621 }
4622
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004623 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004624 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004625 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004626 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004627 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004628 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004629 goto exit;
4630 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004631 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004632 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004633 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004634 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004635 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4636 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004637 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004638 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004639 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004640 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004641 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004642
John Durkopd0321952020-10-29 21:37:36 -07004643#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004644 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004645 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004646 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004647 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004648 output, output_length );
4649 }
Janos Follathadbec812019-06-14 11:05:39 +01004650 else
John Durkop07cc04a2020-11-16 22:08:34 -08004651#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4652#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4653 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004654 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004655 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004656 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004657 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004658 kdf_alg, output,
4659 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004660 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004661 else
John Durkop07cc04a2020-11-16 22:08:34 -08004662#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4663 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004664 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004665 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004666 return( PSA_ERROR_BAD_STATE );
4667 }
4668
4669exit:
4670 if( status != PSA_SUCCESS )
4671 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004672 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004673 * This allows us to differentiate between exhausted operations and
4674 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4675 * operations. */
4676 psa_algorithm_t alg = operation->alg;
4677 psa_key_derivation_abort( operation );
4678 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004679 memset( output, '!', output_length );
4680 }
4681 return( status );
4682}
4683
David Brown7807bf72021-02-09 16:28:23 -07004684#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004685static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4686{
4687 if( data_size >= 8 )
4688 mbedtls_des_key_set_parity( data );
4689 if( data_size >= 16 )
4690 mbedtls_des_key_set_parity( data + 8 );
4691 if( data_size >= 24 )
4692 mbedtls_des_key_set_parity( data + 16 );
4693}
David Brown7807bf72021-02-09 16:28:23 -07004694#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004695
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004696static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004697 psa_key_slot_t *slot,
4698 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004699 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004700{
4701 uint8_t *data = NULL;
4702 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304703 size_t storage_size = bytes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004704 psa_status_t status;
4705
Gilles Peskine8e338702019-07-30 20:06:31 +02004706 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004707 return( PSA_ERROR_INVALID_ARGUMENT );
4708 if( bits % 8 != 0 )
4709 return( PSA_ERROR_INVALID_ARGUMENT );
4710 data = mbedtls_calloc( 1, bytes );
4711 if( data == NULL )
4712 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4713
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004714 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004715 if( status != PSA_SUCCESS )
4716 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004717#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004718 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004719 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004720#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004721
Ronald Cronbf33c932020-11-28 18:06:53 +01004722 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004723 psa_key_attributes_t attributes = {
4724 .core = slot->attr
4725 };
4726
Archanad8a83dc2021-06-14 10:04:16 +05304727 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4728 {
Archana449608b2021-09-08 15:36:05 +05304729 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4730 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304731 if( status != PSA_SUCCESS )
4732 goto exit;
4733 }
4734 status = psa_allocate_buffer_to_slot( slot, storage_size );
4735 if( status != PSA_SUCCESS )
4736 goto exit;
4737
Ronald Cronbf33c932020-11-28 18:06:53 +01004738 status = psa_driver_wrapper_import_key( &attributes,
4739 data, bytes,
4740 slot->key.data,
4741 slot->key.bytes,
4742 &slot->key.bytes, &bits );
4743 if( bits != slot->attr.bits )
4744 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004745
4746exit:
4747 mbedtls_free( data );
4748 return( status );
4749}
4750
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004751psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004752 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004753 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004754{
4755 psa_status_t status;
4756 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004757 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004758
Ronald Cron81709fc2020-11-14 12:10:32 +01004759 *key = MBEDTLS_SVC_KEY_ID_INIT;
4760
Gilles Peskine0f84d622019-09-12 19:03:13 +02004761 /* Reject any attempt to create a zero-length key so that we don't
4762 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4763 if( psa_get_key_bits( attributes ) == 0 )
4764 return( PSA_ERROR_INVALID_ARGUMENT );
4765
Dave Rodgmand69da6c2021-11-16 10:32:48 +00004766 if( operation->alg == PSA_ALG_NONE )
4767 return( PSA_ERROR_BAD_STATE );
4768
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004769 if( ! operation->can_output_key )
4770 return( PSA_ERROR_NOT_PERMITTED );
4771
Ronald Cron81709fc2020-11-14 12:10:32 +01004772 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4773 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004774#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4775 if( driver != NULL )
4776 {
4777 /* Deriving a key in a secure element is not implemented yet. */
4778 status = PSA_ERROR_NOT_SUPPORTED;
4779 }
4780#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004781 if( status == PSA_SUCCESS )
4782 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004783 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004784 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004785 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004786 }
4787 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004788 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004789 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004790 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004791
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004792 return( status );
4793}
4794
Gilles Peskineeab56e42018-07-12 17:12:33 +02004795
4796
4797/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004798/* Key derivation */
4799/****************************************************************/
4800
Steven Cooreman932ffb72021-02-15 12:14:32 +01004801#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004802static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004803 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004804 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004805{
John Durkop07cc04a2020-11-16 22:08:34 -08004806 int is_kdf_alg_supported;
4807
Janos Follath5fe19732019-06-20 15:09:30 +01004808 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4809 * initialisers for this union leave some bytes unspecified.) */
4810 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4811
Gilles Peskine969c5d62019-01-16 15:53:06 +01004812 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004813#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004814 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4815 is_kdf_alg_supported = 1;
4816 else
4817#endif
4818#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4819 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4820 is_kdf_alg_supported = 1;
4821 else
4822#endif
4823#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4824 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4825 is_kdf_alg_supported = 1;
4826 else
4827#endif
4828 is_kdf_alg_supported = 0;
4829
4830 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004831 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004832 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004833 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004834 if( hash_size == 0 )
4835 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004836 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4837 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004838 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004839 {
4840 return( PSA_ERROR_NOT_SUPPORTED );
4841 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004842 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004843 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004844 }
John Durkop07cc04a2020-11-16 22:08:34 -08004845
4846 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004847}
John Durkop07cc04a2020-11-16 22:08:34 -08004848#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004849
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004850psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004851 psa_algorithm_t alg )
4852{
4853 psa_status_t status;
4854
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004855 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004856 return( PSA_ERROR_BAD_STATE );
4857
Gilles Peskine6843c292019-01-18 16:44:49 +01004858 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4859 return( PSA_ERROR_INVALID_ARGUMENT );
4860 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004861 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004862#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004863 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004864 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004865#else
4866 return( PSA_ERROR_NOT_SUPPORTED );
4867#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004868 }
4869 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4870 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004871#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004872 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004873#else
4874 return( PSA_ERROR_NOT_SUPPORTED );
4875#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004876 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004877 else
4878 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004879
4880 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004881 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004882 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004883}
4884
John Durkopd0321952020-10-29 21:37:36 -07004885#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004886static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004887 psa_algorithm_t hash_alg,
4888 psa_key_derivation_step_t step,
4889 const uint8_t *data,
4890 size_t data_length )
4891{
4892 psa_status_t status;
4893 switch( step )
4894 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004895 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004896 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004897 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004898 else
4899 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004900 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4901 hash_alg,
4902 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004903 if( status != PSA_SUCCESS )
4904 return( status );
4905 hkdf->state = HKDF_STATE_STARTED;
4906 return( PSA_SUCCESS );
4907 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004908 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004909 /* If no salt was provided, use an empty salt. */
4910 if( hkdf->state == HKDF_STATE_INIT )
4911 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004912 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4913 hash_alg,
4914 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004915 if( status != PSA_SUCCESS )
4916 return( status );
4917 hkdf->state = HKDF_STATE_STARTED;
4918 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004919 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004920 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004921 status = psa_mac_update( &hkdf->hmac,
4922 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004923 if( status != PSA_SUCCESS )
4924 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004925 status = psa_mac_sign_finish( &hkdf->hmac,
4926 hkdf->prk,
4927 sizeof( hkdf->prk ),
4928 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004929 if( status != PSA_SUCCESS )
4930 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004931 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004932 hkdf->block_number = 0;
4933 hkdf->state = HKDF_STATE_KEYED;
4934 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004935 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004936 if( hkdf->state == HKDF_STATE_OUTPUT )
4937 return( PSA_ERROR_BAD_STATE );
4938 if( hkdf->info_set )
4939 return( PSA_ERROR_BAD_STATE );
4940 hkdf->info_length = data_length;
4941 if( data_length != 0 )
4942 {
4943 hkdf->info = mbedtls_calloc( 1, data_length );
4944 if( hkdf->info == NULL )
4945 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4946 memcpy( hkdf->info, data, data_length );
4947 }
4948 hkdf->info_set = 1;
4949 return( PSA_SUCCESS );
4950 default:
4951 return( PSA_ERROR_INVALID_ARGUMENT );
4952 }
4953}
John Durkop07cc04a2020-11-16 22:08:34 -08004954#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004955
John Durkop07cc04a2020-11-16 22:08:34 -08004956#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4957 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004958static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4959 const uint8_t *data,
4960 size_t data_length )
4961{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004962 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004963 return( PSA_ERROR_BAD_STATE );
4964
Janos Follathd6dce9f2019-07-04 09:11:38 +01004965 if( data_length != 0 )
4966 {
4967 prf->seed = mbedtls_calloc( 1, data_length );
4968 if( prf->seed == NULL )
4969 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004970
Janos Follathd6dce9f2019-07-04 09:11:38 +01004971 memcpy( prf->seed, data, data_length );
4972 prf->seed_length = data_length;
4973 }
Janos Follathf08e2652019-06-13 09:05:41 +01004974
Gilles Peskine43f958b2020-12-13 14:55:14 +01004975 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004976
4977 return( PSA_SUCCESS );
4978}
4979
Janos Follath81550542019-06-13 14:26:34 +01004980static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004981 const uint8_t *data,
4982 size_t data_length )
4983{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004984 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004985 return( PSA_ERROR_BAD_STATE );
4986
Steven Cooremana6df6042021-04-29 19:32:25 +02004987 if( data_length != 0 )
4988 {
4989 prf->secret = mbedtls_calloc( 1, data_length );
4990 if( prf->secret == NULL )
4991 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4992
4993 memcpy( prf->secret, data, data_length );
4994 prf->secret_length = data_length;
4995 }
Janos Follath81550542019-06-13 14:26:34 +01004996
Gilles Peskine43f958b2020-12-13 14:55:14 +01004997 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004998
4999 return( PSA_SUCCESS );
5000}
5001
Janos Follath63028dd2019-06-13 09:15:47 +01005002static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5003 const uint8_t *data,
5004 size_t data_length )
5005{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005006 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005007 return( PSA_ERROR_BAD_STATE );
5008
Janos Follathd6dce9f2019-07-04 09:11:38 +01005009 if( data_length != 0 )
5010 {
5011 prf->label = mbedtls_calloc( 1, data_length );
5012 if( prf->label == NULL )
5013 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005014
Janos Follathd6dce9f2019-07-04 09:11:38 +01005015 memcpy( prf->label, data, data_length );
5016 prf->label_length = data_length;
5017 }
Janos Follath63028dd2019-06-13 09:15:47 +01005018
Gilles Peskine43f958b2020-12-13 14:55:14 +01005019 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005020
5021 return( PSA_SUCCESS );
5022}
5023
Janos Follathb03233e2019-06-11 15:30:30 +01005024static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005025 psa_key_derivation_step_t step,
5026 const uint8_t *data,
5027 size_t data_length )
5028{
Janos Follathb03233e2019-06-11 15:30:30 +01005029 switch( step )
5030 {
Janos Follathf08e2652019-06-13 09:05:41 +01005031 case PSA_KEY_DERIVATION_INPUT_SEED:
5032 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005033 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005034 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005035 case PSA_KEY_DERIVATION_INPUT_LABEL:
5036 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005037 default:
5038 return( PSA_ERROR_INVALID_ARGUMENT );
5039 }
5040}
John Durkop07cc04a2020-11-16 22:08:34 -08005041#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5042 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5043
5044#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5045static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5046 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005047 const uint8_t *data,
5048 size_t data_length )
5049{
5050 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005051 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005052 uint8_t *cur = pms;
5053
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005054 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005055 return( PSA_ERROR_INVALID_ARGUMENT );
5056
5057 /* Quoting RFC 4279, Section 2:
5058 *
5059 * The premaster secret is formed as follows: if the PSK is N octets
5060 * long, concatenate a uint16 with the value N, N zero octets, a second
5061 * uint16 with the value N, and the PSK itself.
5062 */
5063
Joe Subbiani5ecac212021-06-24 13:00:03 +01005064 *cur++ = MBEDTLS_BYTE_1( data_length );
5065 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005066 memset( cur, 0, data_length );
5067 cur += data_length;
5068 *cur++ = pms[0];
5069 *cur++ = pms[1];
5070 memcpy( cur, data, data_length );
5071 cur += data_length;
5072
Steven Cooremana6df6042021-04-29 19:32:25 +02005073 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005074
5075 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5076 return( status );
5077}
Janos Follath6660f0e2019-06-17 08:44:03 +01005078
5079static psa_status_t psa_tls12_prf_psk_to_ms_input(
5080 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005081 psa_key_derivation_step_t step,
5082 const uint8_t *data,
5083 size_t data_length )
5084{
5085 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005086 {
Steven Cooremana6df6042021-04-29 19:32:25 +02005087 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005088 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005089 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005090
Steven Cooremana6df6042021-04-29 19:32:25 +02005091 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01005092}
John Durkop07cc04a2020-11-16 22:08:34 -08005093#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005094
Gilles Peskineb8965192019-09-24 16:21:10 +02005095/** Check whether the given key type is acceptable for the given
5096 * input step of a key derivation.
5097 *
5098 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5099 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5100 * Both secret and non-secret inputs can alternatively have the type
5101 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5102 * that the input was passed as a buffer rather than via a key object.
5103 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005104static int psa_key_derivation_check_input_type(
5105 psa_key_derivation_step_t step,
5106 psa_key_type_t key_type )
5107{
5108 switch( step )
5109 {
5110 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005111 if( key_type == PSA_KEY_TYPE_DERIVE )
5112 return( PSA_SUCCESS );
5113 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005114 return( PSA_SUCCESS );
5115 break;
5116 case PSA_KEY_DERIVATION_INPUT_LABEL:
5117 case PSA_KEY_DERIVATION_INPUT_SALT:
5118 case PSA_KEY_DERIVATION_INPUT_INFO:
5119 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005120 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5121 return( PSA_SUCCESS );
5122 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005123 return( PSA_SUCCESS );
5124 break;
5125 }
5126 return( PSA_ERROR_INVALID_ARGUMENT );
5127}
5128
Janos Follathb80a94e2019-06-12 15:54:46 +01005129static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005130 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005131 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005132 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005133 const uint8_t *data,
5134 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005135{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005136 psa_status_t status;
5137 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5138
5139 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005140 if( status != PSA_SUCCESS )
5141 goto exit;
5142
John Durkopd0321952020-10-29 21:37:36 -07005143#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005144 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005145 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005146 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005147 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005148 step, data, data_length );
5149 }
John Durkop07cc04a2020-11-16 22:08:34 -08005150 else
5151#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5152#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5153 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005154 {
Janos Follathb03233e2019-06-11 15:30:30 +01005155 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005156 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005157 }
John Durkop07cc04a2020-11-16 22:08:34 -08005158 else
5159#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5160#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5161 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005162 {
5163 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005164 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005165 }
5166 else
John Durkop07cc04a2020-11-16 22:08:34 -08005167#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005168 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005169 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005170 (void) data;
5171 (void) data_length;
5172 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005173 return( PSA_ERROR_BAD_STATE );
5174 }
5175
Gilles Peskine224b0d62019-09-23 18:13:17 +02005176exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005177 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005178 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005179 return( status );
5180}
5181
Janos Follath51f4a0f2019-06-14 11:35:55 +01005182psa_status_t psa_key_derivation_input_bytes(
5183 psa_key_derivation_operation_t *operation,
5184 psa_key_derivation_step_t step,
5185 const uint8_t *data,
5186 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005187{
Gilles Peskineb8965192019-09-24 16:21:10 +02005188 return( psa_key_derivation_input_internal( operation, step,
5189 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005190 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005191}
5192
Janos Follath51f4a0f2019-06-14 11:35:55 +01005193psa_status_t psa_key_derivation_input_key(
5194 psa_key_derivation_operation_t *operation,
5195 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005196 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005197{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005198 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005199 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005200 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005201
Ronald Cron5c522922020-11-14 16:35:34 +01005202 status = psa_get_and_lock_transparent_key_slot_with_policy(
5203 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005204 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005205 {
5206 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005207 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005208 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005209
5210 /* Passing a key object as a SECRET input unlocks the permission
5211 * to output to a key object. */
5212 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5213 operation->can_output_key = 1;
5214
Ronald Cronf95a2b12020-10-22 15:24:49 +02005215 status = psa_key_derivation_input_internal( operation,
5216 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005217 slot->key.data,
5218 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005219
Ronald Cron5c522922020-11-14 16:35:34 +01005220 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005221
Ronald Cron5c522922020-11-14 16:35:34 +01005222 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005223}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005224
5225
5226
5227/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005228/* Key agreement */
5229/****************************************************************/
5230
John Durkop6ba40d12020-11-10 08:50:04 -08005231#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005232static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5233 size_t peer_key_length,
5234 const mbedtls_ecp_keypair *our_key,
5235 uint8_t *shared_secret,
5236 size_t shared_secret_size,
5237 size_t *shared_secret_length )
5238{
Steven Cooremand4867872020-08-05 16:31:39 +02005239 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005240 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005241 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005242 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005243 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005244 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005245
Ronald Cron90857082020-11-25 14:58:33 +01005246 status = mbedtls_psa_ecp_load_representation(
5247 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005248 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005249 peer_key,
5250 peer_key_length,
5251 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005252 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005253 goto exit;
5254
Jaeden Amero97271b32019-01-10 19:38:51 +00005255 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005256 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005257 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005258 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005259 status = mbedtls_to_psa_error(
5260 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5261 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005262 goto exit;
5263
Jaeden Amero97271b32019-01-10 19:38:51 +00005264 status = mbedtls_to_psa_error(
5265 mbedtls_ecdh_calc_secret( &ecdh,
5266 shared_secret_length,
5267 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005268 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005269 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005270 if( status != PSA_SUCCESS )
5271 goto exit;
5272 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5273 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005274
5275exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005276 if( status != PSA_SUCCESS )
5277 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005278 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005279 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005280 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005281
Jaeden Amero97271b32019-01-10 19:38:51 +00005282 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005283}
John Durkop6ba40d12020-11-10 08:50:04 -08005284#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005285
Gilles Peskine01d718c2018-09-18 12:01:02 +02005286#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5287
Gilles Peskine0216fe12019-04-11 21:23:21 +02005288static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5289 psa_key_slot_t *private_key,
5290 const uint8_t *peer_key,
5291 size_t peer_key_length,
5292 uint8_t *shared_secret,
5293 size_t shared_secret_size,
5294 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005295{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005296 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005297 {
John Durkop6ba40d12020-11-10 08:50:04 -08005298#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005299 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005300 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005301 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005302 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005303 psa_status_t status = mbedtls_psa_ecp_load_representation(
5304 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005305 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005306 private_key->key.data,
5307 private_key->key.bytes,
5308 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005309 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005310 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005311 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005312 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005313 shared_secret, shared_secret_size,
5314 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005315 mbedtls_ecp_keypair_free( ecp );
5316 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005317 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005318#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005319 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005320 (void) private_key;
5321 (void) peer_key;
5322 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005323 (void) shared_secret;
5324 (void) shared_secret_size;
5325 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005326 return( PSA_ERROR_NOT_SUPPORTED );
5327 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005328}
5329
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005330/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005331 * to potentially free embedded data structures and wipe confidential data.
5332 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005333static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005334 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005335 psa_key_slot_t *private_key,
5336 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005337 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005338{
5339 psa_status_t status;
5340 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5341 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005342 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005343
5344 /* Step 1: run the secret agreement algorithm to generate the shared
5345 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005346 status = psa_key_agreement_raw_internal( ka_alg,
5347 private_key,
5348 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005349 shared_secret,
5350 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005351 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005352 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005353 goto exit;
5354
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005355 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005356 * the shared secret. A shared secret is permitted wherever a key
5357 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005358 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005359 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005360 shared_secret,
5361 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005362exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005363 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005364 return( status );
5365}
5366
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005367psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005368 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005369 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005370 const uint8_t *peer_key,
5371 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005372{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005374 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005375 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005376
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005377 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005378 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005379 status = psa_get_and_lock_transparent_key_slot_with_policy(
5380 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005381 if( status != PSA_SUCCESS )
5382 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005383 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005384 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005385 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005386 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005387 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005388 else
5389 {
5390 /* If a private key has been added as SECRET, we allow the derived
5391 * key material to be used as a key in PSA Crypto. */
5392 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5393 operation->can_output_key = 1;
5394 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005395
Ronald Cron5c522922020-11-14 16:35:34 +01005396 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005397
Ronald Cron5c522922020-11-14 16:35:34 +01005398 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005399}
5400
Gilles Peskinebe697d82019-05-16 18:00:41 +02005401psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005402 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005403 const uint8_t *peer_key,
5404 size_t peer_key_length,
5405 uint8_t *output,
5406 size_t output_size,
5407 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005408{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005409 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005410 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005411 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005412
5413 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5414 {
5415 status = PSA_ERROR_INVALID_ARGUMENT;
5416 goto exit;
5417 }
Ronald Cron5c522922020-11-14 16:35:34 +01005418 status = psa_get_and_lock_transparent_key_slot_with_policy(
5419 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005420 if( status != PSA_SUCCESS )
5421 goto exit;
5422
5423 status = psa_key_agreement_raw_internal( alg, slot,
5424 peer_key, peer_key_length,
5425 output, output_size,
5426 output_length );
5427
5428exit:
5429 if( status != PSA_SUCCESS )
5430 {
5431 /* If an error happens and is not handled properly, the output
5432 * may be used as a key to protect sensitive data. Arrange for such
5433 * a key to be random, which is likely to result in decryption or
5434 * verification errors. This is better than filling the buffer with
5435 * some constant data such as zeros, which would result in the data
5436 * being protected with a reproducible, easily knowable key.
5437 */
5438 psa_generate_random( output, output_size );
5439 *output_length = output_size;
5440 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005441
Ronald Cron5c522922020-11-14 16:35:34 +01005442 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005443
Ronald Cron5c522922020-11-14 16:35:34 +01005444 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005445}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005446
5447
Gilles Peskine30524eb2020-11-13 17:02:26 +01005448
Gilles Peskine86a440b2018-11-12 18:39:40 +01005449/****************************************************************/
5450/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005451/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005452
Gilles Peskine30524eb2020-11-13 17:02:26 +01005453/** Initialize the PSA random generator.
5454 */
5455static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5456{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005457#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5458 memset( rng, 0, sizeof( *rng ) );
5459#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5460
Gilles Peskine30524eb2020-11-13 17:02:26 +01005461 /* Set default configuration if
5462 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5463 if( rng->entropy_init == NULL )
5464 rng->entropy_init = mbedtls_entropy_init;
5465 if( rng->entropy_free == NULL )
5466 rng->entropy_free = mbedtls_entropy_free;
5467
5468 rng->entropy_init( &rng->entropy );
5469#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5470 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5471 /* The PSA entropy injection feature depends on using NV seed as an entropy
5472 * source. Add NV seed as an entropy source for PSA entropy injection. */
5473 mbedtls_entropy_add_source( &rng->entropy,
5474 mbedtls_nv_seed_poll, NULL,
5475 MBEDTLS_ENTROPY_BLOCK_SIZE,
5476 MBEDTLS_ENTROPY_SOURCE_STRONG );
5477#endif
5478
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005479 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005480#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005481}
5482
5483/** Deinitialize the PSA random generator.
5484 */
5485static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5486{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005487#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5488 memset( rng, 0, sizeof( *rng ) );
5489#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005490 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005491 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005492#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005493}
5494
5495/** Seed the PSA random generator.
5496 */
5497static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5498{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005499#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5500 /* Do nothing: the external RNG seeds itself. */
5501 (void) rng;
5502 return( PSA_SUCCESS );
5503#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005504 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005505 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5506 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005507 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005508#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005509}
5510
Gilles Peskinee59236f2018-01-27 23:32:46 +01005511psa_status_t psa_generate_random( uint8_t *output,
5512 size_t output_size )
5513{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005514 GUARD_MODULE_INITIALIZED;
5515
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005516#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5517
5518 size_t output_length = 0;
5519 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5520 output, output_size,
5521 &output_length );
5522 if( status != PSA_SUCCESS )
5523 return( status );
5524 /* Breaking up a request into smaller chunks is currently not supported
5525 * for the extrernal RNG interface. */
5526 if( output_length != output_size )
5527 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5528 return( PSA_SUCCESS );
5529
5530#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5531
Gilles Peskine71ddab92021-01-04 21:01:07 +01005532 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005533 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005534 size_t request_size =
5535 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5536 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5537 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005538 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5539 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005540 if( ret != 0 )
5541 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005542 output_size -= request_size;
5543 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005544 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005545 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005546#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005547}
5548
Gilles Peskine8814fc42020-12-14 15:33:44 +01005549/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005550 *
5551 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5552 * `psa_generate_random(...)`. The state parameter is ignored since the
5553 * PSA API doesn't support passing an explicit state.
5554 *
5555 * In the non-external case, psa_generate_random() calls an
5556 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5557 * and semantics as mbedtls_psa_get_random(). As an optimization,
5558 * instead of doing this back-and-forth between the PSA API and the
5559 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5560 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005561 */
5562#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5563int mbedtls_psa_get_random( void *p_rng,
5564 unsigned char *output,
5565 size_t output_size )
5566{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005567 /* This function takes a pointer to the RNG state because that's what
5568 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5569 * its own state internally and doesn't let the caller access that state.
5570 * So we just ignore the state parameter, and in practice we'll pass
5571 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005572 (void) p_rng;
5573 psa_status_t status = psa_generate_random( output, output_size );
5574 if( status == PSA_SUCCESS )
5575 return( 0 );
5576 else
5577 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5578}
5579#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5580
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005581#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005582#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005583
Gilles Peskine7228da22019-07-15 11:06:15 +02005584psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005585 size_t seed_size )
5586{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005587 if( global_data.initialized )
5588 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005589
5590 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5591 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5592 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5593 return( PSA_ERROR_INVALID_ARGUMENT );
5594
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005595 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005596}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005597#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005598
Ronald Cron3772afe2021-02-08 16:10:05 +01005599/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005600 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005601 * \param type The key type
5602 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005603 *
5604 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005605 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005606 * \retval #PSA_ERROR_INVALID_ARGUMENT
5607 * The size in bits of the key is not valid.
5608 * \retval #PSA_ERROR_NOT_SUPPORTED
5609 * The type and/or the size in bits of the key or the combination of
5610 * the two is not supported.
5611 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005612static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5613 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005614{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005616
Gilles Peskinee59236f2018-01-27 23:32:46 +01005617 if( key_type_is_raw_bytes( type ) )
5618 {
Archana4d7ae1d2021-07-07 02:50:22 +05305619 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005620 if( status != PSA_SUCCESS )
5621 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005622 }
5623 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005624#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005625 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5626 {
5627 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5628 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005629
Ronald Cron01b2aba2020-10-05 09:42:02 +02005630 /* Accept only byte-aligned keys, for the same reasons as
5631 * in psa_import_rsa_key(). */
5632 if( bits % 8 != 0 )
5633 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005634 }
5635 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005636#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005637
Ronald Cron5c4d3862020-12-07 11:07:24 +01005638#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005639 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5640 {
Ronald Crond81ab562021-02-16 09:01:16 +01005641 /* To avoid empty block, return successfully here. */
5642 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005643 }
5644 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005645#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005646 {
5647 return( PSA_ERROR_NOT_SUPPORTED );
5648 }
5649
5650 return( PSA_SUCCESS );
5651}
5652
Ronald Cron55ed0592020-10-05 10:30:40 +02005653psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005654 const psa_key_attributes_t *attributes,
5655 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005656{
5657 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005658 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005659
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005660 if( ( attributes->domain_parameters == NULL ) &&
5661 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005662 return( PSA_ERROR_INVALID_ARGUMENT );
5663
Ronald Cron01b2aba2020-10-05 09:42:02 +02005664 if( key_type_is_raw_bytes( type ) )
5665 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005666 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005667 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005668 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005669
David Brown12ca5032021-02-11 11:02:00 -07005670#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005671 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005672 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005673#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005674 }
5675 else
5676
Jaeden Amero424fa932021-05-14 08:34:32 +01005677#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5678 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005679 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005680 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005681 return( mbedtls_psa_rsa_generate_key( attributes,
5682 key_buffer,
5683 key_buffer_size,
5684 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005685 }
5686 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005687#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5688 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005689
John Durkop9814fa22020-11-04 12:28:15 -08005690#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005691 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005692 {
Ronald Cron7023db52020-11-20 18:17:42 +01005693 return( mbedtls_psa_ecp_generate_key( attributes,
5694 key_buffer,
5695 key_buffer_size,
5696 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005697 }
5698 else
John Durkop9814fa22020-11-04 12:28:15 -08005699#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005700 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005701 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005702 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005703 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005704
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005705 return( PSA_SUCCESS );
5706}
Darryl Green0c6575a2018-11-07 16:05:30 +00005707
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005708psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005709 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005710{
5711 psa_status_t status;
5712 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005713 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005714 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005715
Ronald Cron81709fc2020-11-14 12:10:32 +01005716 *key = MBEDTLS_SVC_KEY_ID_INIT;
5717
Gilles Peskine0f84d622019-09-12 19:03:13 +02005718 /* Reject any attempt to create a zero-length key so that we don't
5719 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5720 if( psa_get_key_bits( attributes ) == 0 )
5721 return( PSA_ERROR_INVALID_ARGUMENT );
5722
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02005723 /* Reject any attempt to create a public key. */
5724 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5725 return( PSA_ERROR_INVALID_ARGUMENT );
5726
Ronald Cron81709fc2020-11-14 12:10:32 +01005727 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5728 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005729 if( status != PSA_SUCCESS )
5730 goto exit;
5731
Ronald Cron977c2472020-10-13 08:32:21 +02005732 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305733 * storage ( thus not in the case of generating a key in a secure element
5734 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5735 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005736 if( slot->key.data == NULL )
5737 {
5738 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5739 PSA_KEY_LOCATION_LOCAL_STORAGE )
5740 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005741 status = psa_validate_key_type_and_size_for_key_generation(
5742 attributes->core.type, attributes->core.bits );
5743 if( status != PSA_SUCCESS )
5744 goto exit;
5745
5746 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5747 attributes->core.type,
5748 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005749 }
5750 else
5751 {
5752 status = psa_driver_wrapper_get_key_buffer_size(
5753 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005754 if( status != PSA_SUCCESS )
5755 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005756 }
Ronald Cron977c2472020-10-13 08:32:21 +02005757
5758 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5759 if( status != PSA_SUCCESS )
5760 goto exit;
5761 }
5762
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005763 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005764 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005765
Ronald Cron2b56bc82020-10-05 10:02:26 +02005766 if( status != PSA_SUCCESS )
5767 psa_remove_key_data_from_memory( slot );
5768
Gilles Peskine11792082019-08-06 18:36:36 +02005769exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005770 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005771 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005772 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005773 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005774
Darryl Green0c6575a2018-11-07 16:05:30 +00005775 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005776}
5777
Gilles Peskinee59236f2018-01-27 23:32:46 +01005778/****************************************************************/
5779/* Module setup */
5780/****************************************************************/
5781
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005782#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005783psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5784 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5785 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5786{
5787 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5788 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005789 global_data.rng.entropy_init = entropy_init;
5790 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005791 return( PSA_SUCCESS );
5792}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005793#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005794
Gilles Peskinee59236f2018-01-27 23:32:46 +01005795void mbedtls_psa_crypto_free( void )
5796{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005797 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005798 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5799 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005800 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005801 }
5802 /* Wipe all remaining data, including configuration.
5803 * In particular, this sets all state indicator to the value
5804 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005805 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005806#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005807 /* Unregister all secure element drivers, so that we restart from
5808 * a pristine state. */
5809 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005810#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005811}
5812
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005813#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5814/** Recover a transaction that was interrupted by a power failure.
5815 *
5816 * This function is called during initialization, before psa_crypto_init()
5817 * returns. If this function returns a failure status, the initialization
5818 * fails.
5819 */
5820static psa_status_t psa_crypto_recover_transaction(
5821 const psa_crypto_transaction_t *transaction )
5822{
5823 switch( transaction->unknown.type )
5824 {
5825 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5826 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005827 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005828 * is implemented.
5829 * https://github.com/ARMmbed/mbed-crypto/issues/218
5830 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005831 default:
5832 /* We found an unsupported transaction in the storage.
5833 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005834 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005835 }
5836}
5837#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5838
Gilles Peskinee59236f2018-01-27 23:32:46 +01005839psa_status_t psa_crypto_init( void )
5840{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005841 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005842
Gilles Peskinec6b69072018-11-20 21:42:52 +01005843 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005844 if( global_data.initialized != 0 )
5845 return( PSA_SUCCESS );
5846
Gilles Peskine30524eb2020-11-13 17:02:26 +01005847 /* Initialize and seed the random generator. */
5848 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005849 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005850 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005851 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005852 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005853 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005854
Gilles Peskine66fb1262018-12-10 16:29:04 +01005855 status = psa_initialize_key_slots( );
5856 if( status != PSA_SUCCESS )
5857 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005858
Gilles Peskined9348f22019-10-01 15:22:29 +02005859#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5860 status = psa_init_all_se_drivers( );
5861 if( status != PSA_SUCCESS )
5862 goto exit;
5863#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5864
Gilles Peskine4b734222019-07-24 15:56:31 +02005865#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005866 status = psa_crypto_load_transaction( );
5867 if( status == PSA_SUCCESS )
5868 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005869 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5870 if( status != PSA_SUCCESS )
5871 goto exit;
5872 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005873 }
5874 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5875 {
5876 /* There's no transaction to complete. It's all good. */
5877 status = PSA_SUCCESS;
5878 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005879#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005880
Gilles Peskinec6b69072018-11-20 21:42:52 +01005881 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005882 global_data.initialized = 1;
5883
5884exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005885 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005886 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005887 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005888}
5889
5890#endif /* MBEDTLS_PSA_CRYPTO_C */