blob: 818ff9e9005f36b63c982caa67577f57d2328a29 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
30
Ronald Crond6d28882020-12-14 14:56:02 +010031#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010036#include "psa_crypto_hash.h"
Steven Cooreman32d56942021-03-19 17:39:17 +010037#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010038#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010039#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020040#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020041#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020042#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010043#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010044/* Include internal declarations that are useful for implementing persistently
45 * stored keys. */
46#include "psa_crypto_storage.h"
47
Gilles Peskineb2b64d32020-12-14 16:43:58 +010048#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010049
Gilles Peskineb46bef22019-07-30 21:32:04 +020050#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010051#include <stdlib.h>
52#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010053#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020054#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010055#define mbedtls_calloc calloc
56#define mbedtls_free free
57#endif
58
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010059#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010060#include "mbedtls/arc4.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/blowfish.h"
65#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020066#include "mbedtls/chacha20.h"
67#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/cipher.h"
69#include "mbedtls/ccm.h"
70#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020072#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010073#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010074#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075#include "mbedtls/error.h"
76#include "mbedtls/gcm.h"
77#include "mbedtls/md2.h"
78#include "mbedtls/md4.h"
79#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010080#include "mbedtls/md.h"
81#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010082#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010083#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010084#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000085#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010086#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010087#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088#include "mbedtls/sha1.h"
89#include "mbedtls/sha256.h"
90#include "mbedtls/sha512.h"
91#include "mbedtls/xtea.h"
92
Gilles Peskine996deb12018-08-01 15:45:45 +020093#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
94
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010095/****************************************************************/
96/* Global data, support functions and library management */
97/****************************************************************/
98
Gilles Peskine48c0ea12018-06-21 14:15:31 +020099static int key_type_is_raw_bytes( psa_key_type_t type )
100{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200101 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200102}
103
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100104/* Values for psa_global_data_t::rng_state */
105#define RNG_NOT_INITIALIZED 0
106#define RNG_INITIALIZED 1
107#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100108
Gilles Peskine2d277862018-06-18 15:41:12 +0200109typedef struct
110{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100111 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100112 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100113 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100114} psa_global_data_t;
115
116static psa_global_data_t global_data;
117
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100118#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
119mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
120 &global_data.rng.drbg;
121#endif
122
itayzafrir0adf0fc2018-09-06 16:24:41 +0300123#define GUARD_MODULE_INITIALIZED \
124 if( global_data.initialized == 0 ) \
125 return( PSA_ERROR_BAD_STATE );
126
Steven Cooreman01164162020-07-20 15:31:37 +0200127psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100128{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100129 /* Mbed TLS error codes can combine a high-level error code and a
130 * low-level error code. The low-level error usually reflects the
131 * root cause better, so dispatch on that preferably. */
132 int low_level_ret = - ( -ret & 0x007f );
133 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100134 {
135 case 0:
136 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100137
138 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
139 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
140 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
141 return( PSA_ERROR_NOT_SUPPORTED );
142 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
143 return( PSA_ERROR_HARDWARE_FAILURE );
144
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200145 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
146 return( PSA_ERROR_HARDWARE_FAILURE );
147
Gilles Peskine9a944802018-06-21 09:35:35 +0200148 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
149 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
150 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
151 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
152 case MBEDTLS_ERR_ASN1_INVALID_DATA:
153 return( PSA_ERROR_INVALID_ARGUMENT );
154 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
155 return( PSA_ERROR_INSUFFICIENT_MEMORY );
156 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
157 return( PSA_ERROR_BUFFER_TOO_SMALL );
158
Jaeden Amero93e21112019-02-20 13:57:28 +0000159#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000160 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
162 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
163#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100164 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
165 return( PSA_ERROR_NOT_SUPPORTED );
166 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
167 return( PSA_ERROR_HARDWARE_FAILURE );
168
Jaeden Amero93e21112019-02-20 13:57:28 +0000169#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000170 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000171#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
172 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
173#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100174 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
175 return( PSA_ERROR_NOT_SUPPORTED );
176 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
177 return( PSA_ERROR_HARDWARE_FAILURE );
178
179 case MBEDTLS_ERR_CCM_BAD_INPUT:
180 return( PSA_ERROR_INVALID_ARGUMENT );
181 case MBEDTLS_ERR_CCM_AUTH_FAILED:
182 return( PSA_ERROR_INVALID_SIGNATURE );
183 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
184 return( PSA_ERROR_HARDWARE_FAILURE );
185
Gilles Peskine26869f22019-05-06 15:25:00 +0200186 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
187 return( PSA_ERROR_INVALID_ARGUMENT );
188
189 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
190 return( PSA_ERROR_BAD_STATE );
191 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
192 return( PSA_ERROR_INVALID_SIGNATURE );
193
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
195 return( PSA_ERROR_NOT_SUPPORTED );
196 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
197 return( PSA_ERROR_INVALID_ARGUMENT );
198 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
199 return( PSA_ERROR_INSUFFICIENT_MEMORY );
200 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
201 return( PSA_ERROR_INVALID_PADDING );
202 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200203 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100204 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
205 return( PSA_ERROR_INVALID_SIGNATURE );
206 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200207 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
209 return( PSA_ERROR_HARDWARE_FAILURE );
210
211 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
212 return( PSA_ERROR_HARDWARE_FAILURE );
213
Gilles Peskine82e57d12020-11-13 21:31:17 +0100214#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
215 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100216 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
217 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
219 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
220 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
221 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
222 return( PSA_ERROR_NOT_SUPPORTED );
223 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
224 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100225#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100226
227 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
228 return( PSA_ERROR_NOT_SUPPORTED );
229 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
230 return( PSA_ERROR_HARDWARE_FAILURE );
231
Gilles Peskinee59236f2018-01-27 23:32:46 +0100232 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
233 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
234 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
235 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100236
237 case MBEDTLS_ERR_GCM_AUTH_FAILED:
238 return( PSA_ERROR_INVALID_SIGNATURE );
239 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200240 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100241 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
242 return( PSA_ERROR_HARDWARE_FAILURE );
243
Gilles Peskine82e57d12020-11-13 21:31:17 +0100244#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
245 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100246 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
247 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100248 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
249 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
250 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
251 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
252 return( PSA_ERROR_NOT_SUPPORTED );
253 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
254 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
255#endif
256
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200257 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
258 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
259 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
260 return( PSA_ERROR_HARDWARE_FAILURE );
261
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
263 return( PSA_ERROR_NOT_SUPPORTED );
264 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_MD_ALLOC_FAILED:
267 return( PSA_ERROR_INSUFFICIENT_MEMORY );
268 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
269 return( PSA_ERROR_STORAGE_FAILURE );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200270 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
271 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100272
Gilles Peskinef76aa772018-10-29 19:24:33 +0100273 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
274 return( PSA_ERROR_STORAGE_FAILURE );
275 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
278 return( PSA_ERROR_INVALID_ARGUMENT );
279 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
280 return( PSA_ERROR_BUFFER_TOO_SMALL );
281 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
282 return( PSA_ERROR_INVALID_ARGUMENT );
283 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
284 return( PSA_ERROR_INVALID_ARGUMENT );
285 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
286 return( PSA_ERROR_INVALID_ARGUMENT );
287 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
288 return( PSA_ERROR_INSUFFICIENT_MEMORY );
289
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100290 case MBEDTLS_ERR_PK_ALLOC_FAILED:
291 return( PSA_ERROR_INSUFFICIENT_MEMORY );
292 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
293 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100296 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100297 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
298 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
299 return( PSA_ERROR_INVALID_ARGUMENT );
300 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
301 return( PSA_ERROR_NOT_SUPPORTED );
302 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
303 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
304 return( PSA_ERROR_NOT_PERMITTED );
305 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
306 return( PSA_ERROR_INVALID_ARGUMENT );
307 case MBEDTLS_ERR_PK_INVALID_ALG:
308 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
309 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
310 return( PSA_ERROR_NOT_SUPPORTED );
311 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
312 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100313 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
314 return( PSA_ERROR_HARDWARE_FAILURE );
315
Gilles Peskineff2d2002019-05-06 15:26:23 +0200316 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
317 return( PSA_ERROR_HARDWARE_FAILURE );
318 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
319 return( PSA_ERROR_NOT_SUPPORTED );
320
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200321 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
322 return( PSA_ERROR_HARDWARE_FAILURE );
323
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
325 return( PSA_ERROR_INVALID_ARGUMENT );
326 case MBEDTLS_ERR_RSA_INVALID_PADDING:
327 return( PSA_ERROR_INVALID_PADDING );
328 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
329 return( PSA_ERROR_HARDWARE_FAILURE );
330 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
331 return( PSA_ERROR_INVALID_ARGUMENT );
332 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
333 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200334 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
336 return( PSA_ERROR_INVALID_SIGNATURE );
337 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
338 return( PSA_ERROR_BUFFER_TOO_SMALL );
339 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100340 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100341 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
342 return( PSA_ERROR_NOT_SUPPORTED );
343 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
344 return( PSA_ERROR_HARDWARE_FAILURE );
345
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200346 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
347 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
348 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
349 return( PSA_ERROR_HARDWARE_FAILURE );
350
Gilles Peskinea5905292018-02-07 20:59:33 +0100351 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
352 return( PSA_ERROR_INVALID_ARGUMENT );
353 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
354 return( PSA_ERROR_HARDWARE_FAILURE );
355
itayzafrir5c753392018-05-08 11:18:38 +0300356 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300357 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300358 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300359 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
360 return( PSA_ERROR_BUFFER_TOO_SMALL );
361 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
362 return( PSA_ERROR_NOT_SUPPORTED );
363 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
364 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
365 return( PSA_ERROR_INVALID_SIGNATURE );
366 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
367 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100368 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
369 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300370 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
371 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100372
Janos Follatha13b9052019-11-22 12:48:59 +0000373 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
374 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300375
Gilles Peskinee59236f2018-01-27 23:32:46 +0100376 default:
David Saadab4ecc272019-02-14 13:48:10 +0200377 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100378 }
379}
380
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200381
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200382
383
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100384/****************************************************************/
385/* Key management */
386/****************************************************************/
387
Gilles Peskine73167e12019-07-12 23:44:37 +0200388#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
389static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
390{
Gilles Peskine8e338702019-07-30 20:06:31 +0200391 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200392}
393#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
394
John Durkop07cc04a2020-11-16 22:08:34 -0800395/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
396 * current test driver in key_management.c is using this function
397 * when accelerators are used for ECC key pair and public key.
398 * Once that dependency is resolved these guards can be removed.
399 */
John Durkop9814fa22020-11-04 12:28:15 -0800400#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800401 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
402 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
403 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100404mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 size_t bits,
406 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200407{
408 switch( curve )
409 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100410 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100411 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100413#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100415 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100416#endif
417#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100418 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100420#endif
421#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100422 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100424#endif
425#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100428#endif
429#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100431 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100432 case 528:
433 if( bits_is_sloppy )
434 return( MBEDTLS_ECP_DP_SECP521R1 );
435 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100437 }
438 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100439
Paul Elliott8ff510a2020-06-02 17:19:28 +0100440 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100441 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100442 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100443#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100446#endif
447#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100448 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100449 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100450#endif
451#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100452 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100454#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100455 }
456 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100457
Paul Elliott8ff510a2020-06-02 17:19:28 +0100458 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100459 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100460 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100461#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100462 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100463 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100464 case 256:
465 if( bits_is_sloppy )
466 return( MBEDTLS_ECP_DP_CURVE25519 );
467 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100468#endif
469#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100470 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100471 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100472#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100473 }
474 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100475
Paul Elliott8ff510a2020-06-02 17:19:28 +0100476 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100477 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100478 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100479#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100480 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100481 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100482#endif
483#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100484 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100485 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100486#endif
487#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100488 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100489 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100490#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100491 }
492 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200493 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100494
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100495 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100496 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200497}
John Durkop9814fa22020-11-04 12:28:15 -0800498#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800499 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
500 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
501 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200502
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200503static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
504 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200505{
506 /* Check that the bit size is acceptable for the key type */
507 switch( type )
508 {
509 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200510 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200511 case PSA_KEY_TYPE_DERIVE:
512 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100513#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200514 case PSA_KEY_TYPE_AES:
515 if( bits != 128 && bits != 192 && bits != 256 )
516 return( PSA_ERROR_INVALID_ARGUMENT );
517 break;
518#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100519#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200520 case PSA_KEY_TYPE_CAMELLIA:
521 if( bits != 128 && bits != 192 && bits != 256 )
522 return( PSA_ERROR_INVALID_ARGUMENT );
523 break;
524#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100525#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200526 case PSA_KEY_TYPE_DES:
527 if( bits != 64 && bits != 128 && bits != 192 )
528 return( PSA_ERROR_INVALID_ARGUMENT );
529 break;
530#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100531#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200532 case PSA_KEY_TYPE_ARC4:
533 if( bits < 8 || bits > 2048 )
534 return( PSA_ERROR_INVALID_ARGUMENT );
535 break;
536#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100537#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200538 case PSA_KEY_TYPE_CHACHA20:
539 if( bits != 256 )
540 return( PSA_ERROR_INVALID_ARGUMENT );
541 break;
542#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200543 default:
544 return( PSA_ERROR_NOT_SUPPORTED );
545 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200546 if( bits % 8 != 0 )
547 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200548
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200549 return( PSA_SUCCESS );
550}
551
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100552/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100553 *
Steven Cooremancd640932021-03-08 12:00:27 +0100554 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
555 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100556 *
557 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100558 * \param[in] key_type The key type of the key to be used with the
559 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100560 *
561 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100562 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100563 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100564 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100565 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100566MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100567 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100568 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100569{
Steven Cooremancd640932021-03-08 12:00:27 +0100570 if( PSA_ALG_IS_HMAC( algorithm ) )
571 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100572 if( key_type == PSA_KEY_TYPE_HMAC )
573 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100574 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100575
576 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100577 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100578 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
579 * key. */
580 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
581 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
582 {
583 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
584 * the block length (larger than 1) for block ciphers. */
585 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
586 return( PSA_SUCCESS );
587 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100588 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100589
590 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100591}
592
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200593psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
594 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200595{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100596 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200597 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200598
Ronald Cronea0f8a62020-11-25 17:52:23 +0100599 slot->key.data = mbedtls_calloc( 1, buffer_length );
600 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200601 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200602
Ronald Cronea0f8a62020-11-25 17:52:23 +0100603 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200604 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200605}
606
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200607psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
608 const uint8_t* data,
609 size_t data_length )
610{
611 psa_status_t status = psa_allocate_buffer_to_slot( slot,
612 data_length );
613 if( status != PSA_SUCCESS )
614 return( status );
615
Ronald Cronea0f8a62020-11-25 17:52:23 +0100616 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200617 return( PSA_SUCCESS );
618}
619
Ronald Crona0fe59f2020-11-29 11:14:53 +0100620psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100621 const psa_key_attributes_t *attributes,
622 const uint8_t *data, size_t data_length,
623 uint8_t *key_buffer, size_t key_buffer_size,
624 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100625{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100626 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
627 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100628
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200629 /* zero-length keys are never supported. */
630 if( data_length == 0 )
631 return( PSA_ERROR_NOT_SUPPORTED );
632
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100633 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100634 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200636
Steven Cooreman75b74362020-07-28 14:30:13 +0200637 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
638 if( data_length > SIZE_MAX / 8 )
639 return( PSA_ERROR_NOT_SUPPORTED );
640
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200641 /* Enforce a size limit, and in particular ensure that the bit
642 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100643 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200644 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200645
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100646 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200647 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200648 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200649
Ronald Crondd04d422020-11-28 15:14:42 +0100650 /* Copy the key material. */
651 memcpy( key_buffer, data, data_length );
652 *key_buffer_length = data_length;
653 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200654
Steven Cooreman40120f62020-10-29 11:42:22 +0100655 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100656 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100657 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200658 {
John Durkop9814fa22020-11-04 12:28:15 -0800659#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
660 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100661 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200662 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100663 return( mbedtls_psa_ecp_import_key( attributes,
664 data, data_length,
665 key_buffer, key_buffer_size,
666 key_buffer_length,
667 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100668 }
John Durkop9814fa22020-11-04 12:28:15 -0800669#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
670 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700671#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
672 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100673 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200674 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100675 return( mbedtls_psa_rsa_import_key( attributes,
676 data, data_length,
677 key_buffer, key_buffer_size,
678 key_buffer_length,
679 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200680 }
John Durkop9814fa22020-11-04 12:28:15 -0800681#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
682 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100684
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100685 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100686}
687
Gilles Peskinef603c712019-01-19 13:40:11 +0100688/** Calculate the intersection of two algorithm usage policies.
689 *
690 * Return 0 (which allows no operation) on incompatibility.
691 */
692static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100693 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100694 psa_algorithm_t alg1,
695 psa_algorithm_t alg2 )
696{
Gilles Peskine549ea862019-05-22 11:45:59 +0200697 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100698 if( alg1 == alg2 )
699 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 /* If the policies are from the same hash-and-sign family, check
701 * if one is a wildcard. If so the other has the specific algorithm. */
702 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
703 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
704 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100705 {
Steven Cooreman03488022021-02-18 12:07:20 +0100706 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
707 return( alg2 );
708 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
709 return( alg1 );
710 }
711 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100712 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100713 * restrictive tag length. */
714 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
715 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
716 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
717 {
718 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
719 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100720 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100721
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100722 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100723 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
724 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100725 {
Steven Cooremancd640932021-03-08 12:00:27 +0100726 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
727 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
729 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100730 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100731 ( alg1_len <= alg2_len ) )
732 {
733 return( alg2 );
734 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100735 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100736 ( alg2_len <= alg1_len ) )
737 {
738 return( alg1 );
739 }
740 }
741 /* If the policies are from the same MAC family, check whether one
742 * of them is a minimum-MAC-length policy. Calculate the most
743 * restrictive tag length. */
744 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
745 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
746 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
747 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100748 /* Validate the combination of key type and algorithm. Since the base
749 * algorithm of alg1 and alg2 are the same, we only need this once. */
750 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100751 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100752
Steven Cooreman31a876d2021-03-03 20:47:40 +0100753 /* Get the (exact or at-least) output lengths for both sides of the
754 * requested intersection. None of the currently supported algorithms
755 * have an output length dependent on the actual key size, so setting it
756 * to a bogus value of 0 is currently OK.
757 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100758 * Note that for at-least-this-length wildcard algorithms, the output
759 * length is set to the shortest allowed length, which allows us to
760 * calculate the most restrictive tag length for the intersection. */
761 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
762 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100763 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100764
Steven Cooremana1d83222021-02-25 10:20:29 +0100765 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100766 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
767 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100768 {
Steven Cooremancd640932021-03-08 12:00:27 +0100769 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100770 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100771
772 /* If only one is an at-least-this-length policy, the intersection would
773 * be the other (fixed-length) policy as long as said fixed length is
774 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100775 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100776 {
Steven Cooremancd640932021-03-08 12:00:27 +0100777 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100778 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100779 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100780 {
Steven Cooremancd640932021-03-08 12:00:27 +0100781 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100782 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100783
Steven Cooremancd640932021-03-08 12:00:27 +0100784 /* If none of them are wildcards, check whether they define the same tag
785 * length. This is still possible here when one is default-length and
786 * the other specific-length. Ensure to always return the
787 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100788 if( alg1_len == alg2_len )
789 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100790 }
791 /* If the policies are incompatible, allow nothing. */
792 return( 0 );
793}
794
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795static int psa_key_algorithm_permits( psa_key_type_t key_type,
796 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200797 psa_algorithm_t requested_alg )
798{
Gilles Peskine549ea862019-05-22 11:45:59 +0200799 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200800 if( requested_alg == policy_alg )
801 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100802 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
803 * and requested_alg is the same hash-and-sign family with any hash,
804 * then requested_alg is compliant with policy_alg. */
805 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
806 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200807 {
Steven Cooreman03488022021-02-18 12:07:20 +0100808 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
809 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
810 }
811 /* If policy_alg is a wildcard AEAD algorithm of the same base as
812 * the requested algorithm, check the requested tag length to be
813 * equal-length or longer than the wildcard-specified length. */
814 if( PSA_ALG_IS_AEAD( policy_alg ) &&
815 PSA_ALG_IS_AEAD( requested_alg ) &&
816 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
817 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100818 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100819 {
820 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
821 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
822 }
Steven Cooremancd640932021-03-08 12:00:27 +0100823 /* If policy_alg is a MAC algorithm of the same base as the requested
824 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100825 if( PSA_ALG_IS_MAC( policy_alg ) &&
826 PSA_ALG_IS_MAC( requested_alg ) &&
827 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100828 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100829 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100830 /* Validate the combination of key type and algorithm. Since the policy
831 * and requested algorithms are the same, we only need this once. */
832 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100833 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100834
Steven Cooreman31a876d2021-03-03 20:47:40 +0100835 /* Get both the requested output length for the algorithm which is to be
836 * verified, and the default output length for the base algorithm.
837 * Note that none of the currently supported algorithms have an output
838 * length dependent on actual key size, so setting it to a bogus value
839 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100840 size_t requested_output_length = PSA_MAC_LENGTH(
841 key_type, 0, requested_alg );
842 size_t default_output_length = PSA_MAC_LENGTH(
843 key_type, 0,
844 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100845
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100846 /* If the policy is default-length, only allow an algorithm with
847 * a declared exact-length matching the default. */
848 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100849 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100850
851 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100852 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100853 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
854 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
855 {
856 return( 1 );
857 }
858
Steven Cooremancd640932021-03-08 12:00:27 +0100859 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
860 * check for the requested MAC length to be equal to or longer than the
861 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100862 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
863 {
864 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100865 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100866 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200867 }
Steven Cooremance48e852020-10-05 16:02:45 +0200868 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200869 * a key derivation with that key agreement should also be allowed. This
870 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200871 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
872 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
873 {
874 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
875 policy_alg );
876 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100877 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200878 return( 0 );
879}
880
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100881/** Test whether a policy permits an algorithm.
882 *
883 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100884 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100885 * \note This function requires providing the key type for which the policy is
886 * being validated, since some algorithm policy definitions (e.g. MAC)
887 * have different properties depending on what kind of cipher it is
888 * combined with.
889 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100890 * \retval PSA_SUCCESS When \p alg is a specific algorithm
891 * allowed by the \p policy.
892 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
893 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
894 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100895 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100896static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100897 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100898 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100899{
Steven Cooremand788fab2021-02-25 11:29:17 +0100900 /* '0' is not a valid algorithm */
901 if( alg == 0 )
902 return( PSA_ERROR_INVALID_ARGUMENT );
903
Steven Cooreman7e39f052021-02-23 14:18:32 +0100904 /* A requested algorithm cannot be a wildcard. */
905 if( PSA_ALG_IS_WILDCARD( alg ) )
906 return( PSA_ERROR_INVALID_ARGUMENT );
907
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100908 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
909 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910 return( PSA_SUCCESS );
911 else
912 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100913}
914
Gilles Peskinef603c712019-01-19 13:40:11 +0100915/** Restrict a key policy based on a constraint.
916 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100917 * \note This function requires providing the key type for which the policy is
918 * being restricted, since some algorithm policy definitions (e.g. MAC)
919 * have different properties depending on what kind of cipher it is
920 * combined with.
921 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100922 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100923 * \param[in,out] policy The policy to restrict.
924 * \param[in] constraint The policy constraint to apply.
925 *
926 * \retval #PSA_SUCCESS
927 * \c *policy contains the intersection of the original value of
928 * \c *policy and \c *constraint.
929 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100930 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100931 * \c *policy is unchanged.
932 */
933static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100934 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100935 psa_key_policy_t *policy,
936 const psa_key_policy_t *constraint )
937{
938 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100939 psa_key_policy_algorithm_intersection( key_type, policy->alg,
940 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200941 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100942 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
943 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100944 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
945 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200946 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
947 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100948 policy->usage &= constraint->usage;
949 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200950 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100951 return( PSA_SUCCESS );
952}
953
Ronald Cron5c522922020-11-14 16:35:34 +0100954/** Get the description of a key given its identifier and policy constraints
955 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200956 *
Ronald Cron5c522922020-11-14 16:35:34 +0100957 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100958 * nonzero, the key must allow operations with this algorithm. If \p alg is
959 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100960 *
Ronald Cron5c522922020-11-14 16:35:34 +0100961 * In case of a persistent key, the function loads the description of the key
962 * into a key slot if not already done.
963 *
964 * On success, the returned key slot is locked. It is the responsibility of
965 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200966 */
Ronald Cron5c522922020-11-14 16:35:34 +0100967static psa_status_t psa_get_and_lock_key_slot_with_policy(
968 mbedtls_svc_key_id_t key,
969 psa_key_slot_t **p_slot,
970 psa_key_usage_t usage,
971 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100972{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200973 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
974 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100975
Ronald Cron5c522922020-11-14 16:35:34 +0100976 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100977 if( status != PSA_SUCCESS )
978 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200979 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100980
981 /* Enforce that usage policy for the key slot contains all the flags
982 * required by the usage parameter. There is one exception: public
983 * keys can always be exported, so we treat public key objects as
984 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200985 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100986 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987
Gilles Peskine8e338702019-07-30 20:06:31 +0200988 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100989 {
990 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200991 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100992 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100993
994 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100995 if( alg != 0 )
996 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100997 status = psa_key_policy_permits( &slot->attr.policy,
998 slot->attr.type,
999 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001000 if( status != PSA_SUCCESS )
1001 goto error;
1002 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001003
Darryl Green06fd18d2018-07-16 11:21:11 +01001004 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001005
1006error:
1007 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001008 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001009
1010 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001011}
Darryl Green940d72c2018-07-13 13:18:51 +01001012
Ronald Cron5c522922020-11-14 16:35:34 +01001013/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001014 *
1015 * A transparent key is a key for which the key material is directly
1016 * available, as opposed to a key in a secure element.
1017 *
Ronald Cron5c522922020-11-14 16:35:34 +01001018 * This is a temporary function to use instead of
1019 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1020 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001021 *
Ronald Cron5c522922020-11-14 16:35:34 +01001022 * On success, the returned key slot is locked. It is the responsibility of the
1023 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001024 */
1025#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001026static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1027 mbedtls_svc_key_id_t key,
1028 psa_key_slot_t **p_slot,
1029 psa_key_usage_t usage,
1030 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001031{
Ronald Cron5c522922020-11-14 16:35:34 +01001032 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1033 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001034 if( status != PSA_SUCCESS )
1035 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001036
Gilles Peskineadad8132019-07-25 11:31:23 +02001037 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001038 {
Ronald Cron5c522922020-11-14 16:35:34 +01001039 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001040 *p_slot = NULL;
1041 return( PSA_ERROR_NOT_SUPPORTED );
1042 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001043
Gilles Peskine28f8f302019-07-24 13:30:31 +02001044 return( PSA_SUCCESS );
1045}
1046#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1047/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001048#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1049 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001050#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1051
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001052psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001053{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001054 /* Data pointer will always be either a valid pointer or NULL in an
1055 * initialized slot, so we can just free it. */
1056 if( slot->key.data != NULL )
1057 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1058
1059 mbedtls_free( slot->key.data );
1060 slot->key.data = NULL;
1061 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001062
1063 return( PSA_SUCCESS );
1064}
1065
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001066/** Completely wipe a slot in memory, including its policy.
1067 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001068psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001069{
1070 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001071
1072 /*
1073 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001074 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001075 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1076 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001077 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001078 */
Ronald Cron5c522922020-11-14 16:35:34 +01001079 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001080 {
1081#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001082 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001083#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001084 status = PSA_ERROR_CORRUPTION_DETECTED;
1085 }
1086
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001087 /* Multipart operations may still be using the key. This is safe
1088 * because all multipart operation objects are independent from
1089 * the key slot: if they need to access the key after the setup
1090 * phase, they have a copy of the key. Note that this means that
1091 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001092 /* At this point, key material and other type-specific content has
1093 * been wiped. Clear remaining metadata. We can call memset and not
1094 * zeroize because the metadata is not particularly sensitive. */
1095 memset( slot, 0, sizeof( *slot ) );
1096 return( status );
1097}
1098
Ronald Croncf56a0a2020-08-04 09:51:30 +02001099psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001100{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001101 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 psa_status_t status; /* status of the last operation */
1103 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001104#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1105 psa_se_drv_table_entry_t *driver;
1106#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001107
Ronald Croncf56a0a2020-08-04 09:51:30 +02001108 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001109 return( PSA_SUCCESS );
1110
Ronald Cronf2911112020-10-29 17:51:10 +01001111 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001112 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001113 * key, this will load the key description from persistent memory if not
1114 * done yet. We cannot avoid this loading as without it we don't know if
1115 * the key is operated by an SE or not and this information is needed by
1116 * the current implementation.
1117 */
Ronald Cron5c522922020-11-14 16:35:34 +01001118 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001119 if( status != PSA_SUCCESS )
1120 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001121
Ronald Cronf2911112020-10-29 17:51:10 +01001122 /*
1123 * If the key slot containing the key description is under access by the
1124 * library (apart from the present access), the key cannot be destroyed
1125 * yet. For the time being, just return in error. Eventually (to be
1126 * implemented), the key should be destroyed when all accesses have
1127 * stopped.
1128 */
Ronald Cron5c522922020-11-14 16:35:34 +01001129 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001130 {
Ronald Cron5c522922020-11-14 16:35:34 +01001131 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001132 return( PSA_ERROR_GENERIC_ERROR );
1133 }
1134
Gilles Peskine251c7742021-04-21 22:32:05 +02001135 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1136 {
1137 /* Refuse the destruction of a read-only key (which may or may not work
1138 * if we attempt it, depending on whether the key is merely read-only
1139 * by policy or actually physically read-only).
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001140 * Just do the best we can, which is to wipe the copy in memory
1141 * (done in this function's cleanup code). */
1142 overall_status = PSA_ERROR_NOT_PERMITTED;
1143 goto exit;
Gilles Peskine251c7742021-04-21 22:32:05 +02001144 }
1145
Gilles Peskine354f7672019-07-12 23:46:38 +02001146#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001147 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001148 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001149 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001150 /* For a key in a secure element, we need to do three things:
1151 * remove the key file in internal storage, destroy the
1152 * key inside the secure element, and update the driver's
1153 * persistent data. Start a transaction that will encompass these
1154 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001155 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001156 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001157 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001158 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001159 status = psa_crypto_save_transaction( );
1160 if( status != PSA_SUCCESS )
1161 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001162 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001163 /* We should still try to destroy the key in the secure
1164 * element and the key metadata in storage. This is especially
1165 * important if the error is that the storage is full.
1166 * But how to do it exactly without risking an inconsistent
1167 * state after a reset?
1168 * https://github.com/ARMmbed/mbed-crypto/issues/215
1169 */
1170 overall_status = status;
1171 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001172 }
1173
Ronald Cronea0f8a62020-11-25 17:52:23 +01001174 status = psa_destroy_se_key( driver,
1175 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001176 if( overall_status == PSA_SUCCESS )
1177 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001178 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001179#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1180
Darryl Greend49a4992018-06-18 17:27:26 +01001181#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001182 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001183 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001184 status = psa_destroy_persistent_key( slot->attr.id );
1185 if( overall_status == PSA_SUCCESS )
1186 overall_status = status;
1187
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001188 /* TODO: other slots may have a copy of the same key. We should
1189 * invalidate them.
1190 * https://github.com/ARMmbed/mbed-crypto/issues/214
1191 */
Darryl Greend49a4992018-06-18 17:27:26 +01001192 }
1193#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001194
Gilles Peskinefc762652019-07-22 19:30:34 +02001195#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1196 if( driver != NULL )
1197 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001198 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001199 if( overall_status == PSA_SUCCESS )
1200 overall_status = status;
1201 status = psa_crypto_stop_transaction( );
1202 if( overall_status == PSA_SUCCESS )
1203 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001204 }
1205#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1206
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001207exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001208 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001209 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001210 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001211 overall_status = status;
1212 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001213}
1214
John Durkop07cc04a2020-11-16 22:08:34 -08001215#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001216 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001217static psa_status_t psa_get_rsa_public_exponent(
1218 const mbedtls_rsa_context *rsa,
1219 psa_key_attributes_t *attributes )
1220{
1221 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001223 uint8_t *buffer = NULL;
1224 size_t buflen;
1225 mbedtls_mpi_init( &mpi );
1226
1227 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1228 if( ret != 0 )
1229 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001230 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1231 {
1232 /* It's the default value, which is reported as an empty string,
1233 * so there's nothing to do. */
1234 goto exit;
1235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236
1237 buflen = mbedtls_mpi_size( &mpi );
1238 buffer = mbedtls_calloc( 1, buflen );
1239 if( buffer == NULL )
1240 {
1241 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1242 goto exit;
1243 }
1244 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1245 if( ret != 0 )
1246 goto exit;
1247 attributes->domain_parameters = buffer;
1248 attributes->domain_parameters_size = buflen;
1249
1250exit:
1251 mbedtls_mpi_free( &mpi );
1252 if( ret != 0 )
1253 mbedtls_free( buffer );
1254 return( mbedtls_to_psa_error( ret ) );
1255}
John Durkop07cc04a2020-11-16 22:08:34 -08001256#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001257 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001258
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001259/** Retrieve all the publicly-accessible attributes of a key.
1260 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001261psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001262 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001263{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001265 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001266 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001267
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001268 psa_reset_key_attributes( attributes );
1269
Ronald Cron5c522922020-11-14 16:35:34 +01001270 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001271 if( status != PSA_SUCCESS )
1272 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001273
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001274 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001275 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1276 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1277
1278#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1279 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001280 psa_set_key_slot_number( attributes,
1281 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001282#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001283
Gilles Peskine8e338702019-07-30 20:06:31 +02001284 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001285 {
John Durkop07cc04a2020-11-16 22:08:34 -08001286#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001287 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001288 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001289 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001290#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001291 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001292 * is not yet implemented.
1293 * https://github.com/ARMmbed/mbed-crypto/issues/216
1294 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001295 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001296 break;
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001298 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001299 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001300
Ronald Cron90857082020-11-25 14:58:33 +01001301 status = mbedtls_psa_rsa_load_representation(
1302 slot->attr.type,
1303 slot->key.data,
1304 slot->key.bytes,
1305 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001306 if( status != PSA_SUCCESS )
1307 break;
1308
Steven Cooremana2371e52020-07-28 14:30:39 +02001309 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001310 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001311 mbedtls_rsa_free( rsa );
1312 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001313 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001315#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001316 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001317 default:
1318 /* Nothing else to do. */
1319 break;
1320 }
1321
1322 if( status != PSA_SUCCESS )
1323 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001324
Ronald Cron5c522922020-11-14 16:35:34 +01001325 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001326
Ronald Cron5c522922020-11-14 16:35:34 +01001327 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001328}
1329
Gilles Peskinec8000c02019-08-02 20:15:51 +02001330#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1331psa_status_t psa_get_key_slot_number(
1332 const psa_key_attributes_t *attributes,
1333 psa_key_slot_number_t *slot_number )
1334{
1335 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1336 {
1337 *slot_number = attributes->slot_number;
1338 return( PSA_SUCCESS );
1339 }
1340 else
1341 return( PSA_ERROR_INVALID_ARGUMENT );
1342}
1343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1346 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001347 uint8_t *data,
1348 size_t data_size,
1349 size_t *data_length )
1350{
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001352 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 memcpy( data, key_buffer, key_buffer_size );
1354 memset( data + key_buffer_size, 0,
1355 data_size - key_buffer_size );
1356 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001357 return( PSA_SUCCESS );
1358}
1359
Ronald Cron7285cda2020-11-26 14:46:37 +01001360psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001361 const psa_key_attributes_t *attributes,
1362 const uint8_t *key_buffer, size_t key_buffer_size,
1363 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
1366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( key_type_is_raw_bytes( type ) ||
1368 PSA_KEY_TYPE_IS_RSA( type ) ||
1369 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370 {
1371 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 key_buffer, key_buffer_size,
1373 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374 }
1375 else
1376 {
1377 /* This shouldn't happen in the reference implementation, but
1378 it is valid for a special-purpose implementation to omit
1379 support for exporting certain key types. */
1380 return( PSA_ERROR_NOT_SUPPORTED );
1381 }
1382}
1383
1384psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1385 uint8_t *data,
1386 size_t data_size,
1387 size_t *data_length )
1388{
1389 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1390 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1391 psa_key_slot_t *slot;
1392
Ronald Crone907e552021-01-18 13:22:38 +01001393 /* Reject a zero-length output buffer now, since this can never be a
1394 * valid key representation. This way we know that data must be a valid
1395 * pointer and we can do things like memset(data, ..., data_size). */
1396 if( data_size == 0 )
1397 return( PSA_ERROR_BUFFER_TOO_SMALL );
1398
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399 /* Set the key to empty now, so that even when there are errors, we always
1400 * set data_length to a value between 0 and data_size. On error, setting
1401 * the key to empty is a good choice because an empty key representation is
1402 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001403 *data_length = 0;
1404
Ronald Cron9486f9d2020-11-26 13:36:23 +01001405 /* Export requires the EXPORT flag. There is an exception for public keys,
1406 * which don't require any flag, but
1407 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1408 */
1409 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1410 PSA_KEY_USAGE_EXPORT, 0 );
1411 if( status != PSA_SUCCESS )
1412 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001413
Ronald Crond18b5f82020-11-25 16:46:05 +01001414 psa_key_attributes_t attributes = {
1415 .core = slot->attr
1416 };
Ronald Cron67227982020-11-26 15:16:05 +01001417 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001418 slot->key.data, slot->key.bytes,
1419 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001420
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421 unlock_status = psa_unlock_key_slot( slot );
1422
1423 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1424}
1425
Ronald Cron7285cda2020-11-26 14:46:37 +01001426psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 const psa_key_attributes_t *attributes,
1428 const uint8_t *key_buffer,
1429 size_t key_buffer_size,
1430 uint8_t *data,
1431 size_t data_size,
1432 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433{
Ronald Crond18b5f82020-11-25 16:46:05 +01001434 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001435
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001437 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001438 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001439 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001440 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001441 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 key_buffer, key_buffer_size,
1443 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001444 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001445
Ronald Crond18b5f82020-11-25 16:46:05 +01001446 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001447 {
John Durkop0e005192020-10-31 22:06:54 -07001448#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1449 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001450 return( mbedtls_psa_rsa_export_public_key( attributes,
1451 key_buffer,
1452 key_buffer_size,
1453 data,
1454 data_size,
1455 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001456#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001457 /* We don't know how to convert a private RSA key to public. */
1458 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001459#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1460 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001461 }
1462 else
Moran Pekera998bc62018-04-16 18:16:20 +03001463 {
John Durkop6ba40d12020-11-10 08:50:04 -08001464#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1465 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001466 return( mbedtls_psa_ecp_export_public_key( attributes,
1467 key_buffer,
1468 key_buffer_size,
1469 data,
1470 data_size,
1471 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001472#else
1473 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001474 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001475#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1476 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001477 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001479 else
1480 {
1481 /* This shouldn't happen in the reference implementation, but
1482 it is valid for a special-purpose implementation to omit
1483 support for exporting certain key types. */
1484 return( PSA_ERROR_NOT_SUPPORTED );
1485 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001486}
Ronald Crond18b5f82020-11-25 16:46:05 +01001487
Ronald Croncf56a0a2020-08-04 09:51:30 +02001488psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001489 uint8_t *data,
1490 size_t data_size,
1491 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001492{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001494 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001495 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001496
Ronald Crone907e552021-01-18 13:22:38 +01001497 /* Reject a zero-length output buffer now, since this can never be a
1498 * valid key representation. This way we know that data must be a valid
1499 * pointer and we can do things like memset(data, ..., data_size). */
1500 if( data_size == 0 )
1501 return( PSA_ERROR_BUFFER_TOO_SMALL );
1502
Darryl Greendd8fb772018-11-07 16:00:44 +00001503 /* Set the key to empty now, so that even when there are errors, we always
1504 * set data_length to a value between 0 and data_size. On error, setting
1505 * the key to empty is a good choice because an empty key representation is
1506 * unlikely to be accepted anywhere. */
1507 *data_length = 0;
1508
1509 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001510 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001511 if( status != PSA_SUCCESS )
1512 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001513
Ronald Cron9486f9d2020-11-26 13:36:23 +01001514 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1515 {
1516 status = PSA_ERROR_INVALID_ARGUMENT;
1517 goto exit;
1518 }
1519
Ronald Crond18b5f82020-11-25 16:46:05 +01001520 psa_key_attributes_t attributes = {
1521 .core = slot->attr
1522 };
Ronald Cron67227982020-11-26 15:16:05 +01001523 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001524 &attributes, slot->key.data, slot->key.bytes,
1525 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001526
1527exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001528 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001529
Ronald Cron5c522922020-11-14 16:35:34 +01001530 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001531}
1532
Gilles Peskine91e8c332019-08-02 19:19:39 +02001533#if defined(static_assert)
1534static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1535 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001536static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001537 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001538static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001539 "One or more key attribute flag is listed as both internal-only and external-only" );
1540#endif
1541
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542/** Validate that a key policy is internally well-formed.
1543 *
1544 * This function only rejects invalid policies. It does not validate the
1545 * consistency of the policy with respect to other attributes of the key
1546 * such as the key type.
1547 */
1548static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001549{
1550 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001551 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 PSA_KEY_USAGE_ENCRYPT |
1553 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arme8efa392021-04-14 21:14:28 +02001554 PSA_KEY_USAGE_SIGN_MESSAGE |
1555 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001556 PSA_KEY_USAGE_SIGN_HASH |
1557 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001558 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1559 return( PSA_ERROR_INVALID_ARGUMENT );
1560
Gilles Peskine4747d192019-04-17 15:05:45 +02001561 return( PSA_SUCCESS );
1562}
1563
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001564/** Validate the internal consistency of key attributes.
1565 *
1566 * This function only rejects invalid attribute values. If does not
1567 * validate the consistency of the attributes with any key data that may
1568 * be involved in the creation of the key.
1569 *
1570 * Call this function early in the key creation process.
1571 *
1572 * \param[in] attributes Key attributes for the new key.
1573 * \param[out] p_drv On any return, the driver for the key, if any.
1574 * NULL for a transparent key.
1575 *
1576 */
1577static psa_status_t psa_validate_key_attributes(
1578 const psa_key_attributes_t *attributes,
1579 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001580{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001581 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001582 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001583 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001584
Ronald Cron54b90082020-10-29 15:26:43 +01001585 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001586 if( status != PSA_SUCCESS )
1587 return( status );
1588
Ronald Crond2ed4812020-07-17 16:11:30 +02001589 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001590 if( status != PSA_SUCCESS )
1591 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001592
Ronald Cron65f38a32020-10-23 17:11:13 +02001593 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1594 {
1595 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1596 return( PSA_ERROR_INVALID_ARGUMENT );
1597 }
1598 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001599 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001600 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1601 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001602 }
1603
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001604 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001605 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001606 return( status );
1607
1608 /* Refuse to create overly large keys.
1609 * Note that this doesn't trigger on import if the attributes don't
1610 * explicitly specify a size (so psa_get_key_bits returns 0), so
1611 * psa_import_key() needs its own checks. */
1612 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1613 return( PSA_ERROR_NOT_SUPPORTED );
1614
Gilles Peskine91e8c332019-08-02 19:19:39 +02001615 /* Reject invalid flags. These should not be reachable through the API. */
1616 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1617 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1618 return( PSA_ERROR_INVALID_ARGUMENT );
1619
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001620 return( PSA_SUCCESS );
1621}
1622
Gilles Peskine4747d192019-04-17 15:05:45 +02001623/** Prepare a key slot to receive key material.
1624 *
1625 * This function allocates a key slot and sets its metadata.
1626 *
1627 * If this function fails, call psa_fail_key_creation().
1628 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001629 * This function is intended to be used as follows:
1630 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001631 * it with the specified attributes, and in case of a volatile key assign it
1632 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001633 * -# Populate the slot with the key material.
1634 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1635 * In case of failure at any step, stop the sequence and call
1636 * psa_fail_key_creation().
1637 *
Ronald Cron5c522922020-11-14 16:35:34 +01001638 * On success, the key slot is locked. It is the responsibility of the caller
1639 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001640 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001641 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001642 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001643 * \param[out] p_slot On success, a pointer to the prepared slot.
1644 * \param[out] p_drv On any return, the driver for the key, if any.
1645 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001646 *
1647 * \retval #PSA_SUCCESS
1648 * The key slot is ready to receive key material.
1649 * \return If this function fails, the key slot is an invalid state.
1650 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001651 */
1652static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001654 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001656 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001657{
1658 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001659 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001660 psa_key_slot_t *slot;
1661
Gilles Peskinedf179142019-07-15 22:02:14 +02001662 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001663 *p_drv = NULL;
1664
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001665 status = psa_validate_key_attributes( attributes, p_drv );
1666 if( status != PSA_SUCCESS )
1667 return( status );
1668
Ronald Cronc4d1b512020-07-31 11:26:37 +02001669 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001670 if( status != PSA_SUCCESS )
1671 return( status );
1672 slot = *p_slot;
1673
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001674 /* We're storing the declared bit-size of the key. It's up to each
1675 * creation mechanism to verify that this information is correct.
1676 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001677 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001678 * is optional (import, copy). In case of a volatile key, assign it the
1679 * volatile key identifier associated to the slot returned to contain its
1680 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001681
1682 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001683 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1684 {
1685#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1686 slot->attr.id = volatile_key_id;
1687#else
1688 slot->attr.id.key_id = volatile_key_id;
1689#endif
1690 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001691
Gilles Peskine91e8c332019-08-02 19:19:39 +02001692 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001693 * external-only flags, query `attributes`. Thanks to the check
1694 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001695 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001696 * may have set. */
1697 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001698
Gilles Peskinecbaff462019-07-12 23:46:04 +02001699#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001700 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001701 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001702 * create the key file in internal storage, create the
1703 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001704 * persistent data. This is done by starting a transaction that will
1705 * encompass these three actions.
1706 * For registering a volatile key, we just need to find an appropriate
1707 * slot number inside the SE. Since the key is designated volatile, creating
1708 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001709 /* The first thing to do is to find a slot number for the new key.
1710 * We save the slot number in persistent storage as part of the
1711 * transaction data. It will be needed to recover if the power
1712 * fails during the key creation process, to clean up on the secure
1713 * element side after restarting. Obtaining a slot number from the
1714 * secure element driver updates its persistent state, but we do not yet
1715 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001716 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001717 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001718 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001719 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001720 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001722 if( status != PSA_SUCCESS )
1723 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001724
1725 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001726 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001727 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1728 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001730 psa_crypto_transaction.key.id = slot->attr.id;
1731 status = psa_crypto_save_transaction( );
1732 if( status != PSA_SUCCESS )
1733 {
1734 (void) psa_crypto_stop_transaction( );
1735 return( status );
1736 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001737 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001738
1739 status = psa_copy_key_material_into_slot(
1740 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001741 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001742
1743 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1744 {
1745 /* Key registration only makes sense with a secure element. */
1746 return( PSA_ERROR_INVALID_ARGUMENT );
1747 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001748#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1749
Ronald Cronc4d1b512020-07-31 11:26:37 +02001750 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001751}
Gilles Peskine4747d192019-04-17 15:05:45 +02001752
1753/** Finalize the creation of a key once its key material has been set.
1754 *
1755 * This entails writing the key to persistent storage.
1756 *
1757 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001758 * See the documentation of psa_start_key_creation() for the intended use
1759 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001760 *
Ronald Cron5c522922020-11-14 16:35:34 +01001761 * If the finalization succeeds, the function unlocks the key slot (it was
1762 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1763 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001764 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001765 * \param[in,out] slot Pointer to the slot with key material.
1766 * \param[in] driver The secure element driver for the key,
1767 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001768 * \param[out] key On success, identifier of the key. Note that the
1769 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001770 *
1771 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001772 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001773 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1774 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1775 * \retval #PSA_ERROR_ALREADY_EXISTS
1776 * \retval #PSA_ERROR_DATA_INVALID
1777 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001778 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001779 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 * \return If this function fails, the key slot is an invalid state.
1781 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001782 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001783static psa_status_t psa_finish_key_creation(
1784 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001785 psa_se_drv_table_entry_t *driver,
1786 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001787{
1788 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001789 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001791
1792#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001793 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001795#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1796 if( driver != NULL )
1797 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001798 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001799 psa_key_slot_number_t slot_number =
1800 psa_key_slot_get_slot_number( slot ) ;
1801
Gilles Peskineb46bef22019-07-30 21:32:04 +02001802#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001803 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001804 sizeof( data.slot_number ),
1805 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001806#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001807 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001808 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001809 (uint8_t*) &data,
1810 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001811 }
1812 else
1813#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1814 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001815 /* Key material is saved in export representation in the slot, so
1816 * just pass the slot buffer for storage. */
1817 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001818 slot->key.data,
1819 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001820 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001821 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001822#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1823
Gilles Peskinecbaff462019-07-12 23:46:04 +02001824#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001825 /* Finish the transaction for a key creation. This does not
1826 * happen when registering an existing key. Detect this case
1827 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828 * creation of a persistent key in a secure element requires a transaction,
1829 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001830 if( driver != NULL &&
1831 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001832 {
1833 status = psa_save_se_persistent_data( driver );
1834 if( status != PSA_SUCCESS )
1835 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001836 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001837 return( status );
1838 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001839 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001840 }
1841#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1842
Ronald Cron50972942020-11-14 11:28:25 +01001843 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001844 {
1845 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001846 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001847 if( status != PSA_SUCCESS )
1848 *key = MBEDTLS_SVC_KEY_ID_INIT;
1849 }
Ronald Cron50972942020-11-14 11:28:25 +01001850
Gilles Peskine4747d192019-04-17 15:05:45 +02001851 return( status );
1852}
1853
1854/** Abort the creation of a key.
1855 *
1856 * You may call this function after calling psa_start_key_creation(),
1857 * or after psa_finish_key_creation() fails. In other circumstances, this
1858 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001859 * See the documentation of psa_start_key_creation() for the intended use
1860 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001861 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001862 * \param[in,out] slot Pointer to the slot with key material.
1863 * \param[in] driver The secure element driver for the key,
1864 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001865 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001866static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001867 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001868{
Gilles Peskine011e4282019-06-26 18:34:38 +02001869 (void) driver;
1870
Gilles Peskine4747d192019-04-17 15:05:45 +02001871 if( slot == NULL )
1872 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001873
1874#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001875 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001876 * element, and the failure happened later (when saving metadata
1877 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001878 * element.
1879 * https://github.com/ARMmbed/mbed-crypto/issues/217
1880 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001881
Gilles Peskined7729582019-08-05 15:55:54 +02001882 /* Abort the ongoing transaction if any (there may not be one if
1883 * the creation process failed before starting one, or if the
1884 * key creation is a registration of a key in a secure element).
1885 * Earlier functions must already have done what it takes to undo any
1886 * partial creation. All that's left is to update the transaction data
1887 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001888 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001889#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1890
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 psa_wipe_key_slot( slot );
1892}
1893
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001894/** Validate optional attributes during key creation.
1895 *
1896 * Some key attributes are optional during key creation. If they are
1897 * specified in the attributes structure, check that they are consistent
1898 * with the data in the slot.
1899 *
1900 * This function should be called near the end of key creation, after
1901 * the slot in memory is fully populated but before saving persistent data.
1902 */
1903static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001904 const psa_key_slot_t *slot,
1905 const psa_key_attributes_t *attributes )
1906{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001907 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001909 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 return( PSA_ERROR_INVALID_ARGUMENT );
1911 }
1912
1913 if( attributes->domain_parameters_size != 0 )
1914 {
John Durkop0e005192020-10-31 22:06:54 -07001915#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1916 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001917 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001918 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001919 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001920 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001922
Ronald Cron90857082020-11-25 14:58:33 +01001923 psa_status_t status = mbedtls_psa_rsa_load_representation(
1924 slot->attr.type,
1925 slot->key.data,
1926 slot->key.bytes,
1927 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001928 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001929 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001930
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931 mbedtls_mpi_init( &actual );
1932 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001933 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001935 mbedtls_rsa_free( rsa );
1936 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937 if( ret != 0 )
1938 goto rsa_exit;
1939 ret = mbedtls_mpi_read_binary( &required,
1940 attributes->domain_parameters,
1941 attributes->domain_parameters_size );
1942 if( ret != 0 )
1943 goto rsa_exit;
1944 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1945 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1946 rsa_exit:
1947 mbedtls_mpi_free( &actual );
1948 mbedtls_mpi_free( &required );
1949 if( ret != 0)
1950 return( mbedtls_to_psa_error( ret ) );
1951 }
1952 else
John Durkop9814fa22020-11-04 12:28:15 -08001953#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1954 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955 {
1956 return( PSA_ERROR_INVALID_ARGUMENT );
1957 }
1958 }
1959
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001960 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001961 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001962 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001963 return( PSA_ERROR_INVALID_ARGUMENT );
1964 }
1965
1966 return( PSA_SUCCESS );
1967}
1968
Gilles Peskine4747d192019-04-17 15:05:45 +02001969psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001971 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001972 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001973{
1974 psa_status_t status;
1975 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001976 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001977 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001978
Ronald Cron81709fc2020-11-14 12:10:32 +01001979 *key = MBEDTLS_SVC_KEY_ID_INIT;
1980
Gilles Peskine0f84d622019-09-12 19:03:13 +02001981 /* Reject zero-length symmetric keys (including raw data key objects).
1982 * This also rejects any key which might be encoded as an empty string,
1983 * which is never valid. */
1984 if( data_length == 0 )
1985 return( PSA_ERROR_INVALID_ARGUMENT );
1986
Gilles Peskinedf179142019-07-15 22:02:14 +02001987 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001988 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001989 if( status != PSA_SUCCESS )
1990 goto exit;
1991
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001992 /* In the case of a transparent key or an opaque key stored in local
1993 * storage (thus not in the case of generating a key in a secure element
1994 * or cryptoprocessor with storage), we have to allocate a buffer to
1995 * hold the generated key material. */
1996 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001997 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001998 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001999 if( status != PSA_SUCCESS )
2000 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002001 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002002
2003 bits = slot->attr.bits;
2004 status = psa_driver_wrapper_import_key( attributes,
2005 data, data_length,
2006 slot->key.data,
2007 slot->key.bytes,
2008 &slot->key.bytes, &bits );
2009 if( status != PSA_SUCCESS )
2010 goto exit;
2011
2012 if( slot->attr.bits == 0 )
2013 slot->attr.bits = (psa_key_bits_t) bits;
2014 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002015 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002016 status = PSA_ERROR_INVALID_ARGUMENT;
2017 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002018 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002019
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002020 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002021 if( status != PSA_SUCCESS )
2022 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023
Ronald Cron81709fc2020-11-14 12:10:32 +01002024 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002026 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002027 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002028
Gilles Peskine4747d192019-04-17 15:05:45 +02002029 return( status );
2030}
2031
Gilles Peskined7729582019-08-05 15:55:54 +02002032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2033psa_status_t mbedtls_psa_register_se_key(
2034 const psa_key_attributes_t *attributes )
2035{
2036 psa_status_t status;
2037 psa_key_slot_t *slot = NULL;
2038 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002039 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002040
2041 /* Leaving attributes unspecified is not currently supported.
2042 * It could make sense to query the key type and size from the
2043 * secure element, but not all secure elements support this
2044 * and the driver HAL doesn't currently support it. */
2045 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2046 return( PSA_ERROR_NOT_SUPPORTED );
2047 if( psa_get_key_bits( attributes ) == 0 )
2048 return( PSA_ERROR_NOT_SUPPORTED );
2049
2050 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002051 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002052 if( status != PSA_SUCCESS )
2053 goto exit;
2054
Ronald Cron81709fc2020-11-14 12:10:32 +01002055 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002056
2057exit:
2058 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002059 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002060
Gilles Peskined7729582019-08-05 15:55:54 +02002061 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002062 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002063 return( status );
2064}
2065#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2066
Gilles Peskinef603c712019-01-19 13:40:11 +01002067static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002069{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002070 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002071 source->key.data,
2072 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002073 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002074 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002075
Steven Cooreman398aee52020-10-13 14:35:45 +02002076 target->attr.type = source->attr.type;
2077 target->attr.bits = source->attr.bits;
2078
2079 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002080}
2081
Ronald Croncf56a0a2020-08-04 09:51:30 +02002082psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002083 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002084 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002085{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002087 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002088 psa_key_slot_t *source_slot = NULL;
2089 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002090 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002091 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002092
Ronald Cron81709fc2020-11-14 12:10:32 +01002093 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2094
Ronald Cron5c522922020-11-14 16:35:34 +01002095 status = psa_get_and_lock_transparent_key_slot_with_policy(
2096 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002097 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002098 goto exit;
2099
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002100 status = psa_validate_optional_attributes( source_slot,
2101 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002102 if( status != PSA_SUCCESS )
2103 goto exit;
2104
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002105 status = psa_restrict_key_policy( source_slot->attr.type,
2106 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002107 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002108 if( status != PSA_SUCCESS )
2109 goto exit;
2110
Ronald Cron81709fc2020-11-14 12:10:32 +01002111 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2112 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002113 if( status != PSA_SUCCESS )
2114 goto exit;
2115
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002116#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2117 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002118 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002119 /* Copying to a secure element is not implemented yet. */
2120 status = PSA_ERROR_NOT_SUPPORTED;
2121 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002122 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002124
Ronald Cron6cc66312021-04-02 12:27:47 +02002125 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2126 {
2127 /*
2128 * Copying through an opaque driver is not implemented yet, consider
2129 * a lifetime with an external location as an invalid parameter for
2130 * now.
2131 */
2132 status = PSA_ERROR_INVALID_ARGUMENT;
2133 goto exit;
2134 }
2135
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002136 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002137 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002138 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002139
Ronald Cron81709fc2020-11-14 12:10:32 +01002140 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002141exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002142 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002143 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002144
Ronald Cron5c522922020-11-14 16:35:34 +01002145 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002146
Ronald Cron5c522922020-11-14 16:35:34 +01002147 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002148}
2149
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002150
2151
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002152/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002153/* Message digests */
2154/****************************************************************/
2155
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2157{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158 /* Aborting a non-active operation is allowed */
2159 if( operation->id == 0 )
2160 return( PSA_SUCCESS );
2161
2162 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2163 operation->id = 0;
2164
2165 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166}
2167
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002168psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002169 psa_algorithm_t alg )
2170{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002172
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002173 /* A context must be freshly initialized before it can be set up. */
2174 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002175 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002176 status = PSA_ERROR_BAD_STATE;
2177 goto exit;
2178 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002179
2180 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmandb861792021-06-24 16:17:43 +01002181 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002182 status = PSA_ERROR_INVALID_ARGUMENT;
2183 goto exit;
2184 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002185
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002186 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2187 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002188 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2189
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002190 status = psa_driver_wrapper_hash_setup( operation, alg );
2191
2192exit:
2193 if( status != PSA_SUCCESS )
Dave Rodgmandb861792021-06-24 16:17:43 +01002194 psa_hash_abort( operation );
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002195
2196 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197}
2198
2199psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2200 const uint8_t *input,
2201 size_t input_length )
2202{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002203 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2204
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002205 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002206 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002207 status = PSA_ERROR_BAD_STATE;
2208 goto exit;
2209 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002210
Steven Cooremanc8288352021-03-04 14:02:19 +01002211 /* Don't require hash implementations to behave correctly on a
2212 * zero-length input, which may have an invalid pointer. */
2213 if( input_length == 0 )
2214 return( PSA_SUCCESS );
2215
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002216 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2217
2218exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002219 if( status != PSA_SUCCESS )
2220 psa_hash_abort( operation );
2221
2222 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223}
2224
2225psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2226 uint8_t *hash,
2227 size_t hash_size,
2228 size_t *hash_length )
2229{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002230 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002231 if( operation->id == 0 )
2232 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233
Steven Cooreman1e582352021-02-18 17:24:37 +01002234 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002235 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002236 psa_hash_abort( operation );
2237 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002238}
2239
Gilles Peskine2d277862018-06-18 15:41:12 +02002240psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2241 const uint8_t *hash,
2242 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002243{
2244 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2245 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002246 psa_status_t status = psa_hash_finish(
2247 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002248 actual_hash, sizeof( actual_hash ),
2249 &actual_hash_length );
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002250
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002251 if( status != PSA_SUCCESS )
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002252 goto exit;
2253
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254 if( actual_hash_length != hash_length )
Dave Rodgmandb861792021-06-24 16:17:43 +01002255 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002256 status = PSA_ERROR_INVALID_SIGNATURE;
2257 goto exit;
2258 }
2259
Steven Cooremana2a1b802021-04-29 16:37:59 +02002260 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002261 status = PSA_ERROR_INVALID_SIGNATURE;
2262
2263exit:
2264 if( status != PSA_SUCCESS )
2265 psa_hash_abort(operation);
2266
2267 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002268}
2269
Gilles Peskine0a749c82019-11-28 19:33:58 +01002270psa_status_t psa_hash_compute( psa_algorithm_t alg,
2271 const uint8_t *input, size_t input_length,
2272 uint8_t *hash, size_t hash_size,
2273 size_t *hash_length )
2274{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002275 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002276 if( !PSA_ALG_IS_HASH( alg ) )
2277 return( PSA_ERROR_INVALID_ARGUMENT );
2278
Steven Cooreman1e582352021-02-18 17:24:37 +01002279 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2280 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002281}
2282
2283psa_status_t psa_hash_compare( psa_algorithm_t alg,
2284 const uint8_t *input, size_t input_length,
2285 const uint8_t *hash, size_t hash_length )
2286{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002287 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2288 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002289
2290 if( !PSA_ALG_IS_HASH( alg ) )
2291 return( PSA_ERROR_INVALID_ARGUMENT );
2292
Steven Cooreman1e582352021-02-18 17:24:37 +01002293 psa_status_t status = psa_driver_wrapper_hash_compute(
2294 alg, input, input_length,
2295 actual_hash, sizeof(actual_hash),
2296 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002297 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002298 return( status );
2299 if( actual_hash_length != hash_length )
2300 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002301 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002302 return( PSA_ERROR_INVALID_SIGNATURE );
2303 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002304}
2305
Gilles Peskineeb35d782019-01-22 17:56:16 +01002306psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2307 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002308{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002309 if( source_operation->id == 0 ||
2310 target_operation->id != 0 )
2311 {
2312 return( PSA_ERROR_BAD_STATE );
2313 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002314
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002315 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2316 target_operation );
2317 if( status != PSA_SUCCESS )
2318 psa_hash_abort( target_operation );
2319
2320 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002321}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002322
2323
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002324/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002325/* MAC */
2326/****************************************************************/
2327
Steven Cooreman07897832021-03-19 18:28:56 +01002328psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002329{
Steven Cooreman07897832021-03-19 18:28:56 +01002330 /* Aborting a non-active operation is allowed */
2331 if( operation->id == 0 )
2332 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002333
Steven Cooreman07897832021-03-19 18:28:56 +01002334 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002335 operation->mac_size = 0;
2336 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002337 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002338
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002339 return( status );
2340}
2341
Ronald Cron1c650a12021-06-17 16:33:22 +02002342static psa_status_t psa_mac_finalize_alg_and_key_validation(
2343 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002344 const psa_key_attributes_t *attributes,
2345 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondef68e72021-06-17 16:46:44 +02002348 psa_key_type_t key_type = psa_get_key_type( attributes );
2349 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002350
Ronald Cron48f875e2021-06-17 16:10:24 +02002351 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Crondef68e72021-06-17 16:46:44 +02002352 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman07897832021-03-19 18:28:56 +01002353
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002354 /* Validate the combination of key type and algorithm */
Ronald Crondef68e72021-06-17 16:46:44 +02002355 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002356 if( status != PSA_SUCCESS )
Ronald Crondef68e72021-06-17 16:46:44 +02002357 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002358
Steven Cooremana6474de2021-05-10 11:13:41 +02002359 /* Get the output length for the algorithm and key combination */
Ronald Crondef68e72021-06-17 16:46:44 +02002360 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002361
Ronald Crondef68e72021-06-17 16:46:44 +02002362 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002363 {
2364 /* A very short MAC is too short for security since it can be
2365 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2366 * so we make this our minimum, even though 32 bits is still
2367 * too small for security. */
Ronald Crondef68e72021-06-17 16:46:44 +02002368 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002369 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002370
Ronald Crondef68e72021-06-17 16:46:44 +02002371 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2372 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002373 {
2374 /* It's impossible to "truncate" to a larger length than the full length
2375 * of the algorithm. */
Ronald Crondef68e72021-06-17 16:46:44 +02002376 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002377 }
2378
Ronald Crondef68e72021-06-17 16:46:44 +02002379 return( PSA_SUCCESS );
Ronald Cron1c650a12021-06-17 16:33:22 +02002380}
2381
2382static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2383 mbedtls_svc_key_id_t key,
2384 psa_algorithm_t alg,
2385 int is_sign )
2386{
2387 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2388 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002389 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002390
2391 /* A context must be freshly initialized before it can be set up. */
2392 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002393 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002394 status = PSA_ERROR_BAD_STATE;
2395 goto exit;
2396 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002397
2398 status = psa_get_and_lock_key_slot_with_policy(
2399 key,
2400 &slot,
Mateusz Starzykdd55b252021-08-17 15:24:32 +02002401 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Cron1c650a12021-06-17 16:33:22 +02002402 alg );
2403 if( status != PSA_SUCCESS )
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002404 goto exit;
Ronald Cron1c650a12021-06-17 16:33:22 +02002405
2406 psa_key_attributes_t attributes = {
2407 .core = slot->attr
2408 };
2409
Ronald Crondef68e72021-06-17 16:46:44 +02002410 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2411 &operation->mac_size );
Ronald Cron1c650a12021-06-17 16:33:22 +02002412 if( status != PSA_SUCCESS )
2413 goto exit;
2414
2415 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002416 /* Dispatch the MAC setup call with validated input */
2417 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002418 {
Steven Cooreman07897832021-03-19 18:28:56 +01002419 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002420 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002421 slot->key.data,
2422 slot->key.bytes,
2423 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002424 }
2425 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002426 {
Steven Cooreman07897832021-03-19 18:28:56 +01002427 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002428 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002429 slot->key.data,
2430 slot->key.bytes,
2431 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002433
Gilles Peskinefbfac682018-07-08 20:51:54 +02002434exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002435 if( status != PSA_SUCCESS )
Steven Cooreman07897832021-03-19 18:28:56 +01002436 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002437
Ronald Cron5c522922020-11-14 16:35:34 +01002438 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002439
Ronald Cron5c522922020-11-14 16:35:34 +01002440 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441}
2442
Gilles Peskine89167cb2018-07-08 20:12:23 +02002443psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002444 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002445 psa_algorithm_t alg )
2446{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002447 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002448}
2449
2450psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002451 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002452 psa_algorithm_t alg )
2453{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002454 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002455}
2456
Steven Cooreman11743f92021-03-19 18:38:46 +01002457psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002458 const uint8_t *input,
2459 size_t input_length )
2460{
Steven Cooreman11743f92021-03-19 18:38:46 +01002461 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002462 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002463
Steven Cooreman11743f92021-03-19 18:38:46 +01002464 /* Don't require hash implementations to behave correctly on a
2465 * zero-length input, which may have an invalid pointer. */
2466 if( input_length == 0 )
2467 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002468
Steven Cooreman11743f92021-03-19 18:38:46 +01002469 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2470 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002471 if( status != PSA_SUCCESS )
Steven Cooreman11743f92021-03-19 18:38:46 +01002472 psa_mac_abort( operation );
2473
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002474 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002475}
2476
Steven Cooreman87885df2021-03-19 19:04:39 +01002477psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002478 uint8_t *mac,
2479 size_t mac_size,
2480 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002481{
Steven Cooreman87885df2021-03-19 19:04:39 +01002482 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2483 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002484
Steven Cooreman87885df2021-03-19 19:04:39 +01002485 if( operation->id == 0 )
Dave Rodgmand73e1b02021-06-24 16:19:08 +01002486 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002487 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002488 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002489 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002490
Steven Cooreman15f0d922021-05-07 14:14:37 +02002491 if( ! operation->is_sign )
Dave Rodgmandb861792021-06-24 16:17:43 +01002492 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002493 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002494 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002495 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002496
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002497 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2498 * once all the error checks are done. */
2499 if( operation->mac_size == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002500 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002501 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002502 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002503 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002504
2505 if( mac_size < operation->mac_size )
Dave Rodgmandb861792021-06-24 16:17:43 +01002506 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002507 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002508 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002509 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002510
Steven Cooreman87885df2021-03-19 19:04:39 +01002511 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman15f0d922021-05-07 14:14:37 +02002512 mac, operation->mac_size,
2513 mac_length );
2514
Dave Rodgman478ab542021-06-25 09:09:02 +01002515exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002516 /* In case of success, set the potential excess room in the output buffer
2517 * to an invalid value, to avoid potentially leaking a longer MAC.
2518 * In case of error, set the output length and content to a safe default,
2519 * such that in case the caller misses an error check, the output would be
2520 * an unachievable MAC.
2521 */
2522 if( status != PSA_SUCCESS )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002523 {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002524 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002525 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002526 }
mohammad16036df908f2018-04-02 08:34:15 -07002527
Ronald Cron882eb782021-06-18 13:05:48 +02002528 if( mac_size > operation->mac_size )
2529 memset( &mac[operation->mac_size], '!',
2530 mac_size - operation->mac_size );
2531
Steven Cooreman87885df2021-03-19 19:04:39 +01002532 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002533
Steven Cooreman87885df2021-03-19 19:04:39 +01002534 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002535}
2536
Steven Cooreman87885df2021-03-19 19:04:39 +01002537psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002538 const uint8_t *mac,
2539 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002540{
Steven Cooreman87885df2021-03-19 19:04:39 +01002541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2542 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002543
Steven Cooreman87885df2021-03-19 19:04:39 +01002544 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002545 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002546 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002547 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002548 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002549
Steven Cooreman15f0d922021-05-07 14:14:37 +02002550 if( operation->is_sign )
Dave Rodgmandb861792021-06-24 16:17:43 +01002551 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002552 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002553 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002554 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002555
2556 if( operation->mac_size != mac_length )
2557 {
2558 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002559 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002560 }
2561
Steven Cooreman87885df2021-03-19 19:04:39 +01002562 status = psa_driver_wrapper_mac_verify_finish( operation,
2563 mac, mac_length );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002564
Dave Rodgman478ab542021-06-25 09:09:02 +01002565exit:
Steven Cooreman87885df2021-03-19 19:04:39 +01002566 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002567
Steven Cooreman87885df2021-03-19 19:04:39 +01002568 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002569}
2570
Ronald Cronef0d8f12021-06-18 14:23:33 +02002571static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2572 psa_algorithm_t alg,
2573 const uint8_t *input,
2574 size_t input_length,
2575 uint8_t *mac,
2576 size_t mac_size,
2577 size_t *mac_length,
2578 int is_sign )
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002579{
2580 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002581 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2582 psa_key_slot_t *slot;
2583 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002584
Ronald Crondbb86462021-06-17 17:17:20 +02002585 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykdd55b252021-08-17 15:24:32 +02002586 key,
2587 &slot,
2588 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Cronef0d8f12021-06-18 14:23:33 +02002589 alg );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002590 if( status != PSA_SUCCESS )
2591 goto exit;
2592
Ronald Crondbb86462021-06-17 17:17:20 +02002593 psa_key_attributes_t attributes = {
2594 .core = slot->attr
2595 };
2596
2597 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2598 &operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002599 if( status != PSA_SUCCESS )
2600 goto exit;
2601
Ronald Crondbb86462021-06-17 17:17:20 +02002602 if( mac_size < operation_mac_size )
2603 {
2604 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002605 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002606 }
2607
2608 status = psa_driver_wrapper_mac_compute(
2609 &attributes,
2610 slot->key.data, slot->key.bytes,
2611 alg,
2612 input, input_length,
2613 mac, operation_mac_size, mac_length );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002614
2615exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002616 /* In case of success, set the potential excess room in the output buffer
2617 * to an invalid value, to avoid potentially leaking a longer MAC.
2618 * In case of error, set the output length and content to a safe default,
2619 * such that in case the caller misses an error check, the output would be
2620 * an unachievable MAC.
2621 */
2622 if( status != PSA_SUCCESS )
Ronald Crondbb86462021-06-17 17:17:20 +02002623 {
Ronald Crondbb86462021-06-17 17:17:20 +02002624 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002625 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002626 }
Ronald Cron882eb782021-06-18 13:05:48 +02002627 if( mac_size > operation_mac_size )
2628 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002629
Ronald Crondbb86462021-06-17 17:17:20 +02002630 unlock_status = psa_unlock_key_slot( slot );
2631
2632 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002633}
2634
Ronald Cronef0d8f12021-06-18 14:23:33 +02002635psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2636 psa_algorithm_t alg,
2637 const uint8_t *input,
2638 size_t input_length,
2639 uint8_t *mac,
2640 size_t mac_size,
2641 size_t *mac_length)
2642{
2643 return( psa_mac_compute_internal( key, alg,
2644 input, input_length,
2645 mac, mac_size, mac_length, 1 ) );
2646}
2647
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002648psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2649 psa_algorithm_t alg,
2650 const uint8_t *input,
2651 size_t input_length,
2652 const uint8_t *mac,
2653 size_t mac_length)
2654{
2655 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002656 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2657 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002658
Ronald Cron4ed83682021-06-18 14:51:29 +02002659 status = psa_mac_compute_internal( key, alg,
2660 input, input_length,
2661 actual_mac, sizeof( actual_mac ),
2662 &actual_mac_length, 0 );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002663 if( status != PSA_SUCCESS )
2664 goto exit;
2665
Ronald Cron4ed83682021-06-18 14:51:29 +02002666 if( mac_length != actual_mac_length )
2667 {
2668 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002669 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002670 }
2671 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2672 {
2673 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002674 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002675 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002676
2677exit:
Ronald Cron4ed83682021-06-18 14:51:29 +02002678 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002679
2680 return ( status );
2681}
Gilles Peskine20035e32018-02-03 22:44:14 +01002682
Gilles Peskine20035e32018-02-03 22:44:14 +01002683/****************************************************************/
2684/* Asymmetric cryptography */
2685/****************************************************************/
2686
gabor-mezei-armc9795782021-05-12 11:03:09 +02002687static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm56980482021-05-05 13:56:27 +02002688 psa_algorithm_t alg )
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002689{
gabor-mezei-armc9795782021-05-12 11:03:09 +02002690 if( input_is_message )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002691 {
2692 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2693 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002694
gabor-mezei-arm56980482021-05-05 13:56:27 +02002695 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2696 {
2697 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2698 return( PSA_ERROR_INVALID_ARGUMENT );
2699 }
2700 }
2701 else
2702 {
2703 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2704 return( PSA_ERROR_INVALID_ARGUMENT );
2705 }
2706
2707 return( PSA_SUCCESS );
2708}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002709
2710static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002711 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002712 psa_algorithm_t alg,
2713 const uint8_t * input,
2714 size_t input_length,
2715 uint8_t * signature,
2716 size_t signature_size,
2717 size_t * signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002718{
2719 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2720 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2721 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002722
2723 *signature_length = 0;
2724
gabor-mezei-armc9795782021-05-12 11:03:09 +02002725 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002726 if( status != PSA_SUCCESS )
2727 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002728
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002729 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002730 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002731 * buffer can in principle be empty since it doesn't actually have
2732 * to be a hash.) */
2733 if( signature_size == 0 )
2734 return( PSA_ERROR_BUFFER_TOO_SMALL );
2735
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002736 status = psa_get_and_lock_key_slot_with_policy(
2737 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002738 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2739 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002740 alg );
2741
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002742 if( status != PSA_SUCCESS )
2743 goto exit;
2744
2745 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2746 {
2747 status = PSA_ERROR_INVALID_ARGUMENT;
2748 goto exit;
2749 }
2750
2751 psa_key_attributes_t attributes = {
2752 .core = slot->attr
2753 };
2754
gabor-mezei-armc9795782021-05-12 11:03:09 +02002755 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002756 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002757 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002758 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002759 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002760 signature, signature_size, signature_length );
2761 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002762 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002763 {
2764
2765 status = psa_driver_wrapper_sign_hash(
2766 &attributes, slot->key.data, slot->key.bytes,
2767 alg, input, input_length,
2768 signature, signature_size, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002769 }
2770
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002771
2772exit:
2773 /* Fill the unused part of the output buffer (the whole buffer on error,
2774 * the trailing part on success) with something that isn't a valid signature
2775 * (barring an attack on the signature and deliberately-crafted input),
2776 * in case the caller doesn't check the return status properly. */
2777 if( status == PSA_SUCCESS )
2778 memset( signature + *signature_length, '!',
2779 signature_size - *signature_length );
2780 else
2781 memset( signature, '!', signature_size );
2782 /* If signature_size is 0 then we have nothing to do. We must not call
2783 * memset because signature may be NULL in this case. */
2784
2785 unlock_status = psa_unlock_key_slot( slot );
2786
2787 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2788}
2789
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002790static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002791 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002792 psa_algorithm_t alg,
2793 const uint8_t * input,
2794 size_t input_length,
2795 const uint8_t * signature,
2796 size_t signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002797{
2798 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2799 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2800 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002801
gabor-mezei-armc9795782021-05-12 11:03:09 +02002802 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002803 if( status != PSA_SUCCESS )
2804 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002805
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002806 status = psa_get_and_lock_key_slot_with_policy(
2807 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002808 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2809 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002810 alg );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002811
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002812 if( status != PSA_SUCCESS )
2813 return( status );
2814
2815 psa_key_attributes_t attributes = {
2816 .core = slot->attr
2817 };
2818
gabor-mezei-armc9795782021-05-12 11:03:09 +02002819 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002820 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002821 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002822 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002823 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002824 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002825 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002826 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002827 {
2828 status = psa_driver_wrapper_verify_hash(
2829 &attributes, slot->key.data, slot->key.bytes,
2830 alg, input, input_length,
2831 signature, signature_length );
2832 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002833
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002834 unlock_status = psa_unlock_key_slot( slot );
2835
2836 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002837
2838}
2839
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002840psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002841 const psa_key_attributes_t *attributes,
2842 const uint8_t *key_buffer,
2843 size_t key_buffer_size,
2844 psa_algorithm_t alg,
2845 const uint8_t *input,
2846 size_t input_length,
2847 uint8_t *signature,
2848 size_t signature_size,
2849 size_t *signature_length )
2850{
2851 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002852
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002853 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2854 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002855 size_t hash_length;
2856 uint8_t hash[PSA_HASH_MAX_SIZE];
2857
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002858 status = psa_driver_wrapper_hash_compute(
2859 PSA_ALG_SIGN_GET_HASH( alg ),
2860 input, input_length,
2861 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002862
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002863 if( status != PSA_SUCCESS )
2864 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002865
2866 return psa_driver_wrapper_sign_hash(
2867 attributes, key_buffer, key_buffer_size,
2868 alg, hash, hash_length,
2869 signature, signature_size, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002870 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002871
gabor-mezei-arm56980482021-05-05 13:56:27 +02002872 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002873}
2874
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002875psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2876 psa_algorithm_t alg,
2877 const uint8_t * input,
2878 size_t input_length,
2879 uint8_t * signature,
2880 size_t signature_size,
2881 size_t * signature_length )
2882{
2883 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002884 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002885 signature, signature_size, signature_length );
2886}
2887
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002888psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002889 const psa_key_attributes_t *attributes,
2890 const uint8_t *key_buffer,
2891 size_t key_buffer_size,
2892 psa_algorithm_t alg,
2893 const uint8_t *input,
2894 size_t input_length,
2895 const uint8_t *signature,
2896 size_t signature_length )
2897{
2898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002899
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002900 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2901 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002902 size_t hash_length;
2903 uint8_t hash[PSA_HASH_MAX_SIZE];
2904
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002905 status = psa_driver_wrapper_hash_compute(
2906 PSA_ALG_SIGN_GET_HASH( alg ),
2907 input, input_length,
2908 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002909
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002910 if( status != PSA_SUCCESS )
2911 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002912
2913 return psa_driver_wrapper_verify_hash(
2914 attributes, key_buffer, key_buffer_size,
2915 alg, hash, hash_length,
2916 signature, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002917 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002918
gabor-mezei-armef6f2aa2021-05-05 13:59:01 +02002919 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002920}
2921
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002922psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2923 psa_algorithm_t alg,
2924 const uint8_t * input,
2925 size_t input_length,
2926 const uint8_t * signature,
2927 size_t signature_length )
2928{
2929 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002930 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002931 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002932}
2933
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002934psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002935 const psa_key_attributes_t *attributes,
2936 const uint8_t *key_buffer, size_t key_buffer_size,
2937 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2938 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002939{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002940 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002941 {
Ronald Cron4501c982021-03-19 20:09:32 +01002942 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2943 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002944 {
Ronald Cron4501c982021-03-19 20:09:32 +01002945#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2946 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2947 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002948 attributes,
2949 key_buffer, key_buffer_size,
2950 alg, hash, hash_length,
2951 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002952#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2953 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002954 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002955 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002956 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002957 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002958 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002959 }
2960 else
Ronald Cron4501c982021-03-19 20:09:32 +01002961 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2962 {
2963 if( PSA_ALG_IS_ECDSA( alg ) )
2964 {
2965#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2966 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2967 return( mbedtls_psa_ecdsa_sign_hash(
2968 attributes,
2969 key_buffer, key_buffer_size,
2970 alg, hash, hash_length,
2971 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002972#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2973 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002974 }
2975 else
2976 {
2977 return( PSA_ERROR_INVALID_ARGUMENT );
2978 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002979 }
Ronald Cron4501c982021-03-19 20:09:32 +01002980
2981 (void)key_buffer;
2982 (void)key_buffer_size;
2983 (void)hash;
2984 (void)hash_length;
2985 (void)signature;
2986 (void)signature_size;
2987 (void)signature_length;
2988
2989 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002990}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002991
2992psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2993 psa_algorithm_t alg,
2994 const uint8_t *hash,
2995 size_t hash_length,
2996 uint8_t *signature,
2997 size_t signature_size,
2998 size_t *signature_length )
2999{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003000 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003001 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003002 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03003003}
3004
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003005psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003006 const psa_key_attributes_t *attributes,
3007 const uint8_t *key_buffer, size_t key_buffer_size,
3008 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3009 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003010{
Ronald Cron99b8ed72021-02-17 10:33:32 +01003011 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003012 {
Ronald Cron4501c982021-03-19 20:09:32 +01003013 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
3014 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003015 {
Ronald Cron4501c982021-03-19 20:09:32 +01003016#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3017 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3018 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01003019 attributes,
3020 key_buffer, key_buffer_size,
3021 alg, hash, hash_length,
3022 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01003023#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3024 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02003025 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003026 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003027 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003028 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003029 }
itayzafrir5c753392018-05-08 11:18:38 +03003030 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003031 else
Ronald Cron4501c982021-03-19 20:09:32 +01003032 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003033 {
Ronald Cron4501c982021-03-19 20:09:32 +01003034 if( PSA_ALG_IS_ECDSA( alg ) )
3035 {
3036#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3037 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3038 return( mbedtls_psa_ecdsa_verify_hash(
3039 attributes,
3040 key_buffer, key_buffer_size,
3041 alg, hash, hash_length,
3042 signature, signature_length ) );
3043#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3044 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3045 }
3046 else
3047 {
3048 return( PSA_ERROR_INVALID_ARGUMENT );
3049 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003050 }
Ronald Cron4501c982021-03-19 20:09:32 +01003051
3052 (void)key_buffer;
3053 (void)key_buffer_size;
3054 (void)hash;
3055 (void)hash_length;
3056 (void)signature;
3057 (void)signature_length;
3058
3059 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003060}
3061
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003062psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3063 psa_algorithm_t alg,
3064 const uint8_t *hash,
3065 size_t hash_length,
3066 const uint8_t *signature,
3067 size_t signature_length )
3068{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003069 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003070 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003071 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003072}
3073
John Durkop0e005192020-10-31 22:06:54 -07003074#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003075static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3076 mbedtls_rsa_context *rsa )
3077{
3078 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3079 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3080 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3081 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3082}
John Durkop0e005192020-10-31 22:06:54 -07003083#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003084
Ronald Croncf56a0a2020-08-04 09:51:30 +02003085psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003086 psa_algorithm_t alg,
3087 const uint8_t *input,
3088 size_t input_length,
3089 const uint8_t *salt,
3090 size_t salt_length,
3091 uint8_t *output,
3092 size_t output_size,
3093 size_t *output_length )
3094{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003096 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003097 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003098
Darryl Green5cc689a2018-07-24 15:34:10 +01003099 (void) input;
3100 (void) input_length;
3101 (void) salt;
3102 (void) output;
3103 (void) output_size;
3104
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003105 *output_length = 0;
3106
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003107 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3108 return( PSA_ERROR_INVALID_ARGUMENT );
3109
Ronald Cron5c522922020-11-14 16:35:34 +01003110 status = psa_get_and_lock_transparent_key_slot_with_policy(
3111 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003112 if( status != PSA_SUCCESS )
3113 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003114 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3115 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003116 {
3117 status = PSA_ERROR_INVALID_ARGUMENT;
3118 goto exit;
3119 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003120
John Durkop6ba40d12020-11-10 08:50:04 -08003121#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3122 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003123 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003124 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003125 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003126 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3127 slot->key.data,
3128 slot->key.bytes,
3129 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003130 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003131 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003132
3133 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003134 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003135 status = PSA_ERROR_BUFFER_TOO_SMALL;
3136 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003137 }
John Durkop0e005192020-10-31 22:06:54 -07003138#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3140 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003141 status = mbedtls_to_psa_error(
3142 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003143 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003144 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003145 MBEDTLS_RSA_PUBLIC,
3146 input_length,
3147 input,
3148 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003149 }
3150 else
John Durkop0e005192020-10-31 22:06:54 -07003151#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3152#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003153 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3154 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003155 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003156 status = mbedtls_to_psa_error(
3157 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003158 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003159 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160 MBEDTLS_RSA_PUBLIC,
3161 salt, salt_length,
3162 input_length,
3163 input,
3164 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003165 }
3166 else
John Durkop0e005192020-10-31 22:06:54 -07003167#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003169 status = PSA_ERROR_INVALID_ARGUMENT;
3170 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003171 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003172rsa_exit:
3173 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003174 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003175
Steven Cooremana2371e52020-07-28 14:30:39 +02003176 mbedtls_rsa_free( rsa );
3177 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003178 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003179 else
John Durkop9814fa22020-11-04 12:28:15 -08003180#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003181 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003182 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003183 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003184 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003185
3186exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003187 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003188
Ronald Cron5c522922020-11-14 16:35:34 +01003189 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003190}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003191
Ronald Croncf56a0a2020-08-04 09:51:30 +02003192psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003193 psa_algorithm_t alg,
3194 const uint8_t *input,
3195 size_t input_length,
3196 const uint8_t *salt,
3197 size_t salt_length,
3198 uint8_t *output,
3199 size_t output_size,
3200 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003201{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003203 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003204 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003205
Darryl Green5cc689a2018-07-24 15:34:10 +01003206 (void) input;
3207 (void) input_length;
3208 (void) salt;
3209 (void) output;
3210 (void) output_size;
3211
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003212 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003213
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003214 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3215 return( PSA_ERROR_INVALID_ARGUMENT );
3216
Ronald Cron5c522922020-11-14 16:35:34 +01003217 status = psa_get_and_lock_transparent_key_slot_with_policy(
3218 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003219 if( status != PSA_SUCCESS )
3220 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003221 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003222 {
3223 status = PSA_ERROR_INVALID_ARGUMENT;
3224 goto exit;
3225 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003226
John Durkop6ba40d12020-11-10 08:50:04 -08003227#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3228 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003229 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003230 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003231 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003232 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3233 slot->key.data,
3234 slot->key.bytes,
3235 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003236 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003237 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003238
Steven Cooremana2371e52020-07-28 14:30:39 +02003239 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003240 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003241 status = PSA_ERROR_INVALID_ARGUMENT;
3242 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003243 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003244
John Durkop0e005192020-10-31 22:06:54 -07003245#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003246 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003247 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003248 status = mbedtls_to_psa_error(
3249 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003250 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003251 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003252 MBEDTLS_RSA_PRIVATE,
3253 output_length,
3254 input,
3255 output,
3256 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003257 }
3258 else
John Durkop0e005192020-10-31 22:06:54 -07003259#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3260#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003261 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003262 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003263 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003264 status = mbedtls_to_psa_error(
3265 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003266 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003267 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003268 MBEDTLS_RSA_PRIVATE,
3269 salt, salt_length,
3270 output_length,
3271 input,
3272 output,
3273 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003274 }
3275 else
John Durkop0e005192020-10-31 22:06:54 -07003276#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003277 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003278 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003279 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003280
Steven Cooreman4fed4552020-08-03 14:46:03 +02003281rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003282 mbedtls_rsa_free( rsa );
3283 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003284 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003285 else
John Durkop6ba40d12020-11-10 08:50:04 -08003286#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3287 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003288 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003289 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003290 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003291
3292exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003293 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003294
Ronald Cron5c522922020-11-14 16:35:34 +01003295 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003296}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003297
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003298
3299
mohammad1603503973b2018-03-12 15:59:30 +02003300/****************************************************************/
3301/* Symmetric cryptography */
3302/****************************************************************/
3303
Ronald Cronab99ac22020-10-01 16:38:28 +02003304static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3305 mbedtls_svc_key_id_t key,
3306 psa_algorithm_t alg,
3307 mbedtls_operation_t cipher_operation )
3308{
3309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3310 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003311 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003312 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3313 PSA_KEY_USAGE_ENCRYPT :
3314 PSA_KEY_USAGE_DECRYPT );
3315
3316 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003317 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01003318 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003319 status = PSA_ERROR_BAD_STATE;
3320 goto exit;
3321 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003322
Ronald Cronab99ac22020-10-01 16:38:28 +02003323 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmandb861792021-06-24 16:17:43 +01003324 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003325 status = PSA_ERROR_INVALID_ARGUMENT;
3326 goto exit;
3327 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003328
Ronald Cronab99ac22020-10-01 16:38:28 +02003329 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3330 if( status != PSA_SUCCESS )
3331 goto exit;
3332
Ronald Cron49fafa92021-03-10 08:34:23 +01003333 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003334 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003335 * so we only set it (in the driver wrapper) after resources have been
3336 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003337 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003338 if( alg == PSA_ALG_ECB_NO_PADDING )
3339 operation->iv_required = 0;
3340 else
3341 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003342 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003343
Ronald Crona4af55f2020-12-14 14:36:06 +01003344 psa_key_attributes_t attributes = {
3345 .core = slot->attr
3346 };
3347
Ronald Cronab99ac22020-10-01 16:38:28 +02003348 /* Try doing the operation through a driver before using software fallback. */
3349 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003350 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3351 &attributes,
3352 slot->key.data,
3353 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003354 alg );
3355 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003356 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3357 &attributes,
3358 slot->key.data,
3359 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003360 alg );
3361
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003362exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003363 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003364 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003365
Ronald Cron5c522922020-11-14 16:35:34 +01003366 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003367
Ronald Cron5c522922020-11-14 16:35:34 +01003368 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003369}
3370
Gilles Peskinefe119512018-07-08 21:39:34 +02003371psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003372 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003373 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003374{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003375 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003376}
3377
Gilles Peskinefe119512018-07-08 21:39:34 +02003378psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003379 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003380 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003381{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003382 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003383}
3384
Gilles Peskinefe119512018-07-08 21:39:34 +02003385psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003386 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003387 size_t iv_size,
3388 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003389{
Ronald Cron6d051732020-10-01 14:10:20 +02003390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003391
Ronald Cron5618a392021-03-26 09:52:26 +01003392 *iv_length = 0;
3393
Ronald Cron49fafa92021-03-10 08:34:23 +01003394 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003395 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003396 status = PSA_ERROR_BAD_STATE;
3397 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003398 }
3399
Steven Cooreman7df02922020-09-09 15:28:49 +02003400 if( operation->iv_set || ! operation->iv_required )
3401 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003402 status = PSA_ERROR_BAD_STATE;
3403 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003404 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003405
Ronald Cron5618a392021-03-26 09:52:26 +01003406 if( iv_size < operation->default_iv_length )
3407 {
3408 status = PSA_ERROR_BUFFER_TOO_SMALL;
3409 goto exit;
3410 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003411
Ronald Cron5618a392021-03-26 09:52:26 +01003412 status = psa_generate_random( iv, operation->default_iv_length );
3413 if( status != PSA_SUCCESS )
3414 goto exit;
3415
3416 status = psa_driver_wrapper_cipher_set_iv( operation,
3417 iv,
3418 operation->default_iv_length );
3419
3420exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003421 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003422 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003423 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003424 *iv_length = operation->default_iv_length;
3425 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003426 else
Moran Peker395db872018-05-31 14:07:14 +03003427 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003428
itayzafrir534bd7c2018-08-02 13:56:32 +03003429 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003430}
3431
Gilles Peskinefe119512018-07-08 21:39:34 +02003432psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003433 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003434 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003435{
Ronald Cron6d051732020-10-01 14:10:20 +02003436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003437
Ronald Cron49fafa92021-03-10 08:34:23 +01003438 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01003439 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003440 status = PSA_ERROR_BAD_STATE;
3441 goto exit;
3442 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003443
Steven Cooreman7df02922020-09-09 15:28:49 +02003444 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmandb861792021-06-24 16:17:43 +01003445 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003446 status = PSA_ERROR_BAD_STATE;
3447 goto exit;
3448 }
Ronald Crona0d68172021-03-26 10:15:08 +01003449
3450 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmandb861792021-06-24 16:17:43 +01003451 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003452 status = PSA_ERROR_INVALID_ARGUMENT;
3453 goto exit;
3454 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003455
Ronald Crondd24c9b2020-12-15 14:10:01 +01003456 status = psa_driver_wrapper_cipher_set_iv( operation,
3457 iv,
3458 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003459
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003460exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003461 if( status == PSA_SUCCESS )
3462 operation->iv_set = 1;
3463 else
mohammad1603503973b2018-03-12 15:59:30 +02003464 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003465 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003466}
3467
Gilles Peskinee553c652018-06-04 16:22:46 +02003468psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3469 const uint8_t *input,
3470 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003471 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003472 size_t output_size,
3473 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003474{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003476
Ronald Cron49fafa92021-03-10 08:34:23 +01003477 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003478 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003479 status = PSA_ERROR_BAD_STATE;
3480 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003481 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003482
Steven Cooreman7df02922020-09-09 15:28:49 +02003483 if( operation->iv_required && ! operation->iv_set )
3484 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003485 status = PSA_ERROR_BAD_STATE;
3486 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003487 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003488
Ronald Crondd24c9b2020-12-15 14:10:01 +01003489 status = psa_driver_wrapper_cipher_update( operation,
3490 input,
3491 input_length,
3492 output,
3493 output_size,
3494 output_length );
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003495
3496exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003497 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003498 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003499
itayzafrir534bd7c2018-08-02 13:56:32 +03003500 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003501}
3502
Gilles Peskinee553c652018-06-04 16:22:46 +02003503psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3504 uint8_t *output,
3505 size_t output_size,
3506 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003507{
David Saadab4ecc272019-02-14 13:48:10 +02003508 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003509
Ronald Cron49fafa92021-03-10 08:34:23 +01003510 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003511 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003512 status = PSA_ERROR_BAD_STATE;
3513 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003514 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003515
Steven Cooreman7df02922020-09-09 15:28:49 +02003516 if( operation->iv_required && ! operation->iv_set )
3517 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003518 status = PSA_ERROR_BAD_STATE;
3519 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003520 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003521
Ronald Crondd24c9b2020-12-15 14:10:01 +01003522 status = psa_driver_wrapper_cipher_finish( operation,
3523 output,
3524 output_size,
3525 output_length );
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003526
3527exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003528 if( status == PSA_SUCCESS )
3529 return( psa_cipher_abort( operation ) );
3530 else
3531 {
3532 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003533 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003534
Steven Cooremanef8575e2020-09-11 11:44:50 +02003535 return( status );
3536 }
mohammad1603503973b2018-03-12 15:59:30 +02003537}
3538
Gilles Peskinee553c652018-06-04 16:22:46 +02003539psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3540{
Ronald Cron49fafa92021-03-10 08:34:23 +01003541 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003542 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003543 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003544 * in use. It's ok to call abort on such an object, and there's
3545 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003546 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003547 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003548
Ronald Crondd24c9b2020-12-15 14:10:01 +01003549 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003550
Ronald Cron49fafa92021-03-10 08:34:23 +01003551 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003552 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003553 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003554
Moran Peker395db872018-05-31 14:07:14 +03003555 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003556}
3557
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003558psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3559 psa_algorithm_t alg,
3560 const uint8_t *input,
3561 size_t input_length,
3562 uint8_t *output,
3563 size_t output_size,
3564 size_t *output_length )
3565{
3566 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003567 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3568 psa_key_slot_t *slot;
3569 psa_key_type_t key_type;
3570 size_t iv_length;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003571
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003572 *output_length = 0;
3573
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003574 if( ! PSA_ALG_IS_CIPHER( alg ) )
3575 return( PSA_ERROR_INVALID_ARGUMENT );
3576
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003577 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3578 PSA_KEY_USAGE_ENCRYPT,
3579 alg );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003580 if( status != PSA_SUCCESS )
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003581 return( status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003582
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003583 psa_key_attributes_t attributes = {
3584 .core = slot->attr
3585 };
3586
3587 key_type = slot->attr.type;
3588 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3589
3590 if( iv_length > 0 )
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003591 {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003592 if( output_size < iv_length )
3593 {
3594 status = PSA_ERROR_BUFFER_TOO_SMALL;
3595 goto exit;
3596 }
3597
3598 status = psa_generate_random( output, iv_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003599 if( status != PSA_SUCCESS )
3600 goto exit;
3601 }
3602
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003603 status = psa_driver_wrapper_cipher_encrypt(
3604 &attributes, slot->key.data, slot->key.bytes,
3605 alg, input, input_length,
3606 output, output_size, output_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003607
3608exit:
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003609 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003610
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003611 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003612}
3613
3614psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3615 psa_algorithm_t alg,
3616 const uint8_t *input,
3617 size_t input_length,
3618 uint8_t *output,
3619 size_t output_size,
3620 size_t *output_length )
3621{
3622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003623 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3624 psa_key_slot_t *slot;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003625
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003626 *output_length = 0;
3627
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003628 if( ! PSA_ALG_IS_CIPHER( alg ) )
3629 return( PSA_ERROR_INVALID_ARGUMENT );
3630
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003631 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3632 PSA_KEY_USAGE_DECRYPT,
3633 alg );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003634 if( status != PSA_SUCCESS )
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003635 return( status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003636
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003637 psa_key_attributes_t attributes = {
3638 .core = slot->attr
3639 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003640
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003641 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3642 {
3643 status = PSA_ERROR_INVALID_ARGUMENT;
3644 goto exit;
3645 }
3646
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003647 status = psa_driver_wrapper_cipher_decrypt(
3648 &attributes, slot->key.data, slot->key.bytes,
3649 alg, input, input_length,
3650 output, output_size, output_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003651
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003652exit:
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003653 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003654
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003655 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003656}
3657
3658
mohammad16035955c982018-04-26 00:53:03 +03003659/****************************************************************/
3660/* AEAD */
3661/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003662
Ronald Croncf56a0a2020-08-04 09:51:30 +02003663psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003664 psa_algorithm_t alg,
3665 const uint8_t *nonce,
3666 size_t nonce_length,
3667 const uint8_t *additional_data,
3668 size_t additional_data_length,
3669 const uint8_t *plaintext,
3670 size_t plaintext_length,
3671 uint8_t *ciphertext,
3672 size_t ciphertext_size,
3673 size_t *ciphertext_length )
3674{
Ronald Cron215633c2021-03-16 17:15:37 +01003675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3676 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003677
mohammad1603f08a5502018-06-03 15:05:47 +03003678 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003679
Steven Cooremanea7ab132021-03-17 16:28:00 +01003680 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3681 return( PSA_ERROR_NOT_SUPPORTED );
3682
Ronald Cron9a986162021-03-26 12:40:07 +01003683 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003684 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003685 if( status != PSA_SUCCESS )
3686 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003687
Ronald Cron215633c2021-03-16 17:15:37 +01003688 psa_key_attributes_t attributes = {
3689 .core = slot->attr
3690 };
mohammad16035955c982018-04-26 00:53:03 +03003691
Ronald Cronde822812021-03-17 16:08:20 +01003692 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003693 &attributes, slot->key.data, slot->key.bytes,
3694 alg,
3695 nonce, nonce_length,
3696 additional_data, additional_data_length,
3697 plaintext, plaintext_length,
3698 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003699
Gilles Peskineedf9a652018-08-17 18:11:56 +02003700 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3701 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003702
Ronald Cron9f310172021-03-16 16:36:37 +01003703 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003704
mohammad16035955c982018-04-26 00:53:03 +03003705 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003706}
3707
Ronald Croncf56a0a2020-08-04 09:51:30 +02003708psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003709 psa_algorithm_t alg,
3710 const uint8_t *nonce,
3711 size_t nonce_length,
3712 const uint8_t *additional_data,
3713 size_t additional_data_length,
3714 const uint8_t *ciphertext,
3715 size_t ciphertext_length,
3716 uint8_t *plaintext,
3717 size_t plaintext_size,
3718 size_t *plaintext_length )
3719{
Ronald Cron215633c2021-03-16 17:15:37 +01003720 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3721 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003722
Gilles Peskineee652a32018-06-01 19:23:52 +02003723 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003724
Steven Cooremanea7ab132021-03-17 16:28:00 +01003725 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3726 return( PSA_ERROR_NOT_SUPPORTED );
3727
Ronald Cron9a986162021-03-26 12:40:07 +01003728 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003729 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003730 if( status != PSA_SUCCESS )
3731 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003732
Ronald Cron215633c2021-03-16 17:15:37 +01003733 psa_key_attributes_t attributes = {
3734 .core = slot->attr
3735 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003736
Ronald Cronde822812021-03-17 16:08:20 +01003737 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003738 &attributes, slot->key.data, slot->key.bytes,
3739 alg,
3740 nonce, nonce_length,
3741 additional_data, additional_data_length,
3742 ciphertext, ciphertext_length,
3743 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003744
Gilles Peskineedf9a652018-08-17 18:11:56 +02003745 if( status != PSA_SUCCESS && plaintext_size != 0 )
3746 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003747
Ronald Cron215633c2021-03-16 17:15:37 +01003748 psa_unlock_key_slot( slot );
3749
Gilles Peskineedf9a652018-08-17 18:11:56 +02003750 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003751}
3752
Gilles Peskinee59236f2018-01-27 23:32:46 +01003753/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003754/* Generators */
3755/****************************************************************/
3756
John Durkop07cc04a2020-11-16 22:08:34 -08003757#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3758 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3759 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3760#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003761#endif /* At least one builtin KDF */
3762
3763#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3764 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3765 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3766static psa_status_t psa_key_derivation_start_hmac(
3767 psa_mac_operation_t *operation,
3768 psa_algorithm_t hash_alg,
3769 const uint8_t *hmac_key,
3770 size_t hmac_key_length )
3771{
3772 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3773 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3774 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3775 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3776 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3777
Steven Cooreman15f0d922021-05-07 14:14:37 +02003778 operation->is_sign = 1;
3779 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3780
Steven Cooreman9878a162021-05-06 17:58:36 +02003781 status = psa_driver_wrapper_mac_sign_setup( operation,
3782 &attributes,
3783 hmac_key, hmac_key_length,
3784 PSA_ALG_HMAC( hash_alg ) );
3785
3786 psa_reset_key_attributes( &attributes );
3787 return( status );
3788}
3789#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003790
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003791#define HKDF_STATE_INIT 0 /* no input yet */
3792#define HKDF_STATE_STARTED 1 /* got salt */
3793#define HKDF_STATE_KEYED 2 /* got key */
3794#define HKDF_STATE_OUTPUT 3 /* output started */
3795
Gilles Peskinecbe66502019-05-16 16:59:18 +02003796static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003797 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003798{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003799 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3800 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003801 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003802 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003803}
3804
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003805psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003806{
3807 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003808 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003809 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003810 {
3811 /* The object has (apparently) been initialized but it is not
3812 * in use. It's ok to call abort on such an object, and there's
3813 * nothing to do. */
3814 }
3815 else
John Durkopd0321952020-10-29 21:37:36 -07003816#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003817 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003818 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003819 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003820 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003821 }
John Durkop07cc04a2020-11-16 22:08:34 -08003822 else
3823#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3824#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3825 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3826 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003827 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003828 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003829 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003830 if( operation->ctx.tls12_prf.secret != NULL )
3831 {
3832 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3833 operation->ctx.tls12_prf.secret_length );
3834 mbedtls_free( operation->ctx.tls12_prf.secret );
3835 }
3836
Janos Follath6a1d2622019-06-11 10:37:28 +01003837 if( operation->ctx.tls12_prf.seed != NULL )
3838 {
3839 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3840 operation->ctx.tls12_prf.seed_length );
3841 mbedtls_free( operation->ctx.tls12_prf.seed );
3842 }
3843
3844 if( operation->ctx.tls12_prf.label != NULL )
3845 {
3846 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3847 operation->ctx.tls12_prf.label_length );
3848 mbedtls_free( operation->ctx.tls12_prf.label );
3849 }
3850
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003851 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003852
3853 /* We leave the fields Ai and output_block to be erased safely by the
3854 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003855 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003856 else
John Durkop07cc04a2020-11-16 22:08:34 -08003857#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3858 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003859 {
3860 status = PSA_ERROR_BAD_STATE;
3861 }
Janos Follath083036a2019-06-11 10:22:26 +01003862 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003863 return( status );
3864}
3865
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003866psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003867 size_t *capacity)
3868{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003869 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003870 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003871 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003872 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003873 }
3874
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003875 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003876 return( PSA_SUCCESS );
3877}
3878
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003879psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003880 size_t capacity )
3881{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003882 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003883 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003884 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003885 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003886 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003887 return( PSA_SUCCESS );
3888}
3889
John Durkopd0321952020-10-29 21:37:36 -07003890#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003891/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003892 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003893static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremanb27e3502021-04-29 19:11:25 +02003894 psa_algorithm_t hash_alg,
3895 uint8_t *output,
3896 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003897{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003898 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003899 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003900 psa_status_t status;
3901
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003902 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3903 return( PSA_ERROR_BAD_STATE );
3904 hkdf->state = HKDF_STATE_OUTPUT;
3905
Gilles Peskinebef7f142018-07-12 17:22:21 +02003906 while( output_length != 0 )
3907 {
3908 /* Copy what remains of the current block */
3909 uint8_t n = hash_length - hkdf->offset_in_block;
3910 if( n > output_length )
3911 n = (uint8_t) output_length;
3912 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3913 output += n;
3914 output_length -= n;
3915 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003916 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003917 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003918 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003919 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003920 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003921 * object was corrupted or if this function is called directly
3922 * inside the library. */
3923 if( hkdf->block_number == 0xff )
3924 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003925
3926 /* We need a new block */
3927 ++hkdf->block_number;
3928 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02003929
Steven Cooreman9878a162021-05-06 17:58:36 +02003930 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3931 hash_alg,
3932 hkdf->prk,
3933 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003934 if( status != PSA_SUCCESS )
3935 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003936
Gilles Peskinebef7f142018-07-12 17:22:21 +02003937 if( hkdf->block_number != 1 )
3938 {
Steven Cooremanb27e3502021-04-29 19:11:25 +02003939 status = psa_mac_update( &hkdf->hmac,
3940 hkdf->output_block,
3941 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003942 if( status != PSA_SUCCESS )
3943 return( status );
3944 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02003945 status = psa_mac_update( &hkdf->hmac,
3946 hkdf->info,
3947 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003948 if( status != PSA_SUCCESS )
3949 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003950 status = psa_mac_update( &hkdf->hmac,
3951 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003952 if( status != PSA_SUCCESS )
3953 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003954 status = psa_mac_sign_finish( &hkdf->hmac,
3955 hkdf->output_block,
3956 sizeof( hkdf->output_block ),
3957 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003958 if( status != PSA_SUCCESS )
3959 return( status );
3960 }
3961
3962 return( PSA_SUCCESS );
3963}
John Durkop07cc04a2020-11-16 22:08:34 -08003964#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003965
John Durkop07cc04a2020-11-16 22:08:34 -08003966#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3967 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003968static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3969 psa_tls12_prf_key_derivation_t *tls12_prf,
3970 psa_algorithm_t alg )
3971{
3972 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003973 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003974 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3975 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003976 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003977
Janos Follath7742fee2019-06-17 12:58:10 +01003978 /* We can't be wanting more output after block 0xff, otherwise
3979 * the capacity check in psa_key_derivation_output_bytes() would have
3980 * prevented this call. It could happen only if the operation
3981 * object was corrupted or if this function is called directly
3982 * inside the library. */
3983 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003984 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003985
3986 /* We need a new block */
3987 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003988 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003989
3990 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3991 *
3992 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3993 *
3994 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3995 * HMAC_hash(secret, A(2) + seed) +
3996 * HMAC_hash(secret, A(3) + seed) + ...
3997 *
3998 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003999 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004000 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004001 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004002 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004003 * is currently extracted as `output_block` and where i is
4004 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004005 */
4006
Steven Cooreman9878a162021-05-06 17:58:36 +02004007 status = psa_key_derivation_start_hmac( &hmac,
4008 hash_alg,
4009 tls12_prf->secret,
4010 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004011 if( status != PSA_SUCCESS )
4012 goto cleanup;
4013
4014 /* Calculate A(i) where i = tls12_prf->block_number. */
4015 if( tls12_prf->block_number == 1 )
4016 {
4017 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4018 * the variable seed and in this instance means it in the context of the
4019 * P_hash function, where seed = label + seed.) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004020 status = psa_mac_update( &hmac,
4021 tls12_prf->label,
4022 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004023 if( status != PSA_SUCCESS )
4024 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004025 status = psa_mac_update( &hmac,
4026 tls12_prf->seed,
4027 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004028 if( status != PSA_SUCCESS )
4029 goto cleanup;
4030 }
4031 else
4032 {
4033 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004034 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004035 if( status != PSA_SUCCESS )
4036 goto cleanup;
4037 }
4038
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004039 status = psa_mac_sign_finish( &hmac,
4040 tls12_prf->Ai, hash_length,
4041 &hmac_output_length );
4042 if( hmac_output_length != hash_length )
4043 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004044 if( status != PSA_SUCCESS )
4045 goto cleanup;
4046
4047 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman9878a162021-05-06 17:58:36 +02004048 status = psa_key_derivation_start_hmac( &hmac,
4049 hash_alg,
4050 tls12_prf->secret,
4051 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004052 if( status != PSA_SUCCESS )
4053 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004054 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004055 if( status != PSA_SUCCESS )
4056 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004057 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004058 if( status != PSA_SUCCESS )
4059 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004060 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004061 if( status != PSA_SUCCESS )
4062 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004063 status = psa_mac_sign_finish( &hmac,
4064 tls12_prf->output_block, hash_length,
4065 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004066 if( status != PSA_SUCCESS )
4067 goto cleanup;
4068
Janos Follath7742fee2019-06-17 12:58:10 +01004069
4070cleanup:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004071 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004072 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4073 status = cleanup_status;
4074
4075 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004076}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004077
Janos Follath844eb0e2019-06-19 12:10:49 +01004078static psa_status_t psa_key_derivation_tls12_prf_read(
4079 psa_tls12_prf_key_derivation_t *tls12_prf,
4080 psa_algorithm_t alg,
4081 uint8_t *output,
4082 size_t output_length )
4083{
4084 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004085 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004086 psa_status_t status;
4087 uint8_t offset, length;
4088
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004089 switch( tls12_prf->state )
4090 {
4091 case PSA_TLS12_PRF_STATE_LABEL_SET:
4092 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4093 break;
4094 case PSA_TLS12_PRF_STATE_OUTPUT:
4095 break;
4096 default:
4097 return( PSA_ERROR_BAD_STATE );
4098 }
4099
Janos Follath844eb0e2019-06-19 12:10:49 +01004100 while( output_length != 0 )
4101 {
4102 /* Check if we have fully processed the current block. */
4103 if( tls12_prf->left_in_block == 0 )
4104 {
4105 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4106 alg );
4107 if( status != PSA_SUCCESS )
4108 return( status );
4109
4110 continue;
4111 }
4112
4113 if( tls12_prf->left_in_block > output_length )
4114 length = (uint8_t) output_length;
4115 else
4116 length = tls12_prf->left_in_block;
4117
4118 offset = hash_length - tls12_prf->left_in_block;
4119 memcpy( output, tls12_prf->output_block + offset, length );
4120 output += length;
4121 output_length -= length;
4122 tls12_prf->left_in_block -= length;
4123 }
4124
4125 return( PSA_SUCCESS );
4126}
John Durkop07cc04a2020-11-16 22:08:34 -08004127#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4128 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004129
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004130psa_status_t psa_key_derivation_output_bytes(
4131 psa_key_derivation_operation_t *operation,
4132 uint8_t *output,
4133 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004134{
4135 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004136 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004137
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004138 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004139 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004140 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004141 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004142 }
4143
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004144 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004145 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004146 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004147 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004148 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004149 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004150 goto exit;
4151 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004152 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004153 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004154 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004155 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004156 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4157 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004158 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004159 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004160 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004161 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004162 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004163
John Durkopd0321952020-10-29 21:37:36 -07004164#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004165 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004166 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004167 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004168 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004169 output, output_length );
4170 }
Janos Follathadbec812019-06-14 11:05:39 +01004171 else
John Durkop07cc04a2020-11-16 22:08:34 -08004172#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4173#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4174 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004175 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004176 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004177 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004178 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004179 kdf_alg, output,
4180 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004181 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004182 else
John Durkop07cc04a2020-11-16 22:08:34 -08004183#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4184 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004185 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004186 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004187 return( PSA_ERROR_BAD_STATE );
4188 }
4189
4190exit:
4191 if( status != PSA_SUCCESS )
4192 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004193 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004194 * This allows us to differentiate between exhausted operations and
4195 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4196 * operations. */
4197 psa_algorithm_t alg = operation->alg;
4198 psa_key_derivation_abort( operation );
4199 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004200 memset( output, '!', output_length );
4201 }
4202 return( status );
4203}
4204
David Brown7807bf72021-02-09 16:28:23 -07004205#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004206static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4207{
4208 if( data_size >= 8 )
4209 mbedtls_des_key_set_parity( data );
4210 if( data_size >= 16 )
4211 mbedtls_des_key_set_parity( data + 8 );
4212 if( data_size >= 24 )
4213 mbedtls_des_key_set_parity( data + 16 );
4214}
David Brown7807bf72021-02-09 16:28:23 -07004215#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004216
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004217static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004218 psa_key_slot_t *slot,
4219 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004220 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004221{
4222 uint8_t *data = NULL;
4223 size_t bytes = PSA_BITS_TO_BYTES( bits );
4224 psa_status_t status;
4225
Gilles Peskine8e338702019-07-30 20:06:31 +02004226 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004227 return( PSA_ERROR_INVALID_ARGUMENT );
4228 if( bits % 8 != 0 )
4229 return( PSA_ERROR_INVALID_ARGUMENT );
4230 data = mbedtls_calloc( 1, bytes );
4231 if( data == NULL )
4232 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4233
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004234 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004235 if( status != PSA_SUCCESS )
4236 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004237#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004238 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004239 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004240#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004241
4242 status = psa_allocate_buffer_to_slot( slot, bytes );
4243 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004244 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004245
Ronald Cronbf33c932020-11-28 18:06:53 +01004246 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004247 psa_key_attributes_t attributes = {
4248 .core = slot->attr
4249 };
4250
Ronald Cronbf33c932020-11-28 18:06:53 +01004251 status = psa_driver_wrapper_import_key( &attributes,
4252 data, bytes,
4253 slot->key.data,
4254 slot->key.bytes,
4255 &slot->key.bytes, &bits );
4256 if( bits != slot->attr.bits )
4257 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004258
4259exit:
4260 mbedtls_free( data );
4261 return( status );
4262}
4263
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004264psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004265 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004266 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004267{
4268 psa_status_t status;
4269 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004270 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004271
Ronald Cron81709fc2020-11-14 12:10:32 +01004272 *key = MBEDTLS_SVC_KEY_ID_INIT;
4273
Gilles Peskine0f84d622019-09-12 19:03:13 +02004274 /* Reject any attempt to create a zero-length key so that we don't
4275 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4276 if( psa_get_key_bits( attributes ) == 0 )
4277 return( PSA_ERROR_INVALID_ARGUMENT );
4278
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004279 if( ! operation->can_output_key )
4280 return( PSA_ERROR_NOT_PERMITTED );
4281
Ronald Cron81709fc2020-11-14 12:10:32 +01004282 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4283 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004284#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4285 if( driver != NULL )
4286 {
4287 /* Deriving a key in a secure element is not implemented yet. */
4288 status = PSA_ERROR_NOT_SUPPORTED;
4289 }
4290#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004291 if( status == PSA_SUCCESS )
4292 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004293 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004294 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004295 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004296 }
4297 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004298 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004299 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004300 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004301
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004302 return( status );
4303}
4304
Gilles Peskineeab56e42018-07-12 17:12:33 +02004305
4306
4307/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004308/* Key derivation */
4309/****************************************************************/
4310
Steven Cooreman932ffb72021-02-15 12:14:32 +01004311#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004312static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004313 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004314 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004315{
John Durkop07cc04a2020-11-16 22:08:34 -08004316 int is_kdf_alg_supported;
4317
Janos Follath5fe19732019-06-20 15:09:30 +01004318 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4319 * initialisers for this union leave some bytes unspecified.) */
4320 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4321
Gilles Peskine969c5d62019-01-16 15:53:06 +01004322 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004323#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004324 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4325 is_kdf_alg_supported = 1;
4326 else
4327#endif
4328#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4329 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4330 is_kdf_alg_supported = 1;
4331 else
4332#endif
4333#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4334 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4335 is_kdf_alg_supported = 1;
4336 else
4337#endif
4338 is_kdf_alg_supported = 0;
4339
4340 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004341 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004342 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004343 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004344 if( hash_size == 0 )
4345 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004346 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4347 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004348 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004349 {
4350 return( PSA_ERROR_NOT_SUPPORTED );
4351 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004352 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004353 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004354 }
John Durkop07cc04a2020-11-16 22:08:34 -08004355
4356 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004357}
John Durkop07cc04a2020-11-16 22:08:34 -08004358#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004359
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004360psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004361 psa_algorithm_t alg )
4362{
4363 psa_status_t status;
4364
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004365 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004366 return( PSA_ERROR_BAD_STATE );
4367
Gilles Peskine6843c292019-01-18 16:44:49 +01004368 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4369 return( PSA_ERROR_INVALID_ARGUMENT );
4370 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004371 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004372#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004373 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004374 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004375#else
4376 return( PSA_ERROR_NOT_SUPPORTED );
4377#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004378 }
4379 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4380 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004381#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004382 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004383#else
4384 return( PSA_ERROR_NOT_SUPPORTED );
4385#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004386 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004387 else
4388 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004389
4390 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004391 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004392 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004393}
4394
John Durkopd0321952020-10-29 21:37:36 -07004395#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004396static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004397 psa_algorithm_t hash_alg,
4398 psa_key_derivation_step_t step,
4399 const uint8_t *data,
4400 size_t data_length )
4401{
4402 psa_status_t status;
4403 switch( step )
4404 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004405 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004406 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004407 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004408 else
4409 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004410 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4411 hash_alg,
4412 data, data_length );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004413 if( status != PSA_SUCCESS )
4414 return( status );
4415 hkdf->state = HKDF_STATE_STARTED;
4416 return( PSA_SUCCESS );
4417 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004418 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004419 /* If no salt was provided, use an empty salt. */
4420 if( hkdf->state == HKDF_STATE_INIT )
4421 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004422 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4423 hash_alg,
4424 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004425 if( status != PSA_SUCCESS )
4426 return( status );
4427 hkdf->state = HKDF_STATE_STARTED;
4428 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004429 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004430 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004431 status = psa_mac_update( &hkdf->hmac,
4432 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004433 if( status != PSA_SUCCESS )
4434 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004435 status = psa_mac_sign_finish( &hkdf->hmac,
4436 hkdf->prk,
4437 sizeof( hkdf->prk ),
4438 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004439 if( status != PSA_SUCCESS )
4440 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004441 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004442 hkdf->block_number = 0;
4443 hkdf->state = HKDF_STATE_KEYED;
4444 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004445 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004446 if( hkdf->state == HKDF_STATE_OUTPUT )
4447 return( PSA_ERROR_BAD_STATE );
4448 if( hkdf->info_set )
4449 return( PSA_ERROR_BAD_STATE );
4450 hkdf->info_length = data_length;
4451 if( data_length != 0 )
4452 {
4453 hkdf->info = mbedtls_calloc( 1, data_length );
4454 if( hkdf->info == NULL )
4455 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4456 memcpy( hkdf->info, data, data_length );
4457 }
4458 hkdf->info_set = 1;
4459 return( PSA_SUCCESS );
4460 default:
4461 return( PSA_ERROR_INVALID_ARGUMENT );
4462 }
4463}
John Durkop07cc04a2020-11-16 22:08:34 -08004464#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004465
John Durkop07cc04a2020-11-16 22:08:34 -08004466#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4467 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004468static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4469 const uint8_t *data,
4470 size_t data_length )
4471{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004472 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004473 return( PSA_ERROR_BAD_STATE );
4474
Janos Follathd6dce9f2019-07-04 09:11:38 +01004475 if( data_length != 0 )
4476 {
4477 prf->seed = mbedtls_calloc( 1, data_length );
4478 if( prf->seed == NULL )
4479 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004480
Janos Follathd6dce9f2019-07-04 09:11:38 +01004481 memcpy( prf->seed, data, data_length );
4482 prf->seed_length = data_length;
4483 }
Janos Follathf08e2652019-06-13 09:05:41 +01004484
Gilles Peskine43f958b2020-12-13 14:55:14 +01004485 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004486
4487 return( PSA_SUCCESS );
4488}
4489
Janos Follath81550542019-06-13 14:26:34 +01004490static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004491 const uint8_t *data,
4492 size_t data_length )
4493{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004494 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004495 return( PSA_ERROR_BAD_STATE );
4496
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004497 if( data_length != 0 )
4498 {
4499 prf->secret = mbedtls_calloc( 1, data_length );
4500 if( prf->secret == NULL )
4501 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4502
4503 memcpy( prf->secret, data, data_length );
4504 prf->secret_length = data_length;
4505 }
Janos Follath81550542019-06-13 14:26:34 +01004506
Gilles Peskine43f958b2020-12-13 14:55:14 +01004507 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004508
4509 return( PSA_SUCCESS );
4510}
4511
Janos Follath63028dd2019-06-13 09:15:47 +01004512static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4513 const uint8_t *data,
4514 size_t data_length )
4515{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004516 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004517 return( PSA_ERROR_BAD_STATE );
4518
Janos Follathd6dce9f2019-07-04 09:11:38 +01004519 if( data_length != 0 )
4520 {
4521 prf->label = mbedtls_calloc( 1, data_length );
4522 if( prf->label == NULL )
4523 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004524
Janos Follathd6dce9f2019-07-04 09:11:38 +01004525 memcpy( prf->label, data, data_length );
4526 prf->label_length = data_length;
4527 }
Janos Follath63028dd2019-06-13 09:15:47 +01004528
Gilles Peskine43f958b2020-12-13 14:55:14 +01004529 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004530
4531 return( PSA_SUCCESS );
4532}
4533
Janos Follathb03233e2019-06-11 15:30:30 +01004534static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004535 psa_key_derivation_step_t step,
4536 const uint8_t *data,
4537 size_t data_length )
4538{
Janos Follathb03233e2019-06-11 15:30:30 +01004539 switch( step )
4540 {
Janos Follathf08e2652019-06-13 09:05:41 +01004541 case PSA_KEY_DERIVATION_INPUT_SEED:
4542 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004543 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004544 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004545 case PSA_KEY_DERIVATION_INPUT_LABEL:
4546 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004547 default:
4548 return( PSA_ERROR_INVALID_ARGUMENT );
4549 }
4550}
John Durkop07cc04a2020-11-16 22:08:34 -08004551#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4552 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4553
4554#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4555static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4556 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004557 const uint8_t *data,
4558 size_t data_length )
4559{
4560 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004561 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004562 uint8_t *cur = pms;
4563
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004564 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004565 return( PSA_ERROR_INVALID_ARGUMENT );
4566
4567 /* Quoting RFC 4279, Section 2:
4568 *
4569 * The premaster secret is formed as follows: if the PSK is N octets
4570 * long, concatenate a uint16 with the value N, N zero octets, a second
4571 * uint16 with the value N, and the PSK itself.
4572 */
4573
Joe Subbiani2bbafda2021-06-24 13:00:03 +01004574 *cur++ = MBEDTLS_BYTE_1( data_length );
4575 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004576 memset( cur, 0, data_length );
4577 cur += data_length;
4578 *cur++ = pms[0];
4579 *cur++ = pms[1];
4580 memcpy( cur, data, data_length );
4581 cur += data_length;
4582
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004583 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004584
4585 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4586 return( status );
4587}
Janos Follath6660f0e2019-06-17 08:44:03 +01004588
4589static psa_status_t psa_tls12_prf_psk_to_ms_input(
4590 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004591 psa_key_derivation_step_t step,
4592 const uint8_t *data,
4593 size_t data_length )
4594{
4595 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004596 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004597 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004598 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004599 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004600
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004601 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004602}
John Durkop07cc04a2020-11-16 22:08:34 -08004603#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004604
Gilles Peskineb8965192019-09-24 16:21:10 +02004605/** Check whether the given key type is acceptable for the given
4606 * input step of a key derivation.
4607 *
4608 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4609 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4610 * Both secret and non-secret inputs can alternatively have the type
4611 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4612 * that the input was passed as a buffer rather than via a key object.
4613 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004614static int psa_key_derivation_check_input_type(
4615 psa_key_derivation_step_t step,
4616 psa_key_type_t key_type )
4617{
4618 switch( step )
4619 {
4620 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004621 if( key_type == PSA_KEY_TYPE_DERIVE )
4622 return( PSA_SUCCESS );
4623 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004624 return( PSA_SUCCESS );
4625 break;
4626 case PSA_KEY_DERIVATION_INPUT_LABEL:
4627 case PSA_KEY_DERIVATION_INPUT_SALT:
4628 case PSA_KEY_DERIVATION_INPUT_INFO:
4629 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004630 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4631 return( PSA_SUCCESS );
4632 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004633 return( PSA_SUCCESS );
4634 break;
4635 }
4636 return( PSA_ERROR_INVALID_ARGUMENT );
4637}
4638
Janos Follathb80a94e2019-06-12 15:54:46 +01004639static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004641 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004642 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004643 const uint8_t *data,
4644 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004646 psa_status_t status;
4647 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4648
4649 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004650 if( status != PSA_SUCCESS )
4651 goto exit;
4652
John Durkopd0321952020-10-29 21:37:36 -07004653#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004654 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004655 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004657 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004658 step, data, data_length );
4659 }
John Durkop07cc04a2020-11-16 22:08:34 -08004660 else
4661#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4662#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4663 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004664 {
Janos Follathb03233e2019-06-11 15:30:30 +01004665 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004666 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004667 }
John Durkop07cc04a2020-11-16 22:08:34 -08004668 else
4669#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4670#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4671 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004672 {
4673 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004674 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004675 }
4676 else
John Durkop07cc04a2020-11-16 22:08:34 -08004677#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004678 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004679 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004680 (void) data;
4681 (void) data_length;
4682 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004683 return( PSA_ERROR_BAD_STATE );
4684 }
4685
Gilles Peskine224b0d62019-09-23 18:13:17 +02004686exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004687 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004688 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004689 return( status );
4690}
4691
Janos Follath51f4a0f2019-06-14 11:35:55 +01004692psa_status_t psa_key_derivation_input_bytes(
4693 psa_key_derivation_operation_t *operation,
4694 psa_key_derivation_step_t step,
4695 const uint8_t *data,
4696 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004697{
Gilles Peskineb8965192019-09-24 16:21:10 +02004698 return( psa_key_derivation_input_internal( operation, step,
4699 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004700 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004701}
4702
Janos Follath51f4a0f2019-06-14 11:35:55 +01004703psa_status_t psa_key_derivation_input_key(
4704 psa_key_derivation_operation_t *operation,
4705 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004706 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004707{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004708 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004709 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004710 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004711
Ronald Cron5c522922020-11-14 16:35:34 +01004712 status = psa_get_and_lock_transparent_key_slot_with_policy(
4713 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004714 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004715 {
4716 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004717 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004718 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004719
4720 /* Passing a key object as a SECRET input unlocks the permission
4721 * to output to a key object. */
4722 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4723 operation->can_output_key = 1;
4724
Ronald Cronf95a2b12020-10-22 15:24:49 +02004725 status = psa_key_derivation_input_internal( operation,
4726 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004727 slot->key.data,
4728 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004729
Ronald Cron5c522922020-11-14 16:35:34 +01004730 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004731
Ronald Cron5c522922020-11-14 16:35:34 +01004732 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004733}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004734
4735
4736
4737/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004738/* Key agreement */
4739/****************************************************************/
4740
John Durkop6ba40d12020-11-10 08:50:04 -08004741#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004742static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4743 size_t peer_key_length,
4744 const mbedtls_ecp_keypair *our_key,
4745 uint8_t *shared_secret,
4746 size_t shared_secret_size,
4747 size_t *shared_secret_length )
4748{
Steven Cooremand4867872020-08-05 16:31:39 +02004749 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004750 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004751 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004752 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004753 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004754 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004755
Ronald Cron90857082020-11-25 14:58:33 +01004756 status = mbedtls_psa_ecp_load_representation(
4757 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004758 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004759 peer_key,
4760 peer_key_length,
4761 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004762 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004763 goto exit;
4764
Jaeden Amero97271b32019-01-10 19:38:51 +00004765 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004766 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004767 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004768 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004769 status = mbedtls_to_psa_error(
4770 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4771 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004772 goto exit;
4773
Jaeden Amero97271b32019-01-10 19:38:51 +00004774 status = mbedtls_to_psa_error(
4775 mbedtls_ecdh_calc_secret( &ecdh,
4776 shared_secret_length,
4777 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004778 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004779 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004780 if( status != PSA_SUCCESS )
4781 goto exit;
4782 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4783 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004784
4785exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004786 if( status != PSA_SUCCESS )
4787 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004788 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004789 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004790 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004791
Jaeden Amero97271b32019-01-10 19:38:51 +00004792 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004793}
John Durkop6ba40d12020-11-10 08:50:04 -08004794#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004795
Gilles Peskine01d718c2018-09-18 12:01:02 +02004796#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4797
Gilles Peskine0216fe12019-04-11 21:23:21 +02004798static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4799 psa_key_slot_t *private_key,
4800 const uint8_t *peer_key,
4801 size_t peer_key_length,
4802 uint8_t *shared_secret,
4803 size_t shared_secret_size,
4804 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004805{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004806 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004807 {
John Durkop6ba40d12020-11-10 08:50:04 -08004808#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004809 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004810 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004811 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004812 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004813 psa_status_t status = mbedtls_psa_ecp_load_representation(
4814 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004815 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004816 private_key->key.data,
4817 private_key->key.bytes,
4818 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004819 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004820 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004821 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004822 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004823 shared_secret, shared_secret_size,
4824 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004825 mbedtls_ecp_keypair_free( ecp );
4826 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004827 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004828#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004829 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004830 (void) private_key;
4831 (void) peer_key;
4832 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004833 (void) shared_secret;
4834 (void) shared_secret_size;
4835 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004836 return( PSA_ERROR_NOT_SUPPORTED );
4837 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004838}
4839
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004840/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004841 * to potentially free embedded data structures and wipe confidential data.
4842 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004843static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004844 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004845 psa_key_slot_t *private_key,
4846 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004847 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004848{
4849 psa_status_t status;
4850 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4851 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004852 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004853
4854 /* Step 1: run the secret agreement algorithm to generate the shared
4855 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004856 status = psa_key_agreement_raw_internal( ka_alg,
4857 private_key,
4858 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004859 shared_secret,
4860 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004861 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004862 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004863 goto exit;
4864
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004865 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004866 * the shared secret. A shared secret is permitted wherever a key
4867 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004868 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004869 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004870 shared_secret,
4871 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004872exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004873 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004874 return( status );
4875}
4876
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004877psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004878 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004879 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004880 const uint8_t *peer_key,
4881 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004882{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004883 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004884 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004885 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004886
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004887 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004888 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004889 status = psa_get_and_lock_transparent_key_slot_with_policy(
4890 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004891 if( status != PSA_SUCCESS )
4892 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004893 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004894 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004895 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004896 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004897 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004898 else
4899 {
4900 /* If a private key has been added as SECRET, we allow the derived
4901 * key material to be used as a key in PSA Crypto. */
4902 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4903 operation->can_output_key = 1;
4904 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004905
Ronald Cron5c522922020-11-14 16:35:34 +01004906 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004907
Ronald Cron5c522922020-11-14 16:35:34 +01004908 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004909}
4910
Gilles Peskinebe697d82019-05-16 18:00:41 +02004911psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004912 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004913 const uint8_t *peer_key,
4914 size_t peer_key_length,
4915 uint8_t *output,
4916 size_t output_size,
4917 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004918{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004919 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004920 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004921 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004922
4923 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4924 {
4925 status = PSA_ERROR_INVALID_ARGUMENT;
4926 goto exit;
4927 }
Ronald Cron5c522922020-11-14 16:35:34 +01004928 status = psa_get_and_lock_transparent_key_slot_with_policy(
4929 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004930 if( status != PSA_SUCCESS )
4931 goto exit;
4932
4933 status = psa_key_agreement_raw_internal( alg, slot,
4934 peer_key, peer_key_length,
4935 output, output_size,
4936 output_length );
4937
4938exit:
4939 if( status != PSA_SUCCESS )
4940 {
4941 /* If an error happens and is not handled properly, the output
4942 * may be used as a key to protect sensitive data. Arrange for such
4943 * a key to be random, which is likely to result in decryption or
4944 * verification errors. This is better than filling the buffer with
4945 * some constant data such as zeros, which would result in the data
4946 * being protected with a reproducible, easily knowable key.
4947 */
4948 psa_generate_random( output, output_size );
4949 *output_length = output_size;
4950 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004951
Ronald Cron5c522922020-11-14 16:35:34 +01004952 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004953
Ronald Cron5c522922020-11-14 16:35:34 +01004954 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004955}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004956
4957
Gilles Peskine30524eb2020-11-13 17:02:26 +01004958
Gilles Peskine86a440b2018-11-12 18:39:40 +01004959/****************************************************************/
4960/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004961/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004962
Gilles Peskine30524eb2020-11-13 17:02:26 +01004963/** Initialize the PSA random generator.
4964 */
4965static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4966{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004967#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4968 memset( rng, 0, sizeof( *rng ) );
4969#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4970
Gilles Peskine30524eb2020-11-13 17:02:26 +01004971 /* Set default configuration if
4972 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4973 if( rng->entropy_init == NULL )
4974 rng->entropy_init = mbedtls_entropy_init;
4975 if( rng->entropy_free == NULL )
4976 rng->entropy_free = mbedtls_entropy_free;
4977
4978 rng->entropy_init( &rng->entropy );
4979#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4980 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4981 /* The PSA entropy injection feature depends on using NV seed as an entropy
4982 * source. Add NV seed as an entropy source for PSA entropy injection. */
4983 mbedtls_entropy_add_source( &rng->entropy,
4984 mbedtls_nv_seed_poll, NULL,
4985 MBEDTLS_ENTROPY_BLOCK_SIZE,
4986 MBEDTLS_ENTROPY_SOURCE_STRONG );
4987#endif
4988
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004989 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004990#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004991}
4992
4993/** Deinitialize the PSA random generator.
4994 */
4995static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4996{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004997#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4998 memset( rng, 0, sizeof( *rng ) );
4999#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005000 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005001 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005002#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005003}
5004
5005/** Seed the PSA random generator.
5006 */
5007static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5008{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005009#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5010 /* Do nothing: the external RNG seeds itself. */
5011 (void) rng;
5012 return( PSA_SUCCESS );
5013#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005014 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005015 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5016 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005017 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005018#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005019}
5020
Gilles Peskinee59236f2018-01-27 23:32:46 +01005021psa_status_t psa_generate_random( uint8_t *output,
5022 size_t output_size )
5023{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005024 GUARD_MODULE_INITIALIZED;
5025
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005026#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5027
5028 size_t output_length = 0;
5029 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5030 output, output_size,
5031 &output_length );
5032 if( status != PSA_SUCCESS )
5033 return( status );
5034 /* Breaking up a request into smaller chunks is currently not supported
5035 * for the extrernal RNG interface. */
5036 if( output_length != output_size )
5037 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5038 return( PSA_SUCCESS );
5039
5040#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5041
Gilles Peskine71ddab92021-01-04 21:01:07 +01005042 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005043 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005044 size_t request_size =
5045 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5046 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5047 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005048 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5049 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005050 if( ret != 0 )
5051 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005052 output_size -= request_size;
5053 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005054 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005055 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005056#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005057}
5058
Gilles Peskine8814fc42020-12-14 15:33:44 +01005059/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005060 *
5061 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5062 * `psa_generate_random(...)`. The state parameter is ignored since the
5063 * PSA API doesn't support passing an explicit state.
5064 *
5065 * In the non-external case, psa_generate_random() calls an
5066 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5067 * and semantics as mbedtls_psa_get_random(). As an optimization,
5068 * instead of doing this back-and-forth between the PSA API and the
5069 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5070 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005071 */
5072#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5073int mbedtls_psa_get_random( void *p_rng,
5074 unsigned char *output,
5075 size_t output_size )
5076{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005077 /* This function takes a pointer to the RNG state because that's what
5078 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5079 * its own state internally and doesn't let the caller access that state.
5080 * So we just ignore the state parameter, and in practice we'll pass
5081 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005082 (void) p_rng;
5083 psa_status_t status = psa_generate_random( output, output_size );
5084 if( status == PSA_SUCCESS )
5085 return( 0 );
5086 else
5087 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5088}
5089#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5090
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005091#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5092#include "mbedtls/entropy_poll.h"
5093
Gilles Peskine7228da22019-07-15 11:06:15 +02005094psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005095 size_t seed_size )
5096{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005097 if( global_data.initialized )
5098 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005099
5100 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5101 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5102 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5103 return( PSA_ERROR_INVALID_ARGUMENT );
5104
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005105 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005106}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005107#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005108
Ronald Cron3772afe2021-02-08 16:10:05 +01005109/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005110 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005111 * \param type The key type
5112 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005113 *
5114 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005115 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005116 * \retval #PSA_ERROR_INVALID_ARGUMENT
5117 * The size in bits of the key is not valid.
5118 * \retval #PSA_ERROR_NOT_SUPPORTED
5119 * The type and/or the size in bits of the key or the combination of
5120 * the two is not supported.
5121 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005122static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5123 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005124{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005125 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005126
Gilles Peskinee59236f2018-01-27 23:32:46 +01005127 if( key_type_is_raw_bytes( type ) )
5128 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005129 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130 if( status != PSA_SUCCESS )
5131 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005132 }
5133 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005134#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005135 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5136 {
5137 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5138 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005139
Ronald Cron01b2aba2020-10-05 09:42:02 +02005140 /* Accept only byte-aligned keys, for the same reasons as
5141 * in psa_import_rsa_key(). */
5142 if( bits % 8 != 0 )
5143 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005144 }
5145 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005146#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005147
Ronald Cron5c4d3862020-12-07 11:07:24 +01005148#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005149 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5150 {
Ronald Crond81ab562021-02-16 09:01:16 +01005151 /* To avoid empty block, return successfully here. */
5152 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005153 }
5154 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005155#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005156 {
5157 return( PSA_ERROR_NOT_SUPPORTED );
5158 }
5159
5160 return( PSA_SUCCESS );
5161}
5162
Ronald Cron55ed0592020-10-05 10:30:40 +02005163psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005164 const psa_key_attributes_t *attributes,
5165 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005166{
5167 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005168 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005169
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005170 if( ( attributes->domain_parameters == NULL ) &&
5171 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005172 return( PSA_ERROR_INVALID_ARGUMENT );
5173
Ronald Cron01b2aba2020-10-05 09:42:02 +02005174 if( key_type_is_raw_bytes( type ) )
5175 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005176 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005177 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005178 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005179
David Brown12ca5032021-02-11 11:02:00 -07005180#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005181 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005182 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005183#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005184 }
5185 else
5186
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005187#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5188 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005189 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005190 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005191 return( mbedtls_psa_rsa_generate_key( attributes,
5192 key_buffer,
5193 key_buffer_size,
5194 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005195 }
5196 else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005197#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5198 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005199
John Durkop9814fa22020-11-04 12:28:15 -08005200#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005201 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005202 {
Ronald Cron7023db52020-11-20 18:17:42 +01005203 return( mbedtls_psa_ecp_generate_key( attributes,
5204 key_buffer,
5205 key_buffer_size,
5206 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005207 }
5208 else
John Durkop9814fa22020-11-04 12:28:15 -08005209#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005210 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005211 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005212 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005213 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005214
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005215 return( PSA_SUCCESS );
5216}
Darryl Green0c6575a2018-11-07 16:05:30 +00005217
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005218psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005219 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005220{
5221 psa_status_t status;
5222 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005223 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005224 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005225
Ronald Cron81709fc2020-11-14 12:10:32 +01005226 *key = MBEDTLS_SVC_KEY_ID_INIT;
5227
Gilles Peskine0f84d622019-09-12 19:03:13 +02005228 /* Reject any attempt to create a zero-length key so that we don't
5229 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5230 if( psa_get_key_bits( attributes ) == 0 )
5231 return( PSA_ERROR_INVALID_ARGUMENT );
5232
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005233 /* Reject any attempt to create a public key. */
5234 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5235 return( PSA_ERROR_INVALID_ARGUMENT );
5236
Ronald Cron81709fc2020-11-14 12:10:32 +01005237 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5238 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005239 if( status != PSA_SUCCESS )
5240 goto exit;
5241
Ronald Cron977c2472020-10-13 08:32:21 +02005242 /* In the case of a transparent key or an opaque key stored in local
5243 * storage (thus not in the case of generating a key in a secure element
5244 * or cryptoprocessor with storage), we have to allocate a buffer to
5245 * hold the generated key material. */
5246 if( slot->key.data == NULL )
5247 {
5248 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5249 PSA_KEY_LOCATION_LOCAL_STORAGE )
5250 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005251 status = psa_validate_key_type_and_size_for_key_generation(
5252 attributes->core.type, attributes->core.bits );
5253 if( status != PSA_SUCCESS )
5254 goto exit;
5255
5256 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5257 attributes->core.type,
5258 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005259 }
5260 else
5261 {
5262 status = psa_driver_wrapper_get_key_buffer_size(
5263 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005264 if( status != PSA_SUCCESS )
5265 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005266 }
Ronald Cron977c2472020-10-13 08:32:21 +02005267
5268 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5269 if( status != PSA_SUCCESS )
5270 goto exit;
5271 }
5272
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005273 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005274 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005275
Ronald Cron2b56bc82020-10-05 10:02:26 +02005276 if( status != PSA_SUCCESS )
5277 psa_remove_key_data_from_memory( slot );
5278
Gilles Peskine11792082019-08-06 18:36:36 +02005279exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005280 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005281 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005282 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005283 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005284
Darryl Green0c6575a2018-11-07 16:05:30 +00005285 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005286}
5287
Gilles Peskinee59236f2018-01-27 23:32:46 +01005288/****************************************************************/
5289/* Module setup */
5290/****************************************************************/
5291
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005292#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005293psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5294 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5295 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5296{
5297 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5298 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005299 global_data.rng.entropy_init = entropy_init;
5300 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005301 return( PSA_SUCCESS );
5302}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005303#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005304
Gilles Peskinee59236f2018-01-27 23:32:46 +01005305void mbedtls_psa_crypto_free( void )
5306{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005307 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005308 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5309 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005310 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005311 }
5312 /* Wipe all remaining data, including configuration.
5313 * In particular, this sets all state indicator to the value
5314 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005315 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005316#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005317 /* Unregister all secure element drivers, so that we restart from
5318 * a pristine state. */
5319 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005320#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005321}
5322
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005323#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5324/** Recover a transaction that was interrupted by a power failure.
5325 *
5326 * This function is called during initialization, before psa_crypto_init()
5327 * returns. If this function returns a failure status, the initialization
5328 * fails.
5329 */
5330static psa_status_t psa_crypto_recover_transaction(
5331 const psa_crypto_transaction_t *transaction )
5332{
5333 switch( transaction->unknown.type )
5334 {
5335 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5336 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005337 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005338 * is implemented.
5339 * https://github.com/ARMmbed/mbed-crypto/issues/218
5340 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005341 default:
5342 /* We found an unsupported transaction in the storage.
5343 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005344 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005345 }
5346}
5347#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5348
Gilles Peskinee59236f2018-01-27 23:32:46 +01005349psa_status_t psa_crypto_init( void )
5350{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005351 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005352
Gilles Peskinec6b69072018-11-20 21:42:52 +01005353 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005354 if( global_data.initialized != 0 )
5355 return( PSA_SUCCESS );
5356
Gilles Peskine30524eb2020-11-13 17:02:26 +01005357 /* Initialize and seed the random generator. */
5358 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005359 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005360 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005361 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005362 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005363 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005364
Gilles Peskine66fb1262018-12-10 16:29:04 +01005365 status = psa_initialize_key_slots( );
5366 if( status != PSA_SUCCESS )
5367 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005368
Gilles Peskined9348f22019-10-01 15:22:29 +02005369#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5370 status = psa_init_all_se_drivers( );
5371 if( status != PSA_SUCCESS )
5372 goto exit;
5373#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5374
Gilles Peskine4b734222019-07-24 15:56:31 +02005375#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005376 status = psa_crypto_load_transaction( );
5377 if( status == PSA_SUCCESS )
5378 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005379 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5380 if( status != PSA_SUCCESS )
5381 goto exit;
5382 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005383 }
5384 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5385 {
5386 /* There's no transaction to complete. It's all good. */
5387 status = PSA_SUCCESS;
5388 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005389#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005390
Gilles Peskinec6b69072018-11-20 21:42:52 +01005391 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005392 global_data.initialized = 1;
5393
5394exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005395 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005396 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005397 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005398}
5399
5400#endif /* MBEDTLS_PSA_CRYPTO_C */