blob: 4f932c6c745936da4757607b00fa65b970cd9605 [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 Peskine6687cd02021-04-21 22:32:05 +02001055 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1056 {
1057 /* Refuse the destruction of a read-only key (which may or may not work
1058 * if we attempt it, depending on whether the key is merely read-only
1059 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001060 * Just do the best we can, which is to wipe the copy in memory
1061 * (done in this function's cleanup code). */
1062 overall_status = PSA_ERROR_NOT_PERMITTED;
1063 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001064 }
1065
Gilles Peskine354f7672019-07-12 23:46:38 +02001066#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001067 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001068 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001069 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001070 /* For a key in a secure element, we need to do three things:
1071 * remove the key file in internal storage, destroy the
1072 * key inside the secure element, and update the driver's
1073 * persistent data. Start a transaction that will encompass these
1074 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001075 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001077 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001078 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001079 status = psa_crypto_save_transaction( );
1080 if( status != PSA_SUCCESS )
1081 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001082 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001083 /* We should still try to destroy the key in the secure
1084 * element and the key metadata in storage. This is especially
1085 * important if the error is that the storage is full.
1086 * But how to do it exactly without risking an inconsistent
1087 * state after a reset?
1088 * https://github.com/ARMmbed/mbed-crypto/issues/215
1089 */
1090 overall_status = status;
1091 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001092 }
1093
Ronald Cronea0f8a62020-11-25 17:52:23 +01001094 status = psa_destroy_se_key( driver,
1095 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001096 if( overall_status == PSA_SUCCESS )
1097 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001098 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001099#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1100
Darryl Greend49a4992018-06-18 17:27:26 +01001101#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001102 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001103 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001104 status = psa_destroy_persistent_key( slot->attr.id );
1105 if( overall_status == PSA_SUCCESS )
1106 overall_status = status;
1107
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001108 /* TODO: other slots may have a copy of the same key. We should
1109 * invalidate them.
1110 * https://github.com/ARMmbed/mbed-crypto/issues/214
1111 */
Darryl Greend49a4992018-06-18 17:27:26 +01001112 }
1113#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001114
Gilles Peskinefc762652019-07-22 19:30:34 +02001115#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1116 if( driver != NULL )
1117 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001118 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001119 if( overall_status == PSA_SUCCESS )
1120 overall_status = status;
1121 status = psa_crypto_stop_transaction( );
1122 if( overall_status == PSA_SUCCESS )
1123 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001124 }
1125#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1126
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001128 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001130 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001131 overall_status = status;
1132 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001133}
1134
John Durkop07cc04a2020-11-16 22:08:34 -08001135#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001136 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001137static psa_status_t psa_get_rsa_public_exponent(
1138 const mbedtls_rsa_context *rsa,
1139 psa_key_attributes_t *attributes )
1140{
1141 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001142 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001143 uint8_t *buffer = NULL;
1144 size_t buflen;
1145 mbedtls_mpi_init( &mpi );
1146
1147 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1148 if( ret != 0 )
1149 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001150 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1151 {
1152 /* It's the default value, which is reported as an empty string,
1153 * so there's nothing to do. */
1154 goto exit;
1155 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001156
1157 buflen = mbedtls_mpi_size( &mpi );
1158 buffer = mbedtls_calloc( 1, buflen );
1159 if( buffer == NULL )
1160 {
1161 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1162 goto exit;
1163 }
1164 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1165 if( ret != 0 )
1166 goto exit;
1167 attributes->domain_parameters = buffer;
1168 attributes->domain_parameters_size = buflen;
1169
1170exit:
1171 mbedtls_mpi_free( &mpi );
1172 if( ret != 0 )
1173 mbedtls_free( buffer );
1174 return( mbedtls_to_psa_error( ret ) );
1175}
John Durkop07cc04a2020-11-16 22:08:34 -08001176#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001177 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001178
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001179/** Retrieve all the publicly-accessible attributes of a key.
1180 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001181psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001182 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001183{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001185 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001186 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001188 psa_reset_key_attributes( attributes );
1189
Ronald Cron5c522922020-11-14 16:35:34 +01001190 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001191 if( status != PSA_SUCCESS )
1192 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001193
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001194 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001195 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1196 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1197
1198#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1199 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001200 psa_set_key_slot_number( attributes,
1201 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001202#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001203
Gilles Peskine8e338702019-07-30 20:06:31 +02001204 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001205 {
John Durkop07cc04a2020-11-16 22:08:34 -08001206#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001207 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001208 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001209 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001210#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001211 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001212 * is not yet implemented.
1213 * https://github.com/ARMmbed/mbed-crypto/issues/216
1214 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001215 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001216 break;
1217#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001218 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001219 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001220
Ronald Cron90857082020-11-25 14:58:33 +01001221 status = mbedtls_psa_rsa_load_representation(
1222 slot->attr.type,
1223 slot->key.data,
1224 slot->key.bytes,
1225 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001226 if( status != PSA_SUCCESS )
1227 break;
1228
Steven Cooremana2371e52020-07-28 14:30:39 +02001229 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001230 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001231 mbedtls_rsa_free( rsa );
1232 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001233 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001234 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001235#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001236 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001237 default:
1238 /* Nothing else to do. */
1239 break;
1240 }
1241
1242 if( status != PSA_SUCCESS )
1243 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001244
Ronald Cron5c522922020-11-14 16:35:34 +01001245 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001248}
1249
Gilles Peskinec8000c02019-08-02 20:15:51 +02001250#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1251psa_status_t psa_get_key_slot_number(
1252 const psa_key_attributes_t *attributes,
1253 psa_key_slot_number_t *slot_number )
1254{
1255 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1256 {
1257 *slot_number = attributes->slot_number;
1258 return( PSA_SUCCESS );
1259 }
1260 else
1261 return( PSA_ERROR_INVALID_ARGUMENT );
1262}
1263#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1264
Ronald Crond18b5f82020-11-25 16:46:05 +01001265static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1266 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001267 uint8_t *data,
1268 size_t data_size,
1269 size_t *data_length )
1270{
Ronald Crond18b5f82020-11-25 16:46:05 +01001271 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001272 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 memcpy( data, key_buffer, key_buffer_size );
1274 memset( data + key_buffer_size, 0,
1275 data_size - key_buffer_size );
1276 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001277 return( PSA_SUCCESS );
1278}
1279
Ronald Cron7285cda2020-11-26 14:46:37 +01001280psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001281 const psa_key_attributes_t *attributes,
1282 const uint8_t *key_buffer, size_t key_buffer_size,
1283 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001284{
Ronald Crond18b5f82020-11-25 16:46:05 +01001285 psa_key_type_t type = attributes->core.type;
1286
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 if( key_type_is_raw_bytes( type ) ||
1288 PSA_KEY_TYPE_IS_RSA( type ) ||
1289 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001290 {
1291 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 key_buffer, key_buffer_size,
1293 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001294 }
1295 else
1296 {
1297 /* This shouldn't happen in the reference implementation, but
1298 it is valid for a special-purpose implementation to omit
1299 support for exporting certain key types. */
1300 return( PSA_ERROR_NOT_SUPPORTED );
1301 }
1302}
1303
1304psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1305 uint8_t *data,
1306 size_t data_size,
1307 size_t *data_length )
1308{
1309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1310 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1311 psa_key_slot_t *slot;
1312
Ronald Crone907e552021-01-18 13:22:38 +01001313 /* Reject a zero-length output buffer now, since this can never be a
1314 * valid key representation. This way we know that data must be a valid
1315 * pointer and we can do things like memset(data, ..., data_size). */
1316 if( data_size == 0 )
1317 return( PSA_ERROR_BUFFER_TOO_SMALL );
1318
Ronald Cron9486f9d2020-11-26 13:36:23 +01001319 /* Set the key to empty now, so that even when there are errors, we always
1320 * set data_length to a value between 0 and data_size. On error, setting
1321 * the key to empty is a good choice because an empty key representation is
1322 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001323 *data_length = 0;
1324
Ronald Cron9486f9d2020-11-26 13:36:23 +01001325 /* Export requires the EXPORT flag. There is an exception for public keys,
1326 * which don't require any flag, but
1327 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1328 */
1329 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1330 PSA_KEY_USAGE_EXPORT, 0 );
1331 if( status != PSA_SUCCESS )
1332 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001333
Ronald Crond18b5f82020-11-25 16:46:05 +01001334 psa_key_attributes_t attributes = {
1335 .core = slot->attr
1336 };
Ronald Cron67227982020-11-26 15:16:05 +01001337 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001338 slot->key.data, slot->key.bytes,
1339 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001340
Ronald Cron9486f9d2020-11-26 13:36:23 +01001341 unlock_status = psa_unlock_key_slot( slot );
1342
1343 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1344}
1345
Ronald Cron7285cda2020-11-26 14:46:37 +01001346psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 const psa_key_attributes_t *attributes,
1348 const uint8_t *key_buffer,
1349 size_t key_buffer_size,
1350 uint8_t *data,
1351 size_t data_size,
1352 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353{
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001355
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001357 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001359 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001360 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001361 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 key_buffer, key_buffer_size,
1363 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001364 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001365
Ronald Crond18b5f82020-11-25 16:46:05 +01001366 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001367 {
John Durkop0e005192020-10-31 22:06:54 -07001368#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1369 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001370 return( mbedtls_psa_rsa_export_public_key( attributes,
1371 key_buffer,
1372 key_buffer_size,
1373 data,
1374 data_size,
1375 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001376#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001377 /* We don't know how to convert a private RSA key to public. */
1378 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001379#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1380 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001381 }
1382 else
Moran Pekera998bc62018-04-16 18:16:20 +03001383 {
John Durkop6ba40d12020-11-10 08:50:04 -08001384#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1385 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001386 return( mbedtls_psa_ecp_export_public_key( attributes,
1387 key_buffer,
1388 key_buffer_size,
1389 data,
1390 data_size,
1391 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001392#else
1393 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001394 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001395#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1396 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001397 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001398 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001399 else
1400 {
1401 /* This shouldn't happen in the reference implementation, but
1402 it is valid for a special-purpose implementation to omit
1403 support for exporting certain key types. */
1404 return( PSA_ERROR_NOT_SUPPORTED );
1405 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001406}
Ronald Crond18b5f82020-11-25 16:46:05 +01001407
Ronald Croncf56a0a2020-08-04 09:51:30 +02001408psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001409 uint8_t *data,
1410 size_t data_size,
1411 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001412{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001413 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001414 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001415 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001416
Ronald Crone907e552021-01-18 13:22:38 +01001417 /* Reject a zero-length output buffer now, since this can never be a
1418 * valid key representation. This way we know that data must be a valid
1419 * pointer and we can do things like memset(data, ..., data_size). */
1420 if( data_size == 0 )
1421 return( PSA_ERROR_BUFFER_TOO_SMALL );
1422
Darryl Greendd8fb772018-11-07 16:00:44 +00001423 /* Set the key to empty now, so that even when there are errors, we always
1424 * set data_length to a value between 0 and data_size. On error, setting
1425 * the key to empty is a good choice because an empty key representation is
1426 * unlikely to be accepted anywhere. */
1427 *data_length = 0;
1428
1429 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001430 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001431 if( status != PSA_SUCCESS )
1432 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001433
Ronald Cron9486f9d2020-11-26 13:36:23 +01001434 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1435 {
1436 status = PSA_ERROR_INVALID_ARGUMENT;
1437 goto exit;
1438 }
1439
Ronald Crond18b5f82020-11-25 16:46:05 +01001440 psa_key_attributes_t attributes = {
1441 .core = slot->attr
1442 };
Ronald Cron67227982020-11-26 15:16:05 +01001443 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001444 &attributes, slot->key.data, slot->key.bytes,
1445 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001446
1447exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001448 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001449
Ronald Cron5c522922020-11-14 16:35:34 +01001450 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001451}
1452
Gilles Peskine91e8c332019-08-02 19:19:39 +02001453#if defined(static_assert)
1454static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1455 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001456static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001457 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001458static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001459 "One or more key attribute flag is listed as both internal-only and external-only" );
1460#endif
1461
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001462/** Validate that a key policy is internally well-formed.
1463 *
1464 * This function only rejects invalid policies. It does not validate the
1465 * consistency of the policy with respect to other attributes of the key
1466 * such as the key type.
1467 */
1468static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001469{
1470 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001471 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001472 PSA_KEY_USAGE_ENCRYPT |
1473 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001474 PSA_KEY_USAGE_SIGN_MESSAGE |
1475 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001476 PSA_KEY_USAGE_SIGN_HASH |
1477 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001478 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001479 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1480 return( PSA_ERROR_INVALID_ARGUMENT );
1481
Gilles Peskine4747d192019-04-17 15:05:45 +02001482 return( PSA_SUCCESS );
1483}
1484
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001485/** Validate the internal consistency of key attributes.
1486 *
1487 * This function only rejects invalid attribute values. If does not
1488 * validate the consistency of the attributes with any key data that may
1489 * be involved in the creation of the key.
1490 *
1491 * Call this function early in the key creation process.
1492 *
1493 * \param[in] attributes Key attributes for the new key.
1494 * \param[out] p_drv On any return, the driver for the key, if any.
1495 * NULL for a transparent key.
1496 *
1497 */
1498static psa_status_t psa_validate_key_attributes(
1499 const psa_key_attributes_t *attributes,
1500 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001501{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001502 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001503 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001504 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001505
Ronald Cron54b90082020-10-29 15:26:43 +01001506 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001507 if( status != PSA_SUCCESS )
1508 return( status );
1509
Ronald Crond2ed4812020-07-17 16:11:30 +02001510 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001511 if( status != PSA_SUCCESS )
1512 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001513
Ronald Cron65f38a32020-10-23 17:11:13 +02001514 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1515 {
1516 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1517 return( PSA_ERROR_INVALID_ARGUMENT );
1518 }
1519 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001520 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001521 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1522 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001523 }
1524
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001525 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001526 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001527 return( status );
1528
1529 /* Refuse to create overly large keys.
1530 * Note that this doesn't trigger on import if the attributes don't
1531 * explicitly specify a size (so psa_get_key_bits returns 0), so
1532 * psa_import_key() needs its own checks. */
1533 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1534 return( PSA_ERROR_NOT_SUPPORTED );
1535
Gilles Peskine91e8c332019-08-02 19:19:39 +02001536 /* Reject invalid flags. These should not be reachable through the API. */
1537 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1538 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1539 return( PSA_ERROR_INVALID_ARGUMENT );
1540
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001541 return( PSA_SUCCESS );
1542}
1543
Gilles Peskine4747d192019-04-17 15:05:45 +02001544/** Prepare a key slot to receive key material.
1545 *
1546 * This function allocates a key slot and sets its metadata.
1547 *
1548 * If this function fails, call psa_fail_key_creation().
1549 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001550 * This function is intended to be used as follows:
1551 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001552 * it with the specified attributes, and in case of a volatile key assign it
1553 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001554 * -# Populate the slot with the key material.
1555 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1556 * In case of failure at any step, stop the sequence and call
1557 * psa_fail_key_creation().
1558 *
Ronald Cron5c522922020-11-14 16:35:34 +01001559 * On success, the key slot is locked. It is the responsibility of the caller
1560 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001561 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001562 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001563 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001564 * \param[out] p_slot On success, a pointer to the prepared slot.
1565 * \param[out] p_drv On any return, the driver for the key, if any.
1566 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001567 *
1568 * \retval #PSA_SUCCESS
1569 * The key slot is ready to receive key material.
1570 * \return If this function fails, the key slot is an invalid state.
1571 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001572 */
1573static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001574 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001575 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001576 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001577 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001578{
1579 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001580 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001581 psa_key_slot_t *slot;
1582
Gilles Peskinedf179142019-07-15 22:02:14 +02001583 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001584 *p_drv = NULL;
1585
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001586 status = psa_validate_key_attributes( attributes, p_drv );
1587 if( status != PSA_SUCCESS )
1588 return( status );
1589
Ronald Cronc4d1b512020-07-31 11:26:37 +02001590 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001591 if( status != PSA_SUCCESS )
1592 return( status );
1593 slot = *p_slot;
1594
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001595 /* We're storing the declared bit-size of the key. It's up to each
1596 * creation mechanism to verify that this information is correct.
1597 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001598 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001599 * is optional (import, copy). In case of a volatile key, assign it the
1600 * volatile key identifier associated to the slot returned to contain its
1601 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001602
1603 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001604 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1605 {
1606#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1607 slot->attr.id = volatile_key_id;
1608#else
1609 slot->attr.id.key_id = volatile_key_id;
1610#endif
1611 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001612
Gilles Peskine91e8c332019-08-02 19:19:39 +02001613 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001614 * external-only flags, query `attributes`. Thanks to the check
1615 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001616 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001617 * may have set. */
1618 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001619
Gilles Peskinecbaff462019-07-12 23:46:04 +02001620#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001621 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001622 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001623 * create the key file in internal storage, create the
1624 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001625 * persistent data. This is done by starting a transaction that will
1626 * encompass these three actions.
1627 * For registering a volatile key, we just need to find an appropriate
1628 * slot number inside the SE. Since the key is designated volatile, creating
1629 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001630 /* The first thing to do is to find a slot number for the new key.
1631 * We save the slot number in persistent storage as part of the
1632 * transaction data. It will be needed to recover if the power
1633 * fails during the key creation process, to clean up on the secure
1634 * element side after restarting. Obtaining a slot number from the
1635 * secure element driver updates its persistent state, but we do not yet
1636 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001637 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001638 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001639 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001640 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001641 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001642 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001643 if( status != PSA_SUCCESS )
1644 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001645
1646 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001647 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001648 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1649 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001650 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001651 psa_crypto_transaction.key.id = slot->attr.id;
1652 status = psa_crypto_save_transaction( );
1653 if( status != PSA_SUCCESS )
1654 {
1655 (void) psa_crypto_stop_transaction( );
1656 return( status );
1657 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001658 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001659
1660 status = psa_copy_key_material_into_slot(
1661 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001662 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001663
1664 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1665 {
1666 /* Key registration only makes sense with a secure element. */
1667 return( PSA_ERROR_INVALID_ARGUMENT );
1668 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001669#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1670
Ronald Cronc4d1b512020-07-31 11:26:37 +02001671 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001672}
Gilles Peskine4747d192019-04-17 15:05:45 +02001673
1674/** Finalize the creation of a key once its key material has been set.
1675 *
1676 * This entails writing the key to persistent storage.
1677 *
1678 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001679 * See the documentation of psa_start_key_creation() for the intended use
1680 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001681 *
Ronald Cron5c522922020-11-14 16:35:34 +01001682 * If the finalization succeeds, the function unlocks the key slot (it was
1683 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1684 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001685 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001686 * \param[in,out] slot Pointer to the slot with key material.
1687 * \param[in] driver The secure element driver for the key,
1688 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001689 * \param[out] key On success, identifier of the key. Note that the
1690 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001691 *
1692 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001693 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001694 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1695 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1696 * \retval #PSA_ERROR_ALREADY_EXISTS
1697 * \retval #PSA_ERROR_DATA_INVALID
1698 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001699 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001700 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001701 * \return If this function fails, the key slot is an invalid state.
1702 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001703 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001704static psa_status_t psa_finish_key_creation(
1705 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001706 psa_se_drv_table_entry_t *driver,
1707 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001708{
1709 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001710 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001711 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001712
1713#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001714 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001715 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001716#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1717 if( driver != NULL )
1718 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001719 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 psa_key_slot_number_t slot_number =
1721 psa_key_slot_get_slot_number( slot ) ;
1722
Gilles Peskineb46bef22019-07-30 21:32:04 +02001723#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001724 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725 sizeof( data.slot_number ),
1726 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001727#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001728 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001729 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001730 (uint8_t*) &data,
1731 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001732 }
1733 else
1734#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1735 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001736 /* Key material is saved in export representation in the slot, so
1737 * just pass the slot buffer for storage. */
1738 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 slot->key.data,
1740 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001741 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001742 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001743#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1744
Gilles Peskinecbaff462019-07-12 23:46:04 +02001745#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001746 /* Finish the transaction for a key creation. This does not
1747 * happen when registering an existing key. Detect this case
1748 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001749 * creation of a persistent key in a secure element requires a transaction,
1750 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001751 if( driver != NULL &&
1752 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001753 {
1754 status = psa_save_se_persistent_data( driver );
1755 if( status != PSA_SUCCESS )
1756 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001757 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001758 return( status );
1759 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001760 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001761 }
1762#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1763
Ronald Cron50972942020-11-14 11:28:25 +01001764 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001765 {
1766 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001767 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001768 if( status != PSA_SUCCESS )
1769 *key = MBEDTLS_SVC_KEY_ID_INIT;
1770 }
Ronald Cron50972942020-11-14 11:28:25 +01001771
Gilles Peskine4747d192019-04-17 15:05:45 +02001772 return( status );
1773}
1774
1775/** Abort the creation of a key.
1776 *
1777 * You may call this function after calling psa_start_key_creation(),
1778 * or after psa_finish_key_creation() fails. In other circumstances, this
1779 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 * See the documentation of psa_start_key_creation() for the intended use
1781 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001782 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 * \param[in,out] slot Pointer to the slot with key material.
1784 * \param[in] driver The secure element driver for the key,
1785 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001786 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001787static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001788 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001789{
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 (void) driver;
1791
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 if( slot == NULL )
1793 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001794
1795#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001796 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001797 * element, and the failure happened later (when saving metadata
1798 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001799 * element.
1800 * https://github.com/ARMmbed/mbed-crypto/issues/217
1801 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001802
Gilles Peskined7729582019-08-05 15:55:54 +02001803 /* Abort the ongoing transaction if any (there may not be one if
1804 * the creation process failed before starting one, or if the
1805 * key creation is a registration of a key in a secure element).
1806 * Earlier functions must already have done what it takes to undo any
1807 * partial creation. All that's left is to update the transaction data
1808 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001809 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001810#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1811
Gilles Peskine4747d192019-04-17 15:05:45 +02001812 psa_wipe_key_slot( slot );
1813}
1814
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001815/** Validate optional attributes during key creation.
1816 *
1817 * Some key attributes are optional during key creation. If they are
1818 * specified in the attributes structure, check that they are consistent
1819 * with the data in the slot.
1820 *
1821 * This function should be called near the end of key creation, after
1822 * the slot in memory is fully populated but before saving persistent data.
1823 */
1824static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001825 const psa_key_slot_t *slot,
1826 const psa_key_attributes_t *attributes )
1827{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001828 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001829 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001830 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 return( PSA_ERROR_INVALID_ARGUMENT );
1832 }
1833
1834 if( attributes->domain_parameters_size != 0 )
1835 {
John Durkop0e005192020-10-31 22:06:54 -07001836#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1837 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001838 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001839 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001840 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001841 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001843
Ronald Cron90857082020-11-25 14:58:33 +01001844 psa_status_t status = mbedtls_psa_rsa_load_representation(
1845 slot->attr.type,
1846 slot->key.data,
1847 slot->key.bytes,
1848 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001849 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001850 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001851
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001852 mbedtls_mpi_init( &actual );
1853 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001854 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001855 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001856 mbedtls_rsa_free( rsa );
1857 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001858 if( ret != 0 )
1859 goto rsa_exit;
1860 ret = mbedtls_mpi_read_binary( &required,
1861 attributes->domain_parameters,
1862 attributes->domain_parameters_size );
1863 if( ret != 0 )
1864 goto rsa_exit;
1865 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1866 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1867 rsa_exit:
1868 mbedtls_mpi_free( &actual );
1869 mbedtls_mpi_free( &required );
1870 if( ret != 0)
1871 return( mbedtls_to_psa_error( ret ) );
1872 }
1873 else
John Durkop9814fa22020-11-04 12:28:15 -08001874#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1875 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876 {
1877 return( PSA_ERROR_INVALID_ARGUMENT );
1878 }
1879 }
1880
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001881 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001882 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001883 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 return( PSA_ERROR_INVALID_ARGUMENT );
1885 }
1886
1887 return( PSA_SUCCESS );
1888}
1889
Gilles Peskine4747d192019-04-17 15:05:45 +02001890psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001892 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001893 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001894{
1895 psa_status_t status;
1896 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001897 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001898 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001899
Ronald Cron81709fc2020-11-14 12:10:32 +01001900 *key = MBEDTLS_SVC_KEY_ID_INIT;
1901
Gilles Peskine0f84d622019-09-12 19:03:13 +02001902 /* Reject zero-length symmetric keys (including raw data key objects).
1903 * This also rejects any key which might be encoded as an empty string,
1904 * which is never valid. */
1905 if( data_length == 0 )
1906 return( PSA_ERROR_INVALID_ARGUMENT );
1907
Gilles Peskinedf179142019-07-15 22:02:14 +02001908 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001909 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 if( status != PSA_SUCCESS )
1911 goto exit;
1912
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001913 /* In the case of a transparent key or an opaque key stored in local
1914 * storage (thus not in the case of generating a key in a secure element
1915 * or cryptoprocessor with storage), we have to allocate a buffer to
1916 * hold the generated key material. */
1917 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001918 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001919 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001920 if( status != PSA_SUCCESS )
1921 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001922 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001923
1924 bits = slot->attr.bits;
1925 status = psa_driver_wrapper_import_key( attributes,
1926 data, data_length,
1927 slot->key.data,
1928 slot->key.bytes,
1929 &slot->key.bytes, &bits );
1930 if( status != PSA_SUCCESS )
1931 goto exit;
1932
1933 if( slot->attr.bits == 0 )
1934 slot->attr.bits = (psa_key_bits_t) bits;
1935 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001936 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001937 status = PSA_ERROR_INVALID_ARGUMENT;
1938 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001939 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001940
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001941 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001942 if( status != PSA_SUCCESS )
1943 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001944
Ronald Cron81709fc2020-11-14 12:10:32 +01001945 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001947 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001948 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001949
Gilles Peskine4747d192019-04-17 15:05:45 +02001950 return( status );
1951}
1952
Gilles Peskined7729582019-08-05 15:55:54 +02001953#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1954psa_status_t mbedtls_psa_register_se_key(
1955 const psa_key_attributes_t *attributes )
1956{
1957 psa_status_t status;
1958 psa_key_slot_t *slot = NULL;
1959 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001960 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001961
1962 /* Leaving attributes unspecified is not currently supported.
1963 * It could make sense to query the key type and size from the
1964 * secure element, but not all secure elements support this
1965 * and the driver HAL doesn't currently support it. */
1966 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1967 return( PSA_ERROR_NOT_SUPPORTED );
1968 if( psa_get_key_bits( attributes ) == 0 )
1969 return( PSA_ERROR_NOT_SUPPORTED );
1970
1971 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001972 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001973 if( status != PSA_SUCCESS )
1974 goto exit;
1975
Ronald Cron81709fc2020-11-14 12:10:32 +01001976 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001977
1978exit:
1979 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001980 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001981
Gilles Peskined7729582019-08-05 15:55:54 +02001982 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001983 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001984 return( status );
1985}
1986#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1987
Gilles Peskinef603c712019-01-19 13:40:11 +01001988static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001989 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001990{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001991 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001992 source->key.data,
1993 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001994 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001995 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001996
Steven Cooreman398aee52020-10-13 14:35:45 +02001997 target->attr.type = source->attr.type;
1998 target->attr.bits = source->attr.bits;
1999
2000 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002001}
2002
Ronald Croncf56a0a2020-08-04 09:51:30 +02002003psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002004 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002005 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002006{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002007 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002008 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002009 psa_key_slot_t *source_slot = NULL;
2010 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002011 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002012 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002013
Ronald Cron81709fc2020-11-14 12:10:32 +01002014 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2015
Ronald Cron5c522922020-11-14 16:35:34 +01002016 status = psa_get_and_lock_transparent_key_slot_with_policy(
2017 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002018 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002019 goto exit;
2020
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002021 status = psa_validate_optional_attributes( source_slot,
2022 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 if( status != PSA_SUCCESS )
2024 goto exit;
2025
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002026 status = psa_restrict_key_policy( source_slot->attr.type,
2027 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002028 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002029 if( status != PSA_SUCCESS )
2030 goto exit;
2031
Ronald Cron81709fc2020-11-14 12:10:32 +01002032 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2033 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002034 if( status != PSA_SUCCESS )
2035 goto exit;
2036
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002037#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2038 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002039 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002040 /* Copying to a secure element is not implemented yet. */
2041 status = PSA_ERROR_NOT_SUPPORTED;
2042 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002043 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002044#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002045
Ronald Cron6cc66312021-04-02 12:27:47 +02002046 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2047 {
2048 /*
2049 * Copying through an opaque driver is not implemented yet, consider
2050 * a lifetime with an external location as an invalid parameter for
2051 * now.
2052 */
2053 status = PSA_ERROR_INVALID_ARGUMENT;
2054 goto exit;
2055 }
2056
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002057 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002058 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002059 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002060
Ronald Cron81709fc2020-11-14 12:10:32 +01002061 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002062exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002063 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002064 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002065
Ronald Cron5c522922020-11-14 16:35:34 +01002066 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002067
Ronald Cron5c522922020-11-14 16:35:34 +01002068 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002069}
2070
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002071
2072
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002073/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002074/* Message digests */
2075/****************************************************************/
2076
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002077psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2078{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002079 /* Aborting a non-active operation is allowed */
2080 if( operation->id == 0 )
2081 return( PSA_SUCCESS );
2082
2083 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2084 operation->id = 0;
2085
2086 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002087}
2088
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002089psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002090 psa_algorithm_t alg )
2091{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002092 /* A context must be freshly initialized before it can be set up. */
2093 if( operation->id != 0 )
2094 return( PSA_ERROR_BAD_STATE );
2095
2096 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002097 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002098
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002099 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2100 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002101 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2102
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002103 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002104}
2105
2106psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2107 const uint8_t *input,
2108 size_t input_length )
2109{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002110 if( operation->id == 0 )
2111 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002112
Steven Cooremanc8288352021-03-04 14:02:19 +01002113 /* Don't require hash implementations to behave correctly on a
2114 * zero-length input, which may have an invalid pointer. */
2115 if( input_length == 0 )
2116 return( PSA_SUCCESS );
2117
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002118 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2119 input, input_length );
2120 if( status != PSA_SUCCESS )
2121 psa_hash_abort( operation );
2122
2123 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002124}
2125
2126psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2127 uint8_t *hash,
2128 size_t hash_size,
2129 size_t *hash_length )
2130{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002131 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002132 if( operation->id == 0 )
2133 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002134
Steven Cooreman1e582352021-02-18 17:24:37 +01002135 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002136 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002137 psa_hash_abort( operation );
2138 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002139}
2140
Gilles Peskine2d277862018-06-18 15:41:12 +02002141psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2142 const uint8_t *hash,
2143 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002144{
2145 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2146 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 psa_status_t status = psa_hash_finish(
2148 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002149 actual_hash, sizeof( actual_hash ),
2150 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002151 if( status != PSA_SUCCESS )
2152 return( status );
2153 if( actual_hash_length != hash_length )
2154 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002155 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156 return( PSA_ERROR_INVALID_SIGNATURE );
2157 return( PSA_SUCCESS );
2158}
2159
Gilles Peskine0a749c82019-11-28 19:33:58 +01002160psa_status_t psa_hash_compute( psa_algorithm_t alg,
2161 const uint8_t *input, size_t input_length,
2162 uint8_t *hash, size_t hash_size,
2163 size_t *hash_length )
2164{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002165 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002166 if( !PSA_ALG_IS_HASH( alg ) )
2167 return( PSA_ERROR_INVALID_ARGUMENT );
2168
Steven Cooreman1e582352021-02-18 17:24:37 +01002169 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2170 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002171}
2172
2173psa_status_t psa_hash_compare( psa_algorithm_t alg,
2174 const uint8_t *input, size_t input_length,
2175 const uint8_t *hash, size_t hash_length )
2176{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002177 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2178 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002179
2180 if( !PSA_ALG_IS_HASH( alg ) )
2181 return( PSA_ERROR_INVALID_ARGUMENT );
2182
Steven Cooreman1e582352021-02-18 17:24:37 +01002183 psa_status_t status = psa_driver_wrapper_hash_compute(
2184 alg, input, input_length,
2185 actual_hash, sizeof(actual_hash),
2186 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002187 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002188 return( status );
2189 if( actual_hash_length != hash_length )
2190 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002191 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002192 return( PSA_ERROR_INVALID_SIGNATURE );
2193 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002194}
2195
Gilles Peskineeb35d782019-01-22 17:56:16 +01002196psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2197 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002198{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002199 if( source_operation->id == 0 ||
2200 target_operation->id != 0 )
2201 {
2202 return( PSA_ERROR_BAD_STATE );
2203 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002204
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002205 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2206 target_operation );
2207 if( status != PSA_SUCCESS )
2208 psa_hash_abort( target_operation );
2209
2210 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002211}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212
2213
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002215/* MAC */
2216/****************************************************************/
2217
Steven Cooremane6804192021-03-19 18:28:56 +01002218psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002219{
Steven Cooremane6804192021-03-19 18:28:56 +01002220 /* Aborting a non-active operation is allowed */
2221 if( operation->id == 0 )
2222 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002223
Steven Cooremane6804192021-03-19 18:28:56 +01002224 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002225 operation->mac_size = 0;
2226 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002227 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002228
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002229 return( status );
2230}
2231
Ronald Cron2dff3b22021-06-17 16:33:22 +02002232static psa_status_t psa_mac_finalize_alg_and_key_validation(
2233 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002234 const psa_key_attributes_t *attributes,
2235 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002236{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002238 psa_key_type_t key_type = psa_get_key_type( attributes );
2239 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002240
Ronald Cron28ea0502021-06-17 16:10:24 +02002241 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002242 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002243
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002244 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002245 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002246 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002247 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002248
Steven Cooremand1a68f12021-05-10 11:13:41 +02002249 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002250 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002251
Ronald Cron79bdd822021-06-17 16:46:44 +02002252 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002253 {
2254 /* A very short MAC is too short for security since it can be
2255 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2256 * so we make this our minimum, even though 32 bits is still
2257 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002258 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002259 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002260
Ronald Cron79bdd822021-06-17 16:46:44 +02002261 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2262 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002263 {
2264 /* It's impossible to "truncate" to a larger length than the full length
2265 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002266 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002267 }
2268
Ronald Cron79bdd822021-06-17 16:46:44 +02002269 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002270}
2271
Gilles Peskinee59236f2018-01-27 23:32:46 +01002272static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2273 mbedtls_svc_key_id_t key,
2274 psa_algorithm_t alg,
2275 int is_sign )
2276{
2277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2278 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2279 psa_key_slot_t *slot;
2280
2281 /* A context must be freshly initialized before it can be set up. */
2282 if( operation->id != 0 )
2283 return( PSA_ERROR_BAD_STATE );
2284
Gilles Peskine8c9def32018-02-08 10:02:12 +01002285 status = psa_get_and_lock_key_slot_with_policy(
2286 key,
2287 &slot,
2288 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2289 alg );
2290 if( status != PSA_SUCCESS )
2291 return( status );
2292
2293 psa_key_attributes_t attributes = {
2294 .core = slot->attr
2295 };
2296
Ronald Cron79bdd822021-06-17 16:46:44 +02002297 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2298 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002299 if( status != PSA_SUCCESS )
2300 goto exit;
2301
2302 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002303 /* Dispatch the MAC setup call with validated input */
2304 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002305 {
Steven Cooremane6804192021-03-19 18:28:56 +01002306 status = psa_driver_wrapper_mac_sign_setup( operation,
2307 &attributes,
2308 slot->key.data,
2309 slot->key.bytes,
2310 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002311 }
2312 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002313 {
Steven Cooremane6804192021-03-19 18:28:56 +01002314 status = psa_driver_wrapper_mac_verify_setup( operation,
2315 &attributes,
2316 slot->key.data,
2317 slot->key.bytes,
2318 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002319 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002320
Gilles Peskinefbfac682018-07-08 20:51:54 +02002321exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002322 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002323 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002324
Ronald Cron5c522922020-11-14 16:35:34 +01002325 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002326
Ronald Cron5c522922020-11-14 16:35:34 +01002327 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328}
2329
Gilles Peskine89167cb2018-07-08 20:12:23 +02002330psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002331 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002332 psa_algorithm_t alg )
2333{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002334 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002335}
2336
2337psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002338 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002339 psa_algorithm_t alg )
2340{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002341 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002342}
2343
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002344psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002345 const uint8_t *input,
2346 size_t input_length )
2347{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002348 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002349 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002350
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002351 /* Don't require hash implementations to behave correctly on a
2352 * zero-length input, which may have an invalid pointer. */
2353 if( input_length == 0 )
2354 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002355
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002356 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2357 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002358 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002359 psa_mac_abort( operation );
2360
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002361 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002362}
2363
Steven Cooremana5b860a2021-03-19 19:04:39 +01002364psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002365 uint8_t *mac,
2366 size_t mac_size,
2367 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002368{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2370 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002371
Steven Cooreman72f736a2021-05-07 14:14:37 +02002372 /* Set the output length and content to a safe default, such that in
2373 * case the caller misses an error check, the output would be an
2374 * unachievable MAC. */
2375 *mac_length = mac_size;
2376
Steven Cooremana5b860a2021-03-19 19:04:39 +01002377 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002378 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002379
Steven Cooreman72f736a2021-05-07 14:14:37 +02002380 if( ! operation->is_sign )
2381 return( PSA_ERROR_BAD_STATE );
2382
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002383 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2384 * once all the error checks are done. */
2385 if( operation->mac_size == 0 )
2386 return( PSA_ERROR_BAD_STATE );
2387
2388 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002389 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002390
Steven Cooremana5b860a2021-03-19 19:04:39 +01002391 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002392 mac, operation->mac_size,
2393 mac_length );
2394
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002395 /* In case of success, set the potential excess room in the output buffer
2396 * to an invalid value, to avoid potentially leaking a longer MAC.
2397 * In case of error, set the output length and content to a safe default,
2398 * such that in case the caller misses an error check, the output would be
2399 * an unachievable MAC.
2400 */
2401 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002402 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002403 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002404 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002405 }
mohammad16036df908f2018-04-02 08:34:15 -07002406
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002407 if( mac_size > operation->mac_size )
2408 memset( &mac[operation->mac_size], '!',
2409 mac_size - operation->mac_size );
2410
Steven Cooremana5b860a2021-03-19 19:04:39 +01002411 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002412
Steven Cooremana5b860a2021-03-19 19:04:39 +01002413 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002414}
2415
Steven Cooremana5b860a2021-03-19 19:04:39 +01002416psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002417 const uint8_t *mac,
2418 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002419{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002420 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2421 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002422
Steven Cooremana5b860a2021-03-19 19:04:39 +01002423 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002424 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002425
Steven Cooreman72f736a2021-05-07 14:14:37 +02002426 if( operation->is_sign )
2427 return( PSA_ERROR_BAD_STATE );
2428
2429 if( operation->mac_size != mac_length )
2430 {
2431 status = PSA_ERROR_INVALID_SIGNATURE;
2432 goto cleanup;
2433 }
2434
Steven Cooremana5b860a2021-03-19 19:04:39 +01002435 status = psa_driver_wrapper_mac_verify_finish( operation,
2436 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002437
2438cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002439 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002440
Steven Cooremana5b860a2021-03-19 19:04:39 +01002441 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442}
2443
Ronald Croncd989b52021-06-18 14:23:33 +02002444static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2445 psa_algorithm_t alg,
2446 const uint8_t *input,
2447 size_t input_length,
2448 uint8_t *mac,
2449 size_t mac_size,
2450 size_t *mac_length,
2451 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002452{
2453 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002454 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2455 psa_key_slot_t *slot;
2456 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002457
Ronald Cron51131b52021-06-17 17:17:20 +02002458 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002459 key, &slot,
2460 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2461 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002462 if( status != PSA_SUCCESS )
2463 goto exit;
2464
Ronald Cron51131b52021-06-17 17:17:20 +02002465 psa_key_attributes_t attributes = {
2466 .core = slot->attr
2467 };
2468
2469 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2470 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002471 if( status != PSA_SUCCESS )
2472 goto exit;
2473
Ronald Cron51131b52021-06-17 17:17:20 +02002474 if( mac_size < operation_mac_size )
2475 {
2476 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002477 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002478 }
2479
2480 status = psa_driver_wrapper_mac_compute(
2481 &attributes,
2482 slot->key.data, slot->key.bytes,
2483 alg,
2484 input, input_length,
2485 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002486
2487exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002488 /* In case of success, set the potential excess room in the output buffer
2489 * to an invalid value, to avoid potentially leaking a longer MAC.
2490 * In case of error, set the output length and content to a safe default,
2491 * such that in case the caller misses an error check, the output would be
2492 * an unachievable MAC.
2493 */
2494 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002495 {
Ronald Cron51131b52021-06-17 17:17:20 +02002496 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002497 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002498 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002499 if( mac_size > operation_mac_size )
2500 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002501
Ronald Cron51131b52021-06-17 17:17:20 +02002502 unlock_status = psa_unlock_key_slot( slot );
2503
2504 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002505}
2506
Ronald Croncd989b52021-06-18 14:23:33 +02002507psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2508 psa_algorithm_t alg,
2509 const uint8_t *input,
2510 size_t input_length,
2511 uint8_t *mac,
2512 size_t mac_size,
2513 size_t *mac_length)
2514{
2515 return( psa_mac_compute_internal( key, alg,
2516 input, input_length,
2517 mac, mac_size, mac_length, 1 ) );
2518}
2519
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002520psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2521 psa_algorithm_t alg,
2522 const uint8_t *input,
2523 size_t input_length,
2524 const uint8_t *mac,
2525 size_t mac_length)
2526{
2527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002528 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2529 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002530
Ronald Crona587cbc2021-06-18 14:51:29 +02002531 status = psa_mac_compute_internal( key, alg,
2532 input, input_length,
2533 actual_mac, sizeof( actual_mac ),
2534 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002535 if( status != PSA_SUCCESS )
2536 goto exit;
2537
Ronald Crona587cbc2021-06-18 14:51:29 +02002538 if( mac_length != actual_mac_length )
2539 {
2540 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002541 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002542 }
2543 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2544 {
2545 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002546 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002547 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002548
2549exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002550 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002551
2552 return ( status );
2553}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002554
Gilles Peskinee59236f2018-01-27 23:32:46 +01002555/****************************************************************/
2556/* Asymmetric cryptography */
2557/****************************************************************/
2558
gabor-mezei-armf0486182021-05-12 11:03:09 +02002559static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002560 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002561{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002562 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002563 {
2564 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2565 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002566
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002567 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2568 {
2569 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2570 return( PSA_ERROR_INVALID_ARGUMENT );
2571 }
2572 }
2573 else
2574 {
2575 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2576 return( PSA_ERROR_INVALID_ARGUMENT );
2577 }
2578
2579 return( PSA_SUCCESS );
2580}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002581
2582static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002583 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002584 psa_algorithm_t alg,
2585 const uint8_t * input,
2586 size_t input_length,
2587 uint8_t * signature,
2588 size_t signature_size,
2589 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002590{
2591 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2592 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2593 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002594
2595 *signature_length = 0;
2596
gabor-mezei-armf0486182021-05-12 11:03:09 +02002597 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002598 if( status != PSA_SUCCESS )
2599 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002600
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002601 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002602 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002603 * buffer can in principle be empty since it doesn't actually have
2604 * to be a hash.) */
2605 if( signature_size == 0 )
2606 return( PSA_ERROR_BUFFER_TOO_SMALL );
2607
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002608 status = psa_get_and_lock_key_slot_with_policy(
2609 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002610 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2611 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002612 alg );
2613
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002614 if( status != PSA_SUCCESS )
2615 goto exit;
2616
2617 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2618 {
2619 status = PSA_ERROR_INVALID_ARGUMENT;
2620 goto exit;
2621 }
2622
2623 psa_key_attributes_t attributes = {
2624 .core = slot->attr
2625 };
2626
gabor-mezei-armf0486182021-05-12 11:03:09 +02002627 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002628 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002629 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002630 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002631 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002632 signature, signature_size, signature_length );
2633 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002634 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002635 {
2636
2637 status = psa_driver_wrapper_sign_hash(
2638 &attributes, slot->key.data, slot->key.bytes,
2639 alg, input, input_length,
2640 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002641 }
2642
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002643
2644exit:
2645 /* Fill the unused part of the output buffer (the whole buffer on error,
2646 * the trailing part on success) with something that isn't a valid signature
2647 * (barring an attack on the signature and deliberately-crafted input),
2648 * in case the caller doesn't check the return status properly. */
2649 if( status == PSA_SUCCESS )
2650 memset( signature + *signature_length, '!',
2651 signature_size - *signature_length );
2652 else
2653 memset( signature, '!', signature_size );
2654 /* If signature_size is 0 then we have nothing to do. We must not call
2655 * memset because signature may be NULL in this case. */
2656
2657 unlock_status = psa_unlock_key_slot( slot );
2658
2659 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2660}
2661
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002662static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002663 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002664 psa_algorithm_t alg,
2665 const uint8_t * input,
2666 size_t input_length,
2667 const uint8_t * signature,
2668 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002669{
2670 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2671 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2672 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002673
gabor-mezei-armf0486182021-05-12 11:03:09 +02002674 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002675 if( status != PSA_SUCCESS )
2676 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002677
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002678 status = psa_get_and_lock_key_slot_with_policy(
2679 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002680 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2681 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002682 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002683
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002684 if( status != PSA_SUCCESS )
2685 return( status );
2686
2687 psa_key_attributes_t attributes = {
2688 .core = slot->attr
2689 };
2690
gabor-mezei-armf0486182021-05-12 11:03:09 +02002691 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002692 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002693 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002694 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002695 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002696 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002697 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002698 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002699 {
2700 status = psa_driver_wrapper_verify_hash(
2701 &attributes, slot->key.data, slot->key.bytes,
2702 alg, input, input_length,
2703 signature, signature_length );
2704 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002705
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002706 unlock_status = psa_unlock_key_slot( slot );
2707
2708 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002709
2710}
2711
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002712psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002713 const psa_key_attributes_t *attributes,
2714 const uint8_t *key_buffer,
2715 size_t key_buffer_size,
2716 psa_algorithm_t alg,
2717 const uint8_t *input,
2718 size_t input_length,
2719 uint8_t *signature,
2720 size_t signature_size,
2721 size_t *signature_length )
2722{
2723 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002724
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002725 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2726 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002727 size_t hash_length;
2728 uint8_t hash[PSA_HASH_MAX_SIZE];
2729
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002730 status = psa_driver_wrapper_hash_compute(
2731 PSA_ALG_SIGN_GET_HASH( alg ),
2732 input, input_length,
2733 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002734
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002735 if( status != PSA_SUCCESS )
2736 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002737
2738 return psa_driver_wrapper_sign_hash(
2739 attributes, key_buffer, key_buffer_size,
2740 alg, hash, hash_length,
2741 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002742 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002743
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002744 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002745}
2746
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002747psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2748 psa_algorithm_t alg,
2749 const uint8_t * input,
2750 size_t input_length,
2751 uint8_t * signature,
2752 size_t signature_size,
2753 size_t * signature_length )
2754{
2755 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002756 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002757 signature, signature_size, signature_length );
2758}
2759
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002760psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002761 const psa_key_attributes_t *attributes,
2762 const uint8_t *key_buffer,
2763 size_t key_buffer_size,
2764 psa_algorithm_t alg,
2765 const uint8_t *input,
2766 size_t input_length,
2767 const uint8_t *signature,
2768 size_t signature_length )
2769{
2770 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002771
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002772 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2773 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002774 size_t hash_length;
2775 uint8_t hash[PSA_HASH_MAX_SIZE];
2776
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002777 status = psa_driver_wrapper_hash_compute(
2778 PSA_ALG_SIGN_GET_HASH( alg ),
2779 input, input_length,
2780 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002781
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002782 if( status != PSA_SUCCESS )
2783 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002784
2785 return psa_driver_wrapper_verify_hash(
2786 attributes, key_buffer, key_buffer_size,
2787 alg, hash, hash_length,
2788 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002789 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002790
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002791 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002792}
2793
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002794psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2795 psa_algorithm_t alg,
2796 const uint8_t * input,
2797 size_t input_length,
2798 const uint8_t * signature,
2799 size_t signature_length )
2800{
2801 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002802 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002803 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002804}
2805
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002806psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002807 const psa_key_attributes_t *attributes,
2808 const uint8_t *key_buffer, size_t key_buffer_size,
2809 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2810 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002811{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002812 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002813 {
Ronald Cron4501c982021-03-19 20:09:32 +01002814 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2815 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002816 {
Ronald Cron4501c982021-03-19 20:09:32 +01002817#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2818 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2819 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002820 attributes,
2821 key_buffer, key_buffer_size,
2822 alg, hash, hash_length,
2823 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002824#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2825 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002826 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002827 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002828 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002829 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002830 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002831 }
2832 else
Ronald Cron4501c982021-03-19 20:09:32 +01002833 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2834 {
2835 if( PSA_ALG_IS_ECDSA( alg ) )
2836 {
2837#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2838 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2839 return( mbedtls_psa_ecdsa_sign_hash(
2840 attributes,
2841 key_buffer, key_buffer_size,
2842 alg, hash, hash_length,
2843 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002844#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2845 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002846 }
2847 else
2848 {
2849 return( PSA_ERROR_INVALID_ARGUMENT );
2850 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002851 }
Ronald Cron4501c982021-03-19 20:09:32 +01002852
2853 (void)key_buffer;
2854 (void)key_buffer_size;
2855 (void)hash;
2856 (void)hash_length;
2857 (void)signature;
2858 (void)signature_size;
2859 (void)signature_length;
2860
2861 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002862}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002863
2864psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2865 psa_algorithm_t alg,
2866 const uint8_t *hash,
2867 size_t hash_length,
2868 uint8_t *signature,
2869 size_t signature_size,
2870 size_t *signature_length )
2871{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002872 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002873 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002874 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002875}
2876
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002877psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002878 const psa_key_attributes_t *attributes,
2879 const uint8_t *key_buffer, size_t key_buffer_size,
2880 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2881 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002882{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002883 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002884 {
Ronald Cron4501c982021-03-19 20:09:32 +01002885 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2886 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002887 {
Ronald Cron4501c982021-03-19 20:09:32 +01002888#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2889 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2890 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002891 attributes,
2892 key_buffer, key_buffer_size,
2893 alg, hash, hash_length,
2894 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002895#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2896 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002897 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002898 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002899 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002900 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002901 }
itayzafrir5c753392018-05-08 11:18:38 +03002902 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002903 else
Ronald Cron4501c982021-03-19 20:09:32 +01002904 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002905 {
Ronald Cron4501c982021-03-19 20:09:32 +01002906 if( PSA_ALG_IS_ECDSA( alg ) )
2907 {
2908#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2909 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2910 return( mbedtls_psa_ecdsa_verify_hash(
2911 attributes,
2912 key_buffer, key_buffer_size,
2913 alg, hash, hash_length,
2914 signature, signature_length ) );
2915#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2916 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2917 }
2918 else
2919 {
2920 return( PSA_ERROR_INVALID_ARGUMENT );
2921 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002922 }
Ronald Cron4501c982021-03-19 20:09:32 +01002923
2924 (void)key_buffer;
2925 (void)key_buffer_size;
2926 (void)hash;
2927 (void)hash_length;
2928 (void)signature;
2929 (void)signature_length;
2930
2931 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002932}
2933
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002934psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2935 psa_algorithm_t alg,
2936 const uint8_t *hash,
2937 size_t hash_length,
2938 const uint8_t *signature,
2939 size_t signature_length )
2940{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002941 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002942 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002943 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002944}
2945
John Durkop0e005192020-10-31 22:06:54 -07002946#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002947static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2948 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002949{
2950 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2951 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2952 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002953
2954 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002955}
John Durkop0e005192020-10-31 22:06:54 -07002956#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002957
Ronald Croncf56a0a2020-08-04 09:51:30 +02002958psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002959 psa_algorithm_t alg,
2960 const uint8_t *input,
2961 size_t input_length,
2962 const uint8_t *salt,
2963 size_t salt_length,
2964 uint8_t *output,
2965 size_t output_size,
2966 size_t *output_length )
2967{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002968 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002969 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002970 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002971
Darryl Green5cc689a2018-07-24 15:34:10 +01002972 (void) input;
2973 (void) input_length;
2974 (void) salt;
2975 (void) output;
2976 (void) output_size;
2977
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002978 *output_length = 0;
2979
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002980 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2981 return( PSA_ERROR_INVALID_ARGUMENT );
2982
Ronald Cron5c522922020-11-14 16:35:34 +01002983 status = psa_get_and_lock_transparent_key_slot_with_policy(
2984 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002985 if( status != PSA_SUCCESS )
2986 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002987 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2988 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002989 {
2990 status = PSA_ERROR_INVALID_ARGUMENT;
2991 goto exit;
2992 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002993
John Durkop6ba40d12020-11-10 08:50:04 -08002994#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2995 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002996 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002997 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002998 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002999 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3000 slot->key.data,
3001 slot->key.bytes,
3002 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003003 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003004 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003005
3006 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003007 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003008 status = PSA_ERROR_BUFFER_TOO_SMALL;
3009 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003010 }
John Durkop0e005192020-10-31 22:06:54 -07003011#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003012 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3013 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003014 status = mbedtls_to_psa_error(
3015 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003016 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003017 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003018 input_length,
3019 input,
3020 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003021 }
3022 else
John Durkop0e005192020-10-31 22:06:54 -07003023#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3024#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003025 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3026 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003027 status = mbedtls_to_psa_error(
3028 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3029 if( status != PSA_SUCCESS )
3030 goto rsa_exit;
3031
Steven Cooreman4fed4552020-08-03 14:46:03 +02003032 status = mbedtls_to_psa_error(
3033 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003034 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003035 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003036 salt, salt_length,
3037 input_length,
3038 input,
3039 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003040 }
3041 else
John Durkop0e005192020-10-31 22:06:54 -07003042#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003043 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003044 status = PSA_ERROR_INVALID_ARGUMENT;
3045 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003046 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003047rsa_exit:
3048 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003049 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003050
Steven Cooremana2371e52020-07-28 14:30:39 +02003051 mbedtls_rsa_free( rsa );
3052 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003053 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003054 else
John Durkop9814fa22020-11-04 12:28:15 -08003055#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003056 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003057 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003058 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003059 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003060
3061exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003062 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003063
Ronald Cron5c522922020-11-14 16:35:34 +01003064 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003065}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003066
Ronald Croncf56a0a2020-08-04 09:51:30 +02003067psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003068 psa_algorithm_t alg,
3069 const uint8_t *input,
3070 size_t input_length,
3071 const uint8_t *salt,
3072 size_t salt_length,
3073 uint8_t *output,
3074 size_t output_size,
3075 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003076{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003078 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003079 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003080
Darryl Green5cc689a2018-07-24 15:34:10 +01003081 (void) input;
3082 (void) input_length;
3083 (void) salt;
3084 (void) output;
3085 (void) output_size;
3086
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003087 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003088
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003089 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3090 return( PSA_ERROR_INVALID_ARGUMENT );
3091
Ronald Cron5c522922020-11-14 16:35:34 +01003092 status = psa_get_and_lock_transparent_key_slot_with_policy(
3093 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003094 if( status != PSA_SUCCESS )
3095 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003096 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003097 {
3098 status = PSA_ERROR_INVALID_ARGUMENT;
3099 goto exit;
3100 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101
John Durkop6ba40d12020-11-10 08:50:04 -08003102#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3103 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003104 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003106 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003107 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3108 slot->key.data,
3109 slot->key.bytes,
3110 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003111 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003113
Steven Cooremana2371e52020-07-28 14:30:39 +02003114 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003115 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003116 status = PSA_ERROR_INVALID_ARGUMENT;
3117 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003118 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003119
John Durkop0e005192020-10-31 22:06:54 -07003120#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003121 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003123 status = mbedtls_to_psa_error(
3124 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003125 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003126 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003127 output_length,
3128 input,
3129 output,
3130 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131 }
3132 else
John Durkop0e005192020-10-31 22:06:54 -07003133#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3134#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003135 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003136 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003137 status = mbedtls_to_psa_error(
3138 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3139 if( status != PSA_SUCCESS )
3140 goto rsa_exit;
3141
Steven Cooreman4fed4552020-08-03 14:46:03 +02003142 status = mbedtls_to_psa_error(
3143 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003144 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003145 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003146 salt, salt_length,
3147 output_length,
3148 input,
3149 output,
3150 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003151 }
3152 else
John Durkop0e005192020-10-31 22:06:54 -07003153#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003155 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003157
Steven Cooreman4fed4552020-08-03 14:46:03 +02003158rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003159 mbedtls_rsa_free( rsa );
3160 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003161 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162 else
John Durkop6ba40d12020-11-10 08:50:04 -08003163#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3164 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003165 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003166 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003168
3169exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003170 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171
Ronald Cron5c522922020-11-14 16:35:34 +01003172 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003173}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003174
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003175
3176
mohammad1603503973b2018-03-12 15:59:30 +02003177/****************************************************************/
3178/* Symmetric cryptography */
3179/****************************************************************/
3180
Ronald Cronab99ac22020-10-01 16:38:28 +02003181static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3182 mbedtls_svc_key_id_t key,
3183 psa_algorithm_t alg,
3184 mbedtls_operation_t cipher_operation )
3185{
3186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3188 psa_key_slot_t *slot;
3189 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3190 PSA_KEY_USAGE_ENCRYPT :
3191 PSA_KEY_USAGE_DECRYPT );
3192
3193 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003194 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003195 return( PSA_ERROR_BAD_STATE );
3196
3197 /* The requested algorithm must be one that can be processed by cipher. */
3198 if( ! PSA_ALG_IS_CIPHER( alg ) )
3199 return( PSA_ERROR_INVALID_ARGUMENT );
3200
3201 /* Fetch key material from key storage. */
3202 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3203 if( status != PSA_SUCCESS )
3204 goto exit;
3205
Ronald Cron49fafa92021-03-10 08:34:23 +01003206 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003207 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003208 * so we only set it (in the driver wrapper) after resources have been
3209 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003210 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003211 if( alg == PSA_ALG_ECB_NO_PADDING )
3212 operation->iv_required = 0;
3213 else
3214 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003215 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003216
Ronald Crona4af55f2020-12-14 14:36:06 +01003217 psa_key_attributes_t attributes = {
3218 .core = slot->attr
3219 };
3220
Ronald Cronab99ac22020-10-01 16:38:28 +02003221 /* Try doing the operation through a driver before using software fallback. */
3222 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003223 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3224 &attributes,
3225 slot->key.data,
3226 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003227 alg );
3228 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003229 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3230 &attributes,
3231 slot->key.data,
3232 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003233 alg );
3234
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003235exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003236 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003237 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003238
Ronald Cron5c522922020-11-14 16:35:34 +01003239 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003240
Ronald Cron5c522922020-11-14 16:35:34 +01003241 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003242}
3243
Gilles Peskinefe119512018-07-08 21:39:34 +02003244psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003245 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003246 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003247{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003248 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003249}
3250
Gilles Peskinefe119512018-07-08 21:39:34 +02003251psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003252 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003253 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003254{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003255 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003256}
3257
Gilles Peskinefe119512018-07-08 21:39:34 +02003258psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003259 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003260 size_t iv_size,
3261 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003262{
Ronald Cron6d051732020-10-01 14:10:20 +02003263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003264
Ronald Cron5618a392021-03-26 09:52:26 +01003265 *iv_length = 0;
3266
Ronald Cron49fafa92021-03-10 08:34:23 +01003267 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003268 {
3269 return( PSA_ERROR_BAD_STATE );
3270 }
3271
Steven Cooreman7df02922020-09-09 15:28:49 +02003272 if( operation->iv_set || ! operation->iv_required )
3273 {
3274 return( PSA_ERROR_BAD_STATE );
3275 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003276
Ronald Cron5618a392021-03-26 09:52:26 +01003277 if( iv_size < operation->default_iv_length )
3278 {
3279 status = PSA_ERROR_BUFFER_TOO_SMALL;
3280 goto exit;
3281 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003282
Ronald Cron5618a392021-03-26 09:52:26 +01003283 status = psa_generate_random( iv, operation->default_iv_length );
3284 if( status != PSA_SUCCESS )
3285 goto exit;
3286
3287 status = psa_driver_wrapper_cipher_set_iv( operation,
3288 iv,
3289 operation->default_iv_length );
3290
3291exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003292 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003293 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003294 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003295 *iv_length = operation->default_iv_length;
3296 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003297 else
Moran Peker395db872018-05-31 14:07:14 +03003298 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003299
itayzafrir534bd7c2018-08-02 13:56:32 +03003300 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003301}
3302
Gilles Peskinefe119512018-07-08 21:39:34 +02003303psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003304 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003305 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003306{
Ronald Cron6d051732020-10-01 14:10:20 +02003307 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003308
Ronald Cron49fafa92021-03-10 08:34:23 +01003309 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003310 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003311
Steven Cooreman7df02922020-09-09 15:28:49 +02003312 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003313 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003314
3315 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3316 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003317
Ronald Crondd24c9b2020-12-15 14:10:01 +01003318 status = psa_driver_wrapper_cipher_set_iv( operation,
3319 iv,
3320 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003321
itayzafrir534bd7c2018-08-02 13:56:32 +03003322 if( status == PSA_SUCCESS )
3323 operation->iv_set = 1;
3324 else
mohammad1603503973b2018-03-12 15:59:30 +02003325 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003326 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003327}
3328
Gilles Peskinee553c652018-06-04 16:22:46 +02003329psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3330 const uint8_t *input,
3331 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003332 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003333 size_t output_size,
3334 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003335{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003336 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003337
Ronald Cron49fafa92021-03-10 08:34:23 +01003338 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003339 {
3340 return( PSA_ERROR_BAD_STATE );
3341 }
3342 if( operation->iv_required && ! operation->iv_set )
3343 {
3344 return( PSA_ERROR_BAD_STATE );
3345 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003346
Ronald Crondd24c9b2020-12-15 14:10:01 +01003347 status = psa_driver_wrapper_cipher_update( operation,
3348 input,
3349 input_length,
3350 output,
3351 output_size,
3352 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003353 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003354 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003355
itayzafrir534bd7c2018-08-02 13:56:32 +03003356 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003357}
3358
Gilles Peskinee553c652018-06-04 16:22:46 +02003359psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3360 uint8_t *output,
3361 size_t output_size,
3362 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003363{
David Saadab4ecc272019-02-14 13:48:10 +02003364 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003365
Ronald Cron49fafa92021-03-10 08:34:23 +01003366 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003367 {
3368 return( PSA_ERROR_BAD_STATE );
3369 }
3370 if( operation->iv_required && ! operation->iv_set )
3371 {
3372 return( PSA_ERROR_BAD_STATE );
3373 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003374
Ronald Crondd24c9b2020-12-15 14:10:01 +01003375 status = psa_driver_wrapper_cipher_finish( operation,
3376 output,
3377 output_size,
3378 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003379 if( status == PSA_SUCCESS )
3380 return( psa_cipher_abort( operation ) );
3381 else
3382 {
3383 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003384 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003385
Steven Cooremanef8575e2020-09-11 11:44:50 +02003386 return( status );
3387 }
mohammad1603503973b2018-03-12 15:59:30 +02003388}
3389
Gilles Peskinee553c652018-06-04 16:22:46 +02003390psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3391{
Ronald Cron49fafa92021-03-10 08:34:23 +01003392 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003393 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003394 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003395 * in use. It's ok to call abort on such an object, and there's
3396 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003397 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003398 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003399
Ronald Crondd24c9b2020-12-15 14:10:01 +01003400 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003401
Ronald Cron49fafa92021-03-10 08:34:23 +01003402 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003403 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003404 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003405
Moran Peker395db872018-05-31 14:07:14 +03003406 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003407}
3408
mohammad16035955c982018-04-26 00:53:03 +03003409/****************************************************************/
3410/* AEAD */
3411/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003412
Ronald Croncf56a0a2020-08-04 09:51:30 +02003413psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003414 psa_algorithm_t alg,
3415 const uint8_t *nonce,
3416 size_t nonce_length,
3417 const uint8_t *additional_data,
3418 size_t additional_data_length,
3419 const uint8_t *plaintext,
3420 size_t plaintext_length,
3421 uint8_t *ciphertext,
3422 size_t ciphertext_size,
3423 size_t *ciphertext_length )
3424{
Ronald Cron215633c2021-03-16 17:15:37 +01003425 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3426 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003427
mohammad1603f08a5502018-06-03 15:05:47 +03003428 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003429
Steven Cooremanea7ab132021-03-17 16:28:00 +01003430 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3431 return( PSA_ERROR_NOT_SUPPORTED );
3432
Ronald Cron9a986162021-03-26 12:40:07 +01003433 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003434 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003435 if( status != PSA_SUCCESS )
3436 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003437
Ronald Cron215633c2021-03-16 17:15:37 +01003438 psa_key_attributes_t attributes = {
3439 .core = slot->attr
3440 };
mohammad16035955c982018-04-26 00:53:03 +03003441
Ronald Cronde822812021-03-17 16:08:20 +01003442 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003443 &attributes, slot->key.data, slot->key.bytes,
3444 alg,
3445 nonce, nonce_length,
3446 additional_data, additional_data_length,
3447 plaintext, plaintext_length,
3448 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003449
Gilles Peskineedf9a652018-08-17 18:11:56 +02003450 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3451 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003452
Ronald Cron9f310172021-03-16 16:36:37 +01003453 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003454
mohammad16035955c982018-04-26 00:53:03 +03003455 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003456}
3457
Ronald Croncf56a0a2020-08-04 09:51:30 +02003458psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003459 psa_algorithm_t alg,
3460 const uint8_t *nonce,
3461 size_t nonce_length,
3462 const uint8_t *additional_data,
3463 size_t additional_data_length,
3464 const uint8_t *ciphertext,
3465 size_t ciphertext_length,
3466 uint8_t *plaintext,
3467 size_t plaintext_size,
3468 size_t *plaintext_length )
3469{
Ronald Cron215633c2021-03-16 17:15:37 +01003470 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3471 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003472
Gilles Peskineee652a32018-06-01 19:23:52 +02003473 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003474
Steven Cooremanea7ab132021-03-17 16:28:00 +01003475 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3476 return( PSA_ERROR_NOT_SUPPORTED );
3477
Ronald Cron9a986162021-03-26 12:40:07 +01003478 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003479 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003480 if( status != PSA_SUCCESS )
3481 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003482
Ronald Cron215633c2021-03-16 17:15:37 +01003483 psa_key_attributes_t attributes = {
3484 .core = slot->attr
3485 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003486
Ronald Cronde822812021-03-17 16:08:20 +01003487 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003488 &attributes, slot->key.data, slot->key.bytes,
3489 alg,
3490 nonce, nonce_length,
3491 additional_data, additional_data_length,
3492 ciphertext, ciphertext_length,
3493 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003494
Gilles Peskineedf9a652018-08-17 18:11:56 +02003495 if( status != PSA_SUCCESS && plaintext_size != 0 )
3496 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003497
Ronald Cron215633c2021-03-16 17:15:37 +01003498 psa_unlock_key_slot( slot );
3499
Gilles Peskineedf9a652018-08-17 18:11:56 +02003500 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003501}
3502
Gilles Peskinee59236f2018-01-27 23:32:46 +01003503/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003504/* Generators */
3505/****************************************************************/
3506
John Durkop07cc04a2020-11-16 22:08:34 -08003507#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3508 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3509 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3510#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003511#endif /* At least one builtin KDF */
3512
3513#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3514 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3515 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3516static psa_status_t psa_key_derivation_start_hmac(
3517 psa_mac_operation_t *operation,
3518 psa_algorithm_t hash_alg,
3519 const uint8_t *hmac_key,
3520 size_t hmac_key_length )
3521{
3522 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3523 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3524 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3525 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3526 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3527
Steven Cooreman72f736a2021-05-07 14:14:37 +02003528 operation->is_sign = 1;
3529 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3530
Steven Cooreman094a77e2021-05-06 17:58:36 +02003531 status = psa_driver_wrapper_mac_sign_setup( operation,
3532 &attributes,
3533 hmac_key, hmac_key_length,
3534 PSA_ALG_HMAC( hash_alg ) );
3535
3536 psa_reset_key_attributes( &attributes );
3537 return( status );
3538}
3539#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003540
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003541#define HKDF_STATE_INIT 0 /* no input yet */
3542#define HKDF_STATE_STARTED 1 /* got salt */
3543#define HKDF_STATE_KEYED 2 /* got key */
3544#define HKDF_STATE_OUTPUT 3 /* output started */
3545
Gilles Peskinecbe66502019-05-16 16:59:18 +02003546static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003547 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003548{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003549 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3550 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003551 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003552 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003553}
3554
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003555psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003556{
3557 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003558 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003559 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003560 {
3561 /* The object has (apparently) been initialized but it is not
3562 * in use. It's ok to call abort on such an object, and there's
3563 * nothing to do. */
3564 }
3565 else
John Durkopd0321952020-10-29 21:37:36 -07003566#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003567 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003568 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003569 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003570 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003571 }
John Durkop07cc04a2020-11-16 22:08:34 -08003572 else
3573#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3574#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3575 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3576 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003577 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003578 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003579 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003580 if( operation->ctx.tls12_prf.secret != NULL )
3581 {
3582 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3583 operation->ctx.tls12_prf.secret_length );
3584 mbedtls_free( operation->ctx.tls12_prf.secret );
3585 }
3586
Janos Follath6a1d2622019-06-11 10:37:28 +01003587 if( operation->ctx.tls12_prf.seed != NULL )
3588 {
3589 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3590 operation->ctx.tls12_prf.seed_length );
3591 mbedtls_free( operation->ctx.tls12_prf.seed );
3592 }
3593
3594 if( operation->ctx.tls12_prf.label != NULL )
3595 {
3596 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3597 operation->ctx.tls12_prf.label_length );
3598 mbedtls_free( operation->ctx.tls12_prf.label );
3599 }
3600
Steven Cooremana6df6042021-04-29 19:32:25 +02003601 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003602
3603 /* We leave the fields Ai and output_block to be erased safely by the
3604 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003605 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003606 else
John Durkop07cc04a2020-11-16 22:08:34 -08003607#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3608 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003609 {
3610 status = PSA_ERROR_BAD_STATE;
3611 }
Janos Follath083036a2019-06-11 10:22:26 +01003612 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003613 return( status );
3614}
3615
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003616psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003617 size_t *capacity)
3618{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003619 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003620 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003621 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003622 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003623 }
3624
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003625 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003626 return( PSA_SUCCESS );
3627}
3628
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003629psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003630 size_t capacity )
3631{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003632 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003633 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003634 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003635 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003636 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003637 return( PSA_SUCCESS );
3638}
3639
John Durkopd0321952020-10-29 21:37:36 -07003640#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003641/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003642 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003643static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003644 psa_algorithm_t hash_alg,
3645 uint8_t *output,
3646 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003647{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003648 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003649 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003650 psa_status_t status;
3651
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003652 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3653 return( PSA_ERROR_BAD_STATE );
3654 hkdf->state = HKDF_STATE_OUTPUT;
3655
Gilles Peskinebef7f142018-07-12 17:22:21 +02003656 while( output_length != 0 )
3657 {
3658 /* Copy what remains of the current block */
3659 uint8_t n = hash_length - hkdf->offset_in_block;
3660 if( n > output_length )
3661 n = (uint8_t) output_length;
3662 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3663 output += n;
3664 output_length -= n;
3665 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003666 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003667 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003668 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003669 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003670 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003671 * object was corrupted or if this function is called directly
3672 * inside the library. */
3673 if( hkdf->block_number == 0xff )
3674 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003675
3676 /* We need a new block */
3677 ++hkdf->block_number;
3678 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003679
Steven Cooreman094a77e2021-05-06 17:58:36 +02003680 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3681 hash_alg,
3682 hkdf->prk,
3683 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003684 if( status != PSA_SUCCESS )
3685 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003686
Gilles Peskinebef7f142018-07-12 17:22:21 +02003687 if( hkdf->block_number != 1 )
3688 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003689 status = psa_mac_update( &hkdf->hmac,
3690 hkdf->output_block,
3691 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003692 if( status != PSA_SUCCESS )
3693 return( status );
3694 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003695 status = psa_mac_update( &hkdf->hmac,
3696 hkdf->info,
3697 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003698 if( status != PSA_SUCCESS )
3699 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003700 status = psa_mac_update( &hkdf->hmac,
3701 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003702 if( status != PSA_SUCCESS )
3703 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003704 status = psa_mac_sign_finish( &hkdf->hmac,
3705 hkdf->output_block,
3706 sizeof( hkdf->output_block ),
3707 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003708 if( status != PSA_SUCCESS )
3709 return( status );
3710 }
3711
3712 return( PSA_SUCCESS );
3713}
John Durkop07cc04a2020-11-16 22:08:34 -08003714#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003715
John Durkop07cc04a2020-11-16 22:08:34 -08003716#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3717 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003718static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3719 psa_tls12_prf_key_derivation_t *tls12_prf,
3720 psa_algorithm_t alg )
3721{
3722 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003723 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003724 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3725 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003726 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003727
Janos Follath7742fee2019-06-17 12:58:10 +01003728 /* We can't be wanting more output after block 0xff, otherwise
3729 * the capacity check in psa_key_derivation_output_bytes() would have
3730 * prevented this call. It could happen only if the operation
3731 * object was corrupted or if this function is called directly
3732 * inside the library. */
3733 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003734 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003735
3736 /* We need a new block */
3737 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003738 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003739
3740 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3741 *
3742 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3743 *
3744 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3745 * HMAC_hash(secret, A(2) + seed) +
3746 * HMAC_hash(secret, A(3) + seed) + ...
3747 *
3748 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003749 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003750 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003751 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003752 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003753 * is currently extracted as `output_block` and where i is
3754 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003755 */
3756
Steven Cooreman094a77e2021-05-06 17:58:36 +02003757 status = psa_key_derivation_start_hmac( &hmac,
3758 hash_alg,
3759 tls12_prf->secret,
3760 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003761 if( status != PSA_SUCCESS )
3762 goto cleanup;
3763
3764 /* Calculate A(i) where i = tls12_prf->block_number. */
3765 if( tls12_prf->block_number == 1 )
3766 {
3767 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3768 * the variable seed and in this instance means it in the context of the
3769 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003770 status = psa_mac_update( &hmac,
3771 tls12_prf->label,
3772 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003773 if( status != PSA_SUCCESS )
3774 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003775 status = psa_mac_update( &hmac,
3776 tls12_prf->seed,
3777 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003778 if( status != PSA_SUCCESS )
3779 goto cleanup;
3780 }
3781 else
3782 {
3783 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003784 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003785 if( status != PSA_SUCCESS )
3786 goto cleanup;
3787 }
3788
Steven Cooremana6df6042021-04-29 19:32:25 +02003789 status = psa_mac_sign_finish( &hmac,
3790 tls12_prf->Ai, hash_length,
3791 &hmac_output_length );
3792 if( hmac_output_length != hash_length )
3793 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003794 if( status != PSA_SUCCESS )
3795 goto cleanup;
3796
3797 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003798 status = psa_key_derivation_start_hmac( &hmac,
3799 hash_alg,
3800 tls12_prf->secret,
3801 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003802 if( status != PSA_SUCCESS )
3803 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003804 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003805 if( status != PSA_SUCCESS )
3806 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003807 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003808 if( status != PSA_SUCCESS )
3809 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003810 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003811 if( status != PSA_SUCCESS )
3812 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003813 status = psa_mac_sign_finish( &hmac,
3814 tls12_prf->output_block, hash_length,
3815 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003816 if( status != PSA_SUCCESS )
3817 goto cleanup;
3818
Janos Follath7742fee2019-06-17 12:58:10 +01003819
3820cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003821 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003822 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3823 status = cleanup_status;
3824
3825 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003826}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003827
Janos Follath844eb0e2019-06-19 12:10:49 +01003828static psa_status_t psa_key_derivation_tls12_prf_read(
3829 psa_tls12_prf_key_derivation_t *tls12_prf,
3830 psa_algorithm_t alg,
3831 uint8_t *output,
3832 size_t output_length )
3833{
3834 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003835 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003836 psa_status_t status;
3837 uint8_t offset, length;
3838
Gilles Peskineb1edaec2021-06-11 22:41:46 +02003839 switch( tls12_prf->state )
3840 {
3841 case PSA_TLS12_PRF_STATE_LABEL_SET:
3842 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
3843 break;
3844 case PSA_TLS12_PRF_STATE_OUTPUT:
3845 break;
3846 default:
3847 return( PSA_ERROR_BAD_STATE );
3848 }
3849
Janos Follath844eb0e2019-06-19 12:10:49 +01003850 while( output_length != 0 )
3851 {
3852 /* Check if we have fully processed the current block. */
3853 if( tls12_prf->left_in_block == 0 )
3854 {
3855 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3856 alg );
3857 if( status != PSA_SUCCESS )
3858 return( status );
3859
3860 continue;
3861 }
3862
3863 if( tls12_prf->left_in_block > output_length )
3864 length = (uint8_t) output_length;
3865 else
3866 length = tls12_prf->left_in_block;
3867
3868 offset = hash_length - tls12_prf->left_in_block;
3869 memcpy( output, tls12_prf->output_block + offset, length );
3870 output += length;
3871 output_length -= length;
3872 tls12_prf->left_in_block -= length;
3873 }
3874
3875 return( PSA_SUCCESS );
3876}
John Durkop07cc04a2020-11-16 22:08:34 -08003877#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3878 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003879
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003880psa_status_t psa_key_derivation_output_bytes(
3881 psa_key_derivation_operation_t *operation,
3882 uint8_t *output,
3883 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003884{
3885 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003886 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003887
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003888 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003889 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003890 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003891 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003892 }
3893
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003894 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003895 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003896 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003897 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003898 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003899 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003900 goto exit;
3901 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003902 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003903 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003905 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003906 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3907 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003908 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003909 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003910 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003911 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003912 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003913
John Durkopd0321952020-10-29 21:37:36 -07003914#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003915 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003916 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003917 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003918 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003919 output, output_length );
3920 }
Janos Follathadbec812019-06-14 11:05:39 +01003921 else
John Durkop07cc04a2020-11-16 22:08:34 -08003922#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3923#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3924 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003925 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003926 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003927 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003928 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003929 kdf_alg, output,
3930 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003931 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003932 else
John Durkop07cc04a2020-11-16 22:08:34 -08003933#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3934 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003935 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003936 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003937 return( PSA_ERROR_BAD_STATE );
3938 }
3939
3940exit:
3941 if( status != PSA_SUCCESS )
3942 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003943 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003944 * This allows us to differentiate between exhausted operations and
3945 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3946 * operations. */
3947 psa_algorithm_t alg = operation->alg;
3948 psa_key_derivation_abort( operation );
3949 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003950 memset( output, '!', output_length );
3951 }
3952 return( status );
3953}
3954
David Brown7807bf72021-02-09 16:28:23 -07003955#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003956static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3957{
3958 if( data_size >= 8 )
3959 mbedtls_des_key_set_parity( data );
3960 if( data_size >= 16 )
3961 mbedtls_des_key_set_parity( data + 8 );
3962 if( data_size >= 24 )
3963 mbedtls_des_key_set_parity( data + 16 );
3964}
David Brown7807bf72021-02-09 16:28:23 -07003965#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003966
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003967static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003968 psa_key_slot_t *slot,
3969 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003970 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003971{
3972 uint8_t *data = NULL;
3973 size_t bytes = PSA_BITS_TO_BYTES( bits );
3974 psa_status_t status;
3975
Gilles Peskine8e338702019-07-30 20:06:31 +02003976 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003977 return( PSA_ERROR_INVALID_ARGUMENT );
3978 if( bits % 8 != 0 )
3979 return( PSA_ERROR_INVALID_ARGUMENT );
3980 data = mbedtls_calloc( 1, bytes );
3981 if( data == NULL )
3982 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3983
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003984 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003985 if( status != PSA_SUCCESS )
3986 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003987#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003988 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003989 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003990#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003991
3992 status = psa_allocate_buffer_to_slot( slot, bytes );
3993 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003994 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003995
Ronald Cronbf33c932020-11-28 18:06:53 +01003996 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003997 psa_key_attributes_t attributes = {
3998 .core = slot->attr
3999 };
4000
Ronald Cronbf33c932020-11-28 18:06:53 +01004001 status = psa_driver_wrapper_import_key( &attributes,
4002 data, bytes,
4003 slot->key.data,
4004 slot->key.bytes,
4005 &slot->key.bytes, &bits );
4006 if( bits != slot->attr.bits )
4007 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004008
4009exit:
4010 mbedtls_free( data );
4011 return( status );
4012}
4013
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004014psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004015 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004016 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004017{
4018 psa_status_t status;
4019 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004020 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004021
Ronald Cron81709fc2020-11-14 12:10:32 +01004022 *key = MBEDTLS_SVC_KEY_ID_INIT;
4023
Gilles Peskine0f84d622019-09-12 19:03:13 +02004024 /* Reject any attempt to create a zero-length key so that we don't
4025 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4026 if( psa_get_key_bits( attributes ) == 0 )
4027 return( PSA_ERROR_INVALID_ARGUMENT );
4028
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004029 if( ! operation->can_output_key )
4030 return( PSA_ERROR_NOT_PERMITTED );
4031
Ronald Cron81709fc2020-11-14 12:10:32 +01004032 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4033 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004034#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4035 if( driver != NULL )
4036 {
4037 /* Deriving a key in a secure element is not implemented yet. */
4038 status = PSA_ERROR_NOT_SUPPORTED;
4039 }
4040#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004041 if( status == PSA_SUCCESS )
4042 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004043 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004044 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004045 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004046 }
4047 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004048 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004049 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004050 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004051
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004052 return( status );
4053}
4054
Gilles Peskineeab56e42018-07-12 17:12:33 +02004055
4056
4057/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004058/* Key derivation */
4059/****************************************************************/
4060
Steven Cooreman932ffb72021-02-15 12:14:32 +01004061#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004062static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004063 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004064 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004065{
John Durkop07cc04a2020-11-16 22:08:34 -08004066 int is_kdf_alg_supported;
4067
Janos Follath5fe19732019-06-20 15:09:30 +01004068 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4069 * initialisers for this union leave some bytes unspecified.) */
4070 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4071
Gilles Peskine969c5d62019-01-16 15:53:06 +01004072 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004073#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004074 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4075 is_kdf_alg_supported = 1;
4076 else
4077#endif
4078#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4079 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4080 is_kdf_alg_supported = 1;
4081 else
4082#endif
4083#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4084 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4085 is_kdf_alg_supported = 1;
4086 else
4087#endif
4088 is_kdf_alg_supported = 0;
4089
4090 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004091 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004092 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004093 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004094 if( hash_size == 0 )
4095 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004096 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4097 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004098 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004099 {
4100 return( PSA_ERROR_NOT_SUPPORTED );
4101 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004102 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004103 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004104 }
John Durkop07cc04a2020-11-16 22:08:34 -08004105
4106 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004107}
John Durkop07cc04a2020-11-16 22:08:34 -08004108#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004109
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004110psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004111 psa_algorithm_t alg )
4112{
4113 psa_status_t status;
4114
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004115 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004116 return( PSA_ERROR_BAD_STATE );
4117
Gilles Peskine6843c292019-01-18 16:44:49 +01004118 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4119 return( PSA_ERROR_INVALID_ARGUMENT );
4120 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004121 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004122#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004123 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004124 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004125#else
4126 return( PSA_ERROR_NOT_SUPPORTED );
4127#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004128 }
4129 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4130 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004131#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004132 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004133#else
4134 return( PSA_ERROR_NOT_SUPPORTED );
4135#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004136 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004137 else
4138 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004139
4140 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004141 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004142 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004143}
4144
John Durkopd0321952020-10-29 21:37:36 -07004145#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004146static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004147 psa_algorithm_t hash_alg,
4148 psa_key_derivation_step_t step,
4149 const uint8_t *data,
4150 size_t data_length )
4151{
4152 psa_status_t status;
4153 switch( step )
4154 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004155 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004156 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004157 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004158 else
4159 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004160 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4161 hash_alg,
4162 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004163 if( status != PSA_SUCCESS )
4164 return( status );
4165 hkdf->state = HKDF_STATE_STARTED;
4166 return( PSA_SUCCESS );
4167 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004168 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004169 /* If no salt was provided, use an empty salt. */
4170 if( hkdf->state == HKDF_STATE_INIT )
4171 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004172 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4173 hash_alg,
4174 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004175 if( status != PSA_SUCCESS )
4176 return( status );
4177 hkdf->state = HKDF_STATE_STARTED;
4178 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004179 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004180 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004181 status = psa_mac_update( &hkdf->hmac,
4182 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004183 if( status != PSA_SUCCESS )
4184 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004185 status = psa_mac_sign_finish( &hkdf->hmac,
4186 hkdf->prk,
4187 sizeof( hkdf->prk ),
4188 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004189 if( status != PSA_SUCCESS )
4190 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004191 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004192 hkdf->block_number = 0;
4193 hkdf->state = HKDF_STATE_KEYED;
4194 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004195 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004196 if( hkdf->state == HKDF_STATE_OUTPUT )
4197 return( PSA_ERROR_BAD_STATE );
4198 if( hkdf->info_set )
4199 return( PSA_ERROR_BAD_STATE );
4200 hkdf->info_length = data_length;
4201 if( data_length != 0 )
4202 {
4203 hkdf->info = mbedtls_calloc( 1, data_length );
4204 if( hkdf->info == NULL )
4205 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4206 memcpy( hkdf->info, data, data_length );
4207 }
4208 hkdf->info_set = 1;
4209 return( PSA_SUCCESS );
4210 default:
4211 return( PSA_ERROR_INVALID_ARGUMENT );
4212 }
4213}
John Durkop07cc04a2020-11-16 22:08:34 -08004214#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004215
John Durkop07cc04a2020-11-16 22:08:34 -08004216#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4217 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004218static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4219 const uint8_t *data,
4220 size_t data_length )
4221{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004222 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004223 return( PSA_ERROR_BAD_STATE );
4224
Janos Follathd6dce9f2019-07-04 09:11:38 +01004225 if( data_length != 0 )
4226 {
4227 prf->seed = mbedtls_calloc( 1, data_length );
4228 if( prf->seed == NULL )
4229 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004230
Janos Follathd6dce9f2019-07-04 09:11:38 +01004231 memcpy( prf->seed, data, data_length );
4232 prf->seed_length = data_length;
4233 }
Janos Follathf08e2652019-06-13 09:05:41 +01004234
Gilles Peskine43f958b2020-12-13 14:55:14 +01004235 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004236
4237 return( PSA_SUCCESS );
4238}
4239
Janos Follath81550542019-06-13 14:26:34 +01004240static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004241 const uint8_t *data,
4242 size_t data_length )
4243{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004244 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004245 return( PSA_ERROR_BAD_STATE );
4246
Steven Cooremana6df6042021-04-29 19:32:25 +02004247 if( data_length != 0 )
4248 {
4249 prf->secret = mbedtls_calloc( 1, data_length );
4250 if( prf->secret == NULL )
4251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4252
4253 memcpy( prf->secret, data, data_length );
4254 prf->secret_length = data_length;
4255 }
Janos Follath81550542019-06-13 14:26:34 +01004256
Gilles Peskine43f958b2020-12-13 14:55:14 +01004257 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004258
4259 return( PSA_SUCCESS );
4260}
4261
Janos Follath63028dd2019-06-13 09:15:47 +01004262static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4263 const uint8_t *data,
4264 size_t data_length )
4265{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004266 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004267 return( PSA_ERROR_BAD_STATE );
4268
Janos Follathd6dce9f2019-07-04 09:11:38 +01004269 if( data_length != 0 )
4270 {
4271 prf->label = mbedtls_calloc( 1, data_length );
4272 if( prf->label == NULL )
4273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004274
Janos Follathd6dce9f2019-07-04 09:11:38 +01004275 memcpy( prf->label, data, data_length );
4276 prf->label_length = data_length;
4277 }
Janos Follath63028dd2019-06-13 09:15:47 +01004278
Gilles Peskine43f958b2020-12-13 14:55:14 +01004279 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004280
4281 return( PSA_SUCCESS );
4282}
4283
Janos Follathb03233e2019-06-11 15:30:30 +01004284static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004285 psa_key_derivation_step_t step,
4286 const uint8_t *data,
4287 size_t data_length )
4288{
Janos Follathb03233e2019-06-11 15:30:30 +01004289 switch( step )
4290 {
Janos Follathf08e2652019-06-13 09:05:41 +01004291 case PSA_KEY_DERIVATION_INPUT_SEED:
4292 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004293 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004294 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004295 case PSA_KEY_DERIVATION_INPUT_LABEL:
4296 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004297 default:
4298 return( PSA_ERROR_INVALID_ARGUMENT );
4299 }
4300}
John Durkop07cc04a2020-11-16 22:08:34 -08004301#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4302 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4303
4304#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4305static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4306 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004307 const uint8_t *data,
4308 size_t data_length )
4309{
4310 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004311 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004312 uint8_t *cur = pms;
4313
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004314 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004315 return( PSA_ERROR_INVALID_ARGUMENT );
4316
4317 /* Quoting RFC 4279, Section 2:
4318 *
4319 * The premaster secret is formed as follows: if the PSK is N octets
4320 * long, concatenate a uint16 with the value N, N zero octets, a second
4321 * uint16 with the value N, and the PSK itself.
4322 */
4323
4324 *cur++ = ( data_length >> 8 ) & 0xff;
4325 *cur++ = ( data_length >> 0 ) & 0xff;
4326 memset( cur, 0, data_length );
4327 cur += data_length;
4328 *cur++ = pms[0];
4329 *cur++ = pms[1];
4330 memcpy( cur, data, data_length );
4331 cur += data_length;
4332
Steven Cooremana6df6042021-04-29 19:32:25 +02004333 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004334
4335 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4336 return( status );
4337}
Janos Follath6660f0e2019-06-17 08:44:03 +01004338
4339static psa_status_t psa_tls12_prf_psk_to_ms_input(
4340 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004341 psa_key_derivation_step_t step,
4342 const uint8_t *data,
4343 size_t data_length )
4344{
4345 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004346 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004347 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004348 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004349 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004350
Steven Cooremana6df6042021-04-29 19:32:25 +02004351 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004352}
John Durkop07cc04a2020-11-16 22:08:34 -08004353#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004354
Gilles Peskineb8965192019-09-24 16:21:10 +02004355/** Check whether the given key type is acceptable for the given
4356 * input step of a key derivation.
4357 *
4358 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4359 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4360 * Both secret and non-secret inputs can alternatively have the type
4361 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4362 * that the input was passed as a buffer rather than via a key object.
4363 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004364static int psa_key_derivation_check_input_type(
4365 psa_key_derivation_step_t step,
4366 psa_key_type_t key_type )
4367{
4368 switch( step )
4369 {
4370 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004371 if( key_type == PSA_KEY_TYPE_DERIVE )
4372 return( PSA_SUCCESS );
4373 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004374 return( PSA_SUCCESS );
4375 break;
4376 case PSA_KEY_DERIVATION_INPUT_LABEL:
4377 case PSA_KEY_DERIVATION_INPUT_SALT:
4378 case PSA_KEY_DERIVATION_INPUT_INFO:
4379 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004380 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4381 return( PSA_SUCCESS );
4382 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004383 return( PSA_SUCCESS );
4384 break;
4385 }
4386 return( PSA_ERROR_INVALID_ARGUMENT );
4387}
4388
Janos Follathb80a94e2019-06-12 15:54:46 +01004389static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004391 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004392 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004393 const uint8_t *data,
4394 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004395{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004396 psa_status_t status;
4397 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4398
4399 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004400 if( status != PSA_SUCCESS )
4401 goto exit;
4402
John Durkopd0321952020-10-29 21:37:36 -07004403#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004404 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004405 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004406 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004407 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004408 step, data, data_length );
4409 }
John Durkop07cc04a2020-11-16 22:08:34 -08004410 else
4411#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4412#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4413 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004414 {
Janos Follathb03233e2019-06-11 15:30:30 +01004415 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004416 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004417 }
John Durkop07cc04a2020-11-16 22:08:34 -08004418 else
4419#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4420#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4421 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004422 {
4423 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004424 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004425 }
4426 else
John Durkop07cc04a2020-11-16 22:08:34 -08004427#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004428 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004429 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004430 (void) data;
4431 (void) data_length;
4432 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004433 return( PSA_ERROR_BAD_STATE );
4434 }
4435
Gilles Peskine224b0d62019-09-23 18:13:17 +02004436exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004437 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004438 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004439 return( status );
4440}
4441
Janos Follath51f4a0f2019-06-14 11:35:55 +01004442psa_status_t psa_key_derivation_input_bytes(
4443 psa_key_derivation_operation_t *operation,
4444 psa_key_derivation_step_t step,
4445 const uint8_t *data,
4446 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004447{
Gilles Peskineb8965192019-09-24 16:21:10 +02004448 return( psa_key_derivation_input_internal( operation, step,
4449 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004450 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004451}
4452
Janos Follath51f4a0f2019-06-14 11:35:55 +01004453psa_status_t psa_key_derivation_input_key(
4454 psa_key_derivation_operation_t *operation,
4455 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004456 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004457{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004458 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004459 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004460 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004461
Ronald Cron5c522922020-11-14 16:35:34 +01004462 status = psa_get_and_lock_transparent_key_slot_with_policy(
4463 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004464 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004465 {
4466 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004467 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004468 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004469
4470 /* Passing a key object as a SECRET input unlocks the permission
4471 * to output to a key object. */
4472 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4473 operation->can_output_key = 1;
4474
Ronald Cronf95a2b12020-10-22 15:24:49 +02004475 status = psa_key_derivation_input_internal( operation,
4476 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004477 slot->key.data,
4478 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004479
Ronald Cron5c522922020-11-14 16:35:34 +01004480 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004481
Ronald Cron5c522922020-11-14 16:35:34 +01004482 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004483}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004484
4485
4486
4487/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004488/* Key agreement */
4489/****************************************************************/
4490
John Durkop6ba40d12020-11-10 08:50:04 -08004491#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004492static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4493 size_t peer_key_length,
4494 const mbedtls_ecp_keypair *our_key,
4495 uint8_t *shared_secret,
4496 size_t shared_secret_size,
4497 size_t *shared_secret_length )
4498{
Steven Cooremand4867872020-08-05 16:31:39 +02004499 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004500 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004501 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004502 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004503 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004504 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004505
Ronald Cron90857082020-11-25 14:58:33 +01004506 status = mbedtls_psa_ecp_load_representation(
4507 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004508 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004509 peer_key,
4510 peer_key_length,
4511 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004512 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004513 goto exit;
4514
Jaeden Amero97271b32019-01-10 19:38:51 +00004515 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004516 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004517 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004518 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004519 status = mbedtls_to_psa_error(
4520 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4521 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004522 goto exit;
4523
Jaeden Amero97271b32019-01-10 19:38:51 +00004524 status = mbedtls_to_psa_error(
4525 mbedtls_ecdh_calc_secret( &ecdh,
4526 shared_secret_length,
4527 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004528 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004529 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004530 if( status != PSA_SUCCESS )
4531 goto exit;
4532 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4533 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004534
4535exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004536 if( status != PSA_SUCCESS )
4537 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004538 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004539 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004540 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004541
Jaeden Amero97271b32019-01-10 19:38:51 +00004542 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004543}
John Durkop6ba40d12020-11-10 08:50:04 -08004544#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004545
Gilles Peskine01d718c2018-09-18 12:01:02 +02004546#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4547
Gilles Peskine0216fe12019-04-11 21:23:21 +02004548static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4549 psa_key_slot_t *private_key,
4550 const uint8_t *peer_key,
4551 size_t peer_key_length,
4552 uint8_t *shared_secret,
4553 size_t shared_secret_size,
4554 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004555{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004556 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004557 {
John Durkop6ba40d12020-11-10 08:50:04 -08004558#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004559 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004560 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004561 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004562 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004563 psa_status_t status = mbedtls_psa_ecp_load_representation(
4564 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004565 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004566 private_key->key.data,
4567 private_key->key.bytes,
4568 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004569 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004570 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004571 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004572 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004573 shared_secret, shared_secret_size,
4574 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004575 mbedtls_ecp_keypair_free( ecp );
4576 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004577 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004578#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004579 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004580 (void) private_key;
4581 (void) peer_key;
4582 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004583 (void) shared_secret;
4584 (void) shared_secret_size;
4585 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004586 return( PSA_ERROR_NOT_SUPPORTED );
4587 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004588}
4589
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004590/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004591 * to potentially free embedded data structures and wipe confidential data.
4592 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004593static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004594 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004595 psa_key_slot_t *private_key,
4596 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004597 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004598{
4599 psa_status_t status;
4600 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4601 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004602 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004603
4604 /* Step 1: run the secret agreement algorithm to generate the shared
4605 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004606 status = psa_key_agreement_raw_internal( ka_alg,
4607 private_key,
4608 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004609 shared_secret,
4610 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004611 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004612 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004613 goto exit;
4614
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004615 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004616 * the shared secret. A shared secret is permitted wherever a key
4617 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004618 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004619 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004620 shared_secret,
4621 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004622exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004623 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004624 return( status );
4625}
4626
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004627psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004628 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004629 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004630 const uint8_t *peer_key,
4631 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004632{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004634 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004635 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004636
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004637 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004638 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004639 status = psa_get_and_lock_transparent_key_slot_with_policy(
4640 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004641 if( status != PSA_SUCCESS )
4642 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004643 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004644 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004645 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004646 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004647 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004648 else
4649 {
4650 /* If a private key has been added as SECRET, we allow the derived
4651 * key material to be used as a key in PSA Crypto. */
4652 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4653 operation->can_output_key = 1;
4654 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004655
Ronald Cron5c522922020-11-14 16:35:34 +01004656 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004657
Ronald Cron5c522922020-11-14 16:35:34 +01004658 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004659}
4660
Gilles Peskinebe697d82019-05-16 18:00:41 +02004661psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004662 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004663 const uint8_t *peer_key,
4664 size_t peer_key_length,
4665 uint8_t *output,
4666 size_t output_size,
4667 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004668{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004670 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004671 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004672
4673 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4674 {
4675 status = PSA_ERROR_INVALID_ARGUMENT;
4676 goto exit;
4677 }
Ronald Cron5c522922020-11-14 16:35:34 +01004678 status = psa_get_and_lock_transparent_key_slot_with_policy(
4679 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004680 if( status != PSA_SUCCESS )
4681 goto exit;
4682
4683 status = psa_key_agreement_raw_internal( alg, slot,
4684 peer_key, peer_key_length,
4685 output, output_size,
4686 output_length );
4687
4688exit:
4689 if( status != PSA_SUCCESS )
4690 {
4691 /* If an error happens and is not handled properly, the output
4692 * may be used as a key to protect sensitive data. Arrange for such
4693 * a key to be random, which is likely to result in decryption or
4694 * verification errors. This is better than filling the buffer with
4695 * some constant data such as zeros, which would result in the data
4696 * being protected with a reproducible, easily knowable key.
4697 */
4698 psa_generate_random( output, output_size );
4699 *output_length = output_size;
4700 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004701
Ronald Cron5c522922020-11-14 16:35:34 +01004702 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004703
Ronald Cron5c522922020-11-14 16:35:34 +01004704 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004705}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004706
4707
Gilles Peskine30524eb2020-11-13 17:02:26 +01004708
Gilles Peskine86a440b2018-11-12 18:39:40 +01004709/****************************************************************/
4710/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004711/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004712
Gilles Peskine30524eb2020-11-13 17:02:26 +01004713/** Initialize the PSA random generator.
4714 */
4715static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4716{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004717#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4718 memset( rng, 0, sizeof( *rng ) );
4719#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4720
Gilles Peskine30524eb2020-11-13 17:02:26 +01004721 /* Set default configuration if
4722 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4723 if( rng->entropy_init == NULL )
4724 rng->entropy_init = mbedtls_entropy_init;
4725 if( rng->entropy_free == NULL )
4726 rng->entropy_free = mbedtls_entropy_free;
4727
4728 rng->entropy_init( &rng->entropy );
4729#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4730 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4731 /* The PSA entropy injection feature depends on using NV seed as an entropy
4732 * source. Add NV seed as an entropy source for PSA entropy injection. */
4733 mbedtls_entropy_add_source( &rng->entropy,
4734 mbedtls_nv_seed_poll, NULL,
4735 MBEDTLS_ENTROPY_BLOCK_SIZE,
4736 MBEDTLS_ENTROPY_SOURCE_STRONG );
4737#endif
4738
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004739 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004740#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004741}
4742
4743/** Deinitialize the PSA random generator.
4744 */
4745static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4746{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004747#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4748 memset( rng, 0, sizeof( *rng ) );
4749#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004750 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004751 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004752#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004753}
4754
4755/** Seed the PSA random generator.
4756 */
4757static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4758{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004759#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4760 /* Do nothing: the external RNG seeds itself. */
4761 (void) rng;
4762 return( PSA_SUCCESS );
4763#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004764 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004765 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4766 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004767 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004768#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004769}
4770
Gilles Peskinee59236f2018-01-27 23:32:46 +01004771psa_status_t psa_generate_random( uint8_t *output,
4772 size_t output_size )
4773{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004774 GUARD_MODULE_INITIALIZED;
4775
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004776#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4777
4778 size_t output_length = 0;
4779 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4780 output, output_size,
4781 &output_length );
4782 if( status != PSA_SUCCESS )
4783 return( status );
4784 /* Breaking up a request into smaller chunks is currently not supported
4785 * for the extrernal RNG interface. */
4786 if( output_length != output_size )
4787 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4788 return( PSA_SUCCESS );
4789
4790#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4791
Gilles Peskine71ddab92021-01-04 21:01:07 +01004792 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004793 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004794 size_t request_size =
4795 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4796 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4797 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004798 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4799 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004800 if( ret != 0 )
4801 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004802 output_size -= request_size;
4803 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004804 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004805 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004806#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004807}
4808
Gilles Peskine8814fc42020-12-14 15:33:44 +01004809/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004810 *
4811 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4812 * `psa_generate_random(...)`. The state parameter is ignored since the
4813 * PSA API doesn't support passing an explicit state.
4814 *
4815 * In the non-external case, psa_generate_random() calls an
4816 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4817 * and semantics as mbedtls_psa_get_random(). As an optimization,
4818 * instead of doing this back-and-forth between the PSA API and the
4819 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4820 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004821 */
4822#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4823int mbedtls_psa_get_random( void *p_rng,
4824 unsigned char *output,
4825 size_t output_size )
4826{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004827 /* This function takes a pointer to the RNG state because that's what
4828 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4829 * its own state internally and doesn't let the caller access that state.
4830 * So we just ignore the state parameter, and in practice we'll pass
4831 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004832 (void) p_rng;
4833 psa_status_t status = psa_generate_random( output, output_size );
4834 if( status == PSA_SUCCESS )
4835 return( 0 );
4836 else
4837 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4838}
4839#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4840
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004841#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004842#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004843
Gilles Peskine7228da22019-07-15 11:06:15 +02004844psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004845 size_t seed_size )
4846{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004847 if( global_data.initialized )
4848 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004849
4850 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4851 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4852 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4853 return( PSA_ERROR_INVALID_ARGUMENT );
4854
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004855 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004856}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004857#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004858
Ronald Cron3772afe2021-02-08 16:10:05 +01004859/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004860 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004861 * \param type The key type
4862 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004863 *
4864 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004865 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004866 * \retval #PSA_ERROR_INVALID_ARGUMENT
4867 * The size in bits of the key is not valid.
4868 * \retval #PSA_ERROR_NOT_SUPPORTED
4869 * The type and/or the size in bits of the key or the combination of
4870 * the two is not supported.
4871 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004872static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4873 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004874{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004876
Gilles Peskinee59236f2018-01-27 23:32:46 +01004877 if( key_type_is_raw_bytes( type ) )
4878 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004879 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004880 if( status != PSA_SUCCESS )
4881 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004882 }
4883 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004884#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004885 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4886 {
4887 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4888 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004889
Ronald Cron01b2aba2020-10-05 09:42:02 +02004890 /* Accept only byte-aligned keys, for the same reasons as
4891 * in psa_import_rsa_key(). */
4892 if( bits % 8 != 0 )
4893 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004894 }
4895 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004896#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004897
Ronald Cron5c4d3862020-12-07 11:07:24 +01004898#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004899 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4900 {
Ronald Crond81ab562021-02-16 09:01:16 +01004901 /* To avoid empty block, return successfully here. */
4902 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004903 }
4904 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004905#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004906 {
4907 return( PSA_ERROR_NOT_SUPPORTED );
4908 }
4909
4910 return( PSA_SUCCESS );
4911}
4912
Ronald Cron55ed0592020-10-05 10:30:40 +02004913psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004914 const psa_key_attributes_t *attributes,
4915 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004916{
4917 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004918 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004919
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004920 if( ( attributes->domain_parameters == NULL ) &&
4921 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004922 return( PSA_ERROR_INVALID_ARGUMENT );
4923
Ronald Cron01b2aba2020-10-05 09:42:02 +02004924 if( key_type_is_raw_bytes( type ) )
4925 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004926 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004927 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004928 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004929
David Brown12ca5032021-02-11 11:02:00 -07004930#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004931 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004932 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004933#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004934 }
4935 else
4936
Jaeden Amero424fa932021-05-14 08:34:32 +01004937#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4938 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004939 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004940 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004941 return( mbedtls_psa_rsa_generate_key( attributes,
4942 key_buffer,
4943 key_buffer_size,
4944 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004945 }
4946 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004947#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4948 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004949
John Durkop9814fa22020-11-04 12:28:15 -08004950#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004951 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004952 {
Ronald Cron7023db52020-11-20 18:17:42 +01004953 return( mbedtls_psa_ecp_generate_key( attributes,
4954 key_buffer,
4955 key_buffer_size,
4956 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004957 }
4958 else
John Durkop9814fa22020-11-04 12:28:15 -08004959#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004960 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004961 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004962 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004963 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004964
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004965 return( PSA_SUCCESS );
4966}
Darryl Green0c6575a2018-11-07 16:05:30 +00004967
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004968psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004969 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004970{
4971 psa_status_t status;
4972 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004973 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004974 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004975
Ronald Cron81709fc2020-11-14 12:10:32 +01004976 *key = MBEDTLS_SVC_KEY_ID_INIT;
4977
Gilles Peskine0f84d622019-09-12 19:03:13 +02004978 /* Reject any attempt to create a zero-length key so that we don't
4979 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4980 if( psa_get_key_bits( attributes ) == 0 )
4981 return( PSA_ERROR_INVALID_ARGUMENT );
4982
Ronald Cron81709fc2020-11-14 12:10:32 +01004983 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4984 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004985 if( status != PSA_SUCCESS )
4986 goto exit;
4987
Ronald Cron977c2472020-10-13 08:32:21 +02004988 /* In the case of a transparent key or an opaque key stored in local
4989 * storage (thus not in the case of generating a key in a secure element
4990 * or cryptoprocessor with storage), we have to allocate a buffer to
4991 * hold the generated key material. */
4992 if( slot->key.data == NULL )
4993 {
4994 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4995 PSA_KEY_LOCATION_LOCAL_STORAGE )
4996 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004997 status = psa_validate_key_type_and_size_for_key_generation(
4998 attributes->core.type, attributes->core.bits );
4999 if( status != PSA_SUCCESS )
5000 goto exit;
5001
5002 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5003 attributes->core.type,
5004 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005005 }
5006 else
5007 {
5008 status = psa_driver_wrapper_get_key_buffer_size(
5009 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005010 if( status != PSA_SUCCESS )
5011 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005012 }
Ronald Cron977c2472020-10-13 08:32:21 +02005013
5014 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5015 if( status != PSA_SUCCESS )
5016 goto exit;
5017 }
5018
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005019 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005020 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005021
Ronald Cron2b56bc82020-10-05 10:02:26 +02005022 if( status != PSA_SUCCESS )
5023 psa_remove_key_data_from_memory( slot );
5024
Gilles Peskine11792082019-08-06 18:36:36 +02005025exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005026 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005027 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005028 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005029 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005030
Darryl Green0c6575a2018-11-07 16:05:30 +00005031 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005032}
5033
Gilles Peskinee59236f2018-01-27 23:32:46 +01005034/****************************************************************/
5035/* Module setup */
5036/****************************************************************/
5037
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005038#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005039psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5040 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5041 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5042{
5043 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5044 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005045 global_data.rng.entropy_init = entropy_init;
5046 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005047 return( PSA_SUCCESS );
5048}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005049#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005050
Gilles Peskinee59236f2018-01-27 23:32:46 +01005051void mbedtls_psa_crypto_free( void )
5052{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005053 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005054 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5055 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005056 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005057 }
5058 /* Wipe all remaining data, including configuration.
5059 * In particular, this sets all state indicator to the value
5060 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005061 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005063 /* Unregister all secure element drivers, so that we restart from
5064 * a pristine state. */
5065 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005066#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005067}
5068
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005069#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5070/** Recover a transaction that was interrupted by a power failure.
5071 *
5072 * This function is called during initialization, before psa_crypto_init()
5073 * returns. If this function returns a failure status, the initialization
5074 * fails.
5075 */
5076static psa_status_t psa_crypto_recover_transaction(
5077 const psa_crypto_transaction_t *transaction )
5078{
5079 switch( transaction->unknown.type )
5080 {
5081 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5082 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005083 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005084 * is implemented.
5085 * https://github.com/ARMmbed/mbed-crypto/issues/218
5086 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005087 default:
5088 /* We found an unsupported transaction in the storage.
5089 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005090 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005091 }
5092}
5093#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5094
Gilles Peskinee59236f2018-01-27 23:32:46 +01005095psa_status_t psa_crypto_init( void )
5096{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005097 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005098
Gilles Peskinec6b69072018-11-20 21:42:52 +01005099 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005100 if( global_data.initialized != 0 )
5101 return( PSA_SUCCESS );
5102
Gilles Peskine30524eb2020-11-13 17:02:26 +01005103 /* Initialize and seed the random generator. */
5104 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005105 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005106 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005107 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005108 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005109 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005110
Gilles Peskine66fb1262018-12-10 16:29:04 +01005111 status = psa_initialize_key_slots( );
5112 if( status != PSA_SUCCESS )
5113 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005114
Gilles Peskined9348f22019-10-01 15:22:29 +02005115#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5116 status = psa_init_all_se_drivers( );
5117 if( status != PSA_SUCCESS )
5118 goto exit;
5119#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5120
Gilles Peskine4b734222019-07-24 15:56:31 +02005121#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005122 status = psa_crypto_load_transaction( );
5123 if( status == PSA_SUCCESS )
5124 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005125 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5126 if( status != PSA_SUCCESS )
5127 goto exit;
5128 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005129 }
5130 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5131 {
5132 /* There's no transaction to complete. It's all good. */
5133 status = PSA_SUCCESS;
5134 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005135#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005136
Gilles Peskinec6b69072018-11-20 21:42:52 +01005137 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005138 global_data.initialized = 1;
5139
5140exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005141 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005142 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005143 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005144}
5145
5146#endif /* MBEDTLS_PSA_CRYPTO_C */