blob: 7c90102f5f030edbeb3b37a913ee919eb0f95018 [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 Peskinef9f1bdf2021-06-23 20:32:27 +0200270 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
271 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100272
Gilles Peskineff2d2002019-05-06 15:26:23 +0200273 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
274 return( PSA_ERROR_HARDWARE_FAILURE );
275 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
276 return( PSA_ERROR_NOT_SUPPORTED );
277
Gilles Peskinea5905292018-02-07 20:59:33 +0100278 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_RSA_INVALID_PADDING:
281 return( PSA_ERROR_INVALID_PADDING );
282 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
283 return( PSA_ERROR_HARDWARE_FAILURE );
284 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
285 return( PSA_ERROR_INVALID_ARGUMENT );
286 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
287 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200288 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100289 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
290 return( PSA_ERROR_INVALID_SIGNATURE );
291 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
292 return( PSA_ERROR_BUFFER_TOO_SMALL );
293 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100294 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200295
itayzafrir5c753392018-05-08 11:18:38 +0300296 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300297 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300298 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300299 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
300 return( PSA_ERROR_BUFFER_TOO_SMALL );
301 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
302 return( PSA_ERROR_NOT_SUPPORTED );
303 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
304 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
305 return( PSA_ERROR_INVALID_SIGNATURE );
306 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
307 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100308 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
309 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100310
Janos Follatha13b9052019-11-22 12:48:59 +0000311 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
312 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300313
Gilles Peskinee59236f2018-01-27 23:32:46 +0100314 default:
David Saadab4ecc272019-02-14 13:48:10 +0200315 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100316 }
317}
318
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200319
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200320
321
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100322/****************************************************************/
323/* Key management */
324/****************************************************************/
325
Gilles Peskine73167e12019-07-12 23:44:37 +0200326#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
327static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
328{
Gilles Peskine8e338702019-07-30 20:06:31 +0200329 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200330}
331#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
332
John Durkop07cc04a2020-11-16 22:08:34 -0800333/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
334 * current test driver in key_management.c is using this function
335 * when accelerators are used for ECC key pair and public key.
336 * Once that dependency is resolved these guards can be removed.
337 */
John Durkop9814fa22020-11-04 12:28:15 -0800338#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800339 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
340 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
341 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100342mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100343 size_t bits,
344 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200345{
346 switch( curve )
347 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100348 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100349 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100350 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100351#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100352 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100353 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100354#endif
355#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100356 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100357 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100358#endif
359#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100360 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100361 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100362#endif
363#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100364 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100365 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
367#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100368 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100370 case 528:
371 if( bits_is_sloppy )
372 return( MBEDTLS_ECP_DP_SECP521R1 );
373 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100375 }
376 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100377
Paul Elliott8ff510a2020-06-02 17:19:28 +0100378 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100379 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100381#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
385#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100386 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100388#endif
389#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100390 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100392#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100393 }
394 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100395
Paul Elliott8ff510a2020-06-02 17:19:28 +0100396 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100397 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100399#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100400 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100402 case 256:
403 if( bits_is_sloppy )
404 return( MBEDTLS_ECP_DP_CURVE25519 );
405 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100406#endif
407#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100408 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100410#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100411 }
412 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100413
Paul Elliott8ff510a2020-06-02 17:19:28 +0100414 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
421#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100422 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100424#endif
425#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100428#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100429 }
430 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200431 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100433 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200435}
John Durkop9814fa22020-11-04 12:28:15 -0800436#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800437 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
438 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
439 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200440
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200441static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
442 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443{
444 /* Check that the bit size is acceptable for the key type */
445 switch( type )
446 {
447 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200448 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200449 case PSA_KEY_TYPE_DERIVE:
450 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100451#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200452 case PSA_KEY_TYPE_AES:
453 if( bits != 128 && bits != 192 && bits != 256 )
454 return( PSA_ERROR_INVALID_ARGUMENT );
455 break;
456#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100457#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200458 case PSA_KEY_TYPE_CAMELLIA:
459 if( bits != 128 && bits != 192 && bits != 256 )
460 return( PSA_ERROR_INVALID_ARGUMENT );
461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_DES:
465 if( bits != 64 && bits != 128 && bits != 192 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200470 case PSA_KEY_TYPE_CHACHA20:
471 if( bits != 256 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 default:
476 return( PSA_ERROR_NOT_SUPPORTED );
477 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200478 if( bits % 8 != 0 )
479 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200480
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200481 return( PSA_SUCCESS );
482}
483
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100484/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100485 *
Steven Cooremancd640932021-03-08 12:00:27 +0100486 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
487 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100488 *
489 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 * \param[in] key_type The key type of the key to be used with the
491 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100492 *
493 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100497 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100499 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100500 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501{
Steven Cooremancd640932021-03-08 12:00:27 +0100502 if( PSA_ALG_IS_HMAC( algorithm ) )
503 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 if( key_type == PSA_KEY_TYPE_HMAC )
505 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100506 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100507
508 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100509 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100510 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
511 * key. */
512 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
513 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
514 {
515 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
516 * the block length (larger than 1) for block ciphers. */
517 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
518 return( PSA_SUCCESS );
519 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100520 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100521
522 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100523}
524
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200525psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
526 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200527{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100528 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200529 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200530
Ronald Cronea0f8a62020-11-25 17:52:23 +0100531 slot->key.data = mbedtls_calloc( 1, buffer_length );
532 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200533 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200534
Ronald Cronea0f8a62020-11-25 17:52:23 +0100535 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200536 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200537}
538
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200539psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
540 const uint8_t* data,
541 size_t data_length )
542{
543 psa_status_t status = psa_allocate_buffer_to_slot( slot,
544 data_length );
545 if( status != PSA_SUCCESS )
546 return( status );
547
Ronald Cronea0f8a62020-11-25 17:52:23 +0100548 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200549 return( PSA_SUCCESS );
550}
551
Ronald Crona0fe59f2020-11-29 11:14:53 +0100552psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100553 const psa_key_attributes_t *attributes,
554 const uint8_t *data, size_t data_length,
555 uint8_t *key_buffer, size_t key_buffer_size,
556 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100557{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100558 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
559 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100560
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200561 /* zero-length keys are never supported. */
562 if( data_length == 0 )
563 return( PSA_ERROR_NOT_SUPPORTED );
564
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100566 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100567 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200568
Steven Cooreman75b74362020-07-28 14:30:13 +0200569 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
570 if( data_length > SIZE_MAX / 8 )
571 return( PSA_ERROR_NOT_SUPPORTED );
572
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200573 /* Enforce a size limit, and in particular ensure that the bit
574 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100575 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200576 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200577
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100578 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200579 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200580 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200581
Ronald Crondd04d422020-11-28 15:14:42 +0100582 /* Copy the key material. */
583 memcpy( key_buffer, data, data_length );
584 *key_buffer_length = data_length;
585 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Steven Cooreman40120f62020-10-29 11:42:22 +0100587 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100588 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100589 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200590 {
John Durkop9814fa22020-11-04 12:28:15 -0800591#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
592 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200594 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100595 return( mbedtls_psa_ecp_import_key( attributes,
596 data, data_length,
597 key_buffer, key_buffer_size,
598 key_buffer_length,
599 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100600 }
John Durkop9814fa22020-11-04 12:28:15 -0800601#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
602 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700603#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
604 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200606 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 return( mbedtls_psa_rsa_import_key( attributes,
608 data, data_length,
609 key_buffer, key_buffer_size,
610 key_buffer_length,
611 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200612 }
John Durkop9814fa22020-11-04 12:28:15 -0800613#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
614 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100615 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100616
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100617 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100618}
619
Gilles Peskinef603c712019-01-19 13:40:11 +0100620/** Calculate the intersection of two algorithm usage policies.
621 *
622 * Return 0 (which allows no operation) on incompatibility.
623 */
624static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100625 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100626 psa_algorithm_t alg1,
627 psa_algorithm_t alg2 )
628{
Gilles Peskine549ea862019-05-22 11:45:59 +0200629 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100630 if( alg1 == alg2 )
631 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100632 /* If the policies are from the same hash-and-sign family, check
633 * if one is a wildcard. If so the other has the specific algorithm. */
634 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
635 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
636 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100637 {
Steven Cooreman03488022021-02-18 12:07:20 +0100638 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
639 return( alg2 );
640 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
641 return( alg1 );
642 }
643 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100644 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100645 * restrictive tag length. */
646 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
647 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
648 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
649 {
650 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
651 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100652 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100653
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100654 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100655 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
656 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100657 {
Steven Cooremancd640932021-03-08 12:00:27 +0100658 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
659 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100660 }
661 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100662 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100663 ( alg1_len <= alg2_len ) )
664 {
665 return( alg2 );
666 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100667 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100668 ( alg2_len <= alg1_len ) )
669 {
670 return( alg1 );
671 }
672 }
673 /* If the policies are from the same MAC family, check whether one
674 * of them is a minimum-MAC-length policy. Calculate the most
675 * restrictive tag length. */
676 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
677 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
678 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
679 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100680 /* Validate the combination of key type and algorithm. Since the base
681 * algorithm of alg1 and alg2 are the same, we only need this once. */
682 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100683 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100684
Steven Cooreman31a876d2021-03-03 20:47:40 +0100685 /* Get the (exact or at-least) output lengths for both sides of the
686 * requested intersection. None of the currently supported algorithms
687 * have an output length dependent on the actual key size, so setting it
688 * to a bogus value of 0 is currently OK.
689 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100690 * Note that for at-least-this-length wildcard algorithms, the output
691 * length is set to the shortest allowed length, which allows us to
692 * calculate the most restrictive tag length for the intersection. */
693 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
694 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100695 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100696
Steven Cooremana1d83222021-02-25 10:20:29 +0100697 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100698 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
699 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100700 {
Steven Cooremancd640932021-03-08 12:00:27 +0100701 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100702 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100703
704 /* If only one is an at-least-this-length policy, the intersection would
705 * be the other (fixed-length) policy as long as said fixed length is
706 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100707 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100708 {
Steven Cooremancd640932021-03-08 12:00:27 +0100709 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100710 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100711 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100712 {
Steven Cooremancd640932021-03-08 12:00:27 +0100713 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100714 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100715
Steven Cooremancd640932021-03-08 12:00:27 +0100716 /* If none of them are wildcards, check whether they define the same tag
717 * length. This is still possible here when one is default-length and
718 * the other specific-length. Ensure to always return the
719 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100720 if( alg1_len == alg2_len )
721 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100722 }
723 /* If the policies are incompatible, allow nothing. */
724 return( 0 );
725}
726
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100727static int psa_key_algorithm_permits( psa_key_type_t key_type,
728 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200729 psa_algorithm_t requested_alg )
730{
Gilles Peskine549ea862019-05-22 11:45:59 +0200731 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200732 if( requested_alg == policy_alg )
733 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100734 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
735 * and requested_alg is the same hash-and-sign family with any hash,
736 * then requested_alg is compliant with policy_alg. */
737 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
738 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200739 {
Steven Cooreman03488022021-02-18 12:07:20 +0100740 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
741 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
742 }
743 /* If policy_alg is a wildcard AEAD algorithm of the same base as
744 * the requested algorithm, check the requested tag length to be
745 * equal-length or longer than the wildcard-specified length. */
746 if( PSA_ALG_IS_AEAD( policy_alg ) &&
747 PSA_ALG_IS_AEAD( requested_alg ) &&
748 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
749 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100750 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100751 {
752 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
753 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
754 }
Steven Cooremancd640932021-03-08 12:00:27 +0100755 /* If policy_alg is a MAC algorithm of the same base as the requested
756 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100757 if( PSA_ALG_IS_MAC( policy_alg ) &&
758 PSA_ALG_IS_MAC( requested_alg ) &&
759 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100760 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100761 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100762 /* Validate the combination of key type and algorithm. Since the policy
763 * and requested algorithms are the same, we only need this once. */
764 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100765 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100766
Steven Cooreman31a876d2021-03-03 20:47:40 +0100767 /* Get both the requested output length for the algorithm which is to be
768 * verified, and the default output length for the base algorithm.
769 * Note that none of the currently supported algorithms have an output
770 * length dependent on actual key size, so setting it to a bogus value
771 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100772 size_t requested_output_length = PSA_MAC_LENGTH(
773 key_type, 0, requested_alg );
774 size_t default_output_length = PSA_MAC_LENGTH(
775 key_type, 0,
776 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100777
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100778 /* If the policy is default-length, only allow an algorithm with
779 * a declared exact-length matching the default. */
780 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100781 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782
783 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100784 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100785 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
786 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
787 {
788 return( 1 );
789 }
790
Steven Cooremancd640932021-03-08 12:00:27 +0100791 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
792 * check for the requested MAC length to be equal to or longer than the
793 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100794 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
795 {
796 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100797 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100798 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200799 }
Steven Cooremance48e852020-10-05 16:02:45 +0200800 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200801 * a key derivation with that key agreement should also be allowed. This
802 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200803 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
804 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
805 {
806 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
807 policy_alg );
808 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100809 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 return( 0 );
811}
812
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100813/** Test whether a policy permits an algorithm.
814 *
815 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100816 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100817 * \note This function requires providing the key type for which the policy is
818 * being validated, since some algorithm policy definitions (e.g. MAC)
819 * have different properties depending on what kind of cipher it is
820 * combined with.
821 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100822 * \retval PSA_SUCCESS When \p alg is a specific algorithm
823 * allowed by the \p policy.
824 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
825 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
826 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100827 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100829 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100830 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831{
Steven Cooremand788fab2021-02-25 11:29:17 +0100832 /* '0' is not a valid algorithm */
833 if( alg == 0 )
834 return( PSA_ERROR_INVALID_ARGUMENT );
835
Steven Cooreman7e39f052021-02-23 14:18:32 +0100836 /* A requested algorithm cannot be a wildcard. */
837 if( PSA_ALG_IS_WILDCARD( alg ) )
838 return( PSA_ERROR_INVALID_ARGUMENT );
839
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100840 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
841 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100842 return( PSA_SUCCESS );
843 else
844 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100845}
846
Gilles Peskinef603c712019-01-19 13:40:11 +0100847/** Restrict a key policy based on a constraint.
848 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100849 * \note This function requires providing the key type for which the policy is
850 * being restricted, since some algorithm policy definitions (e.g. MAC)
851 * have different properties depending on what kind of cipher it is
852 * combined with.
853 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100854 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100855 * \param[in,out] policy The policy to restrict.
856 * \param[in] constraint The policy constraint to apply.
857 *
858 * \retval #PSA_SUCCESS
859 * \c *policy contains the intersection of the original value of
860 * \c *policy and \c *constraint.
861 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100862 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100863 * \c *policy is unchanged.
864 */
865static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100866 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100867 psa_key_policy_t *policy,
868 const psa_key_policy_t *constraint )
869{
870 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100871 psa_key_policy_algorithm_intersection( key_type, policy->alg,
872 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200873 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100874 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
875 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100876 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
877 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200878 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
879 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 policy->usage &= constraint->usage;
881 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200882 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100883 return( PSA_SUCCESS );
884}
885
Ronald Cron5c522922020-11-14 16:35:34 +0100886/** Get the description of a key given its identifier and policy constraints
887 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200888 *
Ronald Cron5c522922020-11-14 16:35:34 +0100889 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100890 * nonzero, the key must allow operations with this algorithm. If \p alg is
891 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100892 *
Ronald Cron5c522922020-11-14 16:35:34 +0100893 * In case of a persistent key, the function loads the description of the key
894 * into a key slot if not already done.
895 *
896 * On success, the returned key slot is locked. It is the responsibility of
897 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200898 */
Ronald Cron5c522922020-11-14 16:35:34 +0100899static psa_status_t psa_get_and_lock_key_slot_with_policy(
900 mbedtls_svc_key_id_t key,
901 psa_key_slot_t **p_slot,
902 psa_key_usage_t usage,
903 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100904{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
906 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100907
Ronald Cron5c522922020-11-14 16:35:34 +0100908 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100909 if( status != PSA_SUCCESS )
910 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200911 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100912
913 /* Enforce that usage policy for the key slot contains all the flags
914 * required by the usage parameter. There is one exception: public
915 * keys can always be exported, so we treat public key objects as
916 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200917 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100918 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200919
Gilles Peskine8e338702019-07-30 20:06:31 +0200920 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100921 {
922 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200923 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100924 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100925
926 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100927 if( alg != 0 )
928 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100929 status = psa_key_policy_permits( &slot->attr.policy,
930 slot->attr.type,
931 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100932 if( status != PSA_SUCCESS )
933 goto error;
934 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100935
Darryl Green06fd18d2018-07-16 11:21:11 +0100936 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
938error:
939 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100940 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200941
942 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100943}
Darryl Green940d72c2018-07-13 13:18:51 +0100944
Ronald Cron5c522922020-11-14 16:35:34 +0100945/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200946 *
947 * A transparent key is a key for which the key material is directly
948 * available, as opposed to a key in a secure element.
949 *
Ronald Cron5c522922020-11-14 16:35:34 +0100950 * This is a temporary function to use instead of
951 * psa_get_and_lock_key_slot_with_policy() until secure element support is
952 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200953 *
Ronald Cron5c522922020-11-14 16:35:34 +0100954 * On success, the returned key slot is locked. It is the responsibility of the
955 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 */
957#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100958static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
959 mbedtls_svc_key_id_t key,
960 psa_key_slot_t **p_slot,
961 psa_key_usage_t usage,
962 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200963{
Ronald Cron5c522922020-11-14 16:35:34 +0100964 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
965 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966 if( status != PSA_SUCCESS )
967 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200968
Gilles Peskineadad8132019-07-25 11:31:23 +0200969 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200970 {
Ronald Cron5c522922020-11-14 16:35:34 +0100971 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200972 *p_slot = NULL;
973 return( PSA_ERROR_NOT_SUPPORTED );
974 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200975
Gilles Peskine28f8f302019-07-24 13:30:31 +0200976 return( PSA_SUCCESS );
977}
978#else /* MBEDTLS_PSA_CRYPTO_SE_C */
979/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100980#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
981 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200982#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
983
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200984psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000985{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100986 /* Data pointer will always be either a valid pointer or NULL in an
987 * initialized slot, so we can just free it. */
988 if( slot->key.data != NULL )
989 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
990
991 mbedtls_free( slot->key.data );
992 slot->key.data = NULL;
993 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000994
995 return( PSA_SUCCESS );
996}
997
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100998/** Completely wipe a slot in memory, including its policy.
999 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001000psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001001{
1002 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001003
Ronald Cron5c522922020-11-14 16:35:34 +01001004 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001005 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001006 status = PSA_ERROR_CORRUPTION_DETECTED;
1007 }
1008
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001009 /* Multipart operations may still be using the key. This is safe
1010 * because all multipart operation objects are independent from
1011 * the key slot: if they need to access the key after the setup
1012 * phase, they have a copy of the key. Note that this means that
1013 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001014 /* At this point, key material and other type-specific content has
1015 * been wiped. Clear remaining metadata. We can call memset and not
1016 * zeroize because the metadata is not particularly sensitive. */
1017 memset( slot, 0, sizeof( *slot ) );
1018 return( status );
1019}
1020
Ronald Croncf56a0a2020-08-04 09:51:30 +02001021psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001023 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001024 psa_status_t status; /* status of the last operation */
1025 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1027 psa_se_drv_table_entry_t *driver;
1028#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001029
Ronald Croncf56a0a2020-08-04 09:51:30 +02001030 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001031 return( PSA_SUCCESS );
1032
Ronald Cronf2911112020-10-29 17:51:10 +01001033 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001034 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001035 * key, this will load the key description from persistent memory if not
1036 * done yet. We cannot avoid this loading as without it we don't know if
1037 * the key is operated by an SE or not and this information is needed by
1038 * the current implementation.
1039 */
Ronald Cron5c522922020-11-14 16:35:34 +01001040 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001041 if( status != PSA_SUCCESS )
1042 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001043
Ronald Cronf2911112020-10-29 17:51:10 +01001044 /*
1045 * If the key slot containing the key description is under access by the
1046 * library (apart from the present access), the key cannot be destroyed
1047 * yet. For the time being, just return in error. Eventually (to be
1048 * implemented), the key should be destroyed when all accesses have
1049 * stopped.
1050 */
Ronald Cron5c522922020-11-14 16:35:34 +01001051 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001052 {
Ronald Cron5c522922020-11-14 16:35:34 +01001053 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001054 return( PSA_ERROR_GENERIC_ERROR );
1055 }
1056
Gilles Peskine6687cd02021-04-21 22:32:05 +02001057 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1058 {
1059 /* Refuse the destruction of a read-only key (which may or may not work
1060 * if we attempt it, depending on whether the key is merely read-only
1061 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001062 * Just do the best we can, which is to wipe the copy in memory
1063 * (done in this function's cleanup code). */
1064 overall_status = PSA_ERROR_NOT_PERMITTED;
1065 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001066 }
1067
Gilles Peskine354f7672019-07-12 23:46:38 +02001068#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001069 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001070 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001071 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001072 /* For a key in a secure element, we need to do three things:
1073 * remove the key file in internal storage, destroy the
1074 * key inside the secure element, and update the driver's
1075 * persistent data. Start a transaction that will encompass these
1076 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001077 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001078 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001079 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001080 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001081 status = psa_crypto_save_transaction( );
1082 if( status != PSA_SUCCESS )
1083 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001084 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001085 /* We should still try to destroy the key in the secure
1086 * element and the key metadata in storage. This is especially
1087 * important if the error is that the storage is full.
1088 * But how to do it exactly without risking an inconsistent
1089 * state after a reset?
1090 * https://github.com/ARMmbed/mbed-crypto/issues/215
1091 */
1092 overall_status = status;
1093 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001094 }
1095
Ronald Cronea0f8a62020-11-25 17:52:23 +01001096 status = psa_destroy_se_key( driver,
1097 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001098 if( overall_status == PSA_SUCCESS )
1099 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001100 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001101#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1102
Darryl Greend49a4992018-06-18 17:27:26 +01001103#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001104 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001105 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106 status = psa_destroy_persistent_key( slot->attr.id );
1107 if( overall_status == PSA_SUCCESS )
1108 overall_status = status;
1109
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001110 /* TODO: other slots may have a copy of the same key. We should
1111 * invalidate them.
1112 * https://github.com/ARMmbed/mbed-crypto/issues/214
1113 */
Darryl Greend49a4992018-06-18 17:27:26 +01001114 }
1115#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001116
Gilles Peskinefc762652019-07-22 19:30:34 +02001117#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1118 if( driver != NULL )
1119 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001120 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001121 if( overall_status == PSA_SUCCESS )
1122 overall_status = status;
1123 status = psa_crypto_stop_transaction( );
1124 if( overall_status == PSA_SUCCESS )
1125 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001126 }
1127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1128
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001130 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001131 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001132 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001133 overall_status = status;
1134 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001135}
1136
John Durkop07cc04a2020-11-16 22:08:34 -08001137#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001138 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001139static psa_status_t psa_get_rsa_public_exponent(
1140 const mbedtls_rsa_context *rsa,
1141 psa_key_attributes_t *attributes )
1142{
1143 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001144 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001145 uint8_t *buffer = NULL;
1146 size_t buflen;
1147 mbedtls_mpi_init( &mpi );
1148
1149 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1150 if( ret != 0 )
1151 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001152 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1153 {
1154 /* It's the default value, which is reported as an empty string,
1155 * so there's nothing to do. */
1156 goto exit;
1157 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001158
1159 buflen = mbedtls_mpi_size( &mpi );
1160 buffer = mbedtls_calloc( 1, buflen );
1161 if( buffer == NULL )
1162 {
1163 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1164 goto exit;
1165 }
1166 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1167 if( ret != 0 )
1168 goto exit;
1169 attributes->domain_parameters = buffer;
1170 attributes->domain_parameters_size = buflen;
1171
1172exit:
1173 mbedtls_mpi_free( &mpi );
1174 if( ret != 0 )
1175 mbedtls_free( buffer );
1176 return( mbedtls_to_psa_error( ret ) );
1177}
John Durkop07cc04a2020-11-16 22:08:34 -08001178#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001179 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001180
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001181/** Retrieve all the publicly-accessible attributes of a key.
1182 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001183psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001184 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001185{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001188 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001189
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001190 psa_reset_key_attributes( attributes );
1191
Ronald Cron5c522922020-11-14 16:35:34 +01001192 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001193 if( status != PSA_SUCCESS )
1194 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001195
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001196 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001197 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1198 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1199
1200#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1201 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001202 psa_set_key_slot_number( attributes,
1203 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001204#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001205
Gilles Peskine8e338702019-07-30 20:06:31 +02001206 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001207 {
John Durkop07cc04a2020-11-16 22:08:34 -08001208#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001209 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001210 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001211 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001212#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001213 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001214 * is not yet implemented.
1215 * https://github.com/ARMmbed/mbed-crypto/issues/216
1216 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001217 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001218 break;
1219#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001220 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001221 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001222
Ronald Cron90857082020-11-25 14:58:33 +01001223 status = mbedtls_psa_rsa_load_representation(
1224 slot->attr.type,
1225 slot->key.data,
1226 slot->key.bytes,
1227 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001228 if( status != PSA_SUCCESS )
1229 break;
1230
Steven Cooremana2371e52020-07-28 14:30:39 +02001231 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001232 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001233 mbedtls_rsa_free( rsa );
1234 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001237#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001238 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001239 default:
1240 /* Nothing else to do. */
1241 break;
1242 }
1243
1244 if( status != PSA_SUCCESS )
1245 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001246
Ronald Cron5c522922020-11-14 16:35:34 +01001247 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001248
Ronald Cron5c522922020-11-14 16:35:34 +01001249 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001250}
1251
Gilles Peskinec8000c02019-08-02 20:15:51 +02001252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1253psa_status_t psa_get_key_slot_number(
1254 const psa_key_attributes_t *attributes,
1255 psa_key_slot_number_t *slot_number )
1256{
1257 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1258 {
1259 *slot_number = attributes->slot_number;
1260 return( PSA_SUCCESS );
1261 }
1262 else
1263 return( PSA_ERROR_INVALID_ARGUMENT );
1264}
1265#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1266
Ronald Crond18b5f82020-11-25 16:46:05 +01001267static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1268 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001269 uint8_t *data,
1270 size_t data_size,
1271 size_t *data_length )
1272{
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001274 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001275 memcpy( data, key_buffer, key_buffer_size );
1276 memset( data + key_buffer_size, 0,
1277 data_size - key_buffer_size );
1278 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001279 return( PSA_SUCCESS );
1280}
1281
Ronald Cron7285cda2020-11-26 14:46:37 +01001282psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 const psa_key_attributes_t *attributes,
1284 const uint8_t *key_buffer, size_t key_buffer_size,
1285 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001286{
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 psa_key_type_t type = attributes->core.type;
1288
Ronald Crond18b5f82020-11-25 16:46:05 +01001289 if( key_type_is_raw_bytes( type ) ||
1290 PSA_KEY_TYPE_IS_RSA( type ) ||
1291 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001292 {
1293 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 key_buffer, key_buffer_size,
1295 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001296 }
1297 else
1298 {
1299 /* This shouldn't happen in the reference implementation, but
1300 it is valid for a special-purpose implementation to omit
1301 support for exporting certain key types. */
1302 return( PSA_ERROR_NOT_SUPPORTED );
1303 }
1304}
1305
1306psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1307 uint8_t *data,
1308 size_t data_size,
1309 size_t *data_length )
1310{
1311 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1312 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1313 psa_key_slot_t *slot;
1314
Ronald Crone907e552021-01-18 13:22:38 +01001315 /* Reject a zero-length output buffer now, since this can never be a
1316 * valid key representation. This way we know that data must be a valid
1317 * pointer and we can do things like memset(data, ..., data_size). */
1318 if( data_size == 0 )
1319 return( PSA_ERROR_BUFFER_TOO_SMALL );
1320
Ronald Cron9486f9d2020-11-26 13:36:23 +01001321 /* Set the key to empty now, so that even when there are errors, we always
1322 * set data_length to a value between 0 and data_size. On error, setting
1323 * the key to empty is a good choice because an empty key representation is
1324 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001325 *data_length = 0;
1326
Ronald Cron9486f9d2020-11-26 13:36:23 +01001327 /* Export requires the EXPORT flag. There is an exception for public keys,
1328 * which don't require any flag, but
1329 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1330 */
1331 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1332 PSA_KEY_USAGE_EXPORT, 0 );
1333 if( status != PSA_SUCCESS )
1334 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001335
Ronald Crond18b5f82020-11-25 16:46:05 +01001336 psa_key_attributes_t attributes = {
1337 .core = slot->attr
1338 };
Ronald Cron67227982020-11-26 15:16:05 +01001339 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 slot->key.data, slot->key.bytes,
1341 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342
Ronald Cron9486f9d2020-11-26 13:36:23 +01001343 unlock_status = psa_unlock_key_slot( slot );
1344
1345 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1346}
1347
Ronald Cron7285cda2020-11-26 14:46:37 +01001348psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 const psa_key_attributes_t *attributes,
1350 const uint8_t *key_buffer,
1351 size_t key_buffer_size,
1352 uint8_t *data,
1353 size_t data_size,
1354 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001359 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001360 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001361 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001362 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001363 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001364 key_buffer, key_buffer_size,
1365 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001366 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001369 {
John Durkop0e005192020-10-31 22:06:54 -07001370#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1371 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001372 return( mbedtls_psa_rsa_export_public_key( attributes,
1373 key_buffer,
1374 key_buffer_size,
1375 data,
1376 data_size,
1377 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001378#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001379 /* We don't know how to convert a private RSA key to public. */
1380 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001381#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1382 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001383 }
1384 else
Moran Pekera998bc62018-04-16 18:16:20 +03001385 {
John Durkop6ba40d12020-11-10 08:50:04 -08001386#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1387 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001388 return( mbedtls_psa_ecp_export_public_key( attributes,
1389 key_buffer,
1390 key_buffer_size,
1391 data,
1392 data_size,
1393 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001394#else
1395 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001396 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001397#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1398 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001399 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001400 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001401 else
1402 {
1403 /* This shouldn't happen in the reference implementation, but
1404 it is valid for a special-purpose implementation to omit
1405 support for exporting certain key types. */
1406 return( PSA_ERROR_NOT_SUPPORTED );
1407 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001408}
Ronald Crond18b5f82020-11-25 16:46:05 +01001409
Ronald Croncf56a0a2020-08-04 09:51:30 +02001410psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001411 uint8_t *data,
1412 size_t data_size,
1413 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001414{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001416 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001417 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001418
Ronald Crone907e552021-01-18 13:22:38 +01001419 /* Reject a zero-length output buffer now, since this can never be a
1420 * valid key representation. This way we know that data must be a valid
1421 * pointer and we can do things like memset(data, ..., data_size). */
1422 if( data_size == 0 )
1423 return( PSA_ERROR_BUFFER_TOO_SMALL );
1424
Darryl Greendd8fb772018-11-07 16:00:44 +00001425 /* Set the key to empty now, so that even when there are errors, we always
1426 * set data_length to a value between 0 and data_size. On error, setting
1427 * the key to empty is a good choice because an empty key representation is
1428 * unlikely to be accepted anywhere. */
1429 *data_length = 0;
1430
1431 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001432 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001433 if( status != PSA_SUCCESS )
1434 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001435
Ronald Cron9486f9d2020-11-26 13:36:23 +01001436 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1437 {
1438 status = PSA_ERROR_INVALID_ARGUMENT;
1439 goto exit;
1440 }
1441
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 psa_key_attributes_t attributes = {
1443 .core = slot->attr
1444 };
Ronald Cron67227982020-11-26 15:16:05 +01001445 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 &attributes, slot->key.data, slot->key.bytes,
1447 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001448
1449exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001450 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001451
Ronald Cron5c522922020-11-14 16:35:34 +01001452 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001453}
1454
Gilles Peskine91e8c332019-08-02 19:19:39 +02001455#if defined(static_assert)
1456static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1457 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001458static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001459 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001460static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001461 "One or more key attribute flag is listed as both internal-only and external-only" );
1462#endif
1463
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001464/** Validate that a key policy is internally well-formed.
1465 *
1466 * This function only rejects invalid policies. It does not validate the
1467 * consistency of the policy with respect to other attributes of the key
1468 * such as the key type.
1469 */
1470static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001471{
1472 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001473 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001474 PSA_KEY_USAGE_ENCRYPT |
1475 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001476 PSA_KEY_USAGE_SIGN_MESSAGE |
1477 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001478 PSA_KEY_USAGE_SIGN_HASH |
1479 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001480 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001481 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1482 return( PSA_ERROR_INVALID_ARGUMENT );
1483
Gilles Peskine4747d192019-04-17 15:05:45 +02001484 return( PSA_SUCCESS );
1485}
1486
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001487/** Validate the internal consistency of key attributes.
1488 *
1489 * This function only rejects invalid attribute values. If does not
1490 * validate the consistency of the attributes with any key data that may
1491 * be involved in the creation of the key.
1492 *
1493 * Call this function early in the key creation process.
1494 *
1495 * \param[in] attributes Key attributes for the new key.
1496 * \param[out] p_drv On any return, the driver for the key, if any.
1497 * NULL for a transparent key.
1498 *
1499 */
1500static psa_status_t psa_validate_key_attributes(
1501 const psa_key_attributes_t *attributes,
1502 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001503{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001504 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001505 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001506 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001507
Ronald Cron54b90082020-10-29 15:26:43 +01001508 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001509 if( status != PSA_SUCCESS )
1510 return( status );
1511
Ronald Crond2ed4812020-07-17 16:11:30 +02001512 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001513 if( status != PSA_SUCCESS )
1514 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001515
Ronald Cron65f38a32020-10-23 17:11:13 +02001516 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1517 {
1518 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1519 return( PSA_ERROR_INVALID_ARGUMENT );
1520 }
1521 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001522 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001523 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1524 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001525 }
1526
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001527 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001528 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001529 return( status );
1530
1531 /* Refuse to create overly large keys.
1532 * Note that this doesn't trigger on import if the attributes don't
1533 * explicitly specify a size (so psa_get_key_bits returns 0), so
1534 * psa_import_key() needs its own checks. */
1535 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1536 return( PSA_ERROR_NOT_SUPPORTED );
1537
Gilles Peskine91e8c332019-08-02 19:19:39 +02001538 /* Reject invalid flags. These should not be reachable through the API. */
1539 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1540 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1541 return( PSA_ERROR_INVALID_ARGUMENT );
1542
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001543 return( PSA_SUCCESS );
1544}
1545
Gilles Peskine4747d192019-04-17 15:05:45 +02001546/** Prepare a key slot to receive key material.
1547 *
1548 * This function allocates a key slot and sets its metadata.
1549 *
1550 * If this function fails, call psa_fail_key_creation().
1551 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001552 * This function is intended to be used as follows:
1553 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001554 * it with the specified attributes, and in case of a volatile key assign it
1555 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001556 * -# Populate the slot with the key material.
1557 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1558 * In case of failure at any step, stop the sequence and call
1559 * psa_fail_key_creation().
1560 *
Ronald Cron5c522922020-11-14 16:35:34 +01001561 * On success, the key slot is locked. It is the responsibility of the caller
1562 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001563 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001564 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001565 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001566 * \param[out] p_slot On success, a pointer to the prepared slot.
1567 * \param[out] p_drv On any return, the driver for the key, if any.
1568 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001569 *
1570 * \retval #PSA_SUCCESS
1571 * The key slot is ready to receive key material.
1572 * \return If this function fails, the key slot is an invalid state.
1573 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 */
1575static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001577 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001578 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001579 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001580{
1581 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001582 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 psa_key_slot_t *slot;
1584
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001586 *p_drv = NULL;
1587
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001588 status = psa_validate_key_attributes( attributes, p_drv );
1589 if( status != PSA_SUCCESS )
1590 return( status );
1591
Ronald Cronc4d1b512020-07-31 11:26:37 +02001592 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001593 if( status != PSA_SUCCESS )
1594 return( status );
1595 slot = *p_slot;
1596
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001597 /* We're storing the declared bit-size of the key. It's up to each
1598 * creation mechanism to verify that this information is correct.
1599 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001600 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001601 * is optional (import, copy). In case of a volatile key, assign it the
1602 * volatile key identifier associated to the slot returned to contain its
1603 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001604
1605 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001606 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1607 {
1608#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1609 slot->attr.id = volatile_key_id;
1610#else
1611 slot->attr.id.key_id = volatile_key_id;
1612#endif
1613 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001614
Gilles Peskine91e8c332019-08-02 19:19:39 +02001615 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001616 * external-only flags, query `attributes`. Thanks to the check
1617 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001618 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001619 * may have set. */
1620 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001621
Gilles Peskinecbaff462019-07-12 23:46:04 +02001622#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001623 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001624 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001625 * create the key file in internal storage, create the
1626 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001627 * persistent data. This is done by starting a transaction that will
1628 * encompass these three actions.
1629 * For registering a volatile key, we just need to find an appropriate
1630 * slot number inside the SE. Since the key is designated volatile, creating
1631 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001632 /* The first thing to do is to find a slot number for the new key.
1633 * We save the slot number in persistent storage as part of the
1634 * transaction data. It will be needed to recover if the power
1635 * fails during the key creation process, to clean up on the secure
1636 * element side after restarting. Obtaining a slot number from the
1637 * secure element driver updates its persistent state, but we do not yet
1638 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001639 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001640 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001641 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001642 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001643 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001644 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001645 if( status != PSA_SUCCESS )
1646 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001647
1648 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001649 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001650 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1651 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001653 psa_crypto_transaction.key.id = slot->attr.id;
1654 status = psa_crypto_save_transaction( );
1655 if( status != PSA_SUCCESS )
1656 {
1657 (void) psa_crypto_stop_transaction( );
1658 return( status );
1659 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001660 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661
1662 status = psa_copy_key_material_into_slot(
1663 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001664 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001665
1666 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1667 {
1668 /* Key registration only makes sense with a secure element. */
1669 return( PSA_ERROR_INVALID_ARGUMENT );
1670 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001671#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1672
Ronald Cronc4d1b512020-07-31 11:26:37 +02001673 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001674}
Gilles Peskine4747d192019-04-17 15:05:45 +02001675
1676/** Finalize the creation of a key once its key material has been set.
1677 *
1678 * This entails writing the key to persistent storage.
1679 *
1680 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001681 * See the documentation of psa_start_key_creation() for the intended use
1682 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001683 *
Ronald Cron5c522922020-11-14 16:35:34 +01001684 * If the finalization succeeds, the function unlocks the key slot (it was
1685 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1686 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001687 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001688 * \param[in,out] slot Pointer to the slot with key material.
1689 * \param[in] driver The secure element driver for the key,
1690 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001691 * \param[out] key On success, identifier of the key. Note that the
1692 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001693 *
1694 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001695 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001696 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1697 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1698 * \retval #PSA_ERROR_ALREADY_EXISTS
1699 * \retval #PSA_ERROR_DATA_INVALID
1700 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001701 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001702 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001703 * \return If this function fails, the key slot is an invalid state.
1704 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001705 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001706static psa_status_t psa_finish_key_creation(
1707 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001708 psa_se_drv_table_entry_t *driver,
1709 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001710{
1711 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001712 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001713 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001714
1715#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001716 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001717 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001718#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1719 if( driver != NULL )
1720 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001721 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001722 psa_key_slot_number_t slot_number =
1723 psa_key_slot_get_slot_number( slot ) ;
1724
Gilles Peskineb46bef22019-07-30 21:32:04 +02001725#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001726 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001727 sizeof( data.slot_number ),
1728 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001729#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001731 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001732 (uint8_t*) &data,
1733 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
1735 else
1736#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1737 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001738 /* Key material is saved in export representation in the slot, so
1739 * just pass the slot buffer for storage. */
1740 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 slot->key.data,
1742 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001743 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001744 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001745#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1746
Gilles Peskinecbaff462019-07-12 23:46:04 +02001747#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001748 /* Finish the transaction for a key creation. This does not
1749 * happen when registering an existing key. Detect this case
1750 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001751 * creation of a persistent key in a secure element requires a transaction,
1752 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001753 if( driver != NULL &&
1754 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001755 {
1756 status = psa_save_se_persistent_data( driver );
1757 if( status != PSA_SUCCESS )
1758 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001759 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001760 return( status );
1761 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001762 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001763 }
1764#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1765
Ronald Cron50972942020-11-14 11:28:25 +01001766 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001767 {
1768 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001769 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001770 if( status != PSA_SUCCESS )
1771 *key = MBEDTLS_SVC_KEY_ID_INIT;
1772 }
Ronald Cron50972942020-11-14 11:28:25 +01001773
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 return( status );
1775}
1776
1777/** Abort the creation of a key.
1778 *
1779 * You may call this function after calling psa_start_key_creation(),
1780 * or after psa_finish_key_creation() fails. In other circumstances, this
1781 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001782 * See the documentation of psa_start_key_creation() for the intended use
1783 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001784 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001785 * \param[in,out] slot Pointer to the slot with key material.
1786 * \param[in] driver The secure element driver for the key,
1787 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001789static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001790 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001791{
Gilles Peskine011e4282019-06-26 18:34:38 +02001792 (void) driver;
1793
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 if( slot == NULL )
1795 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001796
1797#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001798 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001799 * element, and the failure happened later (when saving metadata
1800 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001801 * element.
1802 * https://github.com/ARMmbed/mbed-crypto/issues/217
1803 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001804
Gilles Peskined7729582019-08-05 15:55:54 +02001805 /* Abort the ongoing transaction if any (there may not be one if
1806 * the creation process failed before starting one, or if the
1807 * key creation is a registration of a key in a secure element).
1808 * Earlier functions must already have done what it takes to undo any
1809 * partial creation. All that's left is to update the transaction data
1810 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001811 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001812#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1813
Gilles Peskine4747d192019-04-17 15:05:45 +02001814 psa_wipe_key_slot( slot );
1815}
1816
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817/** Validate optional attributes during key creation.
1818 *
1819 * Some key attributes are optional during key creation. If they are
1820 * specified in the attributes structure, check that they are consistent
1821 * with the data in the slot.
1822 *
1823 * This function should be called near the end of key creation, after
1824 * the slot in memory is fully populated but before saving persistent data.
1825 */
1826static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001827 const psa_key_slot_t *slot,
1828 const psa_key_attributes_t *attributes )
1829{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001830 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001831 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001832 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001833 return( PSA_ERROR_INVALID_ARGUMENT );
1834 }
1835
1836 if( attributes->domain_parameters_size != 0 )
1837 {
John Durkop0e005192020-10-31 22:06:54 -07001838#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1839 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001840 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001841 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001842 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001843 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001845
Ronald Cron90857082020-11-25 14:58:33 +01001846 psa_status_t status = mbedtls_psa_rsa_load_representation(
1847 slot->attr.type,
1848 slot->key.data,
1849 slot->key.bytes,
1850 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001851 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001852 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001853
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854 mbedtls_mpi_init( &actual );
1855 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001856 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001858 mbedtls_rsa_free( rsa );
1859 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 if( ret != 0 )
1861 goto rsa_exit;
1862 ret = mbedtls_mpi_read_binary( &required,
1863 attributes->domain_parameters,
1864 attributes->domain_parameters_size );
1865 if( ret != 0 )
1866 goto rsa_exit;
1867 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1868 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1869 rsa_exit:
1870 mbedtls_mpi_free( &actual );
1871 mbedtls_mpi_free( &required );
1872 if( ret != 0)
1873 return( mbedtls_to_psa_error( ret ) );
1874 }
1875 else
John Durkop9814fa22020-11-04 12:28:15 -08001876#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1877 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001878 {
1879 return( PSA_ERROR_INVALID_ARGUMENT );
1880 }
1881 }
1882
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001883 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001885 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001886 return( PSA_ERROR_INVALID_ARGUMENT );
1887 }
1888
1889 return( PSA_SUCCESS );
1890}
1891
Gilles Peskine4747d192019-04-17 15:05:45 +02001892psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001893 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001894 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001895 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001896{
1897 psa_status_t status;
1898 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001899 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001900 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901
Ronald Cron81709fc2020-11-14 12:10:32 +01001902 *key = MBEDTLS_SVC_KEY_ID_INIT;
1903
Gilles Peskine0f84d622019-09-12 19:03:13 +02001904 /* Reject zero-length symmetric keys (including raw data key objects).
1905 * This also rejects any key which might be encoded as an empty string,
1906 * which is never valid. */
1907 if( data_length == 0 )
1908 return( PSA_ERROR_INVALID_ARGUMENT );
1909
Gilles Peskinedf179142019-07-15 22:02:14 +02001910 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001911 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912 if( status != PSA_SUCCESS )
1913 goto exit;
1914
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001915 /* In the case of a transparent key or an opaque key stored in local
1916 * storage (thus not in the case of generating a key in a secure element
1917 * or cryptoprocessor with storage), we have to allocate a buffer to
1918 * hold the generated key material. */
1919 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001920 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001921 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001922 if( status != PSA_SUCCESS )
1923 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001924 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001925
1926 bits = slot->attr.bits;
1927 status = psa_driver_wrapper_import_key( attributes,
1928 data, data_length,
1929 slot->key.data,
1930 slot->key.bytes,
1931 &slot->key.bytes, &bits );
1932 if( status != PSA_SUCCESS )
1933 goto exit;
1934
1935 if( slot->attr.bits == 0 )
1936 slot->attr.bits = (psa_key_bits_t) bits;
1937 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001938 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001939 status = PSA_ERROR_INVALID_ARGUMENT;
1940 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001941 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001942
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001943 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001944 if( status != PSA_SUCCESS )
1945 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001948exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001949 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001950 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001951
Gilles Peskine4747d192019-04-17 15:05:45 +02001952 return( status );
1953}
1954
Gilles Peskined7729582019-08-05 15:55:54 +02001955#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1956psa_status_t mbedtls_psa_register_se_key(
1957 const psa_key_attributes_t *attributes )
1958{
1959 psa_status_t status;
1960 psa_key_slot_t *slot = NULL;
1961 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001962 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001963
1964 /* Leaving attributes unspecified is not currently supported.
1965 * It could make sense to query the key type and size from the
1966 * secure element, but not all secure elements support this
1967 * and the driver HAL doesn't currently support it. */
1968 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1969 return( PSA_ERROR_NOT_SUPPORTED );
1970 if( psa_get_key_bits( attributes ) == 0 )
1971 return( PSA_ERROR_NOT_SUPPORTED );
1972
1973 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001974 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001975 if( status != PSA_SUCCESS )
1976 goto exit;
1977
Ronald Cron81709fc2020-11-14 12:10:32 +01001978 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001979
1980exit:
1981 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001982 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001983
Gilles Peskined7729582019-08-05 15:55:54 +02001984 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001985 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001986 return( status );
1987}
1988#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1989
Gilles Peskinef603c712019-01-19 13:40:11 +01001990static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001991 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001992{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001993 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001994 source->key.data,
1995 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001996 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001997 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001998
Steven Cooreman398aee52020-10-13 14:35:45 +02001999 target->attr.type = source->attr.type;
2000 target->attr.bits = source->attr.bits;
2001
2002 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002003}
2004
Ronald Croncf56a0a2020-08-04 09:51:30 +02002005psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002006 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002007 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002008{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002010 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011 psa_key_slot_t *source_slot = NULL;
2012 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002013 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002014 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002015
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2017
Ronald Cron5c522922020-11-14 16:35:34 +01002018 status = psa_get_and_lock_transparent_key_slot_with_policy(
2019 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002020 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 goto exit;
2022
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002023 status = psa_validate_optional_attributes( source_slot,
2024 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025 if( status != PSA_SUCCESS )
2026 goto exit;
2027
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002028 status = psa_restrict_key_policy( source_slot->attr.type,
2029 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002030 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002031 if( status != PSA_SUCCESS )
2032 goto exit;
2033
Ronald Cron81709fc2020-11-14 12:10:32 +01002034 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2035 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 if( status != PSA_SUCCESS )
2037 goto exit;
2038
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002039#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2040 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002041 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002042 /* Copying to a secure element is not implemented yet. */
2043 status = PSA_ERROR_NOT_SUPPORTED;
2044 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002045 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002047
Ronald Cron6cc66312021-04-02 12:27:47 +02002048 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2049 {
2050 /*
2051 * Copying through an opaque driver is not implemented yet, consider
2052 * a lifetime with an external location as an invalid parameter for
2053 * now.
2054 */
2055 status = PSA_ERROR_INVALID_ARGUMENT;
2056 goto exit;
2057 }
2058
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002060 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002061 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002062
Ronald Cron81709fc2020-11-14 12:10:32 +01002063 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002064exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002065 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002066 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002067
Ronald Cron5c522922020-11-14 16:35:34 +01002068 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002069
Ronald Cron5c522922020-11-14 16:35:34 +01002070 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002071}
2072
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002073
2074
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002075/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002076/* Message digests */
2077/****************************************************************/
2078
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002079psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2080{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002081 /* Aborting a non-active operation is allowed */
2082 if( operation->id == 0 )
2083 return( PSA_SUCCESS );
2084
2085 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2086 operation->id = 0;
2087
2088 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002089}
2090
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002091psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002092 psa_algorithm_t alg )
2093{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002094 /* A context must be freshly initialized before it can be set up. */
2095 if( operation->id != 0 )
2096 return( PSA_ERROR_BAD_STATE );
2097
2098 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002099 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002100
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002101 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2102 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002103 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2104
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002105 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002106}
2107
2108psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2109 const uint8_t *input,
2110 size_t input_length )
2111{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002112 if( operation->id == 0 )
2113 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002114
Steven Cooremanc8288352021-03-04 14:02:19 +01002115 /* Don't require hash implementations to behave correctly on a
2116 * zero-length input, which may have an invalid pointer. */
2117 if( input_length == 0 )
2118 return( PSA_SUCCESS );
2119
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002120 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2121 input, input_length );
2122 if( status != PSA_SUCCESS )
2123 psa_hash_abort( operation );
2124
2125 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002126}
2127
2128psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2129 uint8_t *hash,
2130 size_t hash_size,
2131 size_t *hash_length )
2132{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002133 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002134 if( operation->id == 0 )
2135 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002136
Steven Cooreman1e582352021-02-18 17:24:37 +01002137 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002138 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002139 psa_hash_abort( operation );
2140 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002141}
2142
Gilles Peskine2d277862018-06-18 15:41:12 +02002143psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2144 const uint8_t *hash,
2145 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146{
2147 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2148 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002149 psa_status_t status = psa_hash_finish(
2150 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002151 actual_hash, sizeof( actual_hash ),
2152 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002153 if( status != PSA_SUCCESS )
2154 return( status );
2155 if( actual_hash_length != hash_length )
2156 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002157 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002158 return( PSA_ERROR_INVALID_SIGNATURE );
2159 return( PSA_SUCCESS );
2160}
2161
Gilles Peskine0a749c82019-11-28 19:33:58 +01002162psa_status_t psa_hash_compute( psa_algorithm_t alg,
2163 const uint8_t *input, size_t input_length,
2164 uint8_t *hash, size_t hash_size,
2165 size_t *hash_length )
2166{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002167 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002168 if( !PSA_ALG_IS_HASH( alg ) )
2169 return( PSA_ERROR_INVALID_ARGUMENT );
2170
Steven Cooreman1e582352021-02-18 17:24:37 +01002171 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2172 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002173}
2174
2175psa_status_t psa_hash_compare( psa_algorithm_t alg,
2176 const uint8_t *input, size_t input_length,
2177 const uint8_t *hash, size_t hash_length )
2178{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002179 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2180 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002181
2182 if( !PSA_ALG_IS_HASH( alg ) )
2183 return( PSA_ERROR_INVALID_ARGUMENT );
2184
Steven Cooreman1e582352021-02-18 17:24:37 +01002185 psa_status_t status = psa_driver_wrapper_hash_compute(
2186 alg, input, input_length,
2187 actual_hash, sizeof(actual_hash),
2188 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002189 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002190 return( status );
2191 if( actual_hash_length != hash_length )
2192 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002193 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002194 return( PSA_ERROR_INVALID_SIGNATURE );
2195 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002196}
2197
Gilles Peskineeb35d782019-01-22 17:56:16 +01002198psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2199 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002200{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002201 if( source_operation->id == 0 ||
2202 target_operation->id != 0 )
2203 {
2204 return( PSA_ERROR_BAD_STATE );
2205 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002206
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002207 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2208 target_operation );
2209 if( status != PSA_SUCCESS )
2210 psa_hash_abort( target_operation );
2211
2212 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002213}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214
2215
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002216/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002217/* MAC */
2218/****************************************************************/
2219
Steven Cooremane6804192021-03-19 18:28:56 +01002220psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002221{
Steven Cooremane6804192021-03-19 18:28:56 +01002222 /* Aborting a non-active operation is allowed */
2223 if( operation->id == 0 )
2224 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002225
Steven Cooremane6804192021-03-19 18:28:56 +01002226 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002227 operation->mac_size = 0;
2228 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002229 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002230
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002231 return( status );
2232}
2233
Ronald Cron2dff3b22021-06-17 16:33:22 +02002234static psa_status_t psa_mac_finalize_alg_and_key_validation(
2235 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002236 const psa_key_attributes_t *attributes,
2237 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002238{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002240 psa_key_type_t key_type = psa_get_key_type( attributes );
2241 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002242
Ronald Cron28ea0502021-06-17 16:10:24 +02002243 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002244 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002245
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002246 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002247 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002248 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002249 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002250
Steven Cooremand1a68f12021-05-10 11:13:41 +02002251 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002252 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002253
Ronald Cron79bdd822021-06-17 16:46:44 +02002254 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002255 {
2256 /* A very short MAC is too short for security since it can be
2257 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2258 * so we make this our minimum, even though 32 bits is still
2259 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002260 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002261 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002262
Ronald Cron79bdd822021-06-17 16:46:44 +02002263 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2264 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002265 {
2266 /* It's impossible to "truncate" to a larger length than the full length
2267 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002268 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002269 }
2270
Ronald Cron79bdd822021-06-17 16:46:44 +02002271 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002272}
2273
Gilles Peskinee59236f2018-01-27 23:32:46 +01002274static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2275 mbedtls_svc_key_id_t key,
2276 psa_algorithm_t alg,
2277 int is_sign )
2278{
2279 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2280 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2281 psa_key_slot_t *slot;
2282
2283 /* A context must be freshly initialized before it can be set up. */
2284 if( operation->id != 0 )
2285 return( PSA_ERROR_BAD_STATE );
2286
Gilles Peskine8c9def32018-02-08 10:02:12 +01002287 status = psa_get_and_lock_key_slot_with_policy(
2288 key,
2289 &slot,
2290 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2291 alg );
2292 if( status != PSA_SUCCESS )
2293 return( status );
2294
2295 psa_key_attributes_t attributes = {
2296 .core = slot->attr
2297 };
2298
Ronald Cron79bdd822021-06-17 16:46:44 +02002299 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2300 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002301 if( status != PSA_SUCCESS )
2302 goto exit;
2303
2304 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002305 /* Dispatch the MAC setup call with validated input */
2306 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002307 {
Steven Cooremane6804192021-03-19 18:28:56 +01002308 status = psa_driver_wrapper_mac_sign_setup( operation,
2309 &attributes,
2310 slot->key.data,
2311 slot->key.bytes,
2312 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002313 }
2314 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002315 {
Steven Cooremane6804192021-03-19 18:28:56 +01002316 status = psa_driver_wrapper_mac_verify_setup( operation,
2317 &attributes,
2318 slot->key.data,
2319 slot->key.bytes,
2320 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002321 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002322
Gilles Peskinefbfac682018-07-08 20:51:54 +02002323exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002324 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002325 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002326
Ronald Cron5c522922020-11-14 16:35:34 +01002327 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002328
Ronald Cron5c522922020-11-14 16:35:34 +01002329 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002330}
2331
Gilles Peskine89167cb2018-07-08 20:12:23 +02002332psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002333 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002334 psa_algorithm_t alg )
2335{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002336 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002337}
2338
2339psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002340 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341 psa_algorithm_t alg )
2342{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002343 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002344}
2345
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002346psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002347 const uint8_t *input,
2348 size_t input_length )
2349{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002350 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002351 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002352
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002353 /* Don't require hash implementations to behave correctly on a
2354 * zero-length input, which may have an invalid pointer. */
2355 if( input_length == 0 )
2356 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002357
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002358 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2359 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002360 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002361 psa_mac_abort( operation );
2362
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002363 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002364}
2365
Steven Cooremana5b860a2021-03-19 19:04:39 +01002366psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002367 uint8_t *mac,
2368 size_t mac_size,
2369 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002370{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2372 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002373
Steven Cooreman72f736a2021-05-07 14:14:37 +02002374 /* Set the output length and content to a safe default, such that in
2375 * case the caller misses an error check, the output would be an
2376 * unachievable MAC. */
2377 *mac_length = mac_size;
2378
Steven Cooremana5b860a2021-03-19 19:04:39 +01002379 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002380 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002381
Steven Cooreman72f736a2021-05-07 14:14:37 +02002382 if( ! operation->is_sign )
2383 return( PSA_ERROR_BAD_STATE );
2384
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002385 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2386 * once all the error checks are done. */
2387 if( operation->mac_size == 0 )
2388 return( PSA_ERROR_BAD_STATE );
2389
2390 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002391 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002392
Steven Cooremana5b860a2021-03-19 19:04:39 +01002393 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002394 mac, operation->mac_size,
2395 mac_length );
2396
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002397 /* In case of success, set the potential excess room in the output buffer
2398 * to an invalid value, to avoid potentially leaking a longer MAC.
2399 * In case of error, set the output length and content to a safe default,
2400 * such that in case the caller misses an error check, the output would be
2401 * an unachievable MAC.
2402 */
2403 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002404 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002405 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002406 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002407 }
mohammad16036df908f2018-04-02 08:34:15 -07002408
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002409 if( mac_size > operation->mac_size )
2410 memset( &mac[operation->mac_size], '!',
2411 mac_size - operation->mac_size );
2412
Steven Cooremana5b860a2021-03-19 19:04:39 +01002413 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002414
Steven Cooremana5b860a2021-03-19 19:04:39 +01002415 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002416}
2417
Steven Cooremana5b860a2021-03-19 19:04:39 +01002418psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002419 const uint8_t *mac,
2420 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002421{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2423 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002424
Steven Cooremana5b860a2021-03-19 19:04:39 +01002425 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002426 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002427
Steven Cooreman72f736a2021-05-07 14:14:37 +02002428 if( operation->is_sign )
2429 return( PSA_ERROR_BAD_STATE );
2430
2431 if( operation->mac_size != mac_length )
2432 {
2433 status = PSA_ERROR_INVALID_SIGNATURE;
2434 goto cleanup;
2435 }
2436
Steven Cooremana5b860a2021-03-19 19:04:39 +01002437 status = psa_driver_wrapper_mac_verify_finish( operation,
2438 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002439
2440cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002441 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002442
Steven Cooremana5b860a2021-03-19 19:04:39 +01002443 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002444}
2445
Ronald Croncd989b52021-06-18 14:23:33 +02002446static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2447 psa_algorithm_t alg,
2448 const uint8_t *input,
2449 size_t input_length,
2450 uint8_t *mac,
2451 size_t mac_size,
2452 size_t *mac_length,
2453 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002454{
2455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002456 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2457 psa_key_slot_t *slot;
2458 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002459
Ronald Cron51131b52021-06-17 17:17:20 +02002460 status = psa_get_and_lock_key_slot_with_policy(
Ronald Croncd989b52021-06-18 14:23:33 +02002461 key, &slot,
2462 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2463 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002464 if( status != PSA_SUCCESS )
2465 goto exit;
2466
Ronald Cron51131b52021-06-17 17:17:20 +02002467 psa_key_attributes_t attributes = {
2468 .core = slot->attr
2469 };
2470
2471 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2472 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002473 if( status != PSA_SUCCESS )
2474 goto exit;
2475
Ronald Cron51131b52021-06-17 17:17:20 +02002476 if( mac_size < operation_mac_size )
2477 {
2478 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002479 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002480 }
2481
2482 status = psa_driver_wrapper_mac_compute(
2483 &attributes,
2484 slot->key.data, slot->key.bytes,
2485 alg,
2486 input, input_length,
2487 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002488
2489exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002490 /* In case of success, set the potential excess room in the output buffer
2491 * to an invalid value, to avoid potentially leaking a longer MAC.
2492 * In case of error, set the output length and content to a safe default,
2493 * such that in case the caller misses an error check, the output would be
2494 * an unachievable MAC.
2495 */
2496 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002497 {
Ronald Cron51131b52021-06-17 17:17:20 +02002498 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002499 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002500 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002501 if( mac_size > operation_mac_size )
2502 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002503
Ronald Cron51131b52021-06-17 17:17:20 +02002504 unlock_status = psa_unlock_key_slot( slot );
2505
2506 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002507}
2508
Ronald Croncd989b52021-06-18 14:23:33 +02002509psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2510 psa_algorithm_t alg,
2511 const uint8_t *input,
2512 size_t input_length,
2513 uint8_t *mac,
2514 size_t mac_size,
2515 size_t *mac_length)
2516{
2517 return( psa_mac_compute_internal( key, alg,
2518 input, input_length,
2519 mac, mac_size, mac_length, 1 ) );
2520}
2521
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002522psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2523 psa_algorithm_t alg,
2524 const uint8_t *input,
2525 size_t input_length,
2526 const uint8_t *mac,
2527 size_t mac_length)
2528{
2529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002530 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2531 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002532
Ronald Crona587cbc2021-06-18 14:51:29 +02002533 status = psa_mac_compute_internal( key, alg,
2534 input, input_length,
2535 actual_mac, sizeof( actual_mac ),
2536 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002537 if( status != PSA_SUCCESS )
2538 goto exit;
2539
Ronald Crona587cbc2021-06-18 14:51:29 +02002540 if( mac_length != actual_mac_length )
2541 {
2542 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002543 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002544 }
2545 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2546 {
2547 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002548 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002549 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002550
2551exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002552 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002553
2554 return ( status );
2555}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002556
Gilles Peskinee59236f2018-01-27 23:32:46 +01002557/****************************************************************/
2558/* Asymmetric cryptography */
2559/****************************************************************/
2560
gabor-mezei-armf0486182021-05-12 11:03:09 +02002561static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002562 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002563{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002564 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002565 {
2566 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2567 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002568
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002569 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2570 {
2571 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2572 return( PSA_ERROR_INVALID_ARGUMENT );
2573 }
2574 }
2575 else
2576 {
2577 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2578 return( PSA_ERROR_INVALID_ARGUMENT );
2579 }
2580
2581 return( PSA_SUCCESS );
2582}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002583
2584static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002585 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002586 psa_algorithm_t alg,
2587 const uint8_t * input,
2588 size_t input_length,
2589 uint8_t * signature,
2590 size_t signature_size,
2591 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002592{
2593 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2594 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2595 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002596
2597 *signature_length = 0;
2598
gabor-mezei-armf0486182021-05-12 11:03:09 +02002599 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002600 if( status != PSA_SUCCESS )
2601 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002602
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002603 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002604 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002605 * buffer can in principle be empty since it doesn't actually have
2606 * to be a hash.) */
2607 if( signature_size == 0 )
2608 return( PSA_ERROR_BUFFER_TOO_SMALL );
2609
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002610 status = psa_get_and_lock_key_slot_with_policy(
2611 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002612 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2613 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002614 alg );
2615
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002616 if( status != PSA_SUCCESS )
2617 goto exit;
2618
2619 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2620 {
2621 status = PSA_ERROR_INVALID_ARGUMENT;
2622 goto exit;
2623 }
2624
2625 psa_key_attributes_t attributes = {
2626 .core = slot->attr
2627 };
2628
gabor-mezei-armf0486182021-05-12 11:03:09 +02002629 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002630 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002631 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002632 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002633 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002634 signature, signature_size, signature_length );
2635 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002636 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002637 {
2638
2639 status = psa_driver_wrapper_sign_hash(
2640 &attributes, slot->key.data, slot->key.bytes,
2641 alg, input, input_length,
2642 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002643 }
2644
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002645
2646exit:
2647 /* Fill the unused part of the output buffer (the whole buffer on error,
2648 * the trailing part on success) with something that isn't a valid signature
2649 * (barring an attack on the signature and deliberately-crafted input),
2650 * in case the caller doesn't check the return status properly. */
2651 if( status == PSA_SUCCESS )
2652 memset( signature + *signature_length, '!',
2653 signature_size - *signature_length );
2654 else
2655 memset( signature, '!', signature_size );
2656 /* If signature_size is 0 then we have nothing to do. We must not call
2657 * memset because signature may be NULL in this case. */
2658
2659 unlock_status = psa_unlock_key_slot( slot );
2660
2661 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2662}
2663
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002664static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002665 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666 psa_algorithm_t alg,
2667 const uint8_t * input,
2668 size_t input_length,
2669 const uint8_t * signature,
2670 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002671{
2672 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2673 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2674 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002675
gabor-mezei-armf0486182021-05-12 11:03:09 +02002676 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002677 if( status != PSA_SUCCESS )
2678 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002679
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002680 status = psa_get_and_lock_key_slot_with_policy(
2681 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002682 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2683 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002684 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002685
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002686 if( status != PSA_SUCCESS )
2687 return( status );
2688
2689 psa_key_attributes_t attributes = {
2690 .core = slot->attr
2691 };
2692
gabor-mezei-armf0486182021-05-12 11:03:09 +02002693 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002694 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002695 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002696 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002697 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002698 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002699 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002700 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002701 {
2702 status = psa_driver_wrapper_verify_hash(
2703 &attributes, slot->key.data, slot->key.bytes,
2704 alg, input, input_length,
2705 signature, signature_length );
2706 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002707
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002708 unlock_status = psa_unlock_key_slot( slot );
2709
2710 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002711
2712}
2713
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002714psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002715 const psa_key_attributes_t *attributes,
2716 const uint8_t *key_buffer,
2717 size_t key_buffer_size,
2718 psa_algorithm_t alg,
2719 const uint8_t *input,
2720 size_t input_length,
2721 uint8_t *signature,
2722 size_t signature_size,
2723 size_t *signature_length )
2724{
2725 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002726
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002727 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2728 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002729 size_t hash_length;
2730 uint8_t hash[PSA_HASH_MAX_SIZE];
2731
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002732 status = psa_driver_wrapper_hash_compute(
2733 PSA_ALG_SIGN_GET_HASH( alg ),
2734 input, input_length,
2735 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002736
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002737 if( status != PSA_SUCCESS )
2738 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002739
2740 return psa_driver_wrapper_sign_hash(
2741 attributes, key_buffer, key_buffer_size,
2742 alg, hash, hash_length,
2743 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002744 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002745
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002746 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002747}
2748
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002749psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2750 psa_algorithm_t alg,
2751 const uint8_t * input,
2752 size_t input_length,
2753 uint8_t * signature,
2754 size_t signature_size,
2755 size_t * signature_length )
2756{
2757 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002758 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759 signature, signature_size, signature_length );
2760}
2761
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002762psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002763 const psa_key_attributes_t *attributes,
2764 const uint8_t *key_buffer,
2765 size_t key_buffer_size,
2766 psa_algorithm_t alg,
2767 const uint8_t *input,
2768 size_t input_length,
2769 const uint8_t *signature,
2770 size_t signature_length )
2771{
2772 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002773
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002774 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2775 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002776 size_t hash_length;
2777 uint8_t hash[PSA_HASH_MAX_SIZE];
2778
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002779 status = psa_driver_wrapper_hash_compute(
2780 PSA_ALG_SIGN_GET_HASH( alg ),
2781 input, input_length,
2782 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002783
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002784 if( status != PSA_SUCCESS )
2785 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002786
2787 return psa_driver_wrapper_verify_hash(
2788 attributes, key_buffer, key_buffer_size,
2789 alg, hash, hash_length,
2790 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002791 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002792
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002793 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002794}
2795
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002796psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2797 psa_algorithm_t alg,
2798 const uint8_t * input,
2799 size_t input_length,
2800 const uint8_t * signature,
2801 size_t signature_length )
2802{
2803 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002804 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002805 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002806}
2807
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002808psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002809 const psa_key_attributes_t *attributes,
2810 const uint8_t *key_buffer, size_t key_buffer_size,
2811 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2812 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002813{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002814 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002815 {
Ronald Cron4501c982021-03-19 20:09:32 +01002816 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2817 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002818 {
Ronald Cron4501c982021-03-19 20:09:32 +01002819#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2820 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2821 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002822 attributes,
2823 key_buffer, key_buffer_size,
2824 alg, hash, hash_length,
2825 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002826#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2827 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002828 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002829 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002830 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002831 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002832 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002833 }
2834 else
Ronald Cron4501c982021-03-19 20:09:32 +01002835 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2836 {
2837 if( PSA_ALG_IS_ECDSA( alg ) )
2838 {
2839#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2840 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2841 return( mbedtls_psa_ecdsa_sign_hash(
2842 attributes,
2843 key_buffer, key_buffer_size,
2844 alg, hash, hash_length,
2845 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002846#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2847 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002848 }
2849 else
2850 {
2851 return( PSA_ERROR_INVALID_ARGUMENT );
2852 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002853 }
Ronald Cron4501c982021-03-19 20:09:32 +01002854
2855 (void)key_buffer;
2856 (void)key_buffer_size;
2857 (void)hash;
2858 (void)hash_length;
2859 (void)signature;
2860 (void)signature_size;
2861 (void)signature_length;
2862
2863 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002864}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002865
2866psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2867 psa_algorithm_t alg,
2868 const uint8_t *hash,
2869 size_t hash_length,
2870 uint8_t *signature,
2871 size_t signature_size,
2872 size_t *signature_length )
2873{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002874 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002875 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002876 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002877}
2878
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002879psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002880 const psa_key_attributes_t *attributes,
2881 const uint8_t *key_buffer, size_t key_buffer_size,
2882 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2883 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002884{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002885 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002886 {
Ronald Cron4501c982021-03-19 20:09:32 +01002887 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2888 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002889 {
Ronald Cron4501c982021-03-19 20:09:32 +01002890#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2891 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2892 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002893 attributes,
2894 key_buffer, key_buffer_size,
2895 alg, hash, hash_length,
2896 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002897#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2898 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002899 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002900 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002901 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002902 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002903 }
itayzafrir5c753392018-05-08 11:18:38 +03002904 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002905 else
Ronald Cron4501c982021-03-19 20:09:32 +01002906 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002907 {
Ronald Cron4501c982021-03-19 20:09:32 +01002908 if( PSA_ALG_IS_ECDSA( alg ) )
2909 {
2910#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2911 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2912 return( mbedtls_psa_ecdsa_verify_hash(
2913 attributes,
2914 key_buffer, key_buffer_size,
2915 alg, hash, hash_length,
2916 signature, signature_length ) );
2917#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2918 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2919 }
2920 else
2921 {
2922 return( PSA_ERROR_INVALID_ARGUMENT );
2923 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002924 }
Ronald Cron4501c982021-03-19 20:09:32 +01002925
2926 (void)key_buffer;
2927 (void)key_buffer_size;
2928 (void)hash;
2929 (void)hash_length;
2930 (void)signature;
2931 (void)signature_length;
2932
2933 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002934}
2935
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002936psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2937 psa_algorithm_t alg,
2938 const uint8_t *hash,
2939 size_t hash_length,
2940 const uint8_t *signature,
2941 size_t signature_length )
2942{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002943 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002944 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002945 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002946}
2947
John Durkop0e005192020-10-31 22:06:54 -07002948#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002949static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2950 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002951{
2952 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2953 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2954 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002955
2956 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002957}
John Durkop0e005192020-10-31 22:06:54 -07002958#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002959
Ronald Croncf56a0a2020-08-04 09:51:30 +02002960psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002961 psa_algorithm_t alg,
2962 const uint8_t *input,
2963 size_t input_length,
2964 const uint8_t *salt,
2965 size_t salt_length,
2966 uint8_t *output,
2967 size_t output_size,
2968 size_t *output_length )
2969{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002970 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002971 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002972 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002973
Darryl Green5cc689a2018-07-24 15:34:10 +01002974 (void) input;
2975 (void) input_length;
2976 (void) salt;
2977 (void) output;
2978 (void) output_size;
2979
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002980 *output_length = 0;
2981
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002982 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2983 return( PSA_ERROR_INVALID_ARGUMENT );
2984
Ronald Cron5c522922020-11-14 16:35:34 +01002985 status = psa_get_and_lock_transparent_key_slot_with_policy(
2986 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002987 if( status != PSA_SUCCESS )
2988 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002989 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2990 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002991 {
2992 status = PSA_ERROR_INVALID_ARGUMENT;
2993 goto exit;
2994 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002995
John Durkop6ba40d12020-11-10 08:50:04 -08002996#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2997 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002998 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002999 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003000 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003001 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3002 slot->key.data,
3003 slot->key.bytes,
3004 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003005 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003006 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003007
3008 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003009 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003010 status = PSA_ERROR_BUFFER_TOO_SMALL;
3011 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003012 }
John Durkop0e005192020-10-31 22:06:54 -07003013#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003014 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3015 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003016 status = mbedtls_to_psa_error(
3017 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003018 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003019 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003020 input_length,
3021 input,
3022 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003023 }
3024 else
John Durkop0e005192020-10-31 22:06:54 -07003025#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3026#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003027 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3028 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003029 status = mbedtls_to_psa_error(
3030 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3031 if( status != PSA_SUCCESS )
3032 goto rsa_exit;
3033
Steven Cooreman4fed4552020-08-03 14:46:03 +02003034 status = mbedtls_to_psa_error(
3035 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003036 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003037 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003038 salt, salt_length,
3039 input_length,
3040 input,
3041 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003042 }
3043 else
John Durkop0e005192020-10-31 22:06:54 -07003044#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003045 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003046 status = PSA_ERROR_INVALID_ARGUMENT;
3047 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003048 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003049rsa_exit:
3050 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003051 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003052
Steven Cooremana2371e52020-07-28 14:30:39 +02003053 mbedtls_rsa_free( rsa );
3054 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003055 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056 else
John Durkop9814fa22020-11-04 12:28:15 -08003057#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003058 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003059 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003060 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003061 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003062
3063exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003064 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003065
Ronald Cron5c522922020-11-14 16:35:34 +01003066 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003067}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003068
Ronald Croncf56a0a2020-08-04 09:51:30 +02003069psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003070 psa_algorithm_t alg,
3071 const uint8_t *input,
3072 size_t input_length,
3073 const uint8_t *salt,
3074 size_t salt_length,
3075 uint8_t *output,
3076 size_t output_size,
3077 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003078{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003080 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003081 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003082
Darryl Green5cc689a2018-07-24 15:34:10 +01003083 (void) input;
3084 (void) input_length;
3085 (void) salt;
3086 (void) output;
3087 (void) output_size;
3088
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003089 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003090
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003091 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3092 return( PSA_ERROR_INVALID_ARGUMENT );
3093
Ronald Cron5c522922020-11-14 16:35:34 +01003094 status = psa_get_and_lock_transparent_key_slot_with_policy(
3095 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003096 if( status != PSA_SUCCESS )
3097 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003098 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003099 {
3100 status = PSA_ERROR_INVALID_ARGUMENT;
3101 goto exit;
3102 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003103
John Durkop6ba40d12020-11-10 08:50:04 -08003104#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3105 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003106 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003107 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003108 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003109 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3110 slot->key.data,
3111 slot->key.bytes,
3112 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003113 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115
Steven Cooremana2371e52020-07-28 14:30:39 +02003116 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003117 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003118 status = PSA_ERROR_INVALID_ARGUMENT;
3119 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003120 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121
John Durkop0e005192020-10-31 22:06:54 -07003122#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003123 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003125 status = mbedtls_to_psa_error(
3126 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003127 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003128 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003129 output_length,
3130 input,
3131 output,
3132 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003133 }
3134 else
John Durkop0e005192020-10-31 22:06:54 -07003135#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3136#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003137 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003138 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003139 status = mbedtls_to_psa_error(
3140 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3141 if( status != PSA_SUCCESS )
3142 goto rsa_exit;
3143
Steven Cooreman4fed4552020-08-03 14:46:03 +02003144 status = mbedtls_to_psa_error(
3145 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003146 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003147 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003148 salt, salt_length,
3149 output_length,
3150 input,
3151 output,
3152 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003153 }
3154 else
John Durkop0e005192020-10-31 22:06:54 -07003155#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003157 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003158 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003159
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003161 mbedtls_rsa_free( rsa );
3162 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003163 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003164 else
John Durkop6ba40d12020-11-10 08:50:04 -08003165#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3166 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003167 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003168 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003169 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003170
3171exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003172 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003173
Ronald Cron5c522922020-11-14 16:35:34 +01003174 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003175}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003176
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003177
3178
mohammad1603503973b2018-03-12 15:59:30 +02003179/****************************************************************/
3180/* Symmetric cryptography */
3181/****************************************************************/
3182
Ronald Cronab99ac22020-10-01 16:38:28 +02003183static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3184 mbedtls_svc_key_id_t key,
3185 psa_algorithm_t alg,
3186 mbedtls_operation_t cipher_operation )
3187{
3188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3189 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3190 psa_key_slot_t *slot;
3191 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3192 PSA_KEY_USAGE_ENCRYPT :
3193 PSA_KEY_USAGE_DECRYPT );
3194
3195 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003196 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003197 return( PSA_ERROR_BAD_STATE );
3198
3199 /* The requested algorithm must be one that can be processed by cipher. */
3200 if( ! PSA_ALG_IS_CIPHER( alg ) )
3201 return( PSA_ERROR_INVALID_ARGUMENT );
3202
3203 /* Fetch key material from key storage. */
3204 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3205 if( status != PSA_SUCCESS )
3206 goto exit;
3207
Ronald Cron49fafa92021-03-10 08:34:23 +01003208 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003209 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003210 * so we only set it (in the driver wrapper) after resources have been
3211 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003212 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003213 if( alg == PSA_ALG_ECB_NO_PADDING )
3214 operation->iv_required = 0;
3215 else
3216 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003217 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003218
Ronald Crona4af55f2020-12-14 14:36:06 +01003219 psa_key_attributes_t attributes = {
3220 .core = slot->attr
3221 };
3222
Ronald Cronab99ac22020-10-01 16:38:28 +02003223 /* Try doing the operation through a driver before using software fallback. */
3224 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003225 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3226 &attributes,
3227 slot->key.data,
3228 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003229 alg );
3230 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003231 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3232 &attributes,
3233 slot->key.data,
3234 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003235 alg );
3236
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003237exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003238 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003239 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003240
Ronald Cron5c522922020-11-14 16:35:34 +01003241 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003242
Ronald Cron5c522922020-11-14 16:35:34 +01003243 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003244}
3245
Gilles Peskinefe119512018-07-08 21:39:34 +02003246psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003247 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003248 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003249{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003250 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003251}
3252
Gilles Peskinefe119512018-07-08 21:39:34 +02003253psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003254 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003255 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003256{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003257 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003258}
3259
Gilles Peskinefe119512018-07-08 21:39:34 +02003260psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003261 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003262 size_t iv_size,
3263 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003264{
Ronald Cron6d051732020-10-01 14:10:20 +02003265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003266
Ronald Cron5618a392021-03-26 09:52:26 +01003267 *iv_length = 0;
3268
Ronald Cron49fafa92021-03-10 08:34:23 +01003269 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003270 {
3271 return( PSA_ERROR_BAD_STATE );
3272 }
3273
Steven Cooreman7df02922020-09-09 15:28:49 +02003274 if( operation->iv_set || ! operation->iv_required )
3275 {
3276 return( PSA_ERROR_BAD_STATE );
3277 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003278
Ronald Cron5618a392021-03-26 09:52:26 +01003279 if( iv_size < operation->default_iv_length )
3280 {
3281 status = PSA_ERROR_BUFFER_TOO_SMALL;
3282 goto exit;
3283 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003284
Ronald Cron5618a392021-03-26 09:52:26 +01003285 status = psa_generate_random( iv, operation->default_iv_length );
3286 if( status != PSA_SUCCESS )
3287 goto exit;
3288
3289 status = psa_driver_wrapper_cipher_set_iv( operation,
3290 iv,
3291 operation->default_iv_length );
3292
3293exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003294 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003295 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003296 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003297 *iv_length = operation->default_iv_length;
3298 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003299 else
Moran Peker395db872018-05-31 14:07:14 +03003300 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003301
itayzafrir534bd7c2018-08-02 13:56:32 +03003302 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003303}
3304
Gilles Peskinefe119512018-07-08 21:39:34 +02003305psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003306 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003307 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003308{
Ronald Cron6d051732020-10-01 14:10:20 +02003309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003310
Ronald Cron49fafa92021-03-10 08:34:23 +01003311 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003312 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003313
Steven Cooreman7df02922020-09-09 15:28:49 +02003314 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003315 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003316
3317 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3318 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003319
Ronald Crondd24c9b2020-12-15 14:10:01 +01003320 status = psa_driver_wrapper_cipher_set_iv( operation,
3321 iv,
3322 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003323
itayzafrir534bd7c2018-08-02 13:56:32 +03003324 if( status == PSA_SUCCESS )
3325 operation->iv_set = 1;
3326 else
mohammad1603503973b2018-03-12 15:59:30 +02003327 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003328 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003329}
3330
Gilles Peskinee553c652018-06-04 16:22:46 +02003331psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3332 const uint8_t *input,
3333 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003334 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003335 size_t output_size,
3336 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003337{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003339
Ronald Cron49fafa92021-03-10 08:34:23 +01003340 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003341 {
3342 return( PSA_ERROR_BAD_STATE );
3343 }
3344 if( operation->iv_required && ! operation->iv_set )
3345 {
3346 return( PSA_ERROR_BAD_STATE );
3347 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003348
Ronald Crondd24c9b2020-12-15 14:10:01 +01003349 status = psa_driver_wrapper_cipher_update( operation,
3350 input,
3351 input_length,
3352 output,
3353 output_size,
3354 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003355 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003356 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003357
itayzafrir534bd7c2018-08-02 13:56:32 +03003358 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003359}
3360
Gilles Peskinee553c652018-06-04 16:22:46 +02003361psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3362 uint8_t *output,
3363 size_t output_size,
3364 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003365{
David Saadab4ecc272019-02-14 13:48:10 +02003366 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003367
Ronald Cron49fafa92021-03-10 08:34:23 +01003368 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003369 {
3370 return( PSA_ERROR_BAD_STATE );
3371 }
3372 if( operation->iv_required && ! operation->iv_set )
3373 {
3374 return( PSA_ERROR_BAD_STATE );
3375 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003376
Ronald Crondd24c9b2020-12-15 14:10:01 +01003377 status = psa_driver_wrapper_cipher_finish( operation,
3378 output,
3379 output_size,
3380 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003381 if( status == PSA_SUCCESS )
3382 return( psa_cipher_abort( operation ) );
3383 else
3384 {
3385 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003386 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003387
Steven Cooremanef8575e2020-09-11 11:44:50 +02003388 return( status );
3389 }
mohammad1603503973b2018-03-12 15:59:30 +02003390}
3391
Gilles Peskinee553c652018-06-04 16:22:46 +02003392psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3393{
Ronald Cron49fafa92021-03-10 08:34:23 +01003394 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003395 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003396 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003397 * in use. It's ok to call abort on such an object, and there's
3398 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003399 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003400 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003401
Ronald Crondd24c9b2020-12-15 14:10:01 +01003402 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003403
Ronald Cron49fafa92021-03-10 08:34:23 +01003404 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003405 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003406 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003407
Moran Peker395db872018-05-31 14:07:14 +03003408 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003409}
3410
mohammad16035955c982018-04-26 00:53:03 +03003411/****************************************************************/
3412/* AEAD */
3413/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003414
Ronald Croncf56a0a2020-08-04 09:51:30 +02003415psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003416 psa_algorithm_t alg,
3417 const uint8_t *nonce,
3418 size_t nonce_length,
3419 const uint8_t *additional_data,
3420 size_t additional_data_length,
3421 const uint8_t *plaintext,
3422 size_t plaintext_length,
3423 uint8_t *ciphertext,
3424 size_t ciphertext_size,
3425 size_t *ciphertext_length )
3426{
Ronald Cron215633c2021-03-16 17:15:37 +01003427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3428 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003429
mohammad1603f08a5502018-06-03 15:05:47 +03003430 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003431
Steven Cooremanea7ab132021-03-17 16:28:00 +01003432 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3433 return( PSA_ERROR_NOT_SUPPORTED );
3434
Ronald Cron9a986162021-03-26 12:40:07 +01003435 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003436 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003437 if( status != PSA_SUCCESS )
3438 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003439
Ronald Cron215633c2021-03-16 17:15:37 +01003440 psa_key_attributes_t attributes = {
3441 .core = slot->attr
3442 };
mohammad16035955c982018-04-26 00:53:03 +03003443
Ronald Cronde822812021-03-17 16:08:20 +01003444 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003445 &attributes, slot->key.data, slot->key.bytes,
3446 alg,
3447 nonce, nonce_length,
3448 additional_data, additional_data_length,
3449 plaintext, plaintext_length,
3450 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003451
Gilles Peskineedf9a652018-08-17 18:11:56 +02003452 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3453 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003454
Ronald Cron9f310172021-03-16 16:36:37 +01003455 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003456
mohammad16035955c982018-04-26 00:53:03 +03003457 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003458}
3459
Ronald Croncf56a0a2020-08-04 09:51:30 +02003460psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003461 psa_algorithm_t alg,
3462 const uint8_t *nonce,
3463 size_t nonce_length,
3464 const uint8_t *additional_data,
3465 size_t additional_data_length,
3466 const uint8_t *ciphertext,
3467 size_t ciphertext_length,
3468 uint8_t *plaintext,
3469 size_t plaintext_size,
3470 size_t *plaintext_length )
3471{
Ronald Cron215633c2021-03-16 17:15:37 +01003472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3473 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003474
Gilles Peskineee652a32018-06-01 19:23:52 +02003475 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003476
Steven Cooremanea7ab132021-03-17 16:28:00 +01003477 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3478 return( PSA_ERROR_NOT_SUPPORTED );
3479
Ronald Cron9a986162021-03-26 12:40:07 +01003480 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003481 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003482 if( status != PSA_SUCCESS )
3483 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003484
Ronald Cron215633c2021-03-16 17:15:37 +01003485 psa_key_attributes_t attributes = {
3486 .core = slot->attr
3487 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003488
Ronald Cronde822812021-03-17 16:08:20 +01003489 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003490 &attributes, slot->key.data, slot->key.bytes,
3491 alg,
3492 nonce, nonce_length,
3493 additional_data, additional_data_length,
3494 ciphertext, ciphertext_length,
3495 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003496
Gilles Peskineedf9a652018-08-17 18:11:56 +02003497 if( status != PSA_SUCCESS && plaintext_size != 0 )
3498 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003499
Ronald Cron215633c2021-03-16 17:15:37 +01003500 psa_unlock_key_slot( slot );
3501
Gilles Peskineedf9a652018-08-17 18:11:56 +02003502 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003503}
3504
Gilles Peskinee59236f2018-01-27 23:32:46 +01003505/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003506/* Generators */
3507/****************************************************************/
3508
John Durkop07cc04a2020-11-16 22:08:34 -08003509#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3510 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3511 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3512#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003513#endif /* At least one builtin KDF */
3514
3515#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3516 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3517 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3518static psa_status_t psa_key_derivation_start_hmac(
3519 psa_mac_operation_t *operation,
3520 psa_algorithm_t hash_alg,
3521 const uint8_t *hmac_key,
3522 size_t hmac_key_length )
3523{
3524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3525 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3526 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3527 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3528 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3529
Steven Cooreman72f736a2021-05-07 14:14:37 +02003530 operation->is_sign = 1;
3531 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3532
Steven Cooreman094a77e2021-05-06 17:58:36 +02003533 status = psa_driver_wrapper_mac_sign_setup( operation,
3534 &attributes,
3535 hmac_key, hmac_key_length,
3536 PSA_ALG_HMAC( hash_alg ) );
3537
3538 psa_reset_key_attributes( &attributes );
3539 return( status );
3540}
3541#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003542
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003543#define HKDF_STATE_INIT 0 /* no input yet */
3544#define HKDF_STATE_STARTED 1 /* got salt */
3545#define HKDF_STATE_KEYED 2 /* got key */
3546#define HKDF_STATE_OUTPUT 3 /* output started */
3547
Gilles Peskinecbe66502019-05-16 16:59:18 +02003548static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003549 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003550{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003551 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3552 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003553 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003554 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003555}
3556
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003557psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003558{
3559 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003560 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003561 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003562 {
3563 /* The object has (apparently) been initialized but it is not
3564 * in use. It's ok to call abort on such an object, and there's
3565 * nothing to do. */
3566 }
3567 else
John Durkopd0321952020-10-29 21:37:36 -07003568#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003569 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003570 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003571 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003572 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003573 }
John Durkop07cc04a2020-11-16 22:08:34 -08003574 else
3575#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3576#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3577 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3578 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003579 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003580 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003581 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003582 if( operation->ctx.tls12_prf.secret != NULL )
3583 {
3584 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3585 operation->ctx.tls12_prf.secret_length );
3586 mbedtls_free( operation->ctx.tls12_prf.secret );
3587 }
3588
Janos Follath6a1d2622019-06-11 10:37:28 +01003589 if( operation->ctx.tls12_prf.seed != NULL )
3590 {
3591 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3592 operation->ctx.tls12_prf.seed_length );
3593 mbedtls_free( operation->ctx.tls12_prf.seed );
3594 }
3595
3596 if( operation->ctx.tls12_prf.label != NULL )
3597 {
3598 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3599 operation->ctx.tls12_prf.label_length );
3600 mbedtls_free( operation->ctx.tls12_prf.label );
3601 }
3602
Steven Cooremana6df6042021-04-29 19:32:25 +02003603 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003604
3605 /* We leave the fields Ai and output_block to be erased safely by the
3606 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003607 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003608 else
John Durkop07cc04a2020-11-16 22:08:34 -08003609#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3610 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003611 {
3612 status = PSA_ERROR_BAD_STATE;
3613 }
Janos Follath083036a2019-06-11 10:22:26 +01003614 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003615 return( status );
3616}
3617
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003618psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003619 size_t *capacity)
3620{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003621 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003622 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003623 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003624 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003625 }
3626
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003627 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003628 return( PSA_SUCCESS );
3629}
3630
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003631psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003632 size_t capacity )
3633{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003634 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003635 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003636 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003637 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003638 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003639 return( PSA_SUCCESS );
3640}
3641
John Durkopd0321952020-10-29 21:37:36 -07003642#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003643/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003644 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003645static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003646 psa_algorithm_t hash_alg,
3647 uint8_t *output,
3648 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003649{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003650 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003651 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003652 psa_status_t status;
3653
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003654 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3655 return( PSA_ERROR_BAD_STATE );
3656 hkdf->state = HKDF_STATE_OUTPUT;
3657
Gilles Peskinebef7f142018-07-12 17:22:21 +02003658 while( output_length != 0 )
3659 {
3660 /* Copy what remains of the current block */
3661 uint8_t n = hash_length - hkdf->offset_in_block;
3662 if( n > output_length )
3663 n = (uint8_t) output_length;
3664 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3665 output += n;
3666 output_length -= n;
3667 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003668 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003669 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003670 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003671 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003672 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003673 * object was corrupted or if this function is called directly
3674 * inside the library. */
3675 if( hkdf->block_number == 0xff )
3676 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003677
3678 /* We need a new block */
3679 ++hkdf->block_number;
3680 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003681
Steven Cooreman094a77e2021-05-06 17:58:36 +02003682 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3683 hash_alg,
3684 hkdf->prk,
3685 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003686 if( status != PSA_SUCCESS )
3687 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003688
Gilles Peskinebef7f142018-07-12 17:22:21 +02003689 if( hkdf->block_number != 1 )
3690 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003691 status = psa_mac_update( &hkdf->hmac,
3692 hkdf->output_block,
3693 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003694 if( status != PSA_SUCCESS )
3695 return( status );
3696 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003697 status = psa_mac_update( &hkdf->hmac,
3698 hkdf->info,
3699 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003700 if( status != PSA_SUCCESS )
3701 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003702 status = psa_mac_update( &hkdf->hmac,
3703 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003704 if( status != PSA_SUCCESS )
3705 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003706 status = psa_mac_sign_finish( &hkdf->hmac,
3707 hkdf->output_block,
3708 sizeof( hkdf->output_block ),
3709 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003710 if( status != PSA_SUCCESS )
3711 return( status );
3712 }
3713
3714 return( PSA_SUCCESS );
3715}
John Durkop07cc04a2020-11-16 22:08:34 -08003716#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003717
John Durkop07cc04a2020-11-16 22:08:34 -08003718#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3719 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003720static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3721 psa_tls12_prf_key_derivation_t *tls12_prf,
3722 psa_algorithm_t alg )
3723{
3724 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003725 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003726 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3727 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003728 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003729
Janos Follath7742fee2019-06-17 12:58:10 +01003730 /* We can't be wanting more output after block 0xff, otherwise
3731 * the capacity check in psa_key_derivation_output_bytes() would have
3732 * prevented this call. It could happen only if the operation
3733 * object was corrupted or if this function is called directly
3734 * inside the library. */
3735 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003736 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003737
3738 /* We need a new block */
3739 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003740 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003741
3742 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3743 *
3744 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3745 *
3746 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3747 * HMAC_hash(secret, A(2) + seed) +
3748 * HMAC_hash(secret, A(3) + seed) + ...
3749 *
3750 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003751 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003752 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003753 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003754 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003755 * is currently extracted as `output_block` and where i is
3756 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003757 */
3758
Steven Cooreman094a77e2021-05-06 17:58:36 +02003759 status = psa_key_derivation_start_hmac( &hmac,
3760 hash_alg,
3761 tls12_prf->secret,
3762 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003763 if( status != PSA_SUCCESS )
3764 goto cleanup;
3765
3766 /* Calculate A(i) where i = tls12_prf->block_number. */
3767 if( tls12_prf->block_number == 1 )
3768 {
3769 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3770 * the variable seed and in this instance means it in the context of the
3771 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003772 status = psa_mac_update( &hmac,
3773 tls12_prf->label,
3774 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003775 if( status != PSA_SUCCESS )
3776 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003777 status = psa_mac_update( &hmac,
3778 tls12_prf->seed,
3779 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003780 if( status != PSA_SUCCESS )
3781 goto cleanup;
3782 }
3783 else
3784 {
3785 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003786 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003787 if( status != PSA_SUCCESS )
3788 goto cleanup;
3789 }
3790
Steven Cooremana6df6042021-04-29 19:32:25 +02003791 status = psa_mac_sign_finish( &hmac,
3792 tls12_prf->Ai, hash_length,
3793 &hmac_output_length );
3794 if( hmac_output_length != hash_length )
3795 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003796 if( status != PSA_SUCCESS )
3797 goto cleanup;
3798
3799 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003800 status = psa_key_derivation_start_hmac( &hmac,
3801 hash_alg,
3802 tls12_prf->secret,
3803 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003804 if( status != PSA_SUCCESS )
3805 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003806 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003807 if( status != PSA_SUCCESS )
3808 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003809 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003810 if( status != PSA_SUCCESS )
3811 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003812 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003813 if( status != PSA_SUCCESS )
3814 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003815 status = psa_mac_sign_finish( &hmac,
3816 tls12_prf->output_block, hash_length,
3817 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003818 if( status != PSA_SUCCESS )
3819 goto cleanup;
3820
Janos Follath7742fee2019-06-17 12:58:10 +01003821
3822cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003823 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003824 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3825 status = cleanup_status;
3826
3827 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003828}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003829
Janos Follath844eb0e2019-06-19 12:10:49 +01003830static psa_status_t psa_key_derivation_tls12_prf_read(
3831 psa_tls12_prf_key_derivation_t *tls12_prf,
3832 psa_algorithm_t alg,
3833 uint8_t *output,
3834 size_t output_length )
3835{
3836 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003837 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003838 psa_status_t status;
3839 uint8_t offset, length;
3840
Gilles Peskineb1edaec2021-06-11 22:41:46 +02003841 switch( tls12_prf->state )
3842 {
3843 case PSA_TLS12_PRF_STATE_LABEL_SET:
3844 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
3845 break;
3846 case PSA_TLS12_PRF_STATE_OUTPUT:
3847 break;
3848 default:
3849 return( PSA_ERROR_BAD_STATE );
3850 }
3851
Janos Follath844eb0e2019-06-19 12:10:49 +01003852 while( output_length != 0 )
3853 {
3854 /* Check if we have fully processed the current block. */
3855 if( tls12_prf->left_in_block == 0 )
3856 {
3857 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3858 alg );
3859 if( status != PSA_SUCCESS )
3860 return( status );
3861
3862 continue;
3863 }
3864
3865 if( tls12_prf->left_in_block > output_length )
3866 length = (uint8_t) output_length;
3867 else
3868 length = tls12_prf->left_in_block;
3869
3870 offset = hash_length - tls12_prf->left_in_block;
3871 memcpy( output, tls12_prf->output_block + offset, length );
3872 output += length;
3873 output_length -= length;
3874 tls12_prf->left_in_block -= length;
3875 }
3876
3877 return( PSA_SUCCESS );
3878}
John Durkop07cc04a2020-11-16 22:08:34 -08003879#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3880 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003881
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003882psa_status_t psa_key_derivation_output_bytes(
3883 psa_key_derivation_operation_t *operation,
3884 uint8_t *output,
3885 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003886{
3887 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003888 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003889
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003890 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003891 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003892 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003893 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003894 }
3895
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003896 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003897 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003898 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003899 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003900 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003901 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003902 goto exit;
3903 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003905 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003906 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003907 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003908 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3909 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003910 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003911 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003912 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003913 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003914 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003915
John Durkopd0321952020-10-29 21:37:36 -07003916#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003917 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003918 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003919 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003920 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003921 output, output_length );
3922 }
Janos Follathadbec812019-06-14 11:05:39 +01003923 else
John Durkop07cc04a2020-11-16 22:08:34 -08003924#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3925#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3926 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003927 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003928 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003929 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003930 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003931 kdf_alg, output,
3932 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003933 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003934 else
John Durkop07cc04a2020-11-16 22:08:34 -08003935#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3936 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003937 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003938 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003939 return( PSA_ERROR_BAD_STATE );
3940 }
3941
3942exit:
3943 if( status != PSA_SUCCESS )
3944 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003945 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003946 * This allows us to differentiate between exhausted operations and
3947 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3948 * operations. */
3949 psa_algorithm_t alg = operation->alg;
3950 psa_key_derivation_abort( operation );
3951 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003952 memset( output, '!', output_length );
3953 }
3954 return( status );
3955}
3956
David Brown7807bf72021-02-09 16:28:23 -07003957#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003958static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3959{
3960 if( data_size >= 8 )
3961 mbedtls_des_key_set_parity( data );
3962 if( data_size >= 16 )
3963 mbedtls_des_key_set_parity( data + 8 );
3964 if( data_size >= 24 )
3965 mbedtls_des_key_set_parity( data + 16 );
3966}
David Brown7807bf72021-02-09 16:28:23 -07003967#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003968
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003969static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003970 psa_key_slot_t *slot,
3971 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003972 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003973{
3974 uint8_t *data = NULL;
3975 size_t bytes = PSA_BITS_TO_BYTES( bits );
3976 psa_status_t status;
3977
Gilles Peskine8e338702019-07-30 20:06:31 +02003978 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003979 return( PSA_ERROR_INVALID_ARGUMENT );
3980 if( bits % 8 != 0 )
3981 return( PSA_ERROR_INVALID_ARGUMENT );
3982 data = mbedtls_calloc( 1, bytes );
3983 if( data == NULL )
3984 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3985
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003986 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003987 if( status != PSA_SUCCESS )
3988 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003989#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003990 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003991 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003992#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003993
3994 status = psa_allocate_buffer_to_slot( slot, bytes );
3995 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003996 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003997
Ronald Cronbf33c932020-11-28 18:06:53 +01003998 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003999 psa_key_attributes_t attributes = {
4000 .core = slot->attr
4001 };
4002
Ronald Cronbf33c932020-11-28 18:06:53 +01004003 status = psa_driver_wrapper_import_key( &attributes,
4004 data, bytes,
4005 slot->key.data,
4006 slot->key.bytes,
4007 &slot->key.bytes, &bits );
4008 if( bits != slot->attr.bits )
4009 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004010
4011exit:
4012 mbedtls_free( data );
4013 return( status );
4014}
4015
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004016psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004017 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004018 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004019{
4020 psa_status_t status;
4021 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004022 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004023
Ronald Cron81709fc2020-11-14 12:10:32 +01004024 *key = MBEDTLS_SVC_KEY_ID_INIT;
4025
Gilles Peskine0f84d622019-09-12 19:03:13 +02004026 /* Reject any attempt to create a zero-length key so that we don't
4027 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4028 if( psa_get_key_bits( attributes ) == 0 )
4029 return( PSA_ERROR_INVALID_ARGUMENT );
4030
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004031 if( ! operation->can_output_key )
4032 return( PSA_ERROR_NOT_PERMITTED );
4033
Ronald Cron81709fc2020-11-14 12:10:32 +01004034 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4035 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004036#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4037 if( driver != NULL )
4038 {
4039 /* Deriving a key in a secure element is not implemented yet. */
4040 status = PSA_ERROR_NOT_SUPPORTED;
4041 }
4042#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004043 if( status == PSA_SUCCESS )
4044 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004045 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004046 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004047 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004048 }
4049 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004050 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004051 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004052 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004053
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004054 return( status );
4055}
4056
Gilles Peskineeab56e42018-07-12 17:12:33 +02004057
4058
4059/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004060/* Key derivation */
4061/****************************************************************/
4062
Steven Cooreman932ffb72021-02-15 12:14:32 +01004063#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004064static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004065 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004066 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004067{
John Durkop07cc04a2020-11-16 22:08:34 -08004068 int is_kdf_alg_supported;
4069
Janos Follath5fe19732019-06-20 15:09:30 +01004070 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4071 * initialisers for this union leave some bytes unspecified.) */
4072 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4073
Gilles Peskine969c5d62019-01-16 15:53:06 +01004074 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004076 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4077 is_kdf_alg_supported = 1;
4078 else
4079#endif
4080#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4081 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4082 is_kdf_alg_supported = 1;
4083 else
4084#endif
4085#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4086 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4087 is_kdf_alg_supported = 1;
4088 else
4089#endif
4090 is_kdf_alg_supported = 0;
4091
4092 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004093 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004094 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004095 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004096 if( hash_size == 0 )
4097 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004098 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4099 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004100 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004101 {
4102 return( PSA_ERROR_NOT_SUPPORTED );
4103 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004104 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004105 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004106 }
John Durkop07cc04a2020-11-16 22:08:34 -08004107
4108 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004109}
John Durkop07cc04a2020-11-16 22:08:34 -08004110#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004111
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004112psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004113 psa_algorithm_t alg )
4114{
4115 psa_status_t status;
4116
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004117 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004118 return( PSA_ERROR_BAD_STATE );
4119
Gilles Peskine6843c292019-01-18 16:44:49 +01004120 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4121 return( PSA_ERROR_INVALID_ARGUMENT );
4122 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004123 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004124#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004125 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004126 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004127#else
4128 return( PSA_ERROR_NOT_SUPPORTED );
4129#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004130 }
4131 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4132 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004133#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004134 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004135#else
4136 return( PSA_ERROR_NOT_SUPPORTED );
4137#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004138 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004139 else
4140 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004141
4142 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004143 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004144 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004145}
4146
John Durkopd0321952020-10-29 21:37:36 -07004147#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004148static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004149 psa_algorithm_t hash_alg,
4150 psa_key_derivation_step_t step,
4151 const uint8_t *data,
4152 size_t data_length )
4153{
4154 psa_status_t status;
4155 switch( step )
4156 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004157 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004158 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004159 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004160 else
4161 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004162 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4163 hash_alg,
4164 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004165 if( status != PSA_SUCCESS )
4166 return( status );
4167 hkdf->state = HKDF_STATE_STARTED;
4168 return( PSA_SUCCESS );
4169 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004170 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004171 /* If no salt was provided, use an empty salt. */
4172 if( hkdf->state == HKDF_STATE_INIT )
4173 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004174 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4175 hash_alg,
4176 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004177 if( status != PSA_SUCCESS )
4178 return( status );
4179 hkdf->state = HKDF_STATE_STARTED;
4180 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004181 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004182 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004183 status = psa_mac_update( &hkdf->hmac,
4184 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004185 if( status != PSA_SUCCESS )
4186 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004187 status = psa_mac_sign_finish( &hkdf->hmac,
4188 hkdf->prk,
4189 sizeof( hkdf->prk ),
4190 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004191 if( status != PSA_SUCCESS )
4192 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004193 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004194 hkdf->block_number = 0;
4195 hkdf->state = HKDF_STATE_KEYED;
4196 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004197 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004198 if( hkdf->state == HKDF_STATE_OUTPUT )
4199 return( PSA_ERROR_BAD_STATE );
4200 if( hkdf->info_set )
4201 return( PSA_ERROR_BAD_STATE );
4202 hkdf->info_length = data_length;
4203 if( data_length != 0 )
4204 {
4205 hkdf->info = mbedtls_calloc( 1, data_length );
4206 if( hkdf->info == NULL )
4207 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4208 memcpy( hkdf->info, data, data_length );
4209 }
4210 hkdf->info_set = 1;
4211 return( PSA_SUCCESS );
4212 default:
4213 return( PSA_ERROR_INVALID_ARGUMENT );
4214 }
4215}
John Durkop07cc04a2020-11-16 22:08:34 -08004216#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004217
John Durkop07cc04a2020-11-16 22:08:34 -08004218#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4219 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004220static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4221 const uint8_t *data,
4222 size_t data_length )
4223{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004224 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004225 return( PSA_ERROR_BAD_STATE );
4226
Janos Follathd6dce9f2019-07-04 09:11:38 +01004227 if( data_length != 0 )
4228 {
4229 prf->seed = mbedtls_calloc( 1, data_length );
4230 if( prf->seed == NULL )
4231 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004232
Janos Follathd6dce9f2019-07-04 09:11:38 +01004233 memcpy( prf->seed, data, data_length );
4234 prf->seed_length = data_length;
4235 }
Janos Follathf08e2652019-06-13 09:05:41 +01004236
Gilles Peskine43f958b2020-12-13 14:55:14 +01004237 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004238
4239 return( PSA_SUCCESS );
4240}
4241
Janos Follath81550542019-06-13 14:26:34 +01004242static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004243 const uint8_t *data,
4244 size_t data_length )
4245{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004246 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004247 return( PSA_ERROR_BAD_STATE );
4248
Steven Cooremana6df6042021-04-29 19:32:25 +02004249 if( data_length != 0 )
4250 {
4251 prf->secret = mbedtls_calloc( 1, data_length );
4252 if( prf->secret == NULL )
4253 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4254
4255 memcpy( prf->secret, data, data_length );
4256 prf->secret_length = data_length;
4257 }
Janos Follath81550542019-06-13 14:26:34 +01004258
Gilles Peskine43f958b2020-12-13 14:55:14 +01004259 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004260
4261 return( PSA_SUCCESS );
4262}
4263
Janos Follath63028dd2019-06-13 09:15:47 +01004264static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4265 const uint8_t *data,
4266 size_t data_length )
4267{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004268 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004269 return( PSA_ERROR_BAD_STATE );
4270
Janos Follathd6dce9f2019-07-04 09:11:38 +01004271 if( data_length != 0 )
4272 {
4273 prf->label = mbedtls_calloc( 1, data_length );
4274 if( prf->label == NULL )
4275 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004276
Janos Follathd6dce9f2019-07-04 09:11:38 +01004277 memcpy( prf->label, data, data_length );
4278 prf->label_length = data_length;
4279 }
Janos Follath63028dd2019-06-13 09:15:47 +01004280
Gilles Peskine43f958b2020-12-13 14:55:14 +01004281 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004282
4283 return( PSA_SUCCESS );
4284}
4285
Janos Follathb03233e2019-06-11 15:30:30 +01004286static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004287 psa_key_derivation_step_t step,
4288 const uint8_t *data,
4289 size_t data_length )
4290{
Janos Follathb03233e2019-06-11 15:30:30 +01004291 switch( step )
4292 {
Janos Follathf08e2652019-06-13 09:05:41 +01004293 case PSA_KEY_DERIVATION_INPUT_SEED:
4294 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004295 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004296 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004297 case PSA_KEY_DERIVATION_INPUT_LABEL:
4298 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004299 default:
4300 return( PSA_ERROR_INVALID_ARGUMENT );
4301 }
4302}
John Durkop07cc04a2020-11-16 22:08:34 -08004303#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4304 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4305
4306#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4307static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4308 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004309 const uint8_t *data,
4310 size_t data_length )
4311{
4312 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004313 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004314 uint8_t *cur = pms;
4315
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004316 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004317 return( PSA_ERROR_INVALID_ARGUMENT );
4318
4319 /* Quoting RFC 4279, Section 2:
4320 *
4321 * The premaster secret is formed as follows: if the PSK is N octets
4322 * long, concatenate a uint16 with the value N, N zero octets, a second
4323 * uint16 with the value N, and the PSK itself.
4324 */
4325
4326 *cur++ = ( data_length >> 8 ) & 0xff;
4327 *cur++ = ( data_length >> 0 ) & 0xff;
4328 memset( cur, 0, data_length );
4329 cur += data_length;
4330 *cur++ = pms[0];
4331 *cur++ = pms[1];
4332 memcpy( cur, data, data_length );
4333 cur += data_length;
4334
Steven Cooremana6df6042021-04-29 19:32:25 +02004335 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004336
4337 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4338 return( status );
4339}
Janos Follath6660f0e2019-06-17 08:44:03 +01004340
4341static psa_status_t psa_tls12_prf_psk_to_ms_input(
4342 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004343 psa_key_derivation_step_t step,
4344 const uint8_t *data,
4345 size_t data_length )
4346{
4347 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004348 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004349 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004350 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004351 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004352
Steven Cooremana6df6042021-04-29 19:32:25 +02004353 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004354}
John Durkop07cc04a2020-11-16 22:08:34 -08004355#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004356
Gilles Peskineb8965192019-09-24 16:21:10 +02004357/** Check whether the given key type is acceptable for the given
4358 * input step of a key derivation.
4359 *
4360 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4361 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4362 * Both secret and non-secret inputs can alternatively have the type
4363 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4364 * that the input was passed as a buffer rather than via a key object.
4365 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004366static int psa_key_derivation_check_input_type(
4367 psa_key_derivation_step_t step,
4368 psa_key_type_t key_type )
4369{
4370 switch( step )
4371 {
4372 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004373 if( key_type == PSA_KEY_TYPE_DERIVE )
4374 return( PSA_SUCCESS );
4375 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004376 return( PSA_SUCCESS );
4377 break;
4378 case PSA_KEY_DERIVATION_INPUT_LABEL:
4379 case PSA_KEY_DERIVATION_INPUT_SALT:
4380 case PSA_KEY_DERIVATION_INPUT_INFO:
4381 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004382 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4383 return( PSA_SUCCESS );
4384 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004385 return( PSA_SUCCESS );
4386 break;
4387 }
4388 return( PSA_ERROR_INVALID_ARGUMENT );
4389}
4390
Janos Follathb80a94e2019-06-12 15:54:46 +01004391static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004392 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004393 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004394 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004395 const uint8_t *data,
4396 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004397{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004398 psa_status_t status;
4399 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4400
4401 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004402 if( status != PSA_SUCCESS )
4403 goto exit;
4404
John Durkopd0321952020-10-29 21:37:36 -07004405#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004406 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004407 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004408 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004409 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004410 step, data, data_length );
4411 }
John Durkop07cc04a2020-11-16 22:08:34 -08004412 else
4413#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4414#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4415 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004416 {
Janos Follathb03233e2019-06-11 15:30:30 +01004417 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004418 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004419 }
John Durkop07cc04a2020-11-16 22:08:34 -08004420 else
4421#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4422#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4423 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004424 {
4425 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004426 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004427 }
4428 else
John Durkop07cc04a2020-11-16 22:08:34 -08004429#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004430 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004431 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004432 (void) data;
4433 (void) data_length;
4434 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004435 return( PSA_ERROR_BAD_STATE );
4436 }
4437
Gilles Peskine224b0d62019-09-23 18:13:17 +02004438exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004439 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004440 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004441 return( status );
4442}
4443
Janos Follath51f4a0f2019-06-14 11:35:55 +01004444psa_status_t psa_key_derivation_input_bytes(
4445 psa_key_derivation_operation_t *operation,
4446 psa_key_derivation_step_t step,
4447 const uint8_t *data,
4448 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004449{
Gilles Peskineb8965192019-09-24 16:21:10 +02004450 return( psa_key_derivation_input_internal( operation, step,
4451 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004452 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004453}
4454
Janos Follath51f4a0f2019-06-14 11:35:55 +01004455psa_status_t psa_key_derivation_input_key(
4456 psa_key_derivation_operation_t *operation,
4457 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004458 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004459{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004460 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004461 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004462 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004463
Ronald Cron5c522922020-11-14 16:35:34 +01004464 status = psa_get_and_lock_transparent_key_slot_with_policy(
4465 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004466 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004467 {
4468 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004469 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004470 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004471
4472 /* Passing a key object as a SECRET input unlocks the permission
4473 * to output to a key object. */
4474 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4475 operation->can_output_key = 1;
4476
Ronald Cronf95a2b12020-10-22 15:24:49 +02004477 status = psa_key_derivation_input_internal( operation,
4478 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004479 slot->key.data,
4480 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004481
Ronald Cron5c522922020-11-14 16:35:34 +01004482 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004483
Ronald Cron5c522922020-11-14 16:35:34 +01004484 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004485}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004486
4487
4488
4489/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004490/* Key agreement */
4491/****************************************************************/
4492
John Durkop6ba40d12020-11-10 08:50:04 -08004493#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004494static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4495 size_t peer_key_length,
4496 const mbedtls_ecp_keypair *our_key,
4497 uint8_t *shared_secret,
4498 size_t shared_secret_size,
4499 size_t *shared_secret_length )
4500{
Steven Cooremand4867872020-08-05 16:31:39 +02004501 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004502 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004503 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004504 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004505 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004506 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004507
Ronald Cron90857082020-11-25 14:58:33 +01004508 status = mbedtls_psa_ecp_load_representation(
4509 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004510 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004511 peer_key,
4512 peer_key_length,
4513 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004514 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004515 goto exit;
4516
Jaeden Amero97271b32019-01-10 19:38:51 +00004517 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004518 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004519 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004520 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004521 status = mbedtls_to_psa_error(
4522 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4523 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004524 goto exit;
4525
Jaeden Amero97271b32019-01-10 19:38:51 +00004526 status = mbedtls_to_psa_error(
4527 mbedtls_ecdh_calc_secret( &ecdh,
4528 shared_secret_length,
4529 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004530 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004531 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004532 if( status != PSA_SUCCESS )
4533 goto exit;
4534 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4535 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004536
4537exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004538 if( status != PSA_SUCCESS )
4539 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004540 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004541 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004542 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004543
Jaeden Amero97271b32019-01-10 19:38:51 +00004544 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004545}
John Durkop6ba40d12020-11-10 08:50:04 -08004546#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004547
Gilles Peskine01d718c2018-09-18 12:01:02 +02004548#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4549
Gilles Peskine0216fe12019-04-11 21:23:21 +02004550static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4551 psa_key_slot_t *private_key,
4552 const uint8_t *peer_key,
4553 size_t peer_key_length,
4554 uint8_t *shared_secret,
4555 size_t shared_secret_size,
4556 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004557{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004558 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004559 {
John Durkop6ba40d12020-11-10 08:50:04 -08004560#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004561 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004562 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004563 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004564 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004565 psa_status_t status = mbedtls_psa_ecp_load_representation(
4566 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004567 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004568 private_key->key.data,
4569 private_key->key.bytes,
4570 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004571 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004572 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004573 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004574 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004575 shared_secret, shared_secret_size,
4576 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004577 mbedtls_ecp_keypair_free( ecp );
4578 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004579 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004580#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004581 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004582 (void) private_key;
4583 (void) peer_key;
4584 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004585 (void) shared_secret;
4586 (void) shared_secret_size;
4587 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004588 return( PSA_ERROR_NOT_SUPPORTED );
4589 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004590}
4591
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004592/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004593 * to potentially free embedded data structures and wipe confidential data.
4594 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004595static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004596 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004597 psa_key_slot_t *private_key,
4598 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004599 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004600{
4601 psa_status_t status;
4602 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4603 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004604 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004605
4606 /* Step 1: run the secret agreement algorithm to generate the shared
4607 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004608 status = psa_key_agreement_raw_internal( ka_alg,
4609 private_key,
4610 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004611 shared_secret,
4612 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004613 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004614 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004615 goto exit;
4616
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004617 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004618 * the shared secret. A shared secret is permitted wherever a key
4619 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004620 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004621 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004622 shared_secret,
4623 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004624exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004625 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004626 return( status );
4627}
4628
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004629psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004630 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004631 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004632 const uint8_t *peer_key,
4633 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004634{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004636 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004637 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004638
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004639 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004640 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004641 status = psa_get_and_lock_transparent_key_slot_with_policy(
4642 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004643 if( status != PSA_SUCCESS )
4644 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004645 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004646 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004647 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004648 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004649 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004650 else
4651 {
4652 /* If a private key has been added as SECRET, we allow the derived
4653 * key material to be used as a key in PSA Crypto. */
4654 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4655 operation->can_output_key = 1;
4656 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004657
Ronald Cron5c522922020-11-14 16:35:34 +01004658 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004659
Ronald Cron5c522922020-11-14 16:35:34 +01004660 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004661}
4662
Gilles Peskinebe697d82019-05-16 18:00:41 +02004663psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004664 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004665 const uint8_t *peer_key,
4666 size_t peer_key_length,
4667 uint8_t *output,
4668 size_t output_size,
4669 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004670{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004672 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004673 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004674
4675 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4676 {
4677 status = PSA_ERROR_INVALID_ARGUMENT;
4678 goto exit;
4679 }
Ronald Cron5c522922020-11-14 16:35:34 +01004680 status = psa_get_and_lock_transparent_key_slot_with_policy(
4681 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004682 if( status != PSA_SUCCESS )
4683 goto exit;
4684
4685 status = psa_key_agreement_raw_internal( alg, slot,
4686 peer_key, peer_key_length,
4687 output, output_size,
4688 output_length );
4689
4690exit:
4691 if( status != PSA_SUCCESS )
4692 {
4693 /* If an error happens and is not handled properly, the output
4694 * may be used as a key to protect sensitive data. Arrange for such
4695 * a key to be random, which is likely to result in decryption or
4696 * verification errors. This is better than filling the buffer with
4697 * some constant data such as zeros, which would result in the data
4698 * being protected with a reproducible, easily knowable key.
4699 */
4700 psa_generate_random( output, output_size );
4701 *output_length = output_size;
4702 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004703
Ronald Cron5c522922020-11-14 16:35:34 +01004704 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004705
Ronald Cron5c522922020-11-14 16:35:34 +01004706 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004707}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004708
4709
Gilles Peskine30524eb2020-11-13 17:02:26 +01004710
Gilles Peskine86a440b2018-11-12 18:39:40 +01004711/****************************************************************/
4712/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004713/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004714
Gilles Peskine30524eb2020-11-13 17:02:26 +01004715/** Initialize the PSA random generator.
4716 */
4717static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4718{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004719#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4720 memset( rng, 0, sizeof( *rng ) );
4721#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4722
Gilles Peskine30524eb2020-11-13 17:02:26 +01004723 /* Set default configuration if
4724 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4725 if( rng->entropy_init == NULL )
4726 rng->entropy_init = mbedtls_entropy_init;
4727 if( rng->entropy_free == NULL )
4728 rng->entropy_free = mbedtls_entropy_free;
4729
4730 rng->entropy_init( &rng->entropy );
4731#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4732 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4733 /* The PSA entropy injection feature depends on using NV seed as an entropy
4734 * source. Add NV seed as an entropy source for PSA entropy injection. */
4735 mbedtls_entropy_add_source( &rng->entropy,
4736 mbedtls_nv_seed_poll, NULL,
4737 MBEDTLS_ENTROPY_BLOCK_SIZE,
4738 MBEDTLS_ENTROPY_SOURCE_STRONG );
4739#endif
4740
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004741 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004742#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004743}
4744
4745/** Deinitialize the PSA random generator.
4746 */
4747static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4748{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004749#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4750 memset( rng, 0, sizeof( *rng ) );
4751#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004752 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004753 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004754#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004755}
4756
4757/** Seed the PSA random generator.
4758 */
4759static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4760{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004761#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4762 /* Do nothing: the external RNG seeds itself. */
4763 (void) rng;
4764 return( PSA_SUCCESS );
4765#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004766 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004767 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4768 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004769 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004770#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004771}
4772
Gilles Peskinee59236f2018-01-27 23:32:46 +01004773psa_status_t psa_generate_random( uint8_t *output,
4774 size_t output_size )
4775{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004776 GUARD_MODULE_INITIALIZED;
4777
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004778#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4779
4780 size_t output_length = 0;
4781 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4782 output, output_size,
4783 &output_length );
4784 if( status != PSA_SUCCESS )
4785 return( status );
4786 /* Breaking up a request into smaller chunks is currently not supported
4787 * for the extrernal RNG interface. */
4788 if( output_length != output_size )
4789 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4790 return( PSA_SUCCESS );
4791
4792#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4793
Gilles Peskine71ddab92021-01-04 21:01:07 +01004794 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004795 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004796 size_t request_size =
4797 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4798 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4799 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004800 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4801 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004802 if( ret != 0 )
4803 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004804 output_size -= request_size;
4805 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004806 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004807 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004808#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004809}
4810
Gilles Peskine8814fc42020-12-14 15:33:44 +01004811/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004812 *
4813 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4814 * `psa_generate_random(...)`. The state parameter is ignored since the
4815 * PSA API doesn't support passing an explicit state.
4816 *
4817 * In the non-external case, psa_generate_random() calls an
4818 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4819 * and semantics as mbedtls_psa_get_random(). As an optimization,
4820 * instead of doing this back-and-forth between the PSA API and the
4821 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4822 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004823 */
4824#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4825int mbedtls_psa_get_random( void *p_rng,
4826 unsigned char *output,
4827 size_t output_size )
4828{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004829 /* This function takes a pointer to the RNG state because that's what
4830 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4831 * its own state internally and doesn't let the caller access that state.
4832 * So we just ignore the state parameter, and in practice we'll pass
4833 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004834 (void) p_rng;
4835 psa_status_t status = psa_generate_random( output, output_size );
4836 if( status == PSA_SUCCESS )
4837 return( 0 );
4838 else
4839 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4840}
4841#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4842
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004843#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004844#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004845
Gilles Peskine7228da22019-07-15 11:06:15 +02004846psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004847 size_t seed_size )
4848{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004849 if( global_data.initialized )
4850 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004851
4852 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4853 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4854 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4855 return( PSA_ERROR_INVALID_ARGUMENT );
4856
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004857 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004858}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004859#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004860
Ronald Cron3772afe2021-02-08 16:10:05 +01004861/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004862 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004863 * \param type The key type
4864 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004865 *
4866 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004867 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004868 * \retval #PSA_ERROR_INVALID_ARGUMENT
4869 * The size in bits of the key is not valid.
4870 * \retval #PSA_ERROR_NOT_SUPPORTED
4871 * The type and/or the size in bits of the key or the combination of
4872 * the two is not supported.
4873 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004874static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4875 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004876{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004878
Gilles Peskinee59236f2018-01-27 23:32:46 +01004879 if( key_type_is_raw_bytes( type ) )
4880 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004881 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004882 if( status != PSA_SUCCESS )
4883 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004884 }
4885 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004886#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004887 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4888 {
4889 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4890 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004891
Ronald Cron01b2aba2020-10-05 09:42:02 +02004892 /* Accept only byte-aligned keys, for the same reasons as
4893 * in psa_import_rsa_key(). */
4894 if( bits % 8 != 0 )
4895 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004896 }
4897 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004898#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004899
Ronald Cron5c4d3862020-12-07 11:07:24 +01004900#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004901 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4902 {
Ronald Crond81ab562021-02-16 09:01:16 +01004903 /* To avoid empty block, return successfully here. */
4904 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004905 }
4906 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004907#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004908 {
4909 return( PSA_ERROR_NOT_SUPPORTED );
4910 }
4911
4912 return( PSA_SUCCESS );
4913}
4914
Ronald Cron55ed0592020-10-05 10:30:40 +02004915psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004916 const psa_key_attributes_t *attributes,
4917 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004918{
4919 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004920 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004921
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004922 if( ( attributes->domain_parameters == NULL ) &&
4923 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004924 return( PSA_ERROR_INVALID_ARGUMENT );
4925
Ronald Cron01b2aba2020-10-05 09:42:02 +02004926 if( key_type_is_raw_bytes( type ) )
4927 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004928 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004929 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004930 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004931
David Brown12ca5032021-02-11 11:02:00 -07004932#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004933 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004934 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004935#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004936 }
4937 else
4938
Jaeden Amero424fa932021-05-14 08:34:32 +01004939#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4940 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004941 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004942 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004943 return( mbedtls_psa_rsa_generate_key( attributes,
4944 key_buffer,
4945 key_buffer_size,
4946 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004947 }
4948 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004949#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4950 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004951
John Durkop9814fa22020-11-04 12:28:15 -08004952#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004953 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004954 {
Ronald Cron7023db52020-11-20 18:17:42 +01004955 return( mbedtls_psa_ecp_generate_key( attributes,
4956 key_buffer,
4957 key_buffer_size,
4958 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004959 }
4960 else
John Durkop9814fa22020-11-04 12:28:15 -08004961#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004962 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004963 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004964 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004965 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004966
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004967 return( PSA_SUCCESS );
4968}
Darryl Green0c6575a2018-11-07 16:05:30 +00004969
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004970psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004971 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004972{
4973 psa_status_t status;
4974 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004975 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004976 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004977
Ronald Cron81709fc2020-11-14 12:10:32 +01004978 *key = MBEDTLS_SVC_KEY_ID_INIT;
4979
Gilles Peskine0f84d622019-09-12 19:03:13 +02004980 /* Reject any attempt to create a zero-length key so that we don't
4981 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4982 if( psa_get_key_bits( attributes ) == 0 )
4983 return( PSA_ERROR_INVALID_ARGUMENT );
4984
Ronald Cron81709fc2020-11-14 12:10:32 +01004985 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4986 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004987 if( status != PSA_SUCCESS )
4988 goto exit;
4989
Ronald Cron977c2472020-10-13 08:32:21 +02004990 /* In the case of a transparent key or an opaque key stored in local
4991 * storage (thus not in the case of generating a key in a secure element
4992 * or cryptoprocessor with storage), we have to allocate a buffer to
4993 * hold the generated key material. */
4994 if( slot->key.data == NULL )
4995 {
4996 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4997 PSA_KEY_LOCATION_LOCAL_STORAGE )
4998 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004999 status = psa_validate_key_type_and_size_for_key_generation(
5000 attributes->core.type, attributes->core.bits );
5001 if( status != PSA_SUCCESS )
5002 goto exit;
5003
5004 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5005 attributes->core.type,
5006 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005007 }
5008 else
5009 {
5010 status = psa_driver_wrapper_get_key_buffer_size(
5011 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005012 if( status != PSA_SUCCESS )
5013 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005014 }
Ronald Cron977c2472020-10-13 08:32:21 +02005015
5016 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5017 if( status != PSA_SUCCESS )
5018 goto exit;
5019 }
5020
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005021 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005022 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005023
Ronald Cron2b56bc82020-10-05 10:02:26 +02005024 if( status != PSA_SUCCESS )
5025 psa_remove_key_data_from_memory( slot );
5026
Gilles Peskine11792082019-08-06 18:36:36 +02005027exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005028 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005029 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005030 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005031 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005032
Darryl Green0c6575a2018-11-07 16:05:30 +00005033 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005034}
5035
Gilles Peskinee59236f2018-01-27 23:32:46 +01005036/****************************************************************/
5037/* Module setup */
5038/****************************************************************/
5039
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005040#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005041psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5042 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5043 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5044{
5045 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5046 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005047 global_data.rng.entropy_init = entropy_init;
5048 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005049 return( PSA_SUCCESS );
5050}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005051#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005052
Gilles Peskinee59236f2018-01-27 23:32:46 +01005053void mbedtls_psa_crypto_free( void )
5054{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005055 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005056 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5057 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005058 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005059 }
5060 /* Wipe all remaining data, including configuration.
5061 * In particular, this sets all state indicator to the value
5062 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005063 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005064#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005065 /* Unregister all secure element drivers, so that we restart from
5066 * a pristine state. */
5067 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005068#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005069}
5070
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005071#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5072/** Recover a transaction that was interrupted by a power failure.
5073 *
5074 * This function is called during initialization, before psa_crypto_init()
5075 * returns. If this function returns a failure status, the initialization
5076 * fails.
5077 */
5078static psa_status_t psa_crypto_recover_transaction(
5079 const psa_crypto_transaction_t *transaction )
5080{
5081 switch( transaction->unknown.type )
5082 {
5083 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5084 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005085 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005086 * is implemented.
5087 * https://github.com/ARMmbed/mbed-crypto/issues/218
5088 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005089 default:
5090 /* We found an unsupported transaction in the storage.
5091 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005092 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005093 }
5094}
5095#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5096
Gilles Peskinee59236f2018-01-27 23:32:46 +01005097psa_status_t psa_crypto_init( void )
5098{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005099 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005100
Gilles Peskinec6b69072018-11-20 21:42:52 +01005101 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005102 if( global_data.initialized != 0 )
5103 return( PSA_SUCCESS );
5104
Gilles Peskine30524eb2020-11-13 17:02:26 +01005105 /* Initialize and seed the random generator. */
5106 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005107 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005108 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005109 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005110 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005111 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005112
Gilles Peskine66fb1262018-12-10 16:29:04 +01005113 status = psa_initialize_key_slots( );
5114 if( status != PSA_SUCCESS )
5115 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005116
Gilles Peskined9348f22019-10-01 15:22:29 +02005117#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5118 status = psa_init_all_se_drivers( );
5119 if( status != PSA_SUCCESS )
5120 goto exit;
5121#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5122
Gilles Peskine4b734222019-07-24 15:56:31 +02005123#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005124 status = psa_crypto_load_transaction( );
5125 if( status == PSA_SUCCESS )
5126 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005127 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5128 if( status != PSA_SUCCESS )
5129 goto exit;
5130 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005131 }
5132 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5133 {
5134 /* There's no transaction to complete. It's all good. */
5135 status = PSA_SUCCESS;
5136 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005137#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005138
Gilles Peskinec6b69072018-11-20 21:42:52 +01005139 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005140 global_data.initialized = 1;
5141
5142exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005143 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005144 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005145 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005146}
5147
5148#endif /* MBEDTLS_PSA_CRYPTO_C */