blob: 8416aa76ee2bebfeaae777cc08f237aeddd1a99f [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
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020055#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056#define mbedtls_calloc calloc
57#define mbedtls_free free
58#endif
59
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010060#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020061#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000062#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020063#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020065#include "mbedtls/chacha20.h"
66#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/cipher.h"
68#include "mbedtls/ccm.h"
69#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020071#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010073#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074#include "mbedtls/error.h"
75#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010077#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000078#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010079#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000080#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010081#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000082#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010083#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/sha1.h"
86#include "mbedtls/sha256.h"
87#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088
Gilles Peskine996deb12018-08-01 15:45:45 +020089#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
90
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010091/****************************************************************/
92/* Global data, support functions and library management */
93/****************************************************************/
94
Gilles Peskine48c0ea12018-06-21 14:15:31 +020095static int key_type_is_raw_bytes( psa_key_type_t type )
96{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020097 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020098}
99
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100100/* Values for psa_global_data_t::rng_state */
101#define RNG_NOT_INITIALIZED 0
102#define RNG_INITIALIZED 1
103#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100104
Gilles Peskine2d277862018-06-18 15:41:12 +0200105typedef struct
106{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100107 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100108 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100109 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100110} psa_global_data_t;
111
112static psa_global_data_t global_data;
113
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100114#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
115mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
116 &global_data.rng.drbg;
117#endif
118
itayzafrir0adf0fc2018-09-06 16:24:41 +0300119#define GUARD_MODULE_INITIALIZED \
120 if( global_data.initialized == 0 ) \
121 return( PSA_ERROR_BAD_STATE );
122
Steven Cooreman01164162020-07-20 15:31:37 +0200123psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100125 /* Mbed TLS error codes can combine a high-level error code and a
126 * low-level error code. The low-level error usually reflects the
127 * root cause better, so dispatch on that preferably. */
128 int low_level_ret = - ( -ret & 0x007f );
129 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100130 {
131 case 0:
132 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100133
134 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
135 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100136 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200137 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
138 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
139 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
140 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
141 case MBEDTLS_ERR_ASN1_INVALID_DATA:
142 return( PSA_ERROR_INVALID_ARGUMENT );
143 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
144 return( PSA_ERROR_INSUFFICIENT_MEMORY );
145 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
146 return( PSA_ERROR_BUFFER_TOO_SMALL );
147
Jaeden Amero93e21112019-02-20 13:57:28 +0000148#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000149 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000150#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100151 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
152 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100153
154 case MBEDTLS_ERR_CCM_BAD_INPUT:
155 return( PSA_ERROR_INVALID_ARGUMENT );
156 case MBEDTLS_ERR_CCM_AUTH_FAILED:
157 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100158
Gilles Peskine26869f22019-05-06 15:25:00 +0200159 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
160 return( PSA_ERROR_INVALID_ARGUMENT );
161
162 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
163 return( PSA_ERROR_BAD_STATE );
164 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
165 return( PSA_ERROR_INVALID_SIGNATURE );
166
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
170 return( PSA_ERROR_INVALID_ARGUMENT );
171 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
172 return( PSA_ERROR_INSUFFICIENT_MEMORY );
173 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
174 return( PSA_ERROR_INVALID_PADDING );
175 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200176 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
178 return( PSA_ERROR_INVALID_SIGNATURE );
179 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200180 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100181
Gilles Peskine82e57d12020-11-13 21:31:17 +0100182#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
183 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100184 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
185 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100186 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
187 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
188 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
189 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
190 return( PSA_ERROR_NOT_SUPPORTED );
191 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
192 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100193#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100194
195 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
196 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Gilles Peskinee59236f2018-01-27 23:32:46 +0100198 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
199 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
200 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
201 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100202
203 case MBEDTLS_ERR_GCM_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
205 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200206 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207
Gilles Peskine82e57d12020-11-13 21:31:17 +0100208#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
209 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100210 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
211 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100212 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
213 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
214 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
215 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
216 return( PSA_ERROR_NOT_SUPPORTED );
217 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
218 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
219#endif
220
Gilles Peskinea5905292018-02-07 20:59:33 +0100221 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
224 return( PSA_ERROR_INVALID_ARGUMENT );
225 case MBEDTLS_ERR_MD_ALLOC_FAILED:
226 return( PSA_ERROR_INSUFFICIENT_MEMORY );
227 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
228 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100229
Gilles Peskinef76aa772018-10-29 19:24:33 +0100230 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
231 return( PSA_ERROR_STORAGE_FAILURE );
232 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
233 return( PSA_ERROR_INVALID_ARGUMENT );
234 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
235 return( PSA_ERROR_INVALID_ARGUMENT );
236 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
237 return( PSA_ERROR_BUFFER_TOO_SMALL );
238 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
239 return( PSA_ERROR_INVALID_ARGUMENT );
240 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
241 return( PSA_ERROR_INVALID_ARGUMENT );
242 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
243 return( PSA_ERROR_INVALID_ARGUMENT );
244 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
245 return( PSA_ERROR_INSUFFICIENT_MEMORY );
246
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100247 case MBEDTLS_ERR_PK_ALLOC_FAILED:
248 return( PSA_ERROR_INSUFFICIENT_MEMORY );
249 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
250 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
251 return( PSA_ERROR_INVALID_ARGUMENT );
252 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100253 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100254 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
255 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
256 return( PSA_ERROR_INVALID_ARGUMENT );
257 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
258 return( PSA_ERROR_NOT_SUPPORTED );
259 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
260 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
261 return( PSA_ERROR_NOT_PERMITTED );
262 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
263 return( PSA_ERROR_INVALID_ARGUMENT );
264 case MBEDTLS_ERR_PK_INVALID_ALG:
265 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
266 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
267 return( PSA_ERROR_NOT_SUPPORTED );
268 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
269 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100270
Gilles Peskineff2d2002019-05-06 15:26:23 +0200271 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
272 return( PSA_ERROR_HARDWARE_FAILURE );
273 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
274 return( PSA_ERROR_NOT_SUPPORTED );
275
Gilles Peskinea5905292018-02-07 20:59:33 +0100276 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
277 return( PSA_ERROR_INVALID_ARGUMENT );
278 case MBEDTLS_ERR_RSA_INVALID_PADDING:
279 return( PSA_ERROR_INVALID_PADDING );
280 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
281 return( PSA_ERROR_HARDWARE_FAILURE );
282 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
283 return( PSA_ERROR_INVALID_ARGUMENT );
284 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
285 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200286 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
288 return( PSA_ERROR_INVALID_SIGNATURE );
289 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
290 return( PSA_ERROR_BUFFER_TOO_SMALL );
291 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100292 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200293
itayzafrir5c753392018-05-08 11:18:38 +0300294 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300295 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300296 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300297 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
298 return( PSA_ERROR_BUFFER_TOO_SMALL );
299 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
300 return( PSA_ERROR_NOT_SUPPORTED );
301 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
302 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
303 return( PSA_ERROR_INVALID_SIGNATURE );
304 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
305 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100306 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
307 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100308
Janos Follatha13b9052019-11-22 12:48:59 +0000309 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
310 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300311
Gilles Peskinee59236f2018-01-27 23:32:46 +0100312 default:
David Saadab4ecc272019-02-14 13:48:10 +0200313 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100314 }
315}
316
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200317
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200318
319
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100320/****************************************************************/
321/* Key management */
322/****************************************************************/
323
Gilles Peskine73167e12019-07-12 23:44:37 +0200324#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
325static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
326{
Gilles Peskine8e338702019-07-30 20:06:31 +0200327 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200328}
329#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
330
John Durkop07cc04a2020-11-16 22:08:34 -0800331/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
332 * current test driver in key_management.c is using this function
333 * when accelerators are used for ECC key pair and public key.
334 * Once that dependency is resolved these guards can be removed.
335 */
John Durkop9814fa22020-11-04 12:28:15 -0800336#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800337 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
338 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
339 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100340mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100341 size_t bits,
342 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200343{
344 switch( curve )
345 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100346 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100347 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100348 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100349#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100350 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100351 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100352#endif
353#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100354 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100355 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100356#endif
357#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100358 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100359 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100360#endif
361#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100362 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100363 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100364#endif
365#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100366 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100367 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100368 case 528:
369 if( bits_is_sloppy )
370 return( MBEDTLS_ECP_DP_SECP521R1 );
371 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100372#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 }
374 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100375
Paul Elliott8ff510a2020-06-02 17:19:28 +0100376 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100377 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100378 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100379#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100382#endif
383#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100384 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100385 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100386#endif
387#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100388 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100389 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100390#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 }
392 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100393
Paul Elliott8ff510a2020-06-02 17:19:28 +0100394 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100395 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100396 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100397#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 256:
401 if( bits_is_sloppy )
402 return( MBEDTLS_ECP_DP_CURVE25519 );
403 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100404#endif
405#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100406 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100407 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100408#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 }
410 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100411
Paul Elliott8ff510a2020-06-02 17:19:28 +0100412 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100413 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100414 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100415#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
423#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100424 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100425 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100426#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 }
428 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200429 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100431 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200433}
John Durkop9814fa22020-11-04 12:28:15 -0800434#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800435 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
436 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
437 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200438
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200439static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
440 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200441{
442 /* Check that the bit size is acceptable for the key type */
443 switch( type )
444 {
445 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200447 case PSA_KEY_TYPE_DERIVE:
448 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_AES:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_CAMELLIA:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200462 case PSA_KEY_TYPE_DES:
463 if( bits != 64 && bits != 128 && bits != 192 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100467#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200468 case PSA_KEY_TYPE_CHACHA20:
469 if( bits != 256 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 default:
474 return( PSA_ERROR_NOT_SUPPORTED );
475 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200476 if( bits % 8 != 0 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479 return( PSA_SUCCESS );
480}
481
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100482/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100483 *
Steven Cooremancd640932021-03-08 12:00:27 +0100484 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
485 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 *
487 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100488 * \param[in] key_type The key type of the key to be used with the
489 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 *
491 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100497 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100499{
Steven Cooremancd640932021-03-08 12:00:27 +0100500 if( PSA_ALG_IS_HMAC( algorithm ) )
501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 if( key_type == PSA_KEY_TYPE_HMAC )
503 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100504 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100505
506 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
509 * key. */
510 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
511 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
512 {
513 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
514 * the block length (larger than 1) for block ciphers. */
515 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
516 return( PSA_SUCCESS );
517 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100518 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100519
520 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100521}
522
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200523psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
524 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200525{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100526 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200527 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200528
Ronald Cronea0f8a62020-11-25 17:52:23 +0100529 slot->key.data = mbedtls_calloc( 1, buffer_length );
530 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200531 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200532
Ronald Cronea0f8a62020-11-25 17:52:23 +0100533 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200534 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200535}
536
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200537psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
538 const uint8_t* data,
539 size_t data_length )
540{
541 psa_status_t status = psa_allocate_buffer_to_slot( slot,
542 data_length );
543 if( status != PSA_SUCCESS )
544 return( status );
545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200547 return( PSA_SUCCESS );
548}
549
Ronald Crona0fe59f2020-11-29 11:14:53 +0100550psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100551 const psa_key_attributes_t *attributes,
552 const uint8_t *data, size_t data_length,
553 uint8_t *key_buffer, size_t key_buffer_size,
554 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100555{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
557 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559 /* zero-length keys are never supported. */
560 if( data_length == 0 )
561 return( PSA_ERROR_NOT_SUPPORTED );
562
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100563 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100564 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200566
Steven Cooreman75b74362020-07-28 14:30:13 +0200567 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
568 if( data_length > SIZE_MAX / 8 )
569 return( PSA_ERROR_NOT_SUPPORTED );
570
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200571 /* Enforce a size limit, and in particular ensure that the bit
572 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100573 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200574 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200575
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100576 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200577 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200578 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200579
Ronald Crondd04d422020-11-28 15:14:42 +0100580 /* Copy the key material. */
581 memcpy( key_buffer, data, data_length );
582 *key_buffer_length = data_length;
583 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200584
Steven Cooreman40120f62020-10-29 11:42:22 +0100585 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100586 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100587 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200588 {
John Durkop9814fa22020-11-04 12:28:15 -0800589#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
590 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100591 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200592 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 return( mbedtls_psa_ecp_import_key( attributes,
594 data, data_length,
595 key_buffer, key_buffer_size,
596 key_buffer_length,
597 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100598 }
John Durkop9814fa22020-11-04 12:28:15 -0800599#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
600 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700601#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
602 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100603 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200604 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 return( mbedtls_psa_rsa_import_key( attributes,
606 data, data_length,
607 key_buffer, key_buffer_size,
608 key_buffer_length,
609 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200610 }
John Durkop9814fa22020-11-04 12:28:15 -0800611#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
612 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100613 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100614
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100615 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100616}
617
Gilles Peskinef603c712019-01-19 13:40:11 +0100618/** Calculate the intersection of two algorithm usage policies.
619 *
620 * Return 0 (which allows no operation) on incompatibility.
621 */
622static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100623 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100624 psa_algorithm_t alg1,
625 psa_algorithm_t alg2 )
626{
Gilles Peskine549ea862019-05-22 11:45:59 +0200627 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100628 if( alg1 == alg2 )
629 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100630 /* If the policies are from the same hash-and-sign family, check
631 * if one is a wildcard. If so the other has the specific algorithm. */
632 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
633 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
634 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100635 {
Steven Cooreman03488022021-02-18 12:07:20 +0100636 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
637 return( alg2 );
638 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
639 return( alg1 );
640 }
641 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100642 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100643 * restrictive tag length. */
644 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
645 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
646 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
647 {
648 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
649 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100650 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100651
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100652 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100653 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
654 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100655 {
Steven Cooremancd640932021-03-08 12:00:27 +0100656 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
657 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100658 }
659 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100660 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100661 ( alg1_len <= alg2_len ) )
662 {
663 return( alg2 );
664 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100665 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100666 ( alg2_len <= alg1_len ) )
667 {
668 return( alg1 );
669 }
670 }
671 /* If the policies are from the same MAC family, check whether one
672 * of them is a minimum-MAC-length policy. Calculate the most
673 * restrictive tag length. */
674 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
675 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
676 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
677 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100678 /* Validate the combination of key type and algorithm. Since the base
679 * algorithm of alg1 and alg2 are the same, we only need this once. */
680 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100681 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100682
Steven Cooreman31a876d2021-03-03 20:47:40 +0100683 /* Get the (exact or at-least) output lengths for both sides of the
684 * requested intersection. None of the currently supported algorithms
685 * have an output length dependent on the actual key size, so setting it
686 * to a bogus value of 0 is currently OK.
687 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100688 * Note that for at-least-this-length wildcard algorithms, the output
689 * length is set to the shortest allowed length, which allows us to
690 * calculate the most restrictive tag length for the intersection. */
691 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
692 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100693 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100694
Steven Cooremana1d83222021-02-25 10:20:29 +0100695 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100696 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
697 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100698 {
Steven Cooremancd640932021-03-08 12:00:27 +0100699 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100701
702 /* If only one is an at-least-this-length policy, the intersection would
703 * be the other (fixed-length) policy as long as said fixed length is
704 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100705 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100706 {
Steven Cooremancd640932021-03-08 12:00:27 +0100707 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100708 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100709 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100710 {
Steven Cooremancd640932021-03-08 12:00:27 +0100711 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100712 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100713
Steven Cooremancd640932021-03-08 12:00:27 +0100714 /* If none of them are wildcards, check whether they define the same tag
715 * length. This is still possible here when one is default-length and
716 * the other specific-length. Ensure to always return the
717 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100718 if( alg1_len == alg2_len )
719 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100720 }
721 /* If the policies are incompatible, allow nothing. */
722 return( 0 );
723}
724
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100725static int psa_key_algorithm_permits( psa_key_type_t key_type,
726 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200727 psa_algorithm_t requested_alg )
728{
Gilles Peskine549ea862019-05-22 11:45:59 +0200729 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200730 if( requested_alg == policy_alg )
731 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100732 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
733 * and requested_alg is the same hash-and-sign family with any hash,
734 * then requested_alg is compliant with policy_alg. */
735 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
736 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200737 {
Steven Cooreman03488022021-02-18 12:07:20 +0100738 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
739 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
740 }
741 /* If policy_alg is a wildcard AEAD algorithm of the same base as
742 * the requested algorithm, check the requested tag length to be
743 * equal-length or longer than the wildcard-specified length. */
744 if( PSA_ALG_IS_AEAD( policy_alg ) &&
745 PSA_ALG_IS_AEAD( requested_alg ) &&
746 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
747 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100748 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100749 {
750 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
751 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
752 }
Steven Cooremancd640932021-03-08 12:00:27 +0100753 /* If policy_alg is a MAC algorithm of the same base as the requested
754 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100755 if( PSA_ALG_IS_MAC( policy_alg ) &&
756 PSA_ALG_IS_MAC( requested_alg ) &&
757 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100758 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100759 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100760 /* Validate the combination of key type and algorithm. Since the policy
761 * and requested algorithms are the same, we only need this once. */
762 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100763 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764
Steven Cooreman31a876d2021-03-03 20:47:40 +0100765 /* Get both the requested output length for the algorithm which is to be
766 * verified, and the default output length for the base algorithm.
767 * Note that none of the currently supported algorithms have an output
768 * length dependent on actual key size, so setting it to a bogus value
769 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100770 size_t requested_output_length = PSA_MAC_LENGTH(
771 key_type, 0, requested_alg );
772 size_t default_output_length = PSA_MAC_LENGTH(
773 key_type, 0,
774 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100775
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100776 /* If the policy is default-length, only allow an algorithm with
777 * a declared exact-length matching the default. */
778 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100779 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100780
781 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100782 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
784 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
785 {
786 return( 1 );
787 }
788
Steven Cooremancd640932021-03-08 12:00:27 +0100789 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
790 * check for the requested MAC length to be equal to or longer than the
791 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100792 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
793 {
794 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100795 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200797 }
Steven Cooremance48e852020-10-05 16:02:45 +0200798 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200799 * a key derivation with that key agreement should also be allowed. This
800 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200801 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
802 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
803 {
804 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
805 policy_alg );
806 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100807 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200808 return( 0 );
809}
810
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100811/** Test whether a policy permits an algorithm.
812 *
813 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100815 * \note This function requires providing the key type for which the policy is
816 * being validated, since some algorithm policy definitions (e.g. MAC)
817 * have different properties depending on what kind of cipher it is
818 * combined with.
819 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 * \retval PSA_SUCCESS When \p alg is a specific algorithm
821 * allowed by the \p policy.
822 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
823 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
824 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100825 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100827 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100829{
Steven Cooremand788fab2021-02-25 11:29:17 +0100830 /* '0' is not a valid algorithm */
831 if( alg == 0 )
832 return( PSA_ERROR_INVALID_ARGUMENT );
833
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 /* A requested algorithm cannot be a wildcard. */
835 if( PSA_ALG_IS_WILDCARD( alg ) )
836 return( PSA_ERROR_INVALID_ARGUMENT );
837
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100838 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
839 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100840 return( PSA_SUCCESS );
841 else
842 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100843}
844
Gilles Peskinef603c712019-01-19 13:40:11 +0100845/** Restrict a key policy based on a constraint.
846 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100847 * \note This function requires providing the key type for which the policy is
848 * being restricted, since some algorithm policy definitions (e.g. MAC)
849 * have different properties depending on what kind of cipher it is
850 * combined with.
851 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 * \param[in,out] policy The policy to restrict.
854 * \param[in] constraint The policy constraint to apply.
855 *
856 * \retval #PSA_SUCCESS
857 * \c *policy contains the intersection of the original value of
858 * \c *policy and \c *constraint.
859 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100860 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100861 * \c *policy is unchanged.
862 */
863static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100864 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100865 psa_key_policy_t *policy,
866 const psa_key_policy_t *constraint )
867{
868 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100869 psa_key_policy_algorithm_intersection( key_type, policy->alg,
870 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200871 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100872 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
873 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100874 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
875 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200876 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
877 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100878 policy->usage &= constraint->usage;
879 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200880 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100881 return( PSA_SUCCESS );
882}
883
Ronald Cron5c522922020-11-14 16:35:34 +0100884/** Get the description of a key given its identifier and policy constraints
885 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200886 *
Ronald Cron5c522922020-11-14 16:35:34 +0100887 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100888 * nonzero, the key must allow operations with this algorithm. If \p alg is
889 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100890 *
Ronald Cron5c522922020-11-14 16:35:34 +0100891 * In case of a persistent key, the function loads the description of the key
892 * into a key slot if not already done.
893 *
894 * On success, the returned key slot is locked. It is the responsibility of
895 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200896 */
Ronald Cron5c522922020-11-14 16:35:34 +0100897static psa_status_t psa_get_and_lock_key_slot_with_policy(
898 mbedtls_svc_key_id_t key,
899 psa_key_slot_t **p_slot,
900 psa_key_usage_t usage,
901 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100902{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
904 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
Ronald Cron5c522922020-11-14 16:35:34 +0100906 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100907 if( status != PSA_SUCCESS )
908 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100910
911 /* Enforce that usage policy for the key slot contains all the flags
912 * required by the usage parameter. There is one exception: public
913 * keys can always be exported, so we treat public key objects as
914 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200915 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100916 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200917
Gilles Peskine8e338702019-07-30 20:06:31 +0200918 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100919 {
920 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100922 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100923
924 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100925 if( alg != 0 )
926 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100927 status = psa_key_policy_permits( &slot->attr.policy,
928 slot->attr.type,
929 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100930 if( status != PSA_SUCCESS )
931 goto error;
932 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100933
Darryl Green06fd18d2018-07-16 11:21:11 +0100934 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200935
936error:
937 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100938 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200939
940 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100941}
Darryl Green940d72c2018-07-13 13:18:51 +0100942
Ronald Cron5c522922020-11-14 16:35:34 +0100943/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200944 *
945 * A transparent key is a key for which the key material is directly
946 * available, as opposed to a key in a secure element.
947 *
Ronald Cron5c522922020-11-14 16:35:34 +0100948 * This is a temporary function to use instead of
949 * psa_get_and_lock_key_slot_with_policy() until secure element support is
950 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200951 *
Ronald Cron5c522922020-11-14 16:35:34 +0100952 * On success, the returned key slot is locked. It is the responsibility of the
953 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200954 */
955#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100956static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
957 mbedtls_svc_key_id_t key,
958 psa_key_slot_t **p_slot,
959 psa_key_usage_t usage,
960 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961{
Ronald Cron5c522922020-11-14 16:35:34 +0100962 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
963 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 if( status != PSA_SUCCESS )
965 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200966
Gilles Peskineadad8132019-07-25 11:31:23 +0200967 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 {
Ronald Cron5c522922020-11-14 16:35:34 +0100969 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200970 *p_slot = NULL;
971 return( PSA_ERROR_NOT_SUPPORTED );
972 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200973
Gilles Peskine28f8f302019-07-24 13:30:31 +0200974 return( PSA_SUCCESS );
975}
976#else /* MBEDTLS_PSA_CRYPTO_SE_C */
977/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100978#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
979 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200980#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
981
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200982psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000983{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100984 /* Data pointer will always be either a valid pointer or NULL in an
985 * initialized slot, so we can just free it. */
986 if( slot->key.data != NULL )
987 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
988
989 mbedtls_free( slot->key.data );
990 slot->key.data = NULL;
991 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000992
993 return( PSA_SUCCESS );
994}
995
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100996/** Completely wipe a slot in memory, including its policy.
997 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100998psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100999{
1000 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001001
Ronald Cron5c522922020-11-14 16:35:34 +01001002 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001003 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001004 status = PSA_ERROR_CORRUPTION_DETECTED;
1005 }
1006
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001007 /* Multipart operations may still be using the key. This is safe
1008 * because all multipart operation objects are independent from
1009 * the key slot: if they need to access the key after the setup
1010 * phase, they have a copy of the key. Note that this means that
1011 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001012 /* At this point, key material and other type-specific content has
1013 * been wiped. Clear remaining metadata. We can call memset and not
1014 * zeroize because the metadata is not particularly sensitive. */
1015 memset( slot, 0, sizeof( *slot ) );
1016 return( status );
1017}
1018
Ronald Croncf56a0a2020-08-04 09:51:30 +02001019psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001020{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001021 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001022 psa_status_t status; /* status of the last operation */
1023 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001024#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1025 psa_se_drv_table_entry_t *driver;
1026#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001027
Ronald Croncf56a0a2020-08-04 09:51:30 +02001028 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001029 return( PSA_SUCCESS );
1030
Ronald Cronf2911112020-10-29 17:51:10 +01001031 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001032 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001033 * key, this will load the key description from persistent memory if not
1034 * done yet. We cannot avoid this loading as without it we don't know if
1035 * the key is operated by an SE or not and this information is needed by
1036 * the current implementation.
1037 */
Ronald Cron5c522922020-11-14 16:35:34 +01001038 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001039 if( status != PSA_SUCCESS )
1040 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001041
Ronald Cronf2911112020-10-29 17:51:10 +01001042 /*
1043 * If the key slot containing the key description is under access by the
1044 * library (apart from the present access), the key cannot be destroyed
1045 * yet. For the time being, just return in error. Eventually (to be
1046 * implemented), the key should be destroyed when all accesses have
1047 * stopped.
1048 */
Ronald Cron5c522922020-11-14 16:35:34 +01001049 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001050 {
Ronald Cron5c522922020-11-14 16:35:34 +01001051 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001052 return( PSA_ERROR_GENERIC_ERROR );
1053 }
1054
Gilles Peskine354f7672019-07-12 23:46:38 +02001055#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001056 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001057 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001058 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001059 /* For a key in a secure element, we need to do three things:
1060 * remove the key file in internal storage, destroy the
1061 * key inside the secure element, and update the driver's
1062 * persistent data. Start a transaction that will encompass these
1063 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001064 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001065 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001066 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001067 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001068 status = psa_crypto_save_transaction( );
1069 if( status != PSA_SUCCESS )
1070 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001071 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001072 /* We should still try to destroy the key in the secure
1073 * element and the key metadata in storage. This is especially
1074 * important if the error is that the storage is full.
1075 * But how to do it exactly without risking an inconsistent
1076 * state after a reset?
1077 * https://github.com/ARMmbed/mbed-crypto/issues/215
1078 */
1079 overall_status = status;
1080 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001081 }
1082
Ronald Cronea0f8a62020-11-25 17:52:23 +01001083 status = psa_destroy_se_key( driver,
1084 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001085 if( overall_status == PSA_SUCCESS )
1086 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001087 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001088#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1089
Darryl Greend49a4992018-06-18 17:27:26 +01001090#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001091 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001092 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001093 status = psa_destroy_persistent_key( slot->attr.id );
1094 if( overall_status == PSA_SUCCESS )
1095 overall_status = status;
1096
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001097 /* TODO: other slots may have a copy of the same key. We should
1098 * invalidate them.
1099 * https://github.com/ARMmbed/mbed-crypto/issues/214
1100 */
Darryl Greend49a4992018-06-18 17:27:26 +01001101 }
1102#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001103
Gilles Peskinefc762652019-07-22 19:30:34 +02001104#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1105 if( driver != NULL )
1106 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001107 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001108 if( overall_status == PSA_SUCCESS )
1109 overall_status = status;
1110 status = psa_crypto_stop_transaction( );
1111 if( overall_status == PSA_SUCCESS )
1112 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001113 }
1114#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1115
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1117exit:
1118#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001119 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001120 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1121 if( overall_status == PSA_SUCCESS )
1122 overall_status = status;
1123 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001124}
1125
John Durkop07cc04a2020-11-16 22:08:34 -08001126#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001127 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001128static psa_status_t psa_get_rsa_public_exponent(
1129 const mbedtls_rsa_context *rsa,
1130 psa_key_attributes_t *attributes )
1131{
1132 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001133 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001134 uint8_t *buffer = NULL;
1135 size_t buflen;
1136 mbedtls_mpi_init( &mpi );
1137
1138 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1139 if( ret != 0 )
1140 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001141 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1142 {
1143 /* It's the default value, which is reported as an empty string,
1144 * so there's nothing to do. */
1145 goto exit;
1146 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001147
1148 buflen = mbedtls_mpi_size( &mpi );
1149 buffer = mbedtls_calloc( 1, buflen );
1150 if( buffer == NULL )
1151 {
1152 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1153 goto exit;
1154 }
1155 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1156 if( ret != 0 )
1157 goto exit;
1158 attributes->domain_parameters = buffer;
1159 attributes->domain_parameters_size = buflen;
1160
1161exit:
1162 mbedtls_mpi_free( &mpi );
1163 if( ret != 0 )
1164 mbedtls_free( buffer );
1165 return( mbedtls_to_psa_error( ret ) );
1166}
John Durkop07cc04a2020-11-16 22:08:34 -08001167#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001168 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001169
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001170/** Retrieve all the publicly-accessible attributes of a key.
1171 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001172psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001173 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001177 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001178
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001179 psa_reset_key_attributes( attributes );
1180
Ronald Cron5c522922020-11-14 16:35:34 +01001181 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001182 if( status != PSA_SUCCESS )
1183 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001184
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001185 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001186 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1187 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1188
1189#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1190 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001191 psa_set_key_slot_number( attributes,
1192 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001193#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001194
Gilles Peskine8e338702019-07-30 20:06:31 +02001195 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001196 {
John Durkop07cc04a2020-11-16 22:08:34 -08001197#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001198 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001199 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001200 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001201#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001202 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001203 * is not yet implemented.
1204 * https://github.com/ARMmbed/mbed-crypto/issues/216
1205 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001207 break;
1208#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001209 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001210 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001211
Ronald Cron90857082020-11-25 14:58:33 +01001212 status = mbedtls_psa_rsa_load_representation(
1213 slot->attr.type,
1214 slot->key.data,
1215 slot->key.bytes,
1216 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001217 if( status != PSA_SUCCESS )
1218 break;
1219
Steven Cooremana2371e52020-07-28 14:30:39 +02001220 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001221 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001222 mbedtls_rsa_free( rsa );
1223 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001224 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001225 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001226#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001227 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001228 default:
1229 /* Nothing else to do. */
1230 break;
1231 }
1232
1233 if( status != PSA_SUCCESS )
1234 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001235
Ronald Cron5c522922020-11-14 16:35:34 +01001236 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237
Ronald Cron5c522922020-11-14 16:35:34 +01001238 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001239}
1240
Gilles Peskinec8000c02019-08-02 20:15:51 +02001241#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1242psa_status_t psa_get_key_slot_number(
1243 const psa_key_attributes_t *attributes,
1244 psa_key_slot_number_t *slot_number )
1245{
1246 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1247 {
1248 *slot_number = attributes->slot_number;
1249 return( PSA_SUCCESS );
1250 }
1251 else
1252 return( PSA_ERROR_INVALID_ARGUMENT );
1253}
1254#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1255
Ronald Crond18b5f82020-11-25 16:46:05 +01001256static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1257 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001258 uint8_t *data,
1259 size_t data_size,
1260 size_t *data_length )
1261{
Ronald Crond18b5f82020-11-25 16:46:05 +01001262 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001263 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001264 memcpy( data, key_buffer, key_buffer_size );
1265 memset( data + key_buffer_size, 0,
1266 data_size - key_buffer_size );
1267 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001268 return( PSA_SUCCESS );
1269}
1270
Ronald Cron7285cda2020-11-26 14:46:37 +01001271psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 const psa_key_attributes_t *attributes,
1273 const uint8_t *key_buffer, size_t key_buffer_size,
1274 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001275{
Ronald Crond18b5f82020-11-25 16:46:05 +01001276 psa_key_type_t type = attributes->core.type;
1277
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 if( key_type_is_raw_bytes( type ) ||
1279 PSA_KEY_TYPE_IS_RSA( type ) ||
1280 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001281 {
1282 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 key_buffer, key_buffer_size,
1284 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001285 }
1286 else
1287 {
1288 /* This shouldn't happen in the reference implementation, but
1289 it is valid for a special-purpose implementation to omit
1290 support for exporting certain key types. */
1291 return( PSA_ERROR_NOT_SUPPORTED );
1292 }
1293}
1294
1295psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1296 uint8_t *data,
1297 size_t data_size,
1298 size_t *data_length )
1299{
1300 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1301 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1302 psa_key_slot_t *slot;
1303
Ronald Crone907e552021-01-18 13:22:38 +01001304 /* Reject a zero-length output buffer now, since this can never be a
1305 * valid key representation. This way we know that data must be a valid
1306 * pointer and we can do things like memset(data, ..., data_size). */
1307 if( data_size == 0 )
1308 return( PSA_ERROR_BUFFER_TOO_SMALL );
1309
Ronald Cron9486f9d2020-11-26 13:36:23 +01001310 /* Set the key to empty now, so that even when there are errors, we always
1311 * set data_length to a value between 0 and data_size. On error, setting
1312 * the key to empty is a good choice because an empty key representation is
1313 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001314 *data_length = 0;
1315
Ronald Cron9486f9d2020-11-26 13:36:23 +01001316 /* Export requires the EXPORT flag. There is an exception for public keys,
1317 * which don't require any flag, but
1318 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1319 */
1320 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1321 PSA_KEY_USAGE_EXPORT, 0 );
1322 if( status != PSA_SUCCESS )
1323 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001324
Ronald Crond18b5f82020-11-25 16:46:05 +01001325 psa_key_attributes_t attributes = {
1326 .core = slot->attr
1327 };
Ronald Cron67227982020-11-26 15:16:05 +01001328 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 slot->key.data, slot->key.bytes,
1330 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001331
Ronald Cron9486f9d2020-11-26 13:36:23 +01001332 unlock_status = psa_unlock_key_slot( slot );
1333
1334 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1335}
1336
Ronald Cron7285cda2020-11-26 14:46:37 +01001337psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001338 const psa_key_attributes_t *attributes,
1339 const uint8_t *key_buffer,
1340 size_t key_buffer_size,
1341 uint8_t *data,
1342 size_t data_size,
1343 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001344{
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001346
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001348 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001350 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001351 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 key_buffer, key_buffer_size,
1354 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001355 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001356
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001358 {
John Durkop0e005192020-10-31 22:06:54 -07001359#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1360 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001361 return( mbedtls_psa_rsa_export_public_key( attributes,
1362 key_buffer,
1363 key_buffer_size,
1364 data,
1365 data_size,
1366 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001367#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001368 /* We don't know how to convert a private RSA key to public. */
1369 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001370#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1371 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001372 }
1373 else
Moran Pekera998bc62018-04-16 18:16:20 +03001374 {
John Durkop6ba40d12020-11-10 08:50:04 -08001375#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1376 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001377 return( mbedtls_psa_ecp_export_public_key( attributes,
1378 key_buffer,
1379 key_buffer_size,
1380 data,
1381 data_size,
1382 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001383#else
1384 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001385 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001386#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1387 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001388 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001389 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001390 else
1391 {
1392 /* This shouldn't happen in the reference implementation, but
1393 it is valid for a special-purpose implementation to omit
1394 support for exporting certain key types. */
1395 return( PSA_ERROR_NOT_SUPPORTED );
1396 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001397}
Ronald Crond18b5f82020-11-25 16:46:05 +01001398
Ronald Croncf56a0a2020-08-04 09:51:30 +02001399psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001400 uint8_t *data,
1401 size_t data_size,
1402 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001403{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001405 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001406 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001407
Ronald Crone907e552021-01-18 13:22:38 +01001408 /* Reject a zero-length output buffer now, since this can never be a
1409 * valid key representation. This way we know that data must be a valid
1410 * pointer and we can do things like memset(data, ..., data_size). */
1411 if( data_size == 0 )
1412 return( PSA_ERROR_BUFFER_TOO_SMALL );
1413
Darryl Greendd8fb772018-11-07 16:00:44 +00001414 /* Set the key to empty now, so that even when there are errors, we always
1415 * set data_length to a value between 0 and data_size. On error, setting
1416 * the key to empty is a good choice because an empty key representation is
1417 * unlikely to be accepted anywhere. */
1418 *data_length = 0;
1419
1420 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001421 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001422 if( status != PSA_SUCCESS )
1423 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001424
Ronald Cron9486f9d2020-11-26 13:36:23 +01001425 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1426 {
1427 status = PSA_ERROR_INVALID_ARGUMENT;
1428 goto exit;
1429 }
1430
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 psa_key_attributes_t attributes = {
1432 .core = slot->attr
1433 };
Ronald Cron67227982020-11-26 15:16:05 +01001434 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001435 &attributes, slot->key.data, slot->key.bytes,
1436 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001437
1438exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001439 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001440
Ronald Cron5c522922020-11-14 16:35:34 +01001441 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001442}
1443
Gilles Peskine91e8c332019-08-02 19:19:39 +02001444#if defined(static_assert)
1445static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1446 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001447static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001448 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001449static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001450 "One or more key attribute flag is listed as both internal-only and external-only" );
1451#endif
1452
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001453/** Validate that a key policy is internally well-formed.
1454 *
1455 * This function only rejects invalid policies. It does not validate the
1456 * consistency of the policy with respect to other attributes of the key
1457 * such as the key type.
1458 */
1459static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001460{
1461 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001462 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001463 PSA_KEY_USAGE_ENCRYPT |
1464 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001465 PSA_KEY_USAGE_SIGN_MESSAGE |
1466 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001467 PSA_KEY_USAGE_SIGN_HASH |
1468 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001469 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001470 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1471 return( PSA_ERROR_INVALID_ARGUMENT );
1472
Gilles Peskine4747d192019-04-17 15:05:45 +02001473 return( PSA_SUCCESS );
1474}
1475
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001476/** Validate the internal consistency of key attributes.
1477 *
1478 * This function only rejects invalid attribute values. If does not
1479 * validate the consistency of the attributes with any key data that may
1480 * be involved in the creation of the key.
1481 *
1482 * Call this function early in the key creation process.
1483 *
1484 * \param[in] attributes Key attributes for the new key.
1485 * \param[out] p_drv On any return, the driver for the key, if any.
1486 * NULL for a transparent key.
1487 *
1488 */
1489static psa_status_t psa_validate_key_attributes(
1490 const psa_key_attributes_t *attributes,
1491 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001492{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001493 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001494 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001495 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001496
Ronald Cron54b90082020-10-29 15:26:43 +01001497 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001498 if( status != PSA_SUCCESS )
1499 return( status );
1500
Ronald Crond2ed4812020-07-17 16:11:30 +02001501 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001502 if( status != PSA_SUCCESS )
1503 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001504
Ronald Cron65f38a32020-10-23 17:11:13 +02001505 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1506 {
1507 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1508 return( PSA_ERROR_INVALID_ARGUMENT );
1509 }
1510 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001511 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001512 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1513 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001514 }
1515
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001517 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001518 return( status );
1519
1520 /* Refuse to create overly large keys.
1521 * Note that this doesn't trigger on import if the attributes don't
1522 * explicitly specify a size (so psa_get_key_bits returns 0), so
1523 * psa_import_key() needs its own checks. */
1524 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1525 return( PSA_ERROR_NOT_SUPPORTED );
1526
Gilles Peskine91e8c332019-08-02 19:19:39 +02001527 /* Reject invalid flags. These should not be reachable through the API. */
1528 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1529 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1530 return( PSA_ERROR_INVALID_ARGUMENT );
1531
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001532 return( PSA_SUCCESS );
1533}
1534
Gilles Peskine4747d192019-04-17 15:05:45 +02001535/** Prepare a key slot to receive key material.
1536 *
1537 * This function allocates a key slot and sets its metadata.
1538 *
1539 * If this function fails, call psa_fail_key_creation().
1540 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001541 * This function is intended to be used as follows:
1542 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001543 * it with the specified attributes, and in case of a volatile key assign it
1544 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001545 * -# Populate the slot with the key material.
1546 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1547 * In case of failure at any step, stop the sequence and call
1548 * psa_fail_key_creation().
1549 *
Ronald Cron5c522922020-11-14 16:35:34 +01001550 * On success, the key slot is locked. It is the responsibility of the caller
1551 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001552 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001553 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001554 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001555 * \param[out] p_slot On success, a pointer to the prepared slot.
1556 * \param[out] p_drv On any return, the driver for the key, if any.
1557 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001558 *
1559 * \retval #PSA_SUCCESS
1560 * The key slot is ready to receive key material.
1561 * \return If this function fails, the key slot is an invalid state.
1562 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001563 */
1564static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001565 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001566 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001567 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001568 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001569{
1570 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001571 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001572 psa_key_slot_t *slot;
1573
Gilles Peskinedf179142019-07-15 22:02:14 +02001574 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001575 *p_drv = NULL;
1576
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001577 status = psa_validate_key_attributes( attributes, p_drv );
1578 if( status != PSA_SUCCESS )
1579 return( status );
1580
Ronald Cronc4d1b512020-07-31 11:26:37 +02001581 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001582 if( status != PSA_SUCCESS )
1583 return( status );
1584 slot = *p_slot;
1585
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001586 /* We're storing the declared bit-size of the key. It's up to each
1587 * creation mechanism to verify that this information is correct.
1588 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001589 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001590 * is optional (import, copy). In case of a volatile key, assign it the
1591 * volatile key identifier associated to the slot returned to contain its
1592 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001593
1594 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001595 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1596 {
1597#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1598 slot->attr.id = volatile_key_id;
1599#else
1600 slot->attr.id.key_id = volatile_key_id;
1601#endif
1602 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001603
Gilles Peskine91e8c332019-08-02 19:19:39 +02001604 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001605 * external-only flags, query `attributes`. Thanks to the check
1606 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001607 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001608 * may have set. */
1609 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001610
Gilles Peskinecbaff462019-07-12 23:46:04 +02001611#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001612 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001613 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001614 * create the key file in internal storage, create the
1615 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001616 * persistent data. This is done by starting a transaction that will
1617 * encompass these three actions.
1618 * For registering a volatile key, we just need to find an appropriate
1619 * slot number inside the SE. Since the key is designated volatile, creating
1620 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001621 /* The first thing to do is to find a slot number for the new key.
1622 * We save the slot number in persistent storage as part of the
1623 * transaction data. It will be needed to recover if the power
1624 * fails during the key creation process, to clean up on the secure
1625 * element side after restarting. Obtaining a slot number from the
1626 * secure element driver updates its persistent state, but we do not yet
1627 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001628 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001629 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001630 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001631 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001632 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001633 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001634 if( status != PSA_SUCCESS )
1635 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001636
1637 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001638 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001639 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1640 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001641 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001642 psa_crypto_transaction.key.id = slot->attr.id;
1643 status = psa_crypto_save_transaction( );
1644 if( status != PSA_SUCCESS )
1645 {
1646 (void) psa_crypto_stop_transaction( );
1647 return( status );
1648 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001649 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001650
1651 status = psa_copy_key_material_into_slot(
1652 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001653 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001654
1655 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1656 {
1657 /* Key registration only makes sense with a secure element. */
1658 return( PSA_ERROR_INVALID_ARGUMENT );
1659 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001660#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1661
Ronald Cronc4d1b512020-07-31 11:26:37 +02001662 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001663}
Gilles Peskine4747d192019-04-17 15:05:45 +02001664
1665/** Finalize the creation of a key once its key material has been set.
1666 *
1667 * This entails writing the key to persistent storage.
1668 *
1669 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001670 * See the documentation of psa_start_key_creation() for the intended use
1671 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001672 *
Ronald Cron5c522922020-11-14 16:35:34 +01001673 * If the finalization succeeds, the function unlocks the key slot (it was
1674 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1675 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001676 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001677 * \param[in,out] slot Pointer to the slot with key material.
1678 * \param[in] driver The secure element driver for the key,
1679 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001680 * \param[out] key On success, identifier of the key. Note that the
1681 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001682 *
1683 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001684 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001685 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1686 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1687 * \retval #PSA_ERROR_ALREADY_EXISTS
1688 * \retval #PSA_ERROR_DATA_INVALID
1689 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001690 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001691 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001692 * \return If this function fails, the key slot is an invalid state.
1693 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001694 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001695static psa_status_t psa_finish_key_creation(
1696 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001697 psa_se_drv_table_entry_t *driver,
1698 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001699{
1700 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001701 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001702 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001703
1704#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001705 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001706 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001707#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1708 if( driver != NULL )
1709 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001710 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001711 psa_key_slot_number_t slot_number =
1712 psa_key_slot_get_slot_number( slot ) ;
1713
Gilles Peskineb46bef22019-07-30 21:32:04 +02001714#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001716 sizeof( data.slot_number ),
1717 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001720 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001721 (uint8_t*) &data,
1722 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001723 }
1724 else
1725#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1726 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001727 /* Key material is saved in export representation in the slot, so
1728 * just pass the slot buffer for storage. */
1729 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730 slot->key.data,
1731 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001732 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001733 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001734#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1735
Gilles Peskinecbaff462019-07-12 23:46:04 +02001736#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001737 /* Finish the transaction for a key creation. This does not
1738 * happen when registering an existing key. Detect this case
1739 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001740 * creation of a persistent key in a secure element requires a transaction,
1741 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001742 if( driver != NULL &&
1743 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001744 {
1745 status = psa_save_se_persistent_data( driver );
1746 if( status != PSA_SUCCESS )
1747 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001748 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001749 return( status );
1750 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001751 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001752 }
1753#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1754
Ronald Cron50972942020-11-14 11:28:25 +01001755 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001756 {
1757 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001758 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001759 if( status != PSA_SUCCESS )
1760 *key = MBEDTLS_SVC_KEY_ID_INIT;
1761 }
Ronald Cron50972942020-11-14 11:28:25 +01001762
Gilles Peskine4747d192019-04-17 15:05:45 +02001763 return( status );
1764}
1765
1766/** Abort the creation of a key.
1767 *
1768 * You may call this function after calling psa_start_key_creation(),
1769 * or after psa_finish_key_creation() fails. In other circumstances, this
1770 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001771 * See the documentation of psa_start_key_creation() for the intended use
1772 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001774 * \param[in,out] slot Pointer to the slot with key material.
1775 * \param[in] driver The secure element driver for the key,
1776 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001778static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001779 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001780{
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 (void) driver;
1782
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 if( slot == NULL )
1784 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001785
1786#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001787 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001788 * element, and the failure happened later (when saving metadata
1789 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001790 * element.
1791 * https://github.com/ARMmbed/mbed-crypto/issues/217
1792 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001793
Gilles Peskined7729582019-08-05 15:55:54 +02001794 /* Abort the ongoing transaction if any (there may not be one if
1795 * the creation process failed before starting one, or if the
1796 * key creation is a registration of a key in a secure element).
1797 * Earlier functions must already have done what it takes to undo any
1798 * partial creation. All that's left is to update the transaction data
1799 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001800 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001801#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1802
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 psa_wipe_key_slot( slot );
1804}
1805
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001806/** Validate optional attributes during key creation.
1807 *
1808 * Some key attributes are optional during key creation. If they are
1809 * specified in the attributes structure, check that they are consistent
1810 * with the data in the slot.
1811 *
1812 * This function should be called near the end of key creation, after
1813 * the slot in memory is fully populated but before saving persistent data.
1814 */
1815static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001816 const psa_key_slot_t *slot,
1817 const psa_key_attributes_t *attributes )
1818{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001819 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001820 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001821 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001822 return( PSA_ERROR_INVALID_ARGUMENT );
1823 }
1824
1825 if( attributes->domain_parameters_size != 0 )
1826 {
John Durkop0e005192020-10-31 22:06:54 -07001827#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1828 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001829 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001831 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001832 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001834
Ronald Cron90857082020-11-25 14:58:33 +01001835 psa_status_t status = mbedtls_psa_rsa_load_representation(
1836 slot->attr.type,
1837 slot->key.data,
1838 slot->key.bytes,
1839 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001840 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001841 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001842
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001843 mbedtls_mpi_init( &actual );
1844 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001845 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001846 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001847 mbedtls_rsa_free( rsa );
1848 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001849 if( ret != 0 )
1850 goto rsa_exit;
1851 ret = mbedtls_mpi_read_binary( &required,
1852 attributes->domain_parameters,
1853 attributes->domain_parameters_size );
1854 if( ret != 0 )
1855 goto rsa_exit;
1856 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1857 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1858 rsa_exit:
1859 mbedtls_mpi_free( &actual );
1860 mbedtls_mpi_free( &required );
1861 if( ret != 0)
1862 return( mbedtls_to_psa_error( ret ) );
1863 }
1864 else
John Durkop9814fa22020-11-04 12:28:15 -08001865#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1866 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001867 {
1868 return( PSA_ERROR_INVALID_ARGUMENT );
1869 }
1870 }
1871
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001872 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001873 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001874 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 return( PSA_ERROR_INVALID_ARGUMENT );
1876 }
1877
1878 return( PSA_SUCCESS );
1879}
1880
Gilles Peskine4747d192019-04-17 15:05:45 +02001881psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001883 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001884 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001885{
1886 psa_status_t status;
1887 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001888 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001889 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001890
Ronald Cron81709fc2020-11-14 12:10:32 +01001891 *key = MBEDTLS_SVC_KEY_ID_INIT;
1892
Gilles Peskine0f84d622019-09-12 19:03:13 +02001893 /* Reject zero-length symmetric keys (including raw data key objects).
1894 * This also rejects any key which might be encoded as an empty string,
1895 * which is never valid. */
1896 if( data_length == 0 )
1897 return( PSA_ERROR_INVALID_ARGUMENT );
1898
Gilles Peskinedf179142019-07-15 22:02:14 +02001899 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001900 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 if( status != PSA_SUCCESS )
1902 goto exit;
1903
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001904 /* In the case of a transparent key or an opaque key stored in local
1905 * storage (thus not in the case of generating a key in a secure element
1906 * or cryptoprocessor with storage), we have to allocate a buffer to
1907 * hold the generated key material. */
1908 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001909 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001910 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001911 if( status != PSA_SUCCESS )
1912 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001913 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001914
1915 bits = slot->attr.bits;
1916 status = psa_driver_wrapper_import_key( attributes,
1917 data, data_length,
1918 slot->key.data,
1919 slot->key.bytes,
1920 &slot->key.bytes, &bits );
1921 if( status != PSA_SUCCESS )
1922 goto exit;
1923
1924 if( slot->attr.bits == 0 )
1925 slot->attr.bits = (psa_key_bits_t) bits;
1926 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001927 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001928 status = PSA_ERROR_INVALID_ARGUMENT;
1929 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001930 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001931
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001932 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001933 if( status != PSA_SUCCESS )
1934 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001935
Ronald Cron81709fc2020-11-14 12:10:32 +01001936 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001938 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001939 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001940
Gilles Peskine4747d192019-04-17 15:05:45 +02001941 return( status );
1942}
1943
Gilles Peskined7729582019-08-05 15:55:54 +02001944#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1945psa_status_t mbedtls_psa_register_se_key(
1946 const psa_key_attributes_t *attributes )
1947{
1948 psa_status_t status;
1949 psa_key_slot_t *slot = NULL;
1950 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001951 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001952
1953 /* Leaving attributes unspecified is not currently supported.
1954 * It could make sense to query the key type and size from the
1955 * secure element, but not all secure elements support this
1956 * and the driver HAL doesn't currently support it. */
1957 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1958 return( PSA_ERROR_NOT_SUPPORTED );
1959 if( psa_get_key_bits( attributes ) == 0 )
1960 return( PSA_ERROR_NOT_SUPPORTED );
1961
1962 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001963 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001964 if( status != PSA_SUCCESS )
1965 goto exit;
1966
Ronald Cron81709fc2020-11-14 12:10:32 +01001967 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001968
1969exit:
1970 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001971 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001972
Gilles Peskined7729582019-08-05 15:55:54 +02001973 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001974 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001975 return( status );
1976}
1977#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1978
Gilles Peskinef603c712019-01-19 13:40:11 +01001979static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001980 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001981{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001982 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001983 source->key.data,
1984 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001985 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001986 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001987
Steven Cooreman398aee52020-10-13 14:35:45 +02001988 target->attr.type = source->attr.type;
1989 target->attr.bits = source->attr.bits;
1990
1991 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001992}
1993
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001995 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001996 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001997{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001999 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002000 psa_key_slot_t *source_slot = NULL;
2001 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002002 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002003 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002004
Ronald Cron81709fc2020-11-14 12:10:32 +01002005 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2006
Ronald Cron5c522922020-11-14 16:35:34 +01002007 status = psa_get_and_lock_transparent_key_slot_with_policy(
2008 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002009 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002010 goto exit;
2011
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002012 status = psa_validate_optional_attributes( source_slot,
2013 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002014 if( status != PSA_SUCCESS )
2015 goto exit;
2016
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002017 status = psa_restrict_key_policy( source_slot->attr.type,
2018 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002019 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020 if( status != PSA_SUCCESS )
2021 goto exit;
2022
Ronald Cron81709fc2020-11-14 12:10:32 +01002023 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2024 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002025 if( status != PSA_SUCCESS )
2026 goto exit;
2027
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002028#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2029 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002030 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002031 /* Copying to a secure element is not implemented yet. */
2032 status = PSA_ERROR_NOT_SUPPORTED;
2033 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002034 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002035#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002036
Ronald Cron6cc66312021-04-02 12:27:47 +02002037 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2038 {
2039 /*
2040 * Copying through an opaque driver is not implemented yet, consider
2041 * a lifetime with an external location as an invalid parameter for
2042 * now.
2043 */
2044 status = PSA_ERROR_INVALID_ARGUMENT;
2045 goto exit;
2046 }
2047
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002048 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002049 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002051
Ronald Cron81709fc2020-11-14 12:10:32 +01002052 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002053exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002054 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002055 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002056
Ronald Cron5c522922020-11-14 16:35:34 +01002057 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002058
Ronald Cron5c522922020-11-14 16:35:34 +01002059 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002060}
2061
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002062
2063
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002064/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002065/* Message digests */
2066/****************************************************************/
2067
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002068psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2069{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002070 /* Aborting a non-active operation is allowed */
2071 if( operation->id == 0 )
2072 return( PSA_SUCCESS );
2073
2074 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2075 operation->id = 0;
2076
2077 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002078}
2079
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002080psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002081 psa_algorithm_t alg )
2082{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002083 /* A context must be freshly initialized before it can be set up. */
2084 if( operation->id != 0 )
2085 return( PSA_ERROR_BAD_STATE );
2086
2087 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002088 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002089
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002090 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2091 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002092 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2093
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002094 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002095}
2096
2097psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2098 const uint8_t *input,
2099 size_t input_length )
2100{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002101 if( operation->id == 0 )
2102 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002103
Steven Cooremanc8288352021-03-04 14:02:19 +01002104 /* Don't require hash implementations to behave correctly on a
2105 * zero-length input, which may have an invalid pointer. */
2106 if( input_length == 0 )
2107 return( PSA_SUCCESS );
2108
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002109 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2110 input, input_length );
2111 if( status != PSA_SUCCESS )
2112 psa_hash_abort( operation );
2113
2114 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115}
2116
2117psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2118 uint8_t *hash,
2119 size_t hash_size,
2120 size_t *hash_length )
2121{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002122 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002123 if( operation->id == 0 )
2124 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002125
Steven Cooreman1e582352021-02-18 17:24:37 +01002126 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002127 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002128 psa_hash_abort( operation );
2129 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002130}
2131
Gilles Peskine2d277862018-06-18 15:41:12 +02002132psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2133 const uint8_t *hash,
2134 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135{
2136 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2137 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002138 psa_status_t status = psa_hash_finish(
2139 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002140 actual_hash, sizeof( actual_hash ),
2141 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002142 if( status != PSA_SUCCESS )
2143 return( status );
2144 if( actual_hash_length != hash_length )
2145 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002146 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147 return( PSA_ERROR_INVALID_SIGNATURE );
2148 return( PSA_SUCCESS );
2149}
2150
Gilles Peskine0a749c82019-11-28 19:33:58 +01002151psa_status_t psa_hash_compute( psa_algorithm_t alg,
2152 const uint8_t *input, size_t input_length,
2153 uint8_t *hash, size_t hash_size,
2154 size_t *hash_length )
2155{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002156 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002157 if( !PSA_ALG_IS_HASH( alg ) )
2158 return( PSA_ERROR_INVALID_ARGUMENT );
2159
Steven Cooreman1e582352021-02-18 17:24:37 +01002160 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2161 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002162}
2163
2164psa_status_t psa_hash_compare( psa_algorithm_t alg,
2165 const uint8_t *input, size_t input_length,
2166 const uint8_t *hash, size_t hash_length )
2167{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002168 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2169 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002170
2171 if( !PSA_ALG_IS_HASH( alg ) )
2172 return( PSA_ERROR_INVALID_ARGUMENT );
2173
Steven Cooreman1e582352021-02-18 17:24:37 +01002174 psa_status_t status = psa_driver_wrapper_hash_compute(
2175 alg, input, input_length,
2176 actual_hash, sizeof(actual_hash),
2177 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002178 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002179 return( status );
2180 if( actual_hash_length != hash_length )
2181 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002182 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002183 return( PSA_ERROR_INVALID_SIGNATURE );
2184 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002185}
2186
Gilles Peskineeb35d782019-01-22 17:56:16 +01002187psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2188 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002189{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002190 if( source_operation->id == 0 ||
2191 target_operation->id != 0 )
2192 {
2193 return( PSA_ERROR_BAD_STATE );
2194 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002195
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002196 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2197 target_operation );
2198 if( status != PSA_SUCCESS )
2199 psa_hash_abort( target_operation );
2200
2201 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002202}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203
2204
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002205/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002206/* MAC */
2207/****************************************************************/
2208
Steven Cooremane6804192021-03-19 18:28:56 +01002209psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002210{
Steven Cooremane6804192021-03-19 18:28:56 +01002211 /* Aborting a non-active operation is allowed */
2212 if( operation->id == 0 )
2213 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002214
Steven Cooremane6804192021-03-19 18:28:56 +01002215 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002216 operation->mac_size = 0;
2217 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002218 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002219
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002220 return( status );
2221}
2222
Steven Cooremane6804192021-03-19 18:28:56 +01002223static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002224 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002225 psa_algorithm_t alg,
2226 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002227{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002229 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002230 psa_key_slot_t *slot;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002231
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002232 /* A context must be freshly initialized before it can be set up. */
Steven Cooremane6804192021-03-19 18:28:56 +01002233 if( operation->id != 0 )
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002234 return( PSA_ERROR_BAD_STATE );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002235
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002236 if( ! PSA_ALG_IS_MAC( alg ) )
2237 return( PSA_ERROR_INVALID_ARGUMENT );
2238
Steven Cooremane6804192021-03-19 18:28:56 +01002239 status = psa_get_and_lock_key_slot_with_policy(
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002240 key,
2241 &slot,
2242 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2243 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002244 if( status != PSA_SUCCESS )
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002245 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002246
Steven Cooremane6804192021-03-19 18:28:56 +01002247 psa_key_attributes_t attributes = {
2248 .core = slot->attr
2249 };
2250
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002251 /* Validate the combination of key type and algorithm */
Steven Cooremane6804192021-03-19 18:28:56 +01002252 status = psa_mac_key_can_do( alg, psa_get_key_type( &attributes ) );
Steven Cooreman15472f82021-03-02 16:16:22 +01002253 if( status != PSA_SUCCESS )
2254 goto exit;
2255
Steven Cooreman72f736a2021-05-07 14:14:37 +02002256 operation->is_sign = is_sign;
2257
Steven Cooremand1a68f12021-05-10 11:13:41 +02002258 /* Get the output length for the algorithm and key combination */
Steven Cooreman72f736a2021-05-07 14:14:37 +02002259 operation->mac_size = PSA_MAC_LENGTH(
Steven Cooremand1a68f12021-05-10 11:13:41 +02002260 psa_get_key_type( &attributes ),
2261 psa_get_key_bits( &attributes ),
2262 alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002263
Steven Cooreman72f736a2021-05-07 14:14:37 +02002264 if( operation->mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002265 {
2266 /* A very short MAC is too short for security since it can be
2267 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2268 * so we make this our minimum, even though 32 bits is still
2269 * too small for security. */
2270 status = PSA_ERROR_NOT_SUPPORTED;
2271 goto exit;
2272 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002273
Steven Cooreman72f736a2021-05-07 14:14:37 +02002274 if( operation->mac_size > PSA_MAC_LENGTH( psa_get_key_type( &attributes ),
Steven Cooremand1a68f12021-05-10 11:13:41 +02002275 psa_get_key_bits( &attributes ),
Steven Cooreman72f736a2021-05-07 14:14:37 +02002276 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002277 {
2278 /* It's impossible to "truncate" to a larger length than the full length
2279 * of the algorithm. */
2280 status = PSA_ERROR_INVALID_ARGUMENT;
2281 goto exit;
2282 }
2283
Steven Cooremane6804192021-03-19 18:28:56 +01002284 /* Dispatch the MAC setup call with validated input */
2285 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002286 {
Steven Cooremane6804192021-03-19 18:28:56 +01002287 status = psa_driver_wrapper_mac_sign_setup( operation,
2288 &attributes,
2289 slot->key.data,
2290 slot->key.bytes,
2291 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002292 }
2293 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002294 {
Steven Cooremane6804192021-03-19 18:28:56 +01002295 status = psa_driver_wrapper_mac_verify_setup( operation,
2296 &attributes,
2297 slot->key.data,
2298 slot->key.bytes,
2299 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002300 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002301
Gilles Peskinefbfac682018-07-08 20:51:54 +02002302exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002303 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002304 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002305
Ronald Cron5c522922020-11-14 16:35:34 +01002306 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002307
Ronald Cron5c522922020-11-14 16:35:34 +01002308 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002309}
2310
Gilles Peskine89167cb2018-07-08 20:12:23 +02002311psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002312 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002313 psa_algorithm_t alg )
2314{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002315 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002316}
2317
2318psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002319 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002320 psa_algorithm_t alg )
2321{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002322 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002323}
2324
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002325psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002326 const uint8_t *input,
2327 size_t input_length )
2328{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002329 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002330 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002331
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002332 /* Don't require hash implementations to behave correctly on a
2333 * zero-length input, which may have an invalid pointer. */
2334 if( input_length == 0 )
2335 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002336
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002337 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2338 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002339 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002340 psa_mac_abort( operation );
2341
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002342 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002343}
2344
Steven Cooremana5b860a2021-03-19 19:04:39 +01002345psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002346 uint8_t *mac,
2347 size_t mac_size,
2348 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002349{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002350 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2351 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002352
Steven Cooreman72f736a2021-05-07 14:14:37 +02002353 /* Set the output length and content to a safe default, such that in
2354 * case the caller misses an error check, the output would be an
2355 * unachievable MAC. */
2356 *mac_length = mac_size;
2357
Steven Cooremana5b860a2021-03-19 19:04:39 +01002358 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002359 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002360
Steven Cooreman72f736a2021-05-07 14:14:37 +02002361 if( ! operation->is_sign )
2362 return( PSA_ERROR_BAD_STATE );
2363
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002364 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2365 * once all the error checks are done. */
2366 if( operation->mac_size == 0 )
2367 return( PSA_ERROR_BAD_STATE );
2368
2369 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002370 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002371
Steven Cooremana5b860a2021-03-19 19:04:39 +01002372 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002373 mac, operation->mac_size,
2374 mac_length );
2375
2376 if( status == PSA_SUCCESS )
2377 {
2378 /* Set the excess room in the output buffer to an invalid value, to
2379 * avoid potentially leaking a longer MAC. */
2380 if( mac_size > operation->mac_size )
2381 memset( &mac[operation->mac_size],
2382 '!',
2383 mac_size - operation->mac_size );
2384 }
2385 else
2386 {
2387 /* Set the output length and content to a safe default, such that in
2388 * case the caller misses an error check, the output would be an
2389 * unachievable MAC. */
2390 *mac_length = mac_size;
2391 memset( mac, '!', mac_size );
2392 }
mohammad16036df908f2018-04-02 08:34:15 -07002393
Steven Cooremana5b860a2021-03-19 19:04:39 +01002394 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002395
Steven Cooremana5b860a2021-03-19 19:04:39 +01002396 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002397}
2398
Steven Cooremana5b860a2021-03-19 19:04:39 +01002399psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002400 const uint8_t *mac,
2401 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002402{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2404 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002405
Steven Cooremana5b860a2021-03-19 19:04:39 +01002406 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002407 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002408
Steven Cooreman72f736a2021-05-07 14:14:37 +02002409 if( operation->is_sign )
2410 return( PSA_ERROR_BAD_STATE );
2411
2412 if( operation->mac_size != mac_length )
2413 {
2414 status = PSA_ERROR_INVALID_SIGNATURE;
2415 goto cleanup;
2416 }
2417
Steven Cooremana5b860a2021-03-19 19:04:39 +01002418 status = psa_driver_wrapper_mac_verify_finish( operation,
2419 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002420
2421cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002422 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002423
Steven Cooremana5b860a2021-03-19 19:04:39 +01002424 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002425}
2426
2427
Gilles Peskine20035e32018-02-03 22:44:14 +01002428
Gilles Peskine20035e32018-02-03 22:44:14 +01002429/****************************************************************/
2430/* Asymmetric cryptography */
2431/****************************************************************/
2432
gabor-mezei-armf0486182021-05-12 11:03:09 +02002433static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002434 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002435{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002436 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002437 {
2438 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2439 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002440
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002441 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2442 {
2443 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2444 return( PSA_ERROR_INVALID_ARGUMENT );
2445 }
2446 }
2447 else
2448 {
2449 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2450 return( PSA_ERROR_INVALID_ARGUMENT );
2451 }
2452
2453 return( PSA_SUCCESS );
2454}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002455
2456static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002457 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002458 psa_algorithm_t alg,
2459 const uint8_t * input,
2460 size_t input_length,
2461 uint8_t * signature,
2462 size_t signature_size,
2463 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002464{
2465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2466 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2467 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002468
2469 *signature_length = 0;
2470
gabor-mezei-armf0486182021-05-12 11:03:09 +02002471 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002472 if( status != PSA_SUCCESS )
2473 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002474
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002475 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002476 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002477 * buffer can in principle be empty since it doesn't actually have
2478 * to be a hash.) */
2479 if( signature_size == 0 )
2480 return( PSA_ERROR_BUFFER_TOO_SMALL );
2481
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002482 status = psa_get_and_lock_key_slot_with_policy(
2483 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002484 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2485 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002486 alg );
2487
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002488 if( status != PSA_SUCCESS )
2489 goto exit;
2490
2491 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2492 {
2493 status = PSA_ERROR_INVALID_ARGUMENT;
2494 goto exit;
2495 }
2496
2497 psa_key_attributes_t attributes = {
2498 .core = slot->attr
2499 };
2500
gabor-mezei-armf0486182021-05-12 11:03:09 +02002501 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002502 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002503 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002504 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002505 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002506 signature, signature_size, signature_length );
2507 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002508 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002509 {
2510
2511 status = psa_driver_wrapper_sign_hash(
2512 &attributes, slot->key.data, slot->key.bytes,
2513 alg, input, input_length,
2514 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002515 }
2516
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002517
2518exit:
2519 /* Fill the unused part of the output buffer (the whole buffer on error,
2520 * the trailing part on success) with something that isn't a valid signature
2521 * (barring an attack on the signature and deliberately-crafted input),
2522 * in case the caller doesn't check the return status properly. */
2523 if( status == PSA_SUCCESS )
2524 memset( signature + *signature_length, '!',
2525 signature_size - *signature_length );
2526 else
2527 memset( signature, '!', signature_size );
2528 /* If signature_size is 0 then we have nothing to do. We must not call
2529 * memset because signature may be NULL in this case. */
2530
2531 unlock_status = psa_unlock_key_slot( slot );
2532
2533 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2534}
2535
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002536static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002537 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002538 psa_algorithm_t alg,
2539 const uint8_t * input,
2540 size_t input_length,
2541 const uint8_t * signature,
2542 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002543{
2544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2545 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2546 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002547
gabor-mezei-armf0486182021-05-12 11:03:09 +02002548 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002549 if( status != PSA_SUCCESS )
2550 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002551
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002552 status = psa_get_and_lock_key_slot_with_policy(
2553 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002554 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2555 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002556 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002557
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002558 if( status != PSA_SUCCESS )
2559 return( status );
2560
2561 psa_key_attributes_t attributes = {
2562 .core = slot->attr
2563 };
2564
gabor-mezei-armf0486182021-05-12 11:03:09 +02002565 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002566 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002567 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002568 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002569 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002570 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002571 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002572 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002573 {
2574 status = psa_driver_wrapper_verify_hash(
2575 &attributes, slot->key.data, slot->key.bytes,
2576 alg, input, input_length,
2577 signature, signature_length );
2578 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002579
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002580 unlock_status = psa_unlock_key_slot( slot );
2581
2582 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002583
2584}
2585
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002586psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002587 const psa_key_attributes_t *attributes,
2588 const uint8_t *key_buffer,
2589 size_t key_buffer_size,
2590 psa_algorithm_t alg,
2591 const uint8_t *input,
2592 size_t input_length,
2593 uint8_t *signature,
2594 size_t signature_size,
2595 size_t *signature_length )
2596{
2597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002598
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002599 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2600 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002601 size_t hash_length;
2602 uint8_t hash[PSA_HASH_MAX_SIZE];
2603
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002604 status = psa_driver_wrapper_hash_compute(
2605 PSA_ALG_SIGN_GET_HASH( alg ),
2606 input, input_length,
2607 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002608
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002609 if( status != PSA_SUCCESS )
2610 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002611
2612 return psa_driver_wrapper_sign_hash(
2613 attributes, key_buffer, key_buffer_size,
2614 alg, hash, hash_length,
2615 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002616 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002617
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002618 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002619}
2620
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002621psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2622 psa_algorithm_t alg,
2623 const uint8_t * input,
2624 size_t input_length,
2625 uint8_t * signature,
2626 size_t signature_size,
2627 size_t * signature_length )
2628{
2629 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002630 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002631 signature, signature_size, signature_length );
2632}
2633
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002634psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002635 const psa_key_attributes_t *attributes,
2636 const uint8_t *key_buffer,
2637 size_t key_buffer_size,
2638 psa_algorithm_t alg,
2639 const uint8_t *input,
2640 size_t input_length,
2641 const uint8_t *signature,
2642 size_t signature_length )
2643{
2644 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002645
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002646 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2647 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002648 size_t hash_length;
2649 uint8_t hash[PSA_HASH_MAX_SIZE];
2650
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002651 status = psa_driver_wrapper_hash_compute(
2652 PSA_ALG_SIGN_GET_HASH( alg ),
2653 input, input_length,
2654 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002655
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002656 if( status != PSA_SUCCESS )
2657 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002658
2659 return psa_driver_wrapper_verify_hash(
2660 attributes, key_buffer, key_buffer_size,
2661 alg, hash, hash_length,
2662 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002663 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002664
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002665 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002666}
2667
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002668psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2669 psa_algorithm_t alg,
2670 const uint8_t * input,
2671 size_t input_length,
2672 const uint8_t * signature,
2673 size_t signature_length )
2674{
2675 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002676 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002677 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002678}
2679
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002680psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002681 const psa_key_attributes_t *attributes,
2682 const uint8_t *key_buffer, size_t key_buffer_size,
2683 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2684 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002685{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002686 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002687 {
Ronald Cron4501c982021-03-19 20:09:32 +01002688 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2689 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002690 {
Ronald Cron4501c982021-03-19 20:09:32 +01002691#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2692 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2693 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002694 attributes,
2695 key_buffer, key_buffer_size,
2696 alg, hash, hash_length,
2697 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002698#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2699 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002700 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002701 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002702 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002703 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002704 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002705 }
2706 else
Ronald Cron4501c982021-03-19 20:09:32 +01002707 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2708 {
2709 if( PSA_ALG_IS_ECDSA( alg ) )
2710 {
2711#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2712 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2713 return( mbedtls_psa_ecdsa_sign_hash(
2714 attributes,
2715 key_buffer, key_buffer_size,
2716 alg, hash, hash_length,
2717 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002718#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2719 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002720 }
2721 else
2722 {
2723 return( PSA_ERROR_INVALID_ARGUMENT );
2724 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002725 }
Ronald Cron4501c982021-03-19 20:09:32 +01002726
2727 (void)key_buffer;
2728 (void)key_buffer_size;
2729 (void)hash;
2730 (void)hash_length;
2731 (void)signature;
2732 (void)signature_size;
2733 (void)signature_length;
2734
2735 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002736}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002737
2738psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2739 psa_algorithm_t alg,
2740 const uint8_t *hash,
2741 size_t hash_length,
2742 uint8_t *signature,
2743 size_t signature_size,
2744 size_t *signature_length )
2745{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002746 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002747 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002748 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002749}
2750
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002751psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002752 const psa_key_attributes_t *attributes,
2753 const uint8_t *key_buffer, size_t key_buffer_size,
2754 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2755 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002756{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002757 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002758 {
Ronald Cron4501c982021-03-19 20:09:32 +01002759 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2760 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002761 {
Ronald Cron4501c982021-03-19 20:09:32 +01002762#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2763 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2764 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002765 attributes,
2766 key_buffer, key_buffer_size,
2767 alg, hash, hash_length,
2768 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002769#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2770 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002771 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002772 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002773 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002774 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002775 }
itayzafrir5c753392018-05-08 11:18:38 +03002776 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002777 else
Ronald Cron4501c982021-03-19 20:09:32 +01002778 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002779 {
Ronald Cron4501c982021-03-19 20:09:32 +01002780 if( PSA_ALG_IS_ECDSA( alg ) )
2781 {
2782#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2783 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2784 return( mbedtls_psa_ecdsa_verify_hash(
2785 attributes,
2786 key_buffer, key_buffer_size,
2787 alg, hash, hash_length,
2788 signature, signature_length ) );
2789#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2790 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2791 }
2792 else
2793 {
2794 return( PSA_ERROR_INVALID_ARGUMENT );
2795 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002796 }
Ronald Cron4501c982021-03-19 20:09:32 +01002797
2798 (void)key_buffer;
2799 (void)key_buffer_size;
2800 (void)hash;
2801 (void)hash_length;
2802 (void)signature;
2803 (void)signature_length;
2804
2805 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002806}
2807
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002808psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2809 psa_algorithm_t alg,
2810 const uint8_t *hash,
2811 size_t hash_length,
2812 const uint8_t *signature,
2813 size_t signature_length )
2814{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002815 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002816 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002817 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002818}
2819
John Durkop0e005192020-10-31 22:06:54 -07002820#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002821static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2822 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002823{
2824 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2825 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2826 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002827
2828 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002829}
John Durkop0e005192020-10-31 22:06:54 -07002830#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002831
Ronald Croncf56a0a2020-08-04 09:51:30 +02002832psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002833 psa_algorithm_t alg,
2834 const uint8_t *input,
2835 size_t input_length,
2836 const uint8_t *salt,
2837 size_t salt_length,
2838 uint8_t *output,
2839 size_t output_size,
2840 size_t *output_length )
2841{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002842 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002843 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002844 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002845
Darryl Green5cc689a2018-07-24 15:34:10 +01002846 (void) input;
2847 (void) input_length;
2848 (void) salt;
2849 (void) output;
2850 (void) output_size;
2851
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002852 *output_length = 0;
2853
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002854 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2855 return( PSA_ERROR_INVALID_ARGUMENT );
2856
Ronald Cron5c522922020-11-14 16:35:34 +01002857 status = psa_get_and_lock_transparent_key_slot_with_policy(
2858 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002859 if( status != PSA_SUCCESS )
2860 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002861 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2862 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002863 {
2864 status = PSA_ERROR_INVALID_ARGUMENT;
2865 goto exit;
2866 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002867
John Durkop6ba40d12020-11-10 08:50:04 -08002868#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2869 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002870 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002871 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002872 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002873 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2874 slot->key.data,
2875 slot->key.bytes,
2876 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002877 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02002878 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02002879
2880 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002881 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002882 status = PSA_ERROR_BUFFER_TOO_SMALL;
2883 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002884 }
John Durkop0e005192020-10-31 22:06:54 -07002885#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002886 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
2887 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002888 status = mbedtls_to_psa_error(
2889 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002890 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002891 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002892 input_length,
2893 input,
2894 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002895 }
2896 else
John Durkop0e005192020-10-31 22:06:54 -07002897#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2898#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002899 if( PSA_ALG_IS_RSA_OAEP( alg ) )
2900 {
Ronald Cronea7631b2021-06-03 18:51:59 +02002901 status = mbedtls_to_psa_error(
2902 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
2903 if( status != PSA_SUCCESS )
2904 goto rsa_exit;
2905
Steven Cooreman4fed4552020-08-03 14:46:03 +02002906 status = mbedtls_to_psa_error(
2907 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002908 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002909 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002910 salt, salt_length,
2911 input_length,
2912 input,
2913 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002914 }
2915 else
John Durkop0e005192020-10-31 22:06:54 -07002916#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002917 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002918 status = PSA_ERROR_INVALID_ARGUMENT;
2919 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002920 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02002921rsa_exit:
2922 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02002923 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002924
Steven Cooremana2371e52020-07-28 14:30:39 +02002925 mbedtls_rsa_free( rsa );
2926 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002927 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002928 else
John Durkop9814fa22020-11-04 12:28:15 -08002929#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08002930 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002931 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002932 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002933 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002934
2935exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002936 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002937
Ronald Cron5c522922020-11-14 16:35:34 +01002938 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002939}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002940
Ronald Croncf56a0a2020-08-04 09:51:30 +02002941psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002942 psa_algorithm_t alg,
2943 const uint8_t *input,
2944 size_t input_length,
2945 const uint8_t *salt,
2946 size_t salt_length,
2947 uint8_t *output,
2948 size_t output_size,
2949 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002950{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002951 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002952 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002953 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002954
Darryl Green5cc689a2018-07-24 15:34:10 +01002955 (void) input;
2956 (void) input_length;
2957 (void) salt;
2958 (void) output;
2959 (void) output_size;
2960
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002961 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002962
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002963 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2964 return( PSA_ERROR_INVALID_ARGUMENT );
2965
Ronald Cron5c522922020-11-14 16:35:34 +01002966 status = psa_get_and_lock_transparent_key_slot_with_policy(
2967 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002968 if( status != PSA_SUCCESS )
2969 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002970 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002971 {
2972 status = PSA_ERROR_INVALID_ARGUMENT;
2973 goto exit;
2974 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002975
John Durkop6ba40d12020-11-10 08:50:04 -08002976#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2977 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002978 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002979 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002980 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002981 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2982 slot->key.data,
2983 slot->key.bytes,
2984 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002985 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002986 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002987
Steven Cooremana2371e52020-07-28 14:30:39 +02002988 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002989 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002990 status = PSA_ERROR_INVALID_ARGUMENT;
2991 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002992 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002993
John Durkop0e005192020-10-31 22:06:54 -07002994#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02002995 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002996 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002997 status = mbedtls_to_psa_error(
2998 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002999 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003000 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003001 output_length,
3002 input,
3003 output,
3004 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003005 }
3006 else
John Durkop0e005192020-10-31 22:06:54 -07003007#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3008#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003009 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003010 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003011 status = mbedtls_to_psa_error(
3012 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3013 if( status != PSA_SUCCESS )
3014 goto rsa_exit;
3015
Steven Cooreman4fed4552020-08-03 14:46:03 +02003016 status = mbedtls_to_psa_error(
3017 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003018 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003019 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003020 salt, salt_length,
3021 output_length,
3022 input,
3023 output,
3024 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003025 }
3026 else
John Durkop0e005192020-10-31 22:06:54 -07003027#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003028 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003029 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003030 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003031
Steven Cooreman4fed4552020-08-03 14:46:03 +02003032rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003033 mbedtls_rsa_free( rsa );
3034 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003035 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003036 else
John Durkop6ba40d12020-11-10 08:50:04 -08003037#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3038 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003039 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003040 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003042
3043exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003044 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003045
Ronald Cron5c522922020-11-14 16:35:34 +01003046 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003047}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003048
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003049
3050
mohammad1603503973b2018-03-12 15:59:30 +02003051/****************************************************************/
3052/* Symmetric cryptography */
3053/****************************************************************/
3054
Ronald Cronab99ac22020-10-01 16:38:28 +02003055static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3056 mbedtls_svc_key_id_t key,
3057 psa_algorithm_t alg,
3058 mbedtls_operation_t cipher_operation )
3059{
3060 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3061 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3062 psa_key_slot_t *slot;
3063 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3064 PSA_KEY_USAGE_ENCRYPT :
3065 PSA_KEY_USAGE_DECRYPT );
3066
3067 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003068 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003069 return( PSA_ERROR_BAD_STATE );
3070
3071 /* The requested algorithm must be one that can be processed by cipher. */
3072 if( ! PSA_ALG_IS_CIPHER( alg ) )
3073 return( PSA_ERROR_INVALID_ARGUMENT );
3074
3075 /* Fetch key material from key storage. */
3076 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3077 if( status != PSA_SUCCESS )
3078 goto exit;
3079
Ronald Cron49fafa92021-03-10 08:34:23 +01003080 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003081 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003082 * so we only set it (in the driver wrapper) after resources have been
3083 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003084 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003085 if( alg == PSA_ALG_ECB_NO_PADDING )
3086 operation->iv_required = 0;
3087 else
3088 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003089 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003090
Ronald Crona4af55f2020-12-14 14:36:06 +01003091 psa_key_attributes_t attributes = {
3092 .core = slot->attr
3093 };
3094
Ronald Cronab99ac22020-10-01 16:38:28 +02003095 /* Try doing the operation through a driver before using software fallback. */
3096 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003097 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3098 &attributes,
3099 slot->key.data,
3100 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003101 alg );
3102 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003103 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3104 &attributes,
3105 slot->key.data,
3106 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003107 alg );
3108
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003109exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003110 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003111 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112
Ronald Cron5c522922020-11-14 16:35:34 +01003113 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114
Ronald Cron5c522922020-11-14 16:35:34 +01003115 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003116}
3117
Gilles Peskinefe119512018-07-08 21:39:34 +02003118psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003119 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003120 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003121{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003122 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003123}
3124
Gilles Peskinefe119512018-07-08 21:39:34 +02003125psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003126 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003127 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003128{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003129 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003130}
3131
Gilles Peskinefe119512018-07-08 21:39:34 +02003132psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003133 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003134 size_t iv_size,
3135 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003136{
Ronald Cron6d051732020-10-01 14:10:20 +02003137 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003138
Ronald Cron5618a392021-03-26 09:52:26 +01003139 *iv_length = 0;
3140
Ronald Cron49fafa92021-03-10 08:34:23 +01003141 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003142 {
3143 return( PSA_ERROR_BAD_STATE );
3144 }
3145
Steven Cooreman7df02922020-09-09 15:28:49 +02003146 if( operation->iv_set || ! operation->iv_required )
3147 {
3148 return( PSA_ERROR_BAD_STATE );
3149 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003150
Ronald Cron5618a392021-03-26 09:52:26 +01003151 if( iv_size < operation->default_iv_length )
3152 {
3153 status = PSA_ERROR_BUFFER_TOO_SMALL;
3154 goto exit;
3155 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003156
Ronald Cron5618a392021-03-26 09:52:26 +01003157 status = psa_generate_random( iv, operation->default_iv_length );
3158 if( status != PSA_SUCCESS )
3159 goto exit;
3160
3161 status = psa_driver_wrapper_cipher_set_iv( operation,
3162 iv,
3163 operation->default_iv_length );
3164
3165exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003166 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003167 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003168 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003169 *iv_length = operation->default_iv_length;
3170 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003171 else
Moran Peker395db872018-05-31 14:07:14 +03003172 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003173
itayzafrir534bd7c2018-08-02 13:56:32 +03003174 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003175}
3176
Gilles Peskinefe119512018-07-08 21:39:34 +02003177psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003178 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003179 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003180{
Ronald Cron6d051732020-10-01 14:10:20 +02003181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003182
Ronald Cron49fafa92021-03-10 08:34:23 +01003183 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003184 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003185
Steven Cooreman7df02922020-09-09 15:28:49 +02003186 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003187 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003188
3189 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3190 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003191
Ronald Crondd24c9b2020-12-15 14:10:01 +01003192 status = psa_driver_wrapper_cipher_set_iv( operation,
3193 iv,
3194 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003195
itayzafrir534bd7c2018-08-02 13:56:32 +03003196 if( status == PSA_SUCCESS )
3197 operation->iv_set = 1;
3198 else
mohammad1603503973b2018-03-12 15:59:30 +02003199 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003200 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003201}
3202
Gilles Peskinee553c652018-06-04 16:22:46 +02003203psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3204 const uint8_t *input,
3205 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003206 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003207 size_t output_size,
3208 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003209{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003210 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003211
Ronald Cron49fafa92021-03-10 08:34:23 +01003212 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003213 {
3214 return( PSA_ERROR_BAD_STATE );
3215 }
3216 if( operation->iv_required && ! operation->iv_set )
3217 {
3218 return( PSA_ERROR_BAD_STATE );
3219 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003220
Ronald Crondd24c9b2020-12-15 14:10:01 +01003221 status = psa_driver_wrapper_cipher_update( operation,
3222 input,
3223 input_length,
3224 output,
3225 output_size,
3226 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003227 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003228 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003229
itayzafrir534bd7c2018-08-02 13:56:32 +03003230 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003231}
3232
Gilles Peskinee553c652018-06-04 16:22:46 +02003233psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3234 uint8_t *output,
3235 size_t output_size,
3236 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003237{
David Saadab4ecc272019-02-14 13:48:10 +02003238 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003239
Ronald Cron49fafa92021-03-10 08:34:23 +01003240 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003241 {
3242 return( PSA_ERROR_BAD_STATE );
3243 }
3244 if( operation->iv_required && ! operation->iv_set )
3245 {
3246 return( PSA_ERROR_BAD_STATE );
3247 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003248
Ronald Crondd24c9b2020-12-15 14:10:01 +01003249 status = psa_driver_wrapper_cipher_finish( operation,
3250 output,
3251 output_size,
3252 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003253 if( status == PSA_SUCCESS )
3254 return( psa_cipher_abort( operation ) );
3255 else
3256 {
3257 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003258 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003259
Steven Cooremanef8575e2020-09-11 11:44:50 +02003260 return( status );
3261 }
mohammad1603503973b2018-03-12 15:59:30 +02003262}
3263
Gilles Peskinee553c652018-06-04 16:22:46 +02003264psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3265{
Ronald Cron49fafa92021-03-10 08:34:23 +01003266 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003267 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003268 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003269 * in use. It's ok to call abort on such an object, and there's
3270 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003271 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003272 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003273
Ronald Crondd24c9b2020-12-15 14:10:01 +01003274 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003275
Ronald Cron49fafa92021-03-10 08:34:23 +01003276 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003277 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003278 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003279
Moran Peker395db872018-05-31 14:07:14 +03003280 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003281}
3282
mohammad16035955c982018-04-26 00:53:03 +03003283/****************************************************************/
3284/* AEAD */
3285/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003286
Ronald Croncf56a0a2020-08-04 09:51:30 +02003287psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003288 psa_algorithm_t alg,
3289 const uint8_t *nonce,
3290 size_t nonce_length,
3291 const uint8_t *additional_data,
3292 size_t additional_data_length,
3293 const uint8_t *plaintext,
3294 size_t plaintext_length,
3295 uint8_t *ciphertext,
3296 size_t ciphertext_size,
3297 size_t *ciphertext_length )
3298{
Ronald Cron215633c2021-03-16 17:15:37 +01003299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3300 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003301
mohammad1603f08a5502018-06-03 15:05:47 +03003302 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003303
Steven Cooremanea7ab132021-03-17 16:28:00 +01003304 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3305 return( PSA_ERROR_NOT_SUPPORTED );
3306
Ronald Cron9a986162021-03-26 12:40:07 +01003307 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003308 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003309 if( status != PSA_SUCCESS )
3310 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003311
Ronald Cron215633c2021-03-16 17:15:37 +01003312 psa_key_attributes_t attributes = {
3313 .core = slot->attr
3314 };
mohammad16035955c982018-04-26 00:53:03 +03003315
Ronald Cronde822812021-03-17 16:08:20 +01003316 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003317 &attributes, slot->key.data, slot->key.bytes,
3318 alg,
3319 nonce, nonce_length,
3320 additional_data, additional_data_length,
3321 plaintext, plaintext_length,
3322 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003323
Gilles Peskineedf9a652018-08-17 18:11:56 +02003324 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3325 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003326
Ronald Cron9f310172021-03-16 16:36:37 +01003327 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003328
mohammad16035955c982018-04-26 00:53:03 +03003329 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003330}
3331
Ronald Croncf56a0a2020-08-04 09:51:30 +02003332psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003333 psa_algorithm_t alg,
3334 const uint8_t *nonce,
3335 size_t nonce_length,
3336 const uint8_t *additional_data,
3337 size_t additional_data_length,
3338 const uint8_t *ciphertext,
3339 size_t ciphertext_length,
3340 uint8_t *plaintext,
3341 size_t plaintext_size,
3342 size_t *plaintext_length )
3343{
Ronald Cron215633c2021-03-16 17:15:37 +01003344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3345 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003346
Gilles Peskineee652a32018-06-01 19:23:52 +02003347 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003348
Steven Cooremanea7ab132021-03-17 16:28:00 +01003349 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3350 return( PSA_ERROR_NOT_SUPPORTED );
3351
Ronald Cron9a986162021-03-26 12:40:07 +01003352 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003353 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003354 if( status != PSA_SUCCESS )
3355 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003356
Ronald Cron215633c2021-03-16 17:15:37 +01003357 psa_key_attributes_t attributes = {
3358 .core = slot->attr
3359 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003360
Ronald Cronde822812021-03-17 16:08:20 +01003361 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003362 &attributes, slot->key.data, slot->key.bytes,
3363 alg,
3364 nonce, nonce_length,
3365 additional_data, additional_data_length,
3366 ciphertext, ciphertext_length,
3367 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003368
Gilles Peskineedf9a652018-08-17 18:11:56 +02003369 if( status != PSA_SUCCESS && plaintext_size != 0 )
3370 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003371
Ronald Cron215633c2021-03-16 17:15:37 +01003372 psa_unlock_key_slot( slot );
3373
Gilles Peskineedf9a652018-08-17 18:11:56 +02003374 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003375}
3376
Gilles Peskinee59236f2018-01-27 23:32:46 +01003377/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003378/* Generators */
3379/****************************************************************/
3380
John Durkop07cc04a2020-11-16 22:08:34 -08003381#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3382 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3383 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3384#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003385#endif /* At least one builtin KDF */
3386
3387#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3388 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3389 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3390static psa_status_t psa_key_derivation_start_hmac(
3391 psa_mac_operation_t *operation,
3392 psa_algorithm_t hash_alg,
3393 const uint8_t *hmac_key,
3394 size_t hmac_key_length )
3395{
3396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3397 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3398 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3399 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3400 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3401
Steven Cooreman72f736a2021-05-07 14:14:37 +02003402 operation->is_sign = 1;
3403 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3404
Steven Cooreman094a77e2021-05-06 17:58:36 +02003405 status = psa_driver_wrapper_mac_sign_setup( operation,
3406 &attributes,
3407 hmac_key, hmac_key_length,
3408 PSA_ALG_HMAC( hash_alg ) );
3409
3410 psa_reset_key_attributes( &attributes );
3411 return( status );
3412}
3413#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003414
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003415#define HKDF_STATE_INIT 0 /* no input yet */
3416#define HKDF_STATE_STARTED 1 /* got salt */
3417#define HKDF_STATE_KEYED 2 /* got key */
3418#define HKDF_STATE_OUTPUT 3 /* output started */
3419
Gilles Peskinecbe66502019-05-16 16:59:18 +02003420static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003421 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003422{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003423 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3424 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003425 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003426 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003427}
3428
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003429psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003430{
3431 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003432 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003433 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003434 {
3435 /* The object has (apparently) been initialized but it is not
3436 * in use. It's ok to call abort on such an object, and there's
3437 * nothing to do. */
3438 }
3439 else
John Durkopd0321952020-10-29 21:37:36 -07003440#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003441 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003442 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003443 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003444 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003445 }
John Durkop07cc04a2020-11-16 22:08:34 -08003446 else
3447#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3448#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3449 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3450 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003451 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003452 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003453 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003454 if( operation->ctx.tls12_prf.secret != NULL )
3455 {
3456 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3457 operation->ctx.tls12_prf.secret_length );
3458 mbedtls_free( operation->ctx.tls12_prf.secret );
3459 }
3460
Janos Follath6a1d2622019-06-11 10:37:28 +01003461 if( operation->ctx.tls12_prf.seed != NULL )
3462 {
3463 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3464 operation->ctx.tls12_prf.seed_length );
3465 mbedtls_free( operation->ctx.tls12_prf.seed );
3466 }
3467
3468 if( operation->ctx.tls12_prf.label != NULL )
3469 {
3470 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3471 operation->ctx.tls12_prf.label_length );
3472 mbedtls_free( operation->ctx.tls12_prf.label );
3473 }
3474
Steven Cooremana6df6042021-04-29 19:32:25 +02003475 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003476
3477 /* We leave the fields Ai and output_block to be erased safely by the
3478 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003479 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003480 else
John Durkop07cc04a2020-11-16 22:08:34 -08003481#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3482 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003483 {
3484 status = PSA_ERROR_BAD_STATE;
3485 }
Janos Follath083036a2019-06-11 10:22:26 +01003486 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003487 return( status );
3488}
3489
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003490psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003491 size_t *capacity)
3492{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003493 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003494 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003495 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003496 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003497 }
3498
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003499 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003500 return( PSA_SUCCESS );
3501}
3502
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003503psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003504 size_t capacity )
3505{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003506 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003507 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003508 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003509 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003510 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003511 return( PSA_SUCCESS );
3512}
3513
John Durkopd0321952020-10-29 21:37:36 -07003514#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003515/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003516 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003517static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003518 psa_algorithm_t hash_alg,
3519 uint8_t *output,
3520 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003521{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003522 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003523 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003524 psa_status_t status;
3525
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003526 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3527 return( PSA_ERROR_BAD_STATE );
3528 hkdf->state = HKDF_STATE_OUTPUT;
3529
Gilles Peskinebef7f142018-07-12 17:22:21 +02003530 while( output_length != 0 )
3531 {
3532 /* Copy what remains of the current block */
3533 uint8_t n = hash_length - hkdf->offset_in_block;
3534 if( n > output_length )
3535 n = (uint8_t) output_length;
3536 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3537 output += n;
3538 output_length -= n;
3539 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003540 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003541 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003542 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003543 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003544 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003545 * object was corrupted or if this function is called directly
3546 * inside the library. */
3547 if( hkdf->block_number == 0xff )
3548 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003549
3550 /* We need a new block */
3551 ++hkdf->block_number;
3552 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003553
Steven Cooreman094a77e2021-05-06 17:58:36 +02003554 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3555 hash_alg,
3556 hkdf->prk,
3557 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003558 if( status != PSA_SUCCESS )
3559 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003560
Gilles Peskinebef7f142018-07-12 17:22:21 +02003561 if( hkdf->block_number != 1 )
3562 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003563 status = psa_mac_update( &hkdf->hmac,
3564 hkdf->output_block,
3565 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003566 if( status != PSA_SUCCESS )
3567 return( status );
3568 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003569 status = psa_mac_update( &hkdf->hmac,
3570 hkdf->info,
3571 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003572 if( status != PSA_SUCCESS )
3573 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003574 status = psa_mac_update( &hkdf->hmac,
3575 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003576 if( status != PSA_SUCCESS )
3577 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003578 status = psa_mac_sign_finish( &hkdf->hmac,
3579 hkdf->output_block,
3580 sizeof( hkdf->output_block ),
3581 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003582 if( status != PSA_SUCCESS )
3583 return( status );
3584 }
3585
3586 return( PSA_SUCCESS );
3587}
John Durkop07cc04a2020-11-16 22:08:34 -08003588#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003589
John Durkop07cc04a2020-11-16 22:08:34 -08003590#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3591 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003592static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3593 psa_tls12_prf_key_derivation_t *tls12_prf,
3594 psa_algorithm_t alg )
3595{
3596 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003597 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003598 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3599 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003600 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003601
Janos Follath7742fee2019-06-17 12:58:10 +01003602 /* We can't be wanting more output after block 0xff, otherwise
3603 * the capacity check in psa_key_derivation_output_bytes() would have
3604 * prevented this call. It could happen only if the operation
3605 * object was corrupted or if this function is called directly
3606 * inside the library. */
3607 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003608 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003609
3610 /* We need a new block */
3611 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003612 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003613
3614 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3615 *
3616 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3617 *
3618 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3619 * HMAC_hash(secret, A(2) + seed) +
3620 * HMAC_hash(secret, A(3) + seed) + ...
3621 *
3622 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003623 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003624 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003625 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003626 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003627 * is currently extracted as `output_block` and where i is
3628 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003629 */
3630
Steven Cooreman094a77e2021-05-06 17:58:36 +02003631 status = psa_key_derivation_start_hmac( &hmac,
3632 hash_alg,
3633 tls12_prf->secret,
3634 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003635 if( status != PSA_SUCCESS )
3636 goto cleanup;
3637
3638 /* Calculate A(i) where i = tls12_prf->block_number. */
3639 if( tls12_prf->block_number == 1 )
3640 {
3641 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3642 * the variable seed and in this instance means it in the context of the
3643 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003644 status = psa_mac_update( &hmac,
3645 tls12_prf->label,
3646 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003647 if( status != PSA_SUCCESS )
3648 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003649 status = psa_mac_update( &hmac,
3650 tls12_prf->seed,
3651 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003652 if( status != PSA_SUCCESS )
3653 goto cleanup;
3654 }
3655 else
3656 {
3657 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003658 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003659 if( status != PSA_SUCCESS )
3660 goto cleanup;
3661 }
3662
Steven Cooremana6df6042021-04-29 19:32:25 +02003663 status = psa_mac_sign_finish( &hmac,
3664 tls12_prf->Ai, hash_length,
3665 &hmac_output_length );
3666 if( hmac_output_length != hash_length )
3667 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003668 if( status != PSA_SUCCESS )
3669 goto cleanup;
3670
3671 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003672 status = psa_key_derivation_start_hmac( &hmac,
3673 hash_alg,
3674 tls12_prf->secret,
3675 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003676 if( status != PSA_SUCCESS )
3677 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003678 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003679 if( status != PSA_SUCCESS )
3680 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003681 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003682 if( status != PSA_SUCCESS )
3683 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003684 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003685 if( status != PSA_SUCCESS )
3686 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003687 status = psa_mac_sign_finish( &hmac,
3688 tls12_prf->output_block, hash_length,
3689 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003690 if( status != PSA_SUCCESS )
3691 goto cleanup;
3692
Janos Follath7742fee2019-06-17 12:58:10 +01003693
3694cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003695 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003696 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3697 status = cleanup_status;
3698
3699 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003700}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003701
Janos Follath844eb0e2019-06-19 12:10:49 +01003702static psa_status_t psa_key_derivation_tls12_prf_read(
3703 psa_tls12_prf_key_derivation_t *tls12_prf,
3704 psa_algorithm_t alg,
3705 uint8_t *output,
3706 size_t output_length )
3707{
3708 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003709 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003710 psa_status_t status;
3711 uint8_t offset, length;
3712
3713 while( output_length != 0 )
3714 {
3715 /* Check if we have fully processed the current block. */
3716 if( tls12_prf->left_in_block == 0 )
3717 {
3718 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3719 alg );
3720 if( status != PSA_SUCCESS )
3721 return( status );
3722
3723 continue;
3724 }
3725
3726 if( tls12_prf->left_in_block > output_length )
3727 length = (uint8_t) output_length;
3728 else
3729 length = tls12_prf->left_in_block;
3730
3731 offset = hash_length - tls12_prf->left_in_block;
3732 memcpy( output, tls12_prf->output_block + offset, length );
3733 output += length;
3734 output_length -= length;
3735 tls12_prf->left_in_block -= length;
3736 }
3737
3738 return( PSA_SUCCESS );
3739}
John Durkop07cc04a2020-11-16 22:08:34 -08003740#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3741 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003742
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003743psa_status_t psa_key_derivation_output_bytes(
3744 psa_key_derivation_operation_t *operation,
3745 uint8_t *output,
3746 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003747{
3748 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003749 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003750
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003751 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003752 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003753 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003754 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003755 }
3756
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003757 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003758 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003759 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003760 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003761 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003762 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003763 goto exit;
3764 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003765 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003766 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003767 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003768 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003769 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3770 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003771 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003772 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003773 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003774 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003775 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003776
John Durkopd0321952020-10-29 21:37:36 -07003777#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003778 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003779 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003780 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003781 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003782 output, output_length );
3783 }
Janos Follathadbec812019-06-14 11:05:39 +01003784 else
John Durkop07cc04a2020-11-16 22:08:34 -08003785#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3786#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3787 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003788 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003789 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003790 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003791 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003792 kdf_alg, output,
3793 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003794 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003795 else
John Durkop07cc04a2020-11-16 22:08:34 -08003796#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3797 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003798 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003799 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003800 return( PSA_ERROR_BAD_STATE );
3801 }
3802
3803exit:
3804 if( status != PSA_SUCCESS )
3805 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003806 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003807 * This allows us to differentiate between exhausted operations and
3808 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3809 * operations. */
3810 psa_algorithm_t alg = operation->alg;
3811 psa_key_derivation_abort( operation );
3812 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003813 memset( output, '!', output_length );
3814 }
3815 return( status );
3816}
3817
David Brown7807bf72021-02-09 16:28:23 -07003818#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003819static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3820{
3821 if( data_size >= 8 )
3822 mbedtls_des_key_set_parity( data );
3823 if( data_size >= 16 )
3824 mbedtls_des_key_set_parity( data + 8 );
3825 if( data_size >= 24 )
3826 mbedtls_des_key_set_parity( data + 16 );
3827}
David Brown7807bf72021-02-09 16:28:23 -07003828#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003829
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003830static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003831 psa_key_slot_t *slot,
3832 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003833 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003834{
3835 uint8_t *data = NULL;
3836 size_t bytes = PSA_BITS_TO_BYTES( bits );
3837 psa_status_t status;
3838
Gilles Peskine8e338702019-07-30 20:06:31 +02003839 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003840 return( PSA_ERROR_INVALID_ARGUMENT );
3841 if( bits % 8 != 0 )
3842 return( PSA_ERROR_INVALID_ARGUMENT );
3843 data = mbedtls_calloc( 1, bytes );
3844 if( data == NULL )
3845 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3846
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003847 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003848 if( status != PSA_SUCCESS )
3849 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003850#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003851 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003852 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003853#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003854
3855 status = psa_allocate_buffer_to_slot( slot, bytes );
3856 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003857 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003858
Ronald Cronbf33c932020-11-28 18:06:53 +01003859 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003860 psa_key_attributes_t attributes = {
3861 .core = slot->attr
3862 };
3863
Ronald Cronbf33c932020-11-28 18:06:53 +01003864 status = psa_driver_wrapper_import_key( &attributes,
3865 data, bytes,
3866 slot->key.data,
3867 slot->key.bytes,
3868 &slot->key.bytes, &bits );
3869 if( bits != slot->attr.bits )
3870 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003871
3872exit:
3873 mbedtls_free( data );
3874 return( status );
3875}
3876
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003877psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003878 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003879 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003880{
3881 psa_status_t status;
3882 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02003883 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02003884
Ronald Cron81709fc2020-11-14 12:10:32 +01003885 *key = MBEDTLS_SVC_KEY_ID_INIT;
3886
Gilles Peskine0f84d622019-09-12 19:03:13 +02003887 /* Reject any attempt to create a zero-length key so that we don't
3888 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
3889 if( psa_get_key_bits( attributes ) == 0 )
3890 return( PSA_ERROR_INVALID_ARGUMENT );
3891
Gilles Peskine178c9aa2019-09-24 18:21:06 +02003892 if( ! operation->can_output_key )
3893 return( PSA_ERROR_NOT_PERMITTED );
3894
Ronald Cron81709fc2020-11-14 12:10:32 +01003895 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
3896 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02003897#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3898 if( driver != NULL )
3899 {
3900 /* Deriving a key in a secure element is not implemented yet. */
3901 status = PSA_ERROR_NOT_SUPPORTED;
3902 }
3903#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003904 if( status == PSA_SUCCESS )
3905 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003906 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02003907 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003908 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003909 }
3910 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01003911 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003912 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02003913 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003914
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003915 return( status );
3916}
3917
Gilles Peskineeab56e42018-07-12 17:12:33 +02003918
3919
3920/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02003921/* Key derivation */
3922/****************************************************************/
3923
Steven Cooreman932ffb72021-02-15 12:14:32 +01003924#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003925static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003926 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003927 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003928{
John Durkop07cc04a2020-11-16 22:08:34 -08003929 int is_kdf_alg_supported;
3930
Janos Follath5fe19732019-06-20 15:09:30 +01003931 /* Make sure that operation->ctx is properly zero-initialised. (Macro
3932 * initialisers for this union leave some bytes unspecified.) */
3933 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
3934
Gilles Peskine969c5d62019-01-16 15:53:06 +01003935 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07003936#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08003937 if( PSA_ALG_IS_HKDF( kdf_alg ) )
3938 is_kdf_alg_supported = 1;
3939 else
3940#endif
3941#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
3942 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
3943 is_kdf_alg_supported = 1;
3944 else
3945#endif
3946#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3947 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
3948 is_kdf_alg_supported = 1;
3949 else
3950#endif
3951 is_kdf_alg_supported = 0;
3952
3953 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003954 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003955 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003956 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003957 if( hash_size == 0 )
3958 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003959 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
3960 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02003961 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003962 {
3963 return( PSA_ERROR_NOT_SUPPORTED );
3964 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003965 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01003966 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003967 }
John Durkop07cc04a2020-11-16 22:08:34 -08003968
3969 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003970}
John Durkop07cc04a2020-11-16 22:08:34 -08003971#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003972
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003973psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003974 psa_algorithm_t alg )
3975{
3976 psa_status_t status;
3977
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003978 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003979 return( PSA_ERROR_BAD_STATE );
3980
Gilles Peskine6843c292019-01-18 16:44:49 +01003981 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
3982 return( PSA_ERROR_INVALID_ARGUMENT );
3983 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003984 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01003985#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003986 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003987 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01003988#else
3989 return( PSA_ERROR_NOT_SUPPORTED );
3990#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003991 }
3992 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
3993 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01003994#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003995 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01003996#else
3997 return( PSA_ERROR_NOT_SUPPORTED );
3998#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003999 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004000 else
4001 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004002
4003 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004004 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004005 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004006}
4007
John Durkopd0321952020-10-29 21:37:36 -07004008#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004009static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004010 psa_algorithm_t hash_alg,
4011 psa_key_derivation_step_t step,
4012 const uint8_t *data,
4013 size_t data_length )
4014{
4015 psa_status_t status;
4016 switch( step )
4017 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004018 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004019 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004020 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004021 else
4022 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004023 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4024 hash_alg,
4025 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004026 if( status != PSA_SUCCESS )
4027 return( status );
4028 hkdf->state = HKDF_STATE_STARTED;
4029 return( PSA_SUCCESS );
4030 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004031 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004032 /* If no salt was provided, use an empty salt. */
4033 if( hkdf->state == HKDF_STATE_INIT )
4034 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004035 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4036 hash_alg,
4037 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004038 if( status != PSA_SUCCESS )
4039 return( status );
4040 hkdf->state = HKDF_STATE_STARTED;
4041 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004042 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004043 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004044 status = psa_mac_update( &hkdf->hmac,
4045 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004046 if( status != PSA_SUCCESS )
4047 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004048 status = psa_mac_sign_finish( &hkdf->hmac,
4049 hkdf->prk,
4050 sizeof( hkdf->prk ),
4051 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004052 if( status != PSA_SUCCESS )
4053 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004054 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004055 hkdf->block_number = 0;
4056 hkdf->state = HKDF_STATE_KEYED;
4057 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004058 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004059 if( hkdf->state == HKDF_STATE_OUTPUT )
4060 return( PSA_ERROR_BAD_STATE );
4061 if( hkdf->info_set )
4062 return( PSA_ERROR_BAD_STATE );
4063 hkdf->info_length = data_length;
4064 if( data_length != 0 )
4065 {
4066 hkdf->info = mbedtls_calloc( 1, data_length );
4067 if( hkdf->info == NULL )
4068 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4069 memcpy( hkdf->info, data, data_length );
4070 }
4071 hkdf->info_set = 1;
4072 return( PSA_SUCCESS );
4073 default:
4074 return( PSA_ERROR_INVALID_ARGUMENT );
4075 }
4076}
John Durkop07cc04a2020-11-16 22:08:34 -08004077#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004078
John Durkop07cc04a2020-11-16 22:08:34 -08004079#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4080 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004081static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4082 const uint8_t *data,
4083 size_t data_length )
4084{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004085 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004086 return( PSA_ERROR_BAD_STATE );
4087
Janos Follathd6dce9f2019-07-04 09:11:38 +01004088 if( data_length != 0 )
4089 {
4090 prf->seed = mbedtls_calloc( 1, data_length );
4091 if( prf->seed == NULL )
4092 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004093
Janos Follathd6dce9f2019-07-04 09:11:38 +01004094 memcpy( prf->seed, data, data_length );
4095 prf->seed_length = data_length;
4096 }
Janos Follathf08e2652019-06-13 09:05:41 +01004097
Gilles Peskine43f958b2020-12-13 14:55:14 +01004098 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004099
4100 return( PSA_SUCCESS );
4101}
4102
Janos Follath81550542019-06-13 14:26:34 +01004103static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004104 const uint8_t *data,
4105 size_t data_length )
4106{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004107 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004108 return( PSA_ERROR_BAD_STATE );
4109
Steven Cooremana6df6042021-04-29 19:32:25 +02004110 if( data_length != 0 )
4111 {
4112 prf->secret = mbedtls_calloc( 1, data_length );
4113 if( prf->secret == NULL )
4114 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4115
4116 memcpy( prf->secret, data, data_length );
4117 prf->secret_length = data_length;
4118 }
Janos Follath81550542019-06-13 14:26:34 +01004119
Gilles Peskine43f958b2020-12-13 14:55:14 +01004120 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004121
4122 return( PSA_SUCCESS );
4123}
4124
Janos Follath63028dd2019-06-13 09:15:47 +01004125static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4126 const uint8_t *data,
4127 size_t data_length )
4128{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004129 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004130 return( PSA_ERROR_BAD_STATE );
4131
Janos Follathd6dce9f2019-07-04 09:11:38 +01004132 if( data_length != 0 )
4133 {
4134 prf->label = mbedtls_calloc( 1, data_length );
4135 if( prf->label == NULL )
4136 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004137
Janos Follathd6dce9f2019-07-04 09:11:38 +01004138 memcpy( prf->label, data, data_length );
4139 prf->label_length = data_length;
4140 }
Janos Follath63028dd2019-06-13 09:15:47 +01004141
Gilles Peskine43f958b2020-12-13 14:55:14 +01004142 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004143
4144 return( PSA_SUCCESS );
4145}
4146
Janos Follathb03233e2019-06-11 15:30:30 +01004147static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004148 psa_key_derivation_step_t step,
4149 const uint8_t *data,
4150 size_t data_length )
4151{
Janos Follathb03233e2019-06-11 15:30:30 +01004152 switch( step )
4153 {
Janos Follathf08e2652019-06-13 09:05:41 +01004154 case PSA_KEY_DERIVATION_INPUT_SEED:
4155 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004156 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004157 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004158 case PSA_KEY_DERIVATION_INPUT_LABEL:
4159 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004160 default:
4161 return( PSA_ERROR_INVALID_ARGUMENT );
4162 }
4163}
John Durkop07cc04a2020-11-16 22:08:34 -08004164#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4165 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4166
4167#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4168static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4169 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004170 const uint8_t *data,
4171 size_t data_length )
4172{
4173 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004174 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004175 uint8_t *cur = pms;
4176
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004177 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004178 return( PSA_ERROR_INVALID_ARGUMENT );
4179
4180 /* Quoting RFC 4279, Section 2:
4181 *
4182 * The premaster secret is formed as follows: if the PSK is N octets
4183 * long, concatenate a uint16 with the value N, N zero octets, a second
4184 * uint16 with the value N, and the PSK itself.
4185 */
4186
4187 *cur++ = ( data_length >> 8 ) & 0xff;
4188 *cur++ = ( data_length >> 0 ) & 0xff;
4189 memset( cur, 0, data_length );
4190 cur += data_length;
4191 *cur++ = pms[0];
4192 *cur++ = pms[1];
4193 memcpy( cur, data, data_length );
4194 cur += data_length;
4195
Steven Cooremana6df6042021-04-29 19:32:25 +02004196 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004197
4198 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4199 return( status );
4200}
Janos Follath6660f0e2019-06-17 08:44:03 +01004201
4202static psa_status_t psa_tls12_prf_psk_to_ms_input(
4203 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004204 psa_key_derivation_step_t step,
4205 const uint8_t *data,
4206 size_t data_length )
4207{
4208 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004209 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004210 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004211 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004212 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004213
Steven Cooremana6df6042021-04-29 19:32:25 +02004214 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004215}
John Durkop07cc04a2020-11-16 22:08:34 -08004216#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004217
Gilles Peskineb8965192019-09-24 16:21:10 +02004218/** Check whether the given key type is acceptable for the given
4219 * input step of a key derivation.
4220 *
4221 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4222 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4223 * Both secret and non-secret inputs can alternatively have the type
4224 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4225 * that the input was passed as a buffer rather than via a key object.
4226 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004227static int psa_key_derivation_check_input_type(
4228 psa_key_derivation_step_t step,
4229 psa_key_type_t key_type )
4230{
4231 switch( step )
4232 {
4233 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004234 if( key_type == PSA_KEY_TYPE_DERIVE )
4235 return( PSA_SUCCESS );
4236 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004237 return( PSA_SUCCESS );
4238 break;
4239 case PSA_KEY_DERIVATION_INPUT_LABEL:
4240 case PSA_KEY_DERIVATION_INPUT_SALT:
4241 case PSA_KEY_DERIVATION_INPUT_INFO:
4242 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004243 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4244 return( PSA_SUCCESS );
4245 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004246 return( PSA_SUCCESS );
4247 break;
4248 }
4249 return( PSA_ERROR_INVALID_ARGUMENT );
4250}
4251
Janos Follathb80a94e2019-06-12 15:54:46 +01004252static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004253 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004254 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004255 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004256 const uint8_t *data,
4257 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004258{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004259 psa_status_t status;
4260 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4261
4262 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004263 if( status != PSA_SUCCESS )
4264 goto exit;
4265
John Durkopd0321952020-10-29 21:37:36 -07004266#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004267 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004268 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004269 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004270 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004271 step, data, data_length );
4272 }
John Durkop07cc04a2020-11-16 22:08:34 -08004273 else
4274#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4275#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4276 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004277 {
Janos Follathb03233e2019-06-11 15:30:30 +01004278 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004279 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004280 }
John Durkop07cc04a2020-11-16 22:08:34 -08004281 else
4282#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4283#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4284 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004285 {
4286 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004287 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004288 }
4289 else
John Durkop07cc04a2020-11-16 22:08:34 -08004290#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004291 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004292 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004293 (void) data;
4294 (void) data_length;
4295 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004296 return( PSA_ERROR_BAD_STATE );
4297 }
4298
Gilles Peskine224b0d62019-09-23 18:13:17 +02004299exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004300 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004301 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004302 return( status );
4303}
4304
Janos Follath51f4a0f2019-06-14 11:35:55 +01004305psa_status_t psa_key_derivation_input_bytes(
4306 psa_key_derivation_operation_t *operation,
4307 psa_key_derivation_step_t step,
4308 const uint8_t *data,
4309 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004310{
Gilles Peskineb8965192019-09-24 16:21:10 +02004311 return( psa_key_derivation_input_internal( operation, step,
4312 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004313 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004314}
4315
Janos Follath51f4a0f2019-06-14 11:35:55 +01004316psa_status_t psa_key_derivation_input_key(
4317 psa_key_derivation_operation_t *operation,
4318 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004319 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004320{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004322 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004323 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004324
Ronald Cron5c522922020-11-14 16:35:34 +01004325 status = psa_get_and_lock_transparent_key_slot_with_policy(
4326 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004327 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004328 {
4329 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004330 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004331 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004332
4333 /* Passing a key object as a SECRET input unlocks the permission
4334 * to output to a key object. */
4335 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4336 operation->can_output_key = 1;
4337
Ronald Cronf95a2b12020-10-22 15:24:49 +02004338 status = psa_key_derivation_input_internal( operation,
4339 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004340 slot->key.data,
4341 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004342
Ronald Cron5c522922020-11-14 16:35:34 +01004343 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004344
Ronald Cron5c522922020-11-14 16:35:34 +01004345 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004346}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004347
4348
4349
4350/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004351/* Key agreement */
4352/****************************************************************/
4353
John Durkop6ba40d12020-11-10 08:50:04 -08004354#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004355static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4356 size_t peer_key_length,
4357 const mbedtls_ecp_keypair *our_key,
4358 uint8_t *shared_secret,
4359 size_t shared_secret_size,
4360 size_t *shared_secret_length )
4361{
Steven Cooremand4867872020-08-05 16:31:39 +02004362 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004363 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004364 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004365 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004366 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004367 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004368
Ronald Cron90857082020-11-25 14:58:33 +01004369 status = mbedtls_psa_ecp_load_representation(
4370 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004371 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004372 peer_key,
4373 peer_key_length,
4374 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004375 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004376 goto exit;
4377
Jaeden Amero97271b32019-01-10 19:38:51 +00004378 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004379 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004380 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004381 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004382 status = mbedtls_to_psa_error(
4383 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4384 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004385 goto exit;
4386
Jaeden Amero97271b32019-01-10 19:38:51 +00004387 status = mbedtls_to_psa_error(
4388 mbedtls_ecdh_calc_secret( &ecdh,
4389 shared_secret_length,
4390 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004391 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004392 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004393 if( status != PSA_SUCCESS )
4394 goto exit;
4395 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4396 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004397
4398exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004399 if( status != PSA_SUCCESS )
4400 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004401 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004402 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004403 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004404
Jaeden Amero97271b32019-01-10 19:38:51 +00004405 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004406}
John Durkop6ba40d12020-11-10 08:50:04 -08004407#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004408
Gilles Peskine01d718c2018-09-18 12:01:02 +02004409#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4410
Gilles Peskine0216fe12019-04-11 21:23:21 +02004411static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4412 psa_key_slot_t *private_key,
4413 const uint8_t *peer_key,
4414 size_t peer_key_length,
4415 uint8_t *shared_secret,
4416 size_t shared_secret_size,
4417 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004418{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004419 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004420 {
John Durkop6ba40d12020-11-10 08:50:04 -08004421#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004422 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004423 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004424 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004425 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004426 psa_status_t status = mbedtls_psa_ecp_load_representation(
4427 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004428 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004429 private_key->key.data,
4430 private_key->key.bytes,
4431 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004432 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004433 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004434 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004435 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004436 shared_secret, shared_secret_size,
4437 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004438 mbedtls_ecp_keypair_free( ecp );
4439 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004440 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004441#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004442 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004443 (void) private_key;
4444 (void) peer_key;
4445 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004446 (void) shared_secret;
4447 (void) shared_secret_size;
4448 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004449 return( PSA_ERROR_NOT_SUPPORTED );
4450 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004451}
4452
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004453/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004454 * to potentially free embedded data structures and wipe confidential data.
4455 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004456static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004457 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004458 psa_key_slot_t *private_key,
4459 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004460 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004461{
4462 psa_status_t status;
4463 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4464 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004465 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004466
4467 /* Step 1: run the secret agreement algorithm to generate the shared
4468 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004469 status = psa_key_agreement_raw_internal( ka_alg,
4470 private_key,
4471 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004472 shared_secret,
4473 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004474 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004475 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004476 goto exit;
4477
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004478 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004479 * the shared secret. A shared secret is permitted wherever a key
4480 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004481 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004482 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004483 shared_secret,
4484 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004485exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004486 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004487 return( status );
4488}
4489
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004490psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004491 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004492 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004493 const uint8_t *peer_key,
4494 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004495{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004497 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004498 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004499
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004500 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004501 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004502 status = psa_get_and_lock_transparent_key_slot_with_policy(
4503 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004504 if( status != PSA_SUCCESS )
4505 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004506 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004507 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004508 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004509 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004510 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004511 else
4512 {
4513 /* If a private key has been added as SECRET, we allow the derived
4514 * key material to be used as a key in PSA Crypto. */
4515 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4516 operation->can_output_key = 1;
4517 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004518
Ronald Cron5c522922020-11-14 16:35:34 +01004519 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004520
Ronald Cron5c522922020-11-14 16:35:34 +01004521 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004522}
4523
Gilles Peskinebe697d82019-05-16 18:00:41 +02004524psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004525 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004526 const uint8_t *peer_key,
4527 size_t peer_key_length,
4528 uint8_t *output,
4529 size_t output_size,
4530 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004531{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004532 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004533 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004534 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004535
4536 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4537 {
4538 status = PSA_ERROR_INVALID_ARGUMENT;
4539 goto exit;
4540 }
Ronald Cron5c522922020-11-14 16:35:34 +01004541 status = psa_get_and_lock_transparent_key_slot_with_policy(
4542 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004543 if( status != PSA_SUCCESS )
4544 goto exit;
4545
4546 status = psa_key_agreement_raw_internal( alg, slot,
4547 peer_key, peer_key_length,
4548 output, output_size,
4549 output_length );
4550
4551exit:
4552 if( status != PSA_SUCCESS )
4553 {
4554 /* If an error happens and is not handled properly, the output
4555 * may be used as a key to protect sensitive data. Arrange for such
4556 * a key to be random, which is likely to result in decryption or
4557 * verification errors. This is better than filling the buffer with
4558 * some constant data such as zeros, which would result in the data
4559 * being protected with a reproducible, easily knowable key.
4560 */
4561 psa_generate_random( output, output_size );
4562 *output_length = output_size;
4563 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004564
Ronald Cron5c522922020-11-14 16:35:34 +01004565 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004566
Ronald Cron5c522922020-11-14 16:35:34 +01004567 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004568}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004569
4570
Gilles Peskine30524eb2020-11-13 17:02:26 +01004571
Gilles Peskine86a440b2018-11-12 18:39:40 +01004572/****************************************************************/
4573/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004574/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004575
Gilles Peskine30524eb2020-11-13 17:02:26 +01004576/** Initialize the PSA random generator.
4577 */
4578static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4579{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004580#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4581 memset( rng, 0, sizeof( *rng ) );
4582#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4583
Gilles Peskine30524eb2020-11-13 17:02:26 +01004584 /* Set default configuration if
4585 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4586 if( rng->entropy_init == NULL )
4587 rng->entropy_init = mbedtls_entropy_init;
4588 if( rng->entropy_free == NULL )
4589 rng->entropy_free = mbedtls_entropy_free;
4590
4591 rng->entropy_init( &rng->entropy );
4592#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4593 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4594 /* The PSA entropy injection feature depends on using NV seed as an entropy
4595 * source. Add NV seed as an entropy source for PSA entropy injection. */
4596 mbedtls_entropy_add_source( &rng->entropy,
4597 mbedtls_nv_seed_poll, NULL,
4598 MBEDTLS_ENTROPY_BLOCK_SIZE,
4599 MBEDTLS_ENTROPY_SOURCE_STRONG );
4600#endif
4601
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004602 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004603#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004604}
4605
4606/** Deinitialize the PSA random generator.
4607 */
4608static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4609{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004610#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4611 memset( rng, 0, sizeof( *rng ) );
4612#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004613 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004614 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004615#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004616}
4617
4618/** Seed the PSA random generator.
4619 */
4620static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4621{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004622#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4623 /* Do nothing: the external RNG seeds itself. */
4624 (void) rng;
4625 return( PSA_SUCCESS );
4626#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004627 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004628 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4629 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004630 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004631#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004632}
4633
Gilles Peskinee59236f2018-01-27 23:32:46 +01004634psa_status_t psa_generate_random( uint8_t *output,
4635 size_t output_size )
4636{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004637 GUARD_MODULE_INITIALIZED;
4638
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004639#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4640
4641 size_t output_length = 0;
4642 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4643 output, output_size,
4644 &output_length );
4645 if( status != PSA_SUCCESS )
4646 return( status );
4647 /* Breaking up a request into smaller chunks is currently not supported
4648 * for the extrernal RNG interface. */
4649 if( output_length != output_size )
4650 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4651 return( PSA_SUCCESS );
4652
4653#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4654
Gilles Peskine71ddab92021-01-04 21:01:07 +01004655 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004656 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004657 size_t request_size =
4658 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4659 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4660 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004661 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4662 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004663 if( ret != 0 )
4664 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004665 output_size -= request_size;
4666 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004667 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004668 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004669#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004670}
4671
Gilles Peskine8814fc42020-12-14 15:33:44 +01004672/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004673 *
4674 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4675 * `psa_generate_random(...)`. The state parameter is ignored since the
4676 * PSA API doesn't support passing an explicit state.
4677 *
4678 * In the non-external case, psa_generate_random() calls an
4679 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4680 * and semantics as mbedtls_psa_get_random(). As an optimization,
4681 * instead of doing this back-and-forth between the PSA API and the
4682 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4683 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004684 */
4685#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4686int mbedtls_psa_get_random( void *p_rng,
4687 unsigned char *output,
4688 size_t output_size )
4689{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004690 /* This function takes a pointer to the RNG state because that's what
4691 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4692 * its own state internally and doesn't let the caller access that state.
4693 * So we just ignore the state parameter, and in practice we'll pass
4694 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004695 (void) p_rng;
4696 psa_status_t status = psa_generate_random( output, output_size );
4697 if( status == PSA_SUCCESS )
4698 return( 0 );
4699 else
4700 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4701}
4702#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4703
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004704#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004705#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004706
Gilles Peskine7228da22019-07-15 11:06:15 +02004707psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004708 size_t seed_size )
4709{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004710 if( global_data.initialized )
4711 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004712
4713 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4714 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4715 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4716 return( PSA_ERROR_INVALID_ARGUMENT );
4717
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004718 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004719}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004720#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004721
Ronald Cron3772afe2021-02-08 16:10:05 +01004722/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004723 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004724 * \param type The key type
4725 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004726 *
4727 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004728 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004729 * \retval #PSA_ERROR_INVALID_ARGUMENT
4730 * The size in bits of the key is not valid.
4731 * \retval #PSA_ERROR_NOT_SUPPORTED
4732 * The type and/or the size in bits of the key or the combination of
4733 * the two is not supported.
4734 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004735static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4736 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004737{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004739
Gilles Peskinee59236f2018-01-27 23:32:46 +01004740 if( key_type_is_raw_bytes( type ) )
4741 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004742 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004743 if( status != PSA_SUCCESS )
4744 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004745 }
4746 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004747#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004748 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4749 {
4750 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4751 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004752
Ronald Cron01b2aba2020-10-05 09:42:02 +02004753 /* Accept only byte-aligned keys, for the same reasons as
4754 * in psa_import_rsa_key(). */
4755 if( bits % 8 != 0 )
4756 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004757 }
4758 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004759#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004760
Ronald Cron5c4d3862020-12-07 11:07:24 +01004761#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004762 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4763 {
Ronald Crond81ab562021-02-16 09:01:16 +01004764 /* To avoid empty block, return successfully here. */
4765 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004766 }
4767 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004768#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004769 {
4770 return( PSA_ERROR_NOT_SUPPORTED );
4771 }
4772
4773 return( PSA_SUCCESS );
4774}
4775
Ronald Cron55ed0592020-10-05 10:30:40 +02004776psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004777 const psa_key_attributes_t *attributes,
4778 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004779{
4780 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004781 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004782
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004783 if( ( attributes->domain_parameters == NULL ) &&
4784 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004785 return( PSA_ERROR_INVALID_ARGUMENT );
4786
Ronald Cron01b2aba2020-10-05 09:42:02 +02004787 if( key_type_is_raw_bytes( type ) )
4788 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004789 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004790 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004791 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004792
David Brown12ca5032021-02-11 11:02:00 -07004793#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004794 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004795 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004796#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004797 }
4798 else
4799
Jaeden Amero424fa932021-05-14 08:34:32 +01004800#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4801 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004802 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004803 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004804 return( mbedtls_psa_rsa_generate_key( attributes,
4805 key_buffer,
4806 key_buffer_size,
4807 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004808 }
4809 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004810#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4811 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004812
John Durkop9814fa22020-11-04 12:28:15 -08004813#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004814 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004815 {
Ronald Cron7023db52020-11-20 18:17:42 +01004816 return( mbedtls_psa_ecp_generate_key( attributes,
4817 key_buffer,
4818 key_buffer_size,
4819 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004820 }
4821 else
John Durkop9814fa22020-11-04 12:28:15 -08004822#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004823 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004824 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004825 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004826 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004827
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004828 return( PSA_SUCCESS );
4829}
Darryl Green0c6575a2018-11-07 16:05:30 +00004830
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004831psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004832 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004833{
4834 psa_status_t status;
4835 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004836 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004837 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004838
Ronald Cron81709fc2020-11-14 12:10:32 +01004839 *key = MBEDTLS_SVC_KEY_ID_INIT;
4840
Gilles Peskine0f84d622019-09-12 19:03:13 +02004841 /* Reject any attempt to create a zero-length key so that we don't
4842 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4843 if( psa_get_key_bits( attributes ) == 0 )
4844 return( PSA_ERROR_INVALID_ARGUMENT );
4845
Ronald Cron81709fc2020-11-14 12:10:32 +01004846 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4847 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004848 if( status != PSA_SUCCESS )
4849 goto exit;
4850
Ronald Cron977c2472020-10-13 08:32:21 +02004851 /* In the case of a transparent key or an opaque key stored in local
4852 * storage (thus not in the case of generating a key in a secure element
4853 * or cryptoprocessor with storage), we have to allocate a buffer to
4854 * hold the generated key material. */
4855 if( slot->key.data == NULL )
4856 {
4857 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4858 PSA_KEY_LOCATION_LOCAL_STORAGE )
4859 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004860 status = psa_validate_key_type_and_size_for_key_generation(
4861 attributes->core.type, attributes->core.bits );
4862 if( status != PSA_SUCCESS )
4863 goto exit;
4864
4865 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
4866 attributes->core.type,
4867 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02004868 }
4869 else
4870 {
4871 status = psa_driver_wrapper_get_key_buffer_size(
4872 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01004873 if( status != PSA_SUCCESS )
4874 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02004875 }
Ronald Cron977c2472020-10-13 08:32:21 +02004876
4877 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
4878 if( status != PSA_SUCCESS )
4879 goto exit;
4880 }
4881
Steven Cooreman2a1664c2020-07-20 15:33:08 +02004882 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02004883 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02004884
Ronald Cron2b56bc82020-10-05 10:02:26 +02004885 if( status != PSA_SUCCESS )
4886 psa_remove_key_data_from_memory( slot );
4887
Gilles Peskine11792082019-08-06 18:36:36 +02004888exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004889 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004890 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004891 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004892 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004893
Darryl Green0c6575a2018-11-07 16:05:30 +00004894 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004895}
4896
Gilles Peskinee59236f2018-01-27 23:32:46 +01004897/****************************************************************/
4898/* Module setup */
4899/****************************************************************/
4900
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004901#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01004902psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
4903 void (* entropy_init )( mbedtls_entropy_context *ctx ),
4904 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
4905{
4906 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4907 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004908 global_data.rng.entropy_init = entropy_init;
4909 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01004910 return( PSA_SUCCESS );
4911}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004912#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01004913
Gilles Peskinee59236f2018-01-27 23:32:46 +01004914void mbedtls_psa_crypto_free( void )
4915{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004916 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004917 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4918 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01004919 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004920 }
4921 /* Wipe all remaining data, including configuration.
4922 * In particular, this sets all state indicator to the value
4923 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01004924 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02004925#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02004926 /* Unregister all secure element drivers, so that we restart from
4927 * a pristine state. */
4928 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02004929#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004930}
4931
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004932#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
4933/** Recover a transaction that was interrupted by a power failure.
4934 *
4935 * This function is called during initialization, before psa_crypto_init()
4936 * returns. If this function returns a failure status, the initialization
4937 * fails.
4938 */
4939static psa_status_t psa_crypto_recover_transaction(
4940 const psa_crypto_transaction_t *transaction )
4941{
4942 switch( transaction->unknown.type )
4943 {
4944 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
4945 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01004946 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02004947 * is implemented.
4948 * https://github.com/ARMmbed/mbed-crypto/issues/218
4949 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004950 default:
4951 /* We found an unsupported transaction in the storage.
4952 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01004953 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004954 }
4955}
4956#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
4957
Gilles Peskinee59236f2018-01-27 23:32:46 +01004958psa_status_t psa_crypto_init( void )
4959{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004960 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004961
Gilles Peskinec6b69072018-11-20 21:42:52 +01004962 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004963 if( global_data.initialized != 0 )
4964 return( PSA_SUCCESS );
4965
Gilles Peskine30524eb2020-11-13 17:02:26 +01004966 /* Initialize and seed the random generator. */
4967 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004968 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01004969 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01004970 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004971 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004972 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004973
Gilles Peskine66fb1262018-12-10 16:29:04 +01004974 status = psa_initialize_key_slots( );
4975 if( status != PSA_SUCCESS )
4976 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004977
Gilles Peskined9348f22019-10-01 15:22:29 +02004978#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4979 status = psa_init_all_se_drivers( );
4980 if( status != PSA_SUCCESS )
4981 goto exit;
4982#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
4983
Gilles Peskine4b734222019-07-24 15:56:31 +02004984#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02004985 status = psa_crypto_load_transaction( );
4986 if( status == PSA_SUCCESS )
4987 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004988 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
4989 if( status != PSA_SUCCESS )
4990 goto exit;
4991 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02004992 }
4993 else if( status == PSA_ERROR_DOES_NOT_EXIST )
4994 {
4995 /* There's no transaction to complete. It's all good. */
4996 status = PSA_SUCCESS;
4997 }
Gilles Peskine4b734222019-07-24 15:56:31 +02004998#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02004999
Gilles Peskinec6b69072018-11-20 21:42:52 +01005000 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005001 global_data.initialized = 1;
5002
5003exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005004 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005005 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005006 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005007}
5008
5009#endif /* MBEDTLS_PSA_CRYPTO_C */