blob: 3a49c12a8ffe860ff4c51d303405a20d3250bc77 [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
Gilles Peskine8890f642021-09-21 11:59:39 +0200519#if defined(PSA_WANT_KEY_TYPE_ARIA)
520 case PSA_KEY_TYPE_ARIA:
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_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200526 case PSA_KEY_TYPE_CAMELLIA:
527 if( bits != 128 && bits != 192 && bits != 256 )
528 return( PSA_ERROR_INVALID_ARGUMENT );
529 break;
530#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100531#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200532 case PSA_KEY_TYPE_DES:
533 if( bits != 64 && bits != 128 && bits != 192 )
534 return( PSA_ERROR_INVALID_ARGUMENT );
535 break;
536#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100537#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200538 case PSA_KEY_TYPE_ARC4:
539 if( bits < 8 || bits > 2048 )
540 return( PSA_ERROR_INVALID_ARGUMENT );
541 break;
542#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100543#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200544 case PSA_KEY_TYPE_CHACHA20:
545 if( bits != 256 )
546 return( PSA_ERROR_INVALID_ARGUMENT );
547 break;
548#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200549 default:
550 return( PSA_ERROR_NOT_SUPPORTED );
551 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200552 if( bits % 8 != 0 )
553 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200554
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200555 return( PSA_SUCCESS );
556}
557
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100558/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100559 *
Steven Cooremancd640932021-03-08 12:00:27 +0100560 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
561 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100562 *
563 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100564 * \param[in] key_type The key type of the key to be used with the
565 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100566 *
567 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100568 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100569 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100570 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100571 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100572MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100573 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100574 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100575{
Steven Cooremancd640932021-03-08 12:00:27 +0100576 if( PSA_ALG_IS_HMAC( algorithm ) )
577 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100578 if( key_type == PSA_KEY_TYPE_HMAC )
579 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100580 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100581
582 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100583 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100584 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
585 * key. */
586 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
587 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
588 {
589 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
590 * the block length (larger than 1) for block ciphers. */
591 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
592 return( PSA_SUCCESS );
593 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100594 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100595
596 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100597}
598
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200599psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
600 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200601{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100602 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200603 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200604
Ronald Cronea0f8a62020-11-25 17:52:23 +0100605 slot->key.data = mbedtls_calloc( 1, buffer_length );
606 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200607 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200608
Ronald Cronea0f8a62020-11-25 17:52:23 +0100609 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200610 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200611}
612
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200613psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
614 const uint8_t* data,
615 size_t data_length )
616{
617 psa_status_t status = psa_allocate_buffer_to_slot( slot,
618 data_length );
619 if( status != PSA_SUCCESS )
620 return( status );
621
Ronald Cronea0f8a62020-11-25 17:52:23 +0100622 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200623 return( PSA_SUCCESS );
624}
625
Ronald Crona0fe59f2020-11-29 11:14:53 +0100626psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100627 const psa_key_attributes_t *attributes,
628 const uint8_t *data, size_t data_length,
629 uint8_t *key_buffer, size_t key_buffer_size,
630 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100631{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
633 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100634
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200635 /* zero-length keys are never supported. */
636 if( data_length == 0 )
637 return( PSA_ERROR_NOT_SUPPORTED );
638
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100639 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100640 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100641 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200642
Steven Cooreman75b74362020-07-28 14:30:13 +0200643 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
644 if( data_length > SIZE_MAX / 8 )
645 return( PSA_ERROR_NOT_SUPPORTED );
646
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200647 /* Enforce a size limit, and in particular ensure that the bit
648 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100649 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200650 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200651
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100652 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200653 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200654 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200655
Ronald Crondd04d422020-11-28 15:14:42 +0100656 /* Copy the key material. */
657 memcpy( key_buffer, data, data_length );
658 *key_buffer_length = data_length;
659 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200660
Steven Cooreman40120f62020-10-29 11:42:22 +0100661 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100662 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100663 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200664 {
John Durkop9814fa22020-11-04 12:28:15 -0800665#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
666 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100667 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200668 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100669 return( mbedtls_psa_ecp_import_key( attributes,
670 data, data_length,
671 key_buffer, key_buffer_size,
672 key_buffer_length,
673 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100674 }
John Durkop9814fa22020-11-04 12:28:15 -0800675#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
676 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700677#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
678 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100679 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200680 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 return( mbedtls_psa_rsa_import_key( attributes,
682 data, data_length,
683 key_buffer, key_buffer_size,
684 key_buffer_length,
685 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200686 }
John Durkop9814fa22020-11-04 12:28:15 -0800687#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
688 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100689 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100690
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100691 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100692}
693
Gilles Peskinef603c712019-01-19 13:40:11 +0100694/** Calculate the intersection of two algorithm usage policies.
695 *
696 * Return 0 (which allows no operation) on incompatibility.
697 */
698static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100700 psa_algorithm_t alg1,
701 psa_algorithm_t alg2 )
702{
Gilles Peskine549ea862019-05-22 11:45:59 +0200703 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100704 if( alg1 == alg2 )
705 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100706 /* If the policies are from the same hash-and-sign family, check
707 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine8cb22c82021-09-22 16:15:05 +0200708 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
709 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100710 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100711 {
Steven Cooreman03488022021-02-18 12:07:20 +0100712 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
713 return( alg2 );
714 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
715 return( alg1 );
716 }
717 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100718 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100719 * restrictive tag length. */
720 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
721 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
722 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
723 {
724 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
725 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100726 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100727
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100728 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100729 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
730 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100731 {
Steven Cooremancd640932021-03-08 12:00:27 +0100732 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
733 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100734 }
735 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100736 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100737 ( alg1_len <= alg2_len ) )
738 {
739 return( alg2 );
740 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100741 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100742 ( alg2_len <= alg1_len ) )
743 {
744 return( alg1 );
745 }
746 }
747 /* If the policies are from the same MAC family, check whether one
748 * of them is a minimum-MAC-length policy. Calculate the most
749 * restrictive tag length. */
750 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
751 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
752 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
753 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100754 /* Validate the combination of key type and algorithm. Since the base
755 * algorithm of alg1 and alg2 are the same, we only need this once. */
756 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100757 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100758
Steven Cooreman31a876d2021-03-03 20:47:40 +0100759 /* Get the (exact or at-least) output lengths for both sides of the
760 * requested intersection. None of the currently supported algorithms
761 * have an output length dependent on the actual key size, so setting it
762 * to a bogus value of 0 is currently OK.
763 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764 * Note that for at-least-this-length wildcard algorithms, the output
765 * length is set to the shortest allowed length, which allows us to
766 * calculate the most restrictive tag length for the intersection. */
767 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
768 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100769 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100770
Steven Cooremana1d83222021-02-25 10:20:29 +0100771 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100772 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
773 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100774 {
Steven Cooremancd640932021-03-08 12:00:27 +0100775 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100776 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100777
778 /* If only one is an at-least-this-length policy, the intersection would
779 * be the other (fixed-length) policy as long as said fixed length is
780 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100781 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100782 {
Steven Cooremancd640932021-03-08 12:00:27 +0100783 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100784 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100785 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100786 {
Steven Cooremancd640932021-03-08 12:00:27 +0100787 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100788 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100789
Steven Cooremancd640932021-03-08 12:00:27 +0100790 /* If none of them are wildcards, check whether they define the same tag
791 * length. This is still possible here when one is default-length and
792 * the other specific-length. Ensure to always return the
793 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100794 if( alg1_len == alg2_len )
795 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100796 }
797 /* If the policies are incompatible, allow nothing. */
798 return( 0 );
799}
800
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100801static int psa_key_algorithm_permits( psa_key_type_t key_type,
802 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200803 psa_algorithm_t requested_alg )
804{
Gilles Peskine549ea862019-05-22 11:45:59 +0200805 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200806 if( requested_alg == policy_alg )
807 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100808 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
809 * and requested_alg is the same hash-and-sign family with any hash,
810 * then requested_alg is compliant with policy_alg. */
Gilles Peskine8cb22c82021-09-22 16:15:05 +0200811 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100812 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200813 {
Steven Cooreman03488022021-02-18 12:07:20 +0100814 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
815 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
816 }
817 /* If policy_alg is a wildcard AEAD algorithm of the same base as
818 * the requested algorithm, check the requested tag length to be
819 * equal-length or longer than the wildcard-specified length. */
820 if( PSA_ALG_IS_AEAD( policy_alg ) &&
821 PSA_ALG_IS_AEAD( requested_alg ) &&
822 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
823 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100824 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100825 {
826 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
827 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
828 }
Steven Cooremancd640932021-03-08 12:00:27 +0100829 /* If policy_alg is a MAC algorithm of the same base as the requested
830 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100831 if( PSA_ALG_IS_MAC( policy_alg ) &&
832 PSA_ALG_IS_MAC( requested_alg ) &&
833 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100834 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100835 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100836 /* Validate the combination of key type and algorithm. Since the policy
837 * and requested algorithms are the same, we only need this once. */
838 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100839 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100840
Steven Cooreman31a876d2021-03-03 20:47:40 +0100841 /* Get both the requested output length for the algorithm which is to be
842 * verified, and the default output length for the base algorithm.
843 * Note that none of the currently supported algorithms have an output
844 * length dependent on actual key size, so setting it to a bogus value
845 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100846 size_t requested_output_length = PSA_MAC_LENGTH(
847 key_type, 0, requested_alg );
848 size_t default_output_length = PSA_MAC_LENGTH(
849 key_type, 0,
850 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100851
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100852 /* If the policy is default-length, only allow an algorithm with
853 * a declared exact-length matching the default. */
854 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100855 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100856
857 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100858 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100859 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
860 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
861 {
862 return( 1 );
863 }
864
Steven Cooremancd640932021-03-08 12:00:27 +0100865 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
866 * check for the requested MAC length to be equal to or longer than the
867 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100868 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
869 {
870 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100871 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100872 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200873 }
Steven Cooremance48e852020-10-05 16:02:45 +0200874 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200875 * a key derivation with that key agreement should also be allowed. This
876 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200877 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
878 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
879 {
880 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
881 policy_alg );
882 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100883 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200884 return( 0 );
885}
886
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100887/** Test whether a policy permits an algorithm.
888 *
889 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100890 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100891 * \note This function requires providing the key type for which the policy is
892 * being validated, since some algorithm policy definitions (e.g. MAC)
893 * have different properties depending on what kind of cipher it is
894 * combined with.
895 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100896 * \retval PSA_SUCCESS When \p alg is a specific algorithm
897 * allowed by the \p policy.
898 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
899 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
900 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100901 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100902static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100903 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100904 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100905{
Steven Cooremand788fab2021-02-25 11:29:17 +0100906 /* '0' is not a valid algorithm */
907 if( alg == 0 )
908 return( PSA_ERROR_INVALID_ARGUMENT );
909
Steven Cooreman7e39f052021-02-23 14:18:32 +0100910 /* A requested algorithm cannot be a wildcard. */
911 if( PSA_ALG_IS_WILDCARD( alg ) )
912 return( PSA_ERROR_INVALID_ARGUMENT );
913
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100914 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
915 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100916 return( PSA_SUCCESS );
917 else
918 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100919}
920
Gilles Peskinef603c712019-01-19 13:40:11 +0100921/** Restrict a key policy based on a constraint.
922 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100923 * \note This function requires providing the key type for which the policy is
924 * being restricted, since some algorithm policy definitions (e.g. MAC)
925 * have different properties depending on what kind of cipher it is
926 * combined with.
927 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100928 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100929 * \param[in,out] policy The policy to restrict.
930 * \param[in] constraint The policy constraint to apply.
931 *
932 * \retval #PSA_SUCCESS
933 * \c *policy contains the intersection of the original value of
934 * \c *policy and \c *constraint.
935 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100936 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100937 * \c *policy is unchanged.
938 */
939static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100940 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100941 psa_key_policy_t *policy,
942 const psa_key_policy_t *constraint )
943{
944 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100945 psa_key_policy_algorithm_intersection( key_type, policy->alg,
946 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200947 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100948 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
949 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100950 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
951 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200952 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
953 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100954 policy->usage &= constraint->usage;
955 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200956 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100957 return( PSA_SUCCESS );
958}
959
Ronald Cron5c522922020-11-14 16:35:34 +0100960/** Get the description of a key given its identifier and policy constraints
961 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200962 *
Ronald Cron5c522922020-11-14 16:35:34 +0100963 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100964 * nonzero, the key must allow operations with this algorithm. If \p alg is
965 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100966 *
Ronald Cron5c522922020-11-14 16:35:34 +0100967 * In case of a persistent key, the function loads the description of the key
968 * into a key slot if not already done.
969 *
970 * On success, the returned key slot is locked. It is the responsibility of
971 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200972 */
Ronald Cron5c522922020-11-14 16:35:34 +0100973static psa_status_t psa_get_and_lock_key_slot_with_policy(
974 mbedtls_svc_key_id_t key,
975 psa_key_slot_t **p_slot,
976 psa_key_usage_t usage,
977 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100978{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200979 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
980 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100981
Ronald Cron5c522922020-11-14 16:35:34 +0100982 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100983 if( status != PSA_SUCCESS )
984 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200985 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100986
987 /* Enforce that usage policy for the key slot contains all the flags
988 * required by the usage parameter. There is one exception: public
989 * keys can always be exported, so we treat public key objects as
990 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200991 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100992 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200993
Gilles Peskine8e338702019-07-30 20:06:31 +0200994 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100995 {
996 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200997 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100998 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100999
1000 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +01001001 if( alg != 0 )
1002 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001003 status = psa_key_policy_permits( &slot->attr.policy,
1004 slot->attr.type,
1005 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001006 if( status != PSA_SUCCESS )
1007 goto error;
1008 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001009
Darryl Green06fd18d2018-07-16 11:21:11 +01001010 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001011
1012error:
1013 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001014 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001015
1016 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001017}
Darryl Green940d72c2018-07-13 13:18:51 +01001018
Ronald Cron5c522922020-11-14 16:35:34 +01001019/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001020 *
1021 * A transparent key is a key for which the key material is directly
Ronald Cron8a0466a2021-08-24 15:39:44 +02001022 * available, as opposed to a key in a secure element and/or to be used
1023 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001024 *
Ronald Cron8a0466a2021-08-24 15:39:44 +02001025 * This is a temporary function that may be used instead of
1026 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1027 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001028 *
Ronald Cron5c522922020-11-14 16:35:34 +01001029 * On success, the returned key slot is locked. It is the responsibility of the
1030 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001031 */
Ronald Cron5c522922020-11-14 16:35:34 +01001032static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1033 mbedtls_svc_key_id_t key,
1034 psa_key_slot_t **p_slot,
1035 psa_key_usage_t usage,
1036 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001037{
Ronald Cron5c522922020-11-14 16:35:34 +01001038 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1039 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001040 if( status != PSA_SUCCESS )
1041 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001042
Ronald Cron8a0466a2021-08-24 15:39:44 +02001043 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001044 {
Ronald Cron5c522922020-11-14 16:35:34 +01001045 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001046 *p_slot = NULL;
1047 return( PSA_ERROR_NOT_SUPPORTED );
1048 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001049
Gilles Peskine28f8f302019-07-24 13:30:31 +02001050 return( PSA_SUCCESS );
1051}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001052
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001053psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001054{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001055 /* Data pointer will always be either a valid pointer or NULL in an
1056 * initialized slot, so we can just free it. */
1057 if( slot->key.data != NULL )
1058 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1059
1060 mbedtls_free( slot->key.data );
1061 slot->key.data = NULL;
1062 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001063
1064 return( PSA_SUCCESS );
1065}
1066
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001067/** Completely wipe a slot in memory, including its policy.
1068 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001069psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001070{
1071 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001072
1073 /*
1074 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001075 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001076 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1077 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001078 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001079 */
Ronald Cron5c522922020-11-14 16:35:34 +01001080 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001081 {
1082#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001083 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001084#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001085 status = PSA_ERROR_CORRUPTION_DETECTED;
1086 }
1087
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001088 /* Multipart operations may still be using the key. This is safe
1089 * because all multipart operation objects are independent from
1090 * the key slot: if they need to access the key after the setup
1091 * phase, they have a copy of the key. Note that this means that
1092 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001093 /* At this point, key material and other type-specific content has
1094 * been wiped. Clear remaining metadata. We can call memset and not
1095 * zeroize because the metadata is not particularly sensitive. */
1096 memset( slot, 0, sizeof( *slot ) );
1097 return( status );
1098}
1099
Ronald Croncf56a0a2020-08-04 09:51:30 +02001100psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001101{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001102 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001103 psa_status_t status; /* status of the last operation */
1104 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001105#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1106 psa_se_drv_table_entry_t *driver;
1107#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001108
Ronald Croncf56a0a2020-08-04 09:51:30 +02001109 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001110 return( PSA_SUCCESS );
1111
Ronald Cronf2911112020-10-29 17:51:10 +01001112 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001113 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001114 * key, this will load the key description from persistent memory if not
1115 * done yet. We cannot avoid this loading as without it we don't know if
1116 * the key is operated by an SE or not and this information is needed by
1117 * the current implementation.
1118 */
Ronald Cron5c522922020-11-14 16:35:34 +01001119 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001120 if( status != PSA_SUCCESS )
1121 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001122
Ronald Cronf2911112020-10-29 17:51:10 +01001123 /*
1124 * If the key slot containing the key description is under access by the
1125 * library (apart from the present access), the key cannot be destroyed
1126 * yet. For the time being, just return in error. Eventually (to be
1127 * implemented), the key should be destroyed when all accesses have
1128 * stopped.
1129 */
Ronald Cron5c522922020-11-14 16:35:34 +01001130 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001131 {
Ronald Cron5c522922020-11-14 16:35:34 +01001132 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001133 return( PSA_ERROR_GENERIC_ERROR );
1134 }
1135
Gilles Peskine251c7742021-04-21 22:32:05 +02001136 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1137 {
1138 /* Refuse the destruction of a read-only key (which may or may not work
1139 * if we attempt it, depending on whether the key is merely read-only
1140 * by policy or actually physically read-only).
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001141 * Just do the best we can, which is to wipe the copy in memory
1142 * (done in this function's cleanup code). */
1143 overall_status = PSA_ERROR_NOT_PERMITTED;
1144 goto exit;
Gilles Peskine251c7742021-04-21 22:32:05 +02001145 }
1146
Gilles Peskine354f7672019-07-12 23:46:38 +02001147#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001148 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001149 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001150 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001151 /* For a key in a secure element, we need to do three things:
1152 * remove the key file in internal storage, destroy the
1153 * key inside the secure element, and update the driver's
1154 * persistent data. Start a transaction that will encompass these
1155 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001156 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001157 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001158 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001159 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001160 status = psa_crypto_save_transaction( );
1161 if( status != PSA_SUCCESS )
1162 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001163 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001164 /* We should still try to destroy the key in the secure
1165 * element and the key metadata in storage. This is especially
1166 * important if the error is that the storage is full.
1167 * But how to do it exactly without risking an inconsistent
1168 * state after a reset?
1169 * https://github.com/ARMmbed/mbed-crypto/issues/215
1170 */
1171 overall_status = status;
1172 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001173 }
1174
Ronald Cronea0f8a62020-11-25 17:52:23 +01001175 status = psa_destroy_se_key( driver,
1176 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001177 if( overall_status == PSA_SUCCESS )
1178 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001179 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001180#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1181
Darryl Greend49a4992018-06-18 17:27:26 +01001182#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001183 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001184 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001185 status = psa_destroy_persistent_key( slot->attr.id );
1186 if( overall_status == PSA_SUCCESS )
1187 overall_status = status;
1188
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001189 /* TODO: other slots may have a copy of the same key. We should
1190 * invalidate them.
1191 * https://github.com/ARMmbed/mbed-crypto/issues/214
1192 */
Darryl Greend49a4992018-06-18 17:27:26 +01001193 }
1194#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001195
Gilles Peskinefc762652019-07-22 19:30:34 +02001196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1197 if( driver != NULL )
1198 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001199 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001200 if( overall_status == PSA_SUCCESS )
1201 overall_status = status;
1202 status = psa_crypto_stop_transaction( );
1203 if( overall_status == PSA_SUCCESS )
1204 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001205 }
1206#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1207
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001208exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001209 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001210 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001211 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001212 overall_status = status;
1213 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001214}
1215
John Durkop07cc04a2020-11-16 22:08:34 -08001216#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001217 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001218static psa_status_t psa_get_rsa_public_exponent(
1219 const mbedtls_rsa_context *rsa,
1220 psa_key_attributes_t *attributes )
1221{
1222 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001223 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001224 uint8_t *buffer = NULL;
1225 size_t buflen;
1226 mbedtls_mpi_init( &mpi );
1227
1228 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1229 if( ret != 0 )
1230 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001231 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1232 {
1233 /* It's the default value, which is reported as an empty string,
1234 * so there's nothing to do. */
1235 goto exit;
1236 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001237
1238 buflen = mbedtls_mpi_size( &mpi );
1239 buffer = mbedtls_calloc( 1, buflen );
1240 if( buffer == NULL )
1241 {
1242 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1243 goto exit;
1244 }
1245 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1246 if( ret != 0 )
1247 goto exit;
1248 attributes->domain_parameters = buffer;
1249 attributes->domain_parameters_size = buflen;
1250
1251exit:
1252 mbedtls_mpi_free( &mpi );
1253 if( ret != 0 )
1254 mbedtls_free( buffer );
1255 return( mbedtls_to_psa_error( ret ) );
1256}
John Durkop07cc04a2020-11-16 22:08:34 -08001257#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001258 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001259
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001260/** Retrieve all the publicly-accessible attributes of a key.
1261 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001262psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001263 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001264{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001266 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001267 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001268
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001269 psa_reset_key_attributes( attributes );
1270
Ronald Cron5c522922020-11-14 16:35:34 +01001271 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001272 if( status != PSA_SUCCESS )
1273 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001274
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001275 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001276 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1277 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1278
1279#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron0518f612021-08-24 15:50:05 +02001280 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001281 psa_set_key_slot_number( attributes,
1282 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001283#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001284
Gilles Peskine8e338702019-07-30 20:06:31 +02001285 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001286 {
John Durkop07cc04a2020-11-16 22:08:34 -08001287#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001288 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001289 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001290 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001291#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001292 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001293 * is not yet implemented.
1294 * https://github.com/ARMmbed/mbed-crypto/issues/216
1295 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001296 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001297 break;
1298#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001299 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001300 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001301
Ronald Cron90857082020-11-25 14:58:33 +01001302 status = mbedtls_psa_rsa_load_representation(
1303 slot->attr.type,
1304 slot->key.data,
1305 slot->key.bytes,
1306 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001307 if( status != PSA_SUCCESS )
1308 break;
1309
Steven Cooremana2371e52020-07-28 14:30:39 +02001310 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001311 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001312 mbedtls_rsa_free( rsa );
1313 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001314 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001315 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001316#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001317 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001318 default:
1319 /* Nothing else to do. */
1320 break;
1321 }
1322
1323 if( status != PSA_SUCCESS )
1324 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001325
Ronald Cron5c522922020-11-14 16:35:34 +01001326 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001327
Ronald Cron5c522922020-11-14 16:35:34 +01001328 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001329}
1330
Gilles Peskinec8000c02019-08-02 20:15:51 +02001331#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1332psa_status_t psa_get_key_slot_number(
1333 const psa_key_attributes_t *attributes,
1334 psa_key_slot_number_t *slot_number )
1335{
1336 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1337 {
1338 *slot_number = attributes->slot_number;
1339 return( PSA_SUCCESS );
1340 }
1341 else
1342 return( PSA_ERROR_INVALID_ARGUMENT );
1343}
1344#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1345
Ronald Crond18b5f82020-11-25 16:46:05 +01001346static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1347 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001348 uint8_t *data,
1349 size_t data_size,
1350 size_t *data_length )
1351{
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001353 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001354 memcpy( data, key_buffer, key_buffer_size );
1355 memset( data + key_buffer_size, 0,
1356 data_size - key_buffer_size );
1357 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001358 return( PSA_SUCCESS );
1359}
1360
Ronald Cron7285cda2020-11-26 14:46:37 +01001361psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 const psa_key_attributes_t *attributes,
1363 const uint8_t *key_buffer, size_t key_buffer_size,
1364 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001365{
Ronald Crond18b5f82020-11-25 16:46:05 +01001366 psa_key_type_t type = attributes->core.type;
1367
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 if( key_type_is_raw_bytes( type ) ||
1369 PSA_KEY_TYPE_IS_RSA( type ) ||
1370 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001371 {
1372 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001373 key_buffer, key_buffer_size,
1374 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001375 }
1376 else
1377 {
1378 /* This shouldn't happen in the reference implementation, but
1379 it is valid for a special-purpose implementation to omit
1380 support for exporting certain key types. */
1381 return( PSA_ERROR_NOT_SUPPORTED );
1382 }
1383}
1384
1385psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1386 uint8_t *data,
1387 size_t data_size,
1388 size_t *data_length )
1389{
1390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1391 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1392 psa_key_slot_t *slot;
1393
Ronald Crone907e552021-01-18 13:22:38 +01001394 /* Reject a zero-length output buffer now, since this can never be a
1395 * valid key representation. This way we know that data must be a valid
1396 * pointer and we can do things like memset(data, ..., data_size). */
1397 if( data_size == 0 )
1398 return( PSA_ERROR_BUFFER_TOO_SMALL );
1399
Ronald Cron9486f9d2020-11-26 13:36:23 +01001400 /* Set the key to empty now, so that even when there are errors, we always
1401 * set data_length to a value between 0 and data_size. On error, setting
1402 * the key to empty is a good choice because an empty key representation is
1403 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001404 *data_length = 0;
1405
Ronald Cron9486f9d2020-11-26 13:36:23 +01001406 /* Export requires the EXPORT flag. There is an exception for public keys,
1407 * which don't require any flag, but
1408 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1409 */
1410 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1411 PSA_KEY_USAGE_EXPORT, 0 );
1412 if( status != PSA_SUCCESS )
1413 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001414
Ronald Crond18b5f82020-11-25 16:46:05 +01001415 psa_key_attributes_t attributes = {
1416 .core = slot->attr
1417 };
Ronald Cron67227982020-11-26 15:16:05 +01001418 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001419 slot->key.data, slot->key.bytes,
1420 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421
Ronald Cron9486f9d2020-11-26 13:36:23 +01001422 unlock_status = psa_unlock_key_slot( slot );
1423
1424 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1425}
1426
Ronald Cron7285cda2020-11-26 14:46:37 +01001427psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001428 const psa_key_attributes_t *attributes,
1429 const uint8_t *key_buffer,
1430 size_t key_buffer_size,
1431 uint8_t *data,
1432 size_t data_size,
1433 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001434{
Ronald Crond18b5f82020-11-25 16:46:05 +01001435 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001436
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001438 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001439 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001440 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001441 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001442 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001443 key_buffer, key_buffer_size,
1444 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001445 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001446
Ronald Crond18b5f82020-11-25 16:46:05 +01001447 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001448 {
John Durkop0e005192020-10-31 22:06:54 -07001449#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1450 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001451 return( mbedtls_psa_rsa_export_public_key( attributes,
1452 key_buffer,
1453 key_buffer_size,
1454 data,
1455 data_size,
1456 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001457#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001458 /* We don't know how to convert a private RSA key to public. */
1459 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001460#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1461 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001462 }
1463 else
Moran Pekera998bc62018-04-16 18:16:20 +03001464 {
John Durkop6ba40d12020-11-10 08:50:04 -08001465#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1466 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001467 return( mbedtls_psa_ecp_export_public_key( attributes,
1468 key_buffer,
1469 key_buffer_size,
1470 data,
1471 data_size,
1472 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001473#else
1474 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001475 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001476#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1477 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001478 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001479 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001480 else
1481 {
1482 /* This shouldn't happen in the reference implementation, but
1483 it is valid for a special-purpose implementation to omit
1484 support for exporting certain key types. */
1485 return( PSA_ERROR_NOT_SUPPORTED );
1486 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001487}
Ronald Crond18b5f82020-11-25 16:46:05 +01001488
Ronald Croncf56a0a2020-08-04 09:51:30 +02001489psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001490 uint8_t *data,
1491 size_t data_size,
1492 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001493{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001495 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001496 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001497
Ronald Crone907e552021-01-18 13:22:38 +01001498 /* Reject a zero-length output buffer now, since this can never be a
1499 * valid key representation. This way we know that data must be a valid
1500 * pointer and we can do things like memset(data, ..., data_size). */
1501 if( data_size == 0 )
1502 return( PSA_ERROR_BUFFER_TOO_SMALL );
1503
Darryl Greendd8fb772018-11-07 16:00:44 +00001504 /* Set the key to empty now, so that even when there are errors, we always
1505 * set data_length to a value between 0 and data_size. On error, setting
1506 * the key to empty is a good choice because an empty key representation is
1507 * unlikely to be accepted anywhere. */
1508 *data_length = 0;
1509
1510 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001511 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001512 if( status != PSA_SUCCESS )
1513 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001514
Ronald Cron9486f9d2020-11-26 13:36:23 +01001515 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1516 {
1517 status = PSA_ERROR_INVALID_ARGUMENT;
1518 goto exit;
1519 }
1520
Ronald Crond18b5f82020-11-25 16:46:05 +01001521 psa_key_attributes_t attributes = {
1522 .core = slot->attr
1523 };
Ronald Cron67227982020-11-26 15:16:05 +01001524 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001525 &attributes, slot->key.data, slot->key.bytes,
1526 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001527
1528exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001529 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001530
Ronald Cron5c522922020-11-14 16:35:34 +01001531 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001532}
1533
Gilles Peskine91e8c332019-08-02 19:19:39 +02001534#if defined(static_assert)
1535static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1536 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001537static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001538 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001539static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001540 "One or more key attribute flag is listed as both internal-only and external-only" );
1541#endif
1542
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001543/** Validate that a key policy is internally well-formed.
1544 *
1545 * This function only rejects invalid policies. It does not validate the
1546 * consistency of the policy with respect to other attributes of the key
1547 * such as the key type.
1548 */
1549static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001550{
1551 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001552 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001553 PSA_KEY_USAGE_ENCRYPT |
1554 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arme8efa392021-04-14 21:14:28 +02001555 PSA_KEY_USAGE_SIGN_MESSAGE |
1556 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001557 PSA_KEY_USAGE_SIGN_HASH |
1558 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001559 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1560 return( PSA_ERROR_INVALID_ARGUMENT );
1561
Gilles Peskine4747d192019-04-17 15:05:45 +02001562 return( PSA_SUCCESS );
1563}
1564
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001565/** Validate the internal consistency of key attributes.
1566 *
1567 * This function only rejects invalid attribute values. If does not
1568 * validate the consistency of the attributes with any key data that may
1569 * be involved in the creation of the key.
1570 *
1571 * Call this function early in the key creation process.
1572 *
1573 * \param[in] attributes Key attributes for the new key.
1574 * \param[out] p_drv On any return, the driver for the key, if any.
1575 * NULL for a transparent key.
1576 *
1577 */
1578static psa_status_t psa_validate_key_attributes(
1579 const psa_key_attributes_t *attributes,
1580 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001581{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001582 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001583 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001584 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001585
Ronald Cron54b90082020-10-29 15:26:43 +01001586 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001587 if( status != PSA_SUCCESS )
1588 return( status );
1589
Ronald Crond2ed4812020-07-17 16:11:30 +02001590 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001591 if( status != PSA_SUCCESS )
1592 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001593
Ronald Cron65f38a32020-10-23 17:11:13 +02001594 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1595 {
1596 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1597 return( PSA_ERROR_INVALID_ARGUMENT );
1598 }
1599 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001600 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001601 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1602 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001603 }
1604
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001605 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001606 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001607 return( status );
1608
1609 /* Refuse to create overly large keys.
1610 * Note that this doesn't trigger on import if the attributes don't
1611 * explicitly specify a size (so psa_get_key_bits returns 0), so
1612 * psa_import_key() needs its own checks. */
1613 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1614 return( PSA_ERROR_NOT_SUPPORTED );
1615
Gilles Peskine91e8c332019-08-02 19:19:39 +02001616 /* Reject invalid flags. These should not be reachable through the API. */
1617 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1618 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1619 return( PSA_ERROR_INVALID_ARGUMENT );
1620
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001621 return( PSA_SUCCESS );
1622}
1623
Gilles Peskine4747d192019-04-17 15:05:45 +02001624/** Prepare a key slot to receive key material.
1625 *
1626 * This function allocates a key slot and sets its metadata.
1627 *
1628 * If this function fails, call psa_fail_key_creation().
1629 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001630 * This function is intended to be used as follows:
1631 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001632 * it with the specified attributes, and in case of a volatile key assign it
1633 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001634 * -# Populate the slot with the key material.
1635 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1636 * In case of failure at any step, stop the sequence and call
1637 * psa_fail_key_creation().
1638 *
Ronald Cron5c522922020-11-14 16:35:34 +01001639 * On success, the key slot is locked. It is the responsibility of the caller
1640 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001641 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001642 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001643 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001644 * \param[out] p_slot On success, a pointer to the prepared slot.
1645 * \param[out] p_drv On any return, the driver for the key, if any.
1646 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001647 *
1648 * \retval #PSA_SUCCESS
1649 * The key slot is ready to receive key material.
1650 * \return If this function fails, the key slot is an invalid state.
1651 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001652 */
1653static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001654 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001655 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001656 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001657 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001658{
1659 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001660 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001661 psa_key_slot_t *slot;
1662
Gilles Peskinedf179142019-07-15 22:02:14 +02001663 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001664 *p_drv = NULL;
1665
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001666 status = psa_validate_key_attributes( attributes, p_drv );
1667 if( status != PSA_SUCCESS )
1668 return( status );
1669
Ronald Cronc4d1b512020-07-31 11:26:37 +02001670 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001671 if( status != PSA_SUCCESS )
1672 return( status );
1673 slot = *p_slot;
1674
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001675 /* We're storing the declared bit-size of the key. It's up to each
1676 * creation mechanism to verify that this information is correct.
1677 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001678 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001679 * is optional (import, copy). In case of a volatile key, assign it the
1680 * volatile key identifier associated to the slot returned to contain its
1681 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001682
1683 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001684 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1685 {
1686#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1687 slot->attr.id = volatile_key_id;
1688#else
1689 slot->attr.id.key_id = volatile_key_id;
1690#endif
1691 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001692
Gilles Peskine91e8c332019-08-02 19:19:39 +02001693 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001694 * external-only flags, query `attributes`. Thanks to the check
1695 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001696 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001697 * may have set. */
1698 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001699
Gilles Peskinecbaff462019-07-12 23:46:04 +02001700#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001701 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001702 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001703 * create the key file in internal storage, create the
1704 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001705 * persistent data. This is done by starting a transaction that will
1706 * encompass these three actions.
1707 * For registering a volatile key, we just need to find an appropriate
1708 * slot number inside the SE. Since the key is designated volatile, creating
1709 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001710 /* The first thing to do is to find a slot number for the new key.
1711 * We save the slot number in persistent storage as part of the
1712 * transaction data. It will be needed to recover if the power
1713 * fails during the key creation process, to clean up on the secure
1714 * element side after restarting. Obtaining a slot number from the
1715 * secure element driver updates its persistent state, but we do not yet
1716 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001717 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001718 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001719 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001721 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001722 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001723 if( status != PSA_SUCCESS )
1724 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001725
1726 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001727 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001728 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1729 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001731 psa_crypto_transaction.key.id = slot->attr.id;
1732 status = psa_crypto_save_transaction( );
1733 if( status != PSA_SUCCESS )
1734 {
1735 (void) psa_crypto_stop_transaction( );
1736 return( status );
1737 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001738 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739
1740 status = psa_copy_key_material_into_slot(
1741 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001742 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001743
1744 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1745 {
1746 /* Key registration only makes sense with a secure element. */
1747 return( PSA_ERROR_INVALID_ARGUMENT );
1748 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001749#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1750
Ronald Cronc4d1b512020-07-31 11:26:37 +02001751 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001752}
Gilles Peskine4747d192019-04-17 15:05:45 +02001753
1754/** Finalize the creation of a key once its key material has been set.
1755 *
1756 * This entails writing the key to persistent storage.
1757 *
1758 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001759 * See the documentation of psa_start_key_creation() for the intended use
1760 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001761 *
Ronald Cron5c522922020-11-14 16:35:34 +01001762 * If the finalization succeeds, the function unlocks the key slot (it was
1763 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1764 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001765 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001766 * \param[in,out] slot Pointer to the slot with key material.
1767 * \param[in] driver The secure element driver for the key,
1768 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001769 * \param[out] key On success, identifier of the key. Note that the
1770 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001771 *
1772 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001773 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001774 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1775 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1776 * \retval #PSA_ERROR_ALREADY_EXISTS
1777 * \retval #PSA_ERROR_DATA_INVALID
1778 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001779 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001780 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001781 * \return If this function fails, the key slot is an invalid state.
1782 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001784static psa_status_t psa_finish_key_creation(
1785 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001786 psa_se_drv_table_entry_t *driver,
1787 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001788{
1789 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001790 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001791 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001792
1793#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001794 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001795 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001796#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1797 if( driver != NULL )
1798 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001799 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001800 psa_key_slot_number_t slot_number =
1801 psa_key_slot_get_slot_number( slot ) ;
1802
Gilles Peskineb46bef22019-07-30 21:32:04 +02001803#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001804 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001805 sizeof( data.slot_number ),
1806 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001807#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001808 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001809 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001810 (uint8_t*) &data,
1811 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001812 }
1813 else
1814#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1815 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001816 /* Key material is saved in export representation in the slot, so
1817 * just pass the slot buffer for storage. */
1818 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001819 slot->key.data,
1820 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001821 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001823#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1824
Gilles Peskinecbaff462019-07-12 23:46:04 +02001825#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001826 /* Finish the transaction for a key creation. This does not
1827 * happen when registering an existing key. Detect this case
1828 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001829 * creation of a persistent key in a secure element requires a transaction,
1830 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001831 if( driver != NULL &&
1832 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001833 {
1834 status = psa_save_se_persistent_data( driver );
1835 if( status != PSA_SUCCESS )
1836 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001837 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001838 return( status );
1839 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001840 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001841 }
1842#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1843
Ronald Cron50972942020-11-14 11:28:25 +01001844 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001845 {
1846 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001847 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001848 if( status != PSA_SUCCESS )
1849 *key = MBEDTLS_SVC_KEY_ID_INIT;
1850 }
Ronald Cron50972942020-11-14 11:28:25 +01001851
Gilles Peskine4747d192019-04-17 15:05:45 +02001852 return( status );
1853}
1854
1855/** Abort the creation of a key.
1856 *
1857 * You may call this function after calling psa_start_key_creation(),
1858 * or after psa_finish_key_creation() fails. In other circumstances, this
1859 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001860 * See the documentation of psa_start_key_creation() for the intended use
1861 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001862 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001863 * \param[in,out] slot Pointer to the slot with key material.
1864 * \param[in] driver The secure element driver for the key,
1865 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001866 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001867static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001868 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001869{
Gilles Peskine011e4282019-06-26 18:34:38 +02001870 (void) driver;
1871
Gilles Peskine4747d192019-04-17 15:05:45 +02001872 if( slot == NULL )
1873 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001874
1875#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001876 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001877 * element, and the failure happened later (when saving metadata
1878 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001879 * element.
1880 * https://github.com/ARMmbed/mbed-crypto/issues/217
1881 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001882
Gilles Peskined7729582019-08-05 15:55:54 +02001883 /* Abort the ongoing transaction if any (there may not be one if
1884 * the creation process failed before starting one, or if the
1885 * key creation is a registration of a key in a secure element).
1886 * Earlier functions must already have done what it takes to undo any
1887 * partial creation. All that's left is to update the transaction data
1888 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001889 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001890#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1891
Gilles Peskine4747d192019-04-17 15:05:45 +02001892 psa_wipe_key_slot( slot );
1893}
1894
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001895/** Validate optional attributes during key creation.
1896 *
1897 * Some key attributes are optional during key creation. If they are
1898 * specified in the attributes structure, check that they are consistent
1899 * with the data in the slot.
1900 *
1901 * This function should be called near the end of key creation, after
1902 * the slot in memory is fully populated but before saving persistent data.
1903 */
1904static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001905 const psa_key_slot_t *slot,
1906 const psa_key_attributes_t *attributes )
1907{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001908 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001910 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001911 return( PSA_ERROR_INVALID_ARGUMENT );
1912 }
1913
1914 if( attributes->domain_parameters_size != 0 )
1915 {
John Durkop0e005192020-10-31 22:06:54 -07001916#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1917 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001918 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001919 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001920 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001921 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001922 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001923
Ronald Cron90857082020-11-25 14:58:33 +01001924 psa_status_t status = mbedtls_psa_rsa_load_representation(
1925 slot->attr.type,
1926 slot->key.data,
1927 slot->key.bytes,
1928 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001929 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001930 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001931
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001932 mbedtls_mpi_init( &actual );
1933 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001934 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001935 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001936 mbedtls_rsa_free( rsa );
1937 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001938 if( ret != 0 )
1939 goto rsa_exit;
1940 ret = mbedtls_mpi_read_binary( &required,
1941 attributes->domain_parameters,
1942 attributes->domain_parameters_size );
1943 if( ret != 0 )
1944 goto rsa_exit;
1945 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1946 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1947 rsa_exit:
1948 mbedtls_mpi_free( &actual );
1949 mbedtls_mpi_free( &required );
1950 if( ret != 0)
1951 return( mbedtls_to_psa_error( ret ) );
1952 }
1953 else
John Durkop9814fa22020-11-04 12:28:15 -08001954#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1955 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001956 {
1957 return( PSA_ERROR_INVALID_ARGUMENT );
1958 }
1959 }
1960
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001961 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001962 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001963 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001964 return( PSA_ERROR_INVALID_ARGUMENT );
1965 }
1966
1967 return( PSA_SUCCESS );
1968}
1969
Gilles Peskine4747d192019-04-17 15:05:45 +02001970psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001971 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001972 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001973 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001974{
1975 psa_status_t status;
1976 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001977 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001978 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001979
Ronald Cron81709fc2020-11-14 12:10:32 +01001980 *key = MBEDTLS_SVC_KEY_ID_INIT;
1981
Gilles Peskine0f84d622019-09-12 19:03:13 +02001982 /* Reject zero-length symmetric keys (including raw data key objects).
1983 * This also rejects any key which might be encoded as an empty string,
1984 * which is never valid. */
1985 if( data_length == 0 )
1986 return( PSA_ERROR_INVALID_ARGUMENT );
1987
Gilles Peskinedf179142019-07-15 22:02:14 +02001988 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001989 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001990 if( status != PSA_SUCCESS )
1991 goto exit;
1992
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001993 /* In the case of a transparent key or an opaque key stored in local
1994 * storage (thus not in the case of generating a key in a secure element
1995 * or cryptoprocessor with storage), we have to allocate a buffer to
1996 * hold the generated key material. */
1997 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001998 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001999 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002000 if( status != PSA_SUCCESS )
2001 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002002 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002003
2004 bits = slot->attr.bits;
2005 status = psa_driver_wrapper_import_key( attributes,
2006 data, data_length,
2007 slot->key.data,
2008 slot->key.bytes,
2009 &slot->key.bytes, &bits );
2010 if( status != PSA_SUCCESS )
2011 goto exit;
2012
2013 if( slot->attr.bits == 0 )
2014 slot->attr.bits = (psa_key_bits_t) bits;
2015 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002016 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002017 status = PSA_ERROR_INVALID_ARGUMENT;
2018 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002019 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002020
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002021 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002022 if( status != PSA_SUCCESS )
2023 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024
Ronald Cron81709fc2020-11-14 12:10:32 +01002025 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002026exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002027 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002028 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002029
Gilles Peskine4747d192019-04-17 15:05:45 +02002030 return( status );
2031}
2032
Gilles Peskined7729582019-08-05 15:55:54 +02002033#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2034psa_status_t mbedtls_psa_register_se_key(
2035 const psa_key_attributes_t *attributes )
2036{
2037 psa_status_t status;
2038 psa_key_slot_t *slot = NULL;
2039 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002040 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002041
2042 /* Leaving attributes unspecified is not currently supported.
2043 * It could make sense to query the key type and size from the
2044 * secure element, but not all secure elements support this
2045 * and the driver HAL doesn't currently support it. */
2046 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2047 return( PSA_ERROR_NOT_SUPPORTED );
2048 if( psa_get_key_bits( attributes ) == 0 )
2049 return( PSA_ERROR_NOT_SUPPORTED );
2050
2051 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002052 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002053 if( status != PSA_SUCCESS )
2054 goto exit;
2055
Ronald Cron81709fc2020-11-14 12:10:32 +01002056 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002057
2058exit:
2059 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002060 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002061
Gilles Peskined7729582019-08-05 15:55:54 +02002062 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002063 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002064 return( status );
2065}
2066#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2067
Gilles Peskinef603c712019-01-19 13:40:11 +01002068static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002069 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002070{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002071 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002072 source->key.data,
2073 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002074 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002075 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002076
Steven Cooreman398aee52020-10-13 14:35:45 +02002077 target->attr.type = source->attr.type;
2078 target->attr.bits = source->attr.bits;
2079
2080 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002081}
2082
Ronald Croncf56a0a2020-08-04 09:51:30 +02002083psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002084 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002085 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002086{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002087 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002088 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002089 psa_key_slot_t *source_slot = NULL;
2090 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002091 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002092 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002093
Ronald Cron81709fc2020-11-14 12:10:32 +01002094 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2095
Ronald Cron5c522922020-11-14 16:35:34 +01002096 status = psa_get_and_lock_transparent_key_slot_with_policy(
2097 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002098 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002099 goto exit;
2100
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002101 status = psa_validate_optional_attributes( source_slot,
2102 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002103 if( status != PSA_SUCCESS )
2104 goto exit;
2105
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002106 status = psa_restrict_key_policy( source_slot->attr.type,
2107 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002108 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002109 if( status != PSA_SUCCESS )
2110 goto exit;
2111
Ronald Cron81709fc2020-11-14 12:10:32 +01002112 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2113 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002114 if( status != PSA_SUCCESS )
2115 goto exit;
2116
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002117#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2118 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002119 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002120 /* Copying to a secure element is not implemented yet. */
2121 status = PSA_ERROR_NOT_SUPPORTED;
2122 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002123 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002124#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002125
Ronald Cron6cc66312021-04-02 12:27:47 +02002126 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2127 {
2128 /*
2129 * Copying through an opaque driver is not implemented yet, consider
2130 * a lifetime with an external location as an invalid parameter for
2131 * now.
2132 */
2133 status = PSA_ERROR_INVALID_ARGUMENT;
2134 goto exit;
2135 }
2136
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002137 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002138 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002139 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002140
Ronald Cron81709fc2020-11-14 12:10:32 +01002141 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002142exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002143 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002144 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002145
Ronald Cron5c522922020-11-14 16:35:34 +01002146 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002147
Ronald Cron5c522922020-11-14 16:35:34 +01002148 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002149}
2150
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002151
2152
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002153/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002154/* Message digests */
2155/****************************************************************/
2156
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002157psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2158{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002159 /* Aborting a non-active operation is allowed */
2160 if( operation->id == 0 )
2161 return( PSA_SUCCESS );
2162
2163 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2164 operation->id = 0;
2165
2166 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167}
2168
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002169psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170 psa_algorithm_t alg )
2171{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002172 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002173
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002174 /* A context must be freshly initialized before it can be set up. */
2175 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002176 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002177 status = PSA_ERROR_BAD_STATE;
2178 goto exit;
2179 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002180
2181 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmandb861792021-06-24 16:17:43 +01002182 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002183 status = PSA_ERROR_INVALID_ARGUMENT;
2184 goto exit;
2185 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002186
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002187 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2188 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002189 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2190
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002191 status = psa_driver_wrapper_hash_setup( operation, alg );
2192
2193exit:
2194 if( status != PSA_SUCCESS )
Dave Rodgmandb861792021-06-24 16:17:43 +01002195 psa_hash_abort( operation );
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002196
2197 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002198}
2199
2200psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2201 const uint8_t *input,
2202 size_t input_length )
2203{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2205
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002206 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002207 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002208 status = PSA_ERROR_BAD_STATE;
2209 goto exit;
2210 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002211
Steven Cooremanc8288352021-03-04 14:02:19 +01002212 /* Don't require hash implementations to behave correctly on a
2213 * zero-length input, which may have an invalid pointer. */
2214 if( input_length == 0 )
2215 return( PSA_SUCCESS );
2216
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002217 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2218
2219exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002220 if( status != PSA_SUCCESS )
2221 psa_hash_abort( operation );
2222
2223 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224}
2225
2226psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2227 uint8_t *hash,
2228 size_t hash_size,
2229 size_t *hash_length )
2230{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002231 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002232 if( operation->id == 0 )
2233 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234
Steven Cooreman1e582352021-02-18 17:24:37 +01002235 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002236 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002237 psa_hash_abort( operation );
2238 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239}
2240
Gilles Peskine2d277862018-06-18 15:41:12 +02002241psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2242 const uint8_t *hash,
2243 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244{
2245 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2246 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002247 psa_status_t status = psa_hash_finish(
2248 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002249 actual_hash, sizeof( actual_hash ),
2250 &actual_hash_length );
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002251
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002252 if( status != PSA_SUCCESS )
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002253 goto exit;
2254
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002255 if( actual_hash_length != hash_length )
Dave Rodgmandb861792021-06-24 16:17:43 +01002256 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002257 status = PSA_ERROR_INVALID_SIGNATURE;
2258 goto exit;
2259 }
2260
Steven Cooremana2a1b802021-04-29 16:37:59 +02002261 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002262 status = PSA_ERROR_INVALID_SIGNATURE;
2263
2264exit:
2265 if( status != PSA_SUCCESS )
2266 psa_hash_abort(operation);
2267
2268 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002269}
2270
Gilles Peskine0a749c82019-11-28 19:33:58 +01002271psa_status_t psa_hash_compute( psa_algorithm_t alg,
2272 const uint8_t *input, size_t input_length,
2273 uint8_t *hash, size_t hash_size,
2274 size_t *hash_length )
2275{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002276 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002277 if( !PSA_ALG_IS_HASH( alg ) )
2278 return( PSA_ERROR_INVALID_ARGUMENT );
2279
Steven Cooreman1e582352021-02-18 17:24:37 +01002280 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2281 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002282}
2283
2284psa_status_t psa_hash_compare( psa_algorithm_t alg,
2285 const uint8_t *input, size_t input_length,
2286 const uint8_t *hash, size_t hash_length )
2287{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002288 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2289 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002290
2291 if( !PSA_ALG_IS_HASH( alg ) )
2292 return( PSA_ERROR_INVALID_ARGUMENT );
2293
Steven Cooreman1e582352021-02-18 17:24:37 +01002294 psa_status_t status = psa_driver_wrapper_hash_compute(
2295 alg, input, input_length,
2296 actual_hash, sizeof(actual_hash),
2297 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002298 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002299 return( status );
2300 if( actual_hash_length != hash_length )
2301 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002302 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002303 return( PSA_ERROR_INVALID_SIGNATURE );
2304 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002305}
2306
Gilles Peskineeb35d782019-01-22 17:56:16 +01002307psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2308 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002309{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002310 if( source_operation->id == 0 ||
2311 target_operation->id != 0 )
2312 {
2313 return( PSA_ERROR_BAD_STATE );
2314 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002315
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002316 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2317 target_operation );
2318 if( status != PSA_SUCCESS )
2319 psa_hash_abort( target_operation );
2320
2321 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002322}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002323
2324
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002326/* MAC */
2327/****************************************************************/
2328
Steven Cooreman07897832021-03-19 18:28:56 +01002329psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002330{
Steven Cooreman07897832021-03-19 18:28:56 +01002331 /* Aborting a non-active operation is allowed */
2332 if( operation->id == 0 )
2333 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002334
Steven Cooreman07897832021-03-19 18:28:56 +01002335 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002336 operation->mac_size = 0;
2337 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002338 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002339
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002340 return( status );
2341}
2342
Ronald Cron1c650a12021-06-17 16:33:22 +02002343static psa_status_t psa_mac_finalize_alg_and_key_validation(
2344 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002345 const psa_key_attributes_t *attributes,
2346 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002347{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondef68e72021-06-17 16:46:44 +02002349 psa_key_type_t key_type = psa_get_key_type( attributes );
2350 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002351
Ronald Cron48f875e2021-06-17 16:10:24 +02002352 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Crondef68e72021-06-17 16:46:44 +02002353 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman07897832021-03-19 18:28:56 +01002354
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002355 /* Validate the combination of key type and algorithm */
Ronald Crondef68e72021-06-17 16:46:44 +02002356 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002357 if( status != PSA_SUCCESS )
Ronald Crondef68e72021-06-17 16:46:44 +02002358 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002359
Steven Cooremana6474de2021-05-10 11:13:41 +02002360 /* Get the output length for the algorithm and key combination */
Ronald Crondef68e72021-06-17 16:46:44 +02002361 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002362
Ronald Crondef68e72021-06-17 16:46:44 +02002363 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002364 {
2365 /* A very short MAC is too short for security since it can be
2366 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2367 * so we make this our minimum, even though 32 bits is still
2368 * too small for security. */
Ronald Crondef68e72021-06-17 16:46:44 +02002369 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002370 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002371
Ronald Crondef68e72021-06-17 16:46:44 +02002372 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2373 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002374 {
2375 /* It's impossible to "truncate" to a larger length than the full length
2376 * of the algorithm. */
Ronald Crondef68e72021-06-17 16:46:44 +02002377 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002378 }
2379
Ronald Crondef68e72021-06-17 16:46:44 +02002380 return( PSA_SUCCESS );
Ronald Cron1c650a12021-06-17 16:33:22 +02002381}
2382
2383static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2384 mbedtls_svc_key_id_t key,
2385 psa_algorithm_t alg,
2386 int is_sign )
2387{
2388 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2389 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002390 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002391
2392 /* A context must be freshly initialized before it can be set up. */
2393 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002394 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002395 status = PSA_ERROR_BAD_STATE;
2396 goto exit;
2397 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002398
2399 status = psa_get_and_lock_key_slot_with_policy(
2400 key,
2401 &slot,
Mateusz Starzykdd55b252021-08-17 15:24:32 +02002402 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Cron1c650a12021-06-17 16:33:22 +02002403 alg );
2404 if( status != PSA_SUCCESS )
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002405 goto exit;
Ronald Cron1c650a12021-06-17 16:33:22 +02002406
2407 psa_key_attributes_t attributes = {
2408 .core = slot->attr
2409 };
2410
Ronald Crondef68e72021-06-17 16:46:44 +02002411 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2412 &operation->mac_size );
Ronald Cron1c650a12021-06-17 16:33:22 +02002413 if( status != PSA_SUCCESS )
2414 goto exit;
2415
2416 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002417 /* Dispatch the MAC setup call with validated input */
2418 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002419 {
Steven Cooreman07897832021-03-19 18:28:56 +01002420 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002421 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002422 slot->key.data,
2423 slot->key.bytes,
2424 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002425 }
2426 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002427 {
Steven Cooreman07897832021-03-19 18:28:56 +01002428 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002429 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002430 slot->key.data,
2431 slot->key.bytes,
2432 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002434
Gilles Peskinefbfac682018-07-08 20:51:54 +02002435exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002436 if( status != PSA_SUCCESS )
Steven Cooreman07897832021-03-19 18:28:56 +01002437 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002438
Ronald Cron5c522922020-11-14 16:35:34 +01002439 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002440
Ronald Cron5c522922020-11-14 16:35:34 +01002441 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442}
2443
Gilles Peskine89167cb2018-07-08 20:12:23 +02002444psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002445 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002446 psa_algorithm_t alg )
2447{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002448 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002449}
2450
2451psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002452 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002453 psa_algorithm_t alg )
2454{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002455 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002456}
2457
Steven Cooreman11743f92021-03-19 18:38:46 +01002458psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002459 const uint8_t *input,
2460 size_t input_length )
2461{
Steven Cooreman11743f92021-03-19 18:38:46 +01002462 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002463 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002464
Steven Cooreman11743f92021-03-19 18:38:46 +01002465 /* Don't require hash implementations to behave correctly on a
2466 * zero-length input, which may have an invalid pointer. */
2467 if( input_length == 0 )
2468 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002469
Steven Cooreman11743f92021-03-19 18:38:46 +01002470 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2471 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002472 if( status != PSA_SUCCESS )
Steven Cooreman11743f92021-03-19 18:38:46 +01002473 psa_mac_abort( operation );
2474
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002475 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002476}
2477
Steven Cooreman87885df2021-03-19 19:04:39 +01002478psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002479 uint8_t *mac,
2480 size_t mac_size,
2481 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002482{
Steven Cooreman87885df2021-03-19 19:04:39 +01002483 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2484 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002485
Steven Cooreman87885df2021-03-19 19:04:39 +01002486 if( operation->id == 0 )
Dave Rodgmand73e1b02021-06-24 16:19:08 +01002487 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002488 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002489 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002490 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002491
Steven Cooreman15f0d922021-05-07 14:14:37 +02002492 if( ! operation->is_sign )
Dave Rodgmandb861792021-06-24 16:17:43 +01002493 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002494 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002495 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002496 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002497
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002498 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2499 * once all the error checks are done. */
2500 if( operation->mac_size == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002501 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002502 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002503 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002504 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002505
2506 if( mac_size < operation->mac_size )
Dave Rodgmandb861792021-06-24 16:17:43 +01002507 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002508 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002509 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002510 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002511
Steven Cooreman87885df2021-03-19 19:04:39 +01002512 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman15f0d922021-05-07 14:14:37 +02002513 mac, operation->mac_size,
2514 mac_length );
2515
Dave Rodgman478ab542021-06-25 09:09:02 +01002516exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002517 /* In case of success, set the potential excess room in the output buffer
2518 * to an invalid value, to avoid potentially leaking a longer MAC.
2519 * In case of error, set the output length and content to a safe default,
2520 * such that in case the caller misses an error check, the output would be
2521 * an unachievable MAC.
2522 */
2523 if( status != PSA_SUCCESS )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002524 {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002525 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002526 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002527 }
mohammad16036df908f2018-04-02 08:34:15 -07002528
Ronald Cron882eb782021-06-18 13:05:48 +02002529 if( mac_size > operation->mac_size )
2530 memset( &mac[operation->mac_size], '!',
2531 mac_size - operation->mac_size );
2532
Steven Cooreman87885df2021-03-19 19:04:39 +01002533 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002534
Steven Cooreman87885df2021-03-19 19:04:39 +01002535 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002536}
2537
Steven Cooreman87885df2021-03-19 19:04:39 +01002538psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002539 const uint8_t *mac,
2540 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541{
Steven Cooreman87885df2021-03-19 19:04:39 +01002542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2543 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002544
Steven Cooreman87885df2021-03-19 19:04:39 +01002545 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002546 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002547 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002548 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002549 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002550
Steven Cooreman15f0d922021-05-07 14:14:37 +02002551 if( operation->is_sign )
Dave Rodgmandb861792021-06-24 16:17:43 +01002552 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002553 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002554 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002555 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002556
2557 if( operation->mac_size != mac_length )
2558 {
2559 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002560 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002561 }
2562
Steven Cooreman87885df2021-03-19 19:04:39 +01002563 status = psa_driver_wrapper_mac_verify_finish( operation,
2564 mac, mac_length );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002565
Dave Rodgman478ab542021-06-25 09:09:02 +01002566exit:
Steven Cooreman87885df2021-03-19 19:04:39 +01002567 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002568
Steven Cooreman87885df2021-03-19 19:04:39 +01002569 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002570}
2571
Ronald Cronef0d8f12021-06-18 14:23:33 +02002572static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2573 psa_algorithm_t alg,
2574 const uint8_t *input,
2575 size_t input_length,
2576 uint8_t *mac,
2577 size_t mac_size,
2578 size_t *mac_length,
2579 int is_sign )
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002580{
2581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002582 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2583 psa_key_slot_t *slot;
2584 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002585
Ronald Crondbb86462021-06-17 17:17:20 +02002586 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykdd55b252021-08-17 15:24:32 +02002587 key,
2588 &slot,
2589 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Cronef0d8f12021-06-18 14:23:33 +02002590 alg );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002591 if( status != PSA_SUCCESS )
2592 goto exit;
2593
Ronald Crondbb86462021-06-17 17:17:20 +02002594 psa_key_attributes_t attributes = {
2595 .core = slot->attr
2596 };
2597
2598 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2599 &operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002600 if( status != PSA_SUCCESS )
2601 goto exit;
2602
Ronald Crondbb86462021-06-17 17:17:20 +02002603 if( mac_size < operation_mac_size )
2604 {
2605 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002606 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002607 }
2608
2609 status = psa_driver_wrapper_mac_compute(
2610 &attributes,
2611 slot->key.data, slot->key.bytes,
2612 alg,
2613 input, input_length,
2614 mac, operation_mac_size, mac_length );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002615
2616exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002617 /* In case of success, set the potential excess room in the output buffer
2618 * to an invalid value, to avoid potentially leaking a longer MAC.
2619 * In case of error, set the output length and content to a safe default,
2620 * such that in case the caller misses an error check, the output would be
2621 * an unachievable MAC.
2622 */
2623 if( status != PSA_SUCCESS )
Ronald Crondbb86462021-06-17 17:17:20 +02002624 {
Ronald Crondbb86462021-06-17 17:17:20 +02002625 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002626 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002627 }
Ronald Cron882eb782021-06-18 13:05:48 +02002628 if( mac_size > operation_mac_size )
2629 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002630
Ronald Crondbb86462021-06-17 17:17:20 +02002631 unlock_status = psa_unlock_key_slot( slot );
2632
2633 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002634}
2635
Ronald Cronef0d8f12021-06-18 14:23:33 +02002636psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2637 psa_algorithm_t alg,
2638 const uint8_t *input,
2639 size_t input_length,
2640 uint8_t *mac,
2641 size_t mac_size,
2642 size_t *mac_length)
2643{
2644 return( psa_mac_compute_internal( key, alg,
2645 input, input_length,
2646 mac, mac_size, mac_length, 1 ) );
2647}
2648
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002649psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2650 psa_algorithm_t alg,
2651 const uint8_t *input,
2652 size_t input_length,
2653 const uint8_t *mac,
2654 size_t mac_length)
2655{
2656 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002657 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2658 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002659
Ronald Cron4ed83682021-06-18 14:51:29 +02002660 status = psa_mac_compute_internal( key, alg,
2661 input, input_length,
2662 actual_mac, sizeof( actual_mac ),
2663 &actual_mac_length, 0 );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002664 if( status != PSA_SUCCESS )
2665 goto exit;
2666
Ronald Cron4ed83682021-06-18 14:51:29 +02002667 if( mac_length != actual_mac_length )
2668 {
2669 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002670 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002671 }
2672 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2673 {
2674 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002675 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002676 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002677
2678exit:
Ronald Cron4ed83682021-06-18 14:51:29 +02002679 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002680
2681 return ( status );
2682}
Gilles Peskine20035e32018-02-03 22:44:14 +01002683
Gilles Peskine20035e32018-02-03 22:44:14 +01002684/****************************************************************/
2685/* Asymmetric cryptography */
2686/****************************************************************/
2687
gabor-mezei-armc9795782021-05-12 11:03:09 +02002688static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm56980482021-05-05 13:56:27 +02002689 psa_algorithm_t alg )
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002690{
gabor-mezei-armc9795782021-05-12 11:03:09 +02002691 if( input_is_message )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002692 {
2693 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2694 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002695
Gilles Peskine8cb22c82021-09-22 16:15:05 +02002696 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002697 {
2698 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2699 return( PSA_ERROR_INVALID_ARGUMENT );
2700 }
2701 }
2702 else
2703 {
Mateusz Starzykd22362c2021-08-26 11:46:14 +02002704 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002705 return( PSA_ERROR_INVALID_ARGUMENT );
2706 }
2707
2708 return( PSA_SUCCESS );
2709}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002710
2711static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002712 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002713 psa_algorithm_t alg,
2714 const uint8_t * input,
2715 size_t input_length,
2716 uint8_t * signature,
2717 size_t signature_size,
2718 size_t * signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002719{
2720 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2721 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2722 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002723
2724 *signature_length = 0;
2725
gabor-mezei-armc9795782021-05-12 11:03:09 +02002726 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002727 if( status != PSA_SUCCESS )
2728 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002729
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002730 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002731 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002732 * buffer can in principle be empty since it doesn't actually have
2733 * to be a hash.) */
2734 if( signature_size == 0 )
2735 return( PSA_ERROR_BUFFER_TOO_SMALL );
2736
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002737 status = psa_get_and_lock_key_slot_with_policy(
2738 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002739 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2740 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002741 alg );
2742
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002743 if( status != PSA_SUCCESS )
2744 goto exit;
2745
2746 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2747 {
2748 status = PSA_ERROR_INVALID_ARGUMENT;
2749 goto exit;
2750 }
2751
2752 psa_key_attributes_t attributes = {
2753 .core = slot->attr
2754 };
2755
gabor-mezei-armc9795782021-05-12 11:03:09 +02002756 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002757 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002758 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002759 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002760 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002761 signature, signature_size, signature_length );
2762 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002763 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002764 {
2765
2766 status = psa_driver_wrapper_sign_hash(
2767 &attributes, slot->key.data, slot->key.bytes,
2768 alg, input, input_length,
2769 signature, signature_size, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002770 }
2771
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002772
2773exit:
2774 /* Fill the unused part of the output buffer (the whole buffer on error,
2775 * the trailing part on success) with something that isn't a valid signature
2776 * (barring an attack on the signature and deliberately-crafted input),
2777 * in case the caller doesn't check the return status properly. */
2778 if( status == PSA_SUCCESS )
2779 memset( signature + *signature_length, '!',
2780 signature_size - *signature_length );
2781 else
2782 memset( signature, '!', signature_size );
2783 /* If signature_size is 0 then we have nothing to do. We must not call
2784 * memset because signature may be NULL in this case. */
2785
2786 unlock_status = psa_unlock_key_slot( slot );
2787
2788 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2789}
2790
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002791static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002792 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002793 psa_algorithm_t alg,
2794 const uint8_t * input,
2795 size_t input_length,
2796 const uint8_t * signature,
2797 size_t signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002798{
2799 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2800 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2801 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002802
gabor-mezei-armc9795782021-05-12 11:03:09 +02002803 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002804 if( status != PSA_SUCCESS )
2805 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002806
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002807 status = psa_get_and_lock_key_slot_with_policy(
2808 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002809 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2810 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002811 alg );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002812
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002813 if( status != PSA_SUCCESS )
2814 return( status );
2815
2816 psa_key_attributes_t attributes = {
2817 .core = slot->attr
2818 };
2819
gabor-mezei-armc9795782021-05-12 11:03:09 +02002820 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002821 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002822 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002823 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002824 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002825 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002826 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002827 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002828 {
2829 status = psa_driver_wrapper_verify_hash(
2830 &attributes, slot->key.data, slot->key.bytes,
2831 alg, input, input_length,
2832 signature, signature_length );
2833 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002834
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002835 unlock_status = psa_unlock_key_slot( slot );
2836
2837 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002838
2839}
2840
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002841psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002842 const psa_key_attributes_t *attributes,
2843 const uint8_t *key_buffer,
2844 size_t key_buffer_size,
2845 psa_algorithm_t alg,
2846 const uint8_t *input,
2847 size_t input_length,
2848 uint8_t *signature,
2849 size_t signature_size,
2850 size_t *signature_length )
2851{
2852 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002853
Gilles Peskine8cb22c82021-09-22 16:15:05 +02002854 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002855 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002856 size_t hash_length;
2857 uint8_t hash[PSA_HASH_MAX_SIZE];
2858
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002859 status = psa_driver_wrapper_hash_compute(
2860 PSA_ALG_SIGN_GET_HASH( alg ),
2861 input, input_length,
2862 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002863
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002864 if( status != PSA_SUCCESS )
2865 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002866
2867 return psa_driver_wrapper_sign_hash(
2868 attributes, key_buffer, key_buffer_size,
2869 alg, hash, hash_length,
2870 signature, signature_size, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002871 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002872
gabor-mezei-arm56980482021-05-05 13:56:27 +02002873 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002874}
2875
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002876psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2877 psa_algorithm_t alg,
2878 const uint8_t * input,
2879 size_t input_length,
2880 uint8_t * signature,
2881 size_t signature_size,
2882 size_t * signature_length )
2883{
2884 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002885 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002886 signature, signature_size, signature_length );
2887}
2888
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002889psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002890 const psa_key_attributes_t *attributes,
2891 const uint8_t *key_buffer,
2892 size_t key_buffer_size,
2893 psa_algorithm_t alg,
2894 const uint8_t *input,
2895 size_t input_length,
2896 const uint8_t *signature,
2897 size_t signature_length )
2898{
2899 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002900
Gilles Peskine8cb22c82021-09-22 16:15:05 +02002901 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002902 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002903 size_t hash_length;
2904 uint8_t hash[PSA_HASH_MAX_SIZE];
2905
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002906 status = psa_driver_wrapper_hash_compute(
2907 PSA_ALG_SIGN_GET_HASH( alg ),
2908 input, input_length,
2909 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002910
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002911 if( status != PSA_SUCCESS )
2912 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002913
2914 return psa_driver_wrapper_verify_hash(
2915 attributes, key_buffer, key_buffer_size,
2916 alg, hash, hash_length,
2917 signature, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002918 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002919
gabor-mezei-armef6f2aa2021-05-05 13:59:01 +02002920 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002921}
2922
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002923psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2924 psa_algorithm_t alg,
2925 const uint8_t * input,
2926 size_t input_length,
2927 const uint8_t * signature,
2928 size_t signature_length )
2929{
2930 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002931 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002932 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002933}
2934
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002935psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002936 const psa_key_attributes_t *attributes,
2937 const uint8_t *key_buffer, size_t key_buffer_size,
2938 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2939 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002940{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002941 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002942 {
Ronald Cron4501c982021-03-19 20:09:32 +01002943 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2944 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002945 {
Ronald Cron4501c982021-03-19 20:09:32 +01002946#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2947 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2948 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002949 attributes,
2950 key_buffer, key_buffer_size,
2951 alg, hash, hash_length,
2952 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002953#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2954 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002955 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002956 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002957 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002958 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002959 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002960 }
2961 else
Ronald Cron4501c982021-03-19 20:09:32 +01002962 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2963 {
2964 if( PSA_ALG_IS_ECDSA( alg ) )
2965 {
2966#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2967 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2968 return( mbedtls_psa_ecdsa_sign_hash(
2969 attributes,
2970 key_buffer, key_buffer_size,
2971 alg, hash, hash_length,
2972 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002973#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2974 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002975 }
2976 else
2977 {
2978 return( PSA_ERROR_INVALID_ARGUMENT );
2979 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002980 }
Ronald Cron4501c982021-03-19 20:09:32 +01002981
2982 (void)key_buffer;
2983 (void)key_buffer_size;
2984 (void)hash;
2985 (void)hash_length;
2986 (void)signature;
2987 (void)signature_size;
2988 (void)signature_length;
2989
2990 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002991}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002992
2993psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2994 psa_algorithm_t alg,
2995 const uint8_t *hash,
2996 size_t hash_length,
2997 uint8_t *signature,
2998 size_t signature_size,
2999 size_t *signature_length )
3000{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003001 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003002 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003003 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03003004}
3005
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003006psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003007 const psa_key_attributes_t *attributes,
3008 const uint8_t *key_buffer, size_t key_buffer_size,
3009 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3010 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003011{
Ronald Cron99b8ed72021-02-17 10:33:32 +01003012 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003013 {
Ronald Cron4501c982021-03-19 20:09:32 +01003014 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
3015 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003016 {
Ronald Cron4501c982021-03-19 20:09:32 +01003017#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3018 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3019 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01003020 attributes,
3021 key_buffer, key_buffer_size,
3022 alg, hash, hash_length,
3023 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01003024#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3025 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02003026 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003027 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003028 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003029 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003030 }
itayzafrir5c753392018-05-08 11:18:38 +03003031 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003032 else
Ronald Cron4501c982021-03-19 20:09:32 +01003033 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003034 {
Ronald Cron4501c982021-03-19 20:09:32 +01003035 if( PSA_ALG_IS_ECDSA( alg ) )
3036 {
3037#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3038 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3039 return( mbedtls_psa_ecdsa_verify_hash(
3040 attributes,
3041 key_buffer, key_buffer_size,
3042 alg, hash, hash_length,
3043 signature, signature_length ) );
3044#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3045 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3046 }
3047 else
3048 {
3049 return( PSA_ERROR_INVALID_ARGUMENT );
3050 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003051 }
Ronald Cron4501c982021-03-19 20:09:32 +01003052
3053 (void)key_buffer;
3054 (void)key_buffer_size;
3055 (void)hash;
3056 (void)hash_length;
3057 (void)signature;
3058 (void)signature_length;
3059
3060 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003061}
3062
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3064 psa_algorithm_t alg,
3065 const uint8_t *hash,
3066 size_t hash_length,
3067 const uint8_t *signature,
3068 size_t signature_length )
3069{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003070 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003071 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003072 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003073}
3074
John Durkop0e005192020-10-31 22:06:54 -07003075#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003076static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3077 mbedtls_rsa_context *rsa )
3078{
3079 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3080 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3081 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3082 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3083}
John Durkop0e005192020-10-31 22:06:54 -07003084#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003085
Ronald Croncf56a0a2020-08-04 09:51:30 +02003086psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003087 psa_algorithm_t alg,
3088 const uint8_t *input,
3089 size_t input_length,
3090 const uint8_t *salt,
3091 size_t salt_length,
3092 uint8_t *output,
3093 size_t output_size,
3094 size_t *output_length )
3095{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003096 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003097 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003098 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003099
Darryl Green5cc689a2018-07-24 15:34:10 +01003100 (void) input;
3101 (void) input_length;
3102 (void) salt;
3103 (void) output;
3104 (void) output_size;
3105
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003106 *output_length = 0;
3107
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003108 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3109 return( PSA_ERROR_INVALID_ARGUMENT );
3110
Ronald Cron5c522922020-11-14 16:35:34 +01003111 status = psa_get_and_lock_transparent_key_slot_with_policy(
3112 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003113 if( status != PSA_SUCCESS )
3114 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003115 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3116 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003117 {
3118 status = PSA_ERROR_INVALID_ARGUMENT;
3119 goto exit;
3120 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121
John Durkop6ba40d12020-11-10 08:50:04 -08003122#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3123 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003124 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003126 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003127 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3128 slot->key.data,
3129 slot->key.bytes,
3130 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003131 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003132 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003133
3134 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003135 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003136 status = PSA_ERROR_BUFFER_TOO_SMALL;
3137 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003138 }
John Durkop0e005192020-10-31 22:06:54 -07003139#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003140 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3141 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003142 status = mbedtls_to_psa_error(
3143 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003144 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003145 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003146 MBEDTLS_RSA_PUBLIC,
3147 input_length,
3148 input,
3149 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003150 }
3151 else
John Durkop0e005192020-10-31 22:06:54 -07003152#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3153#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003154 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3155 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003156 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003157 status = mbedtls_to_psa_error(
3158 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003159 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003160 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003161 MBEDTLS_RSA_PUBLIC,
3162 salt, salt_length,
3163 input_length,
3164 input,
3165 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003166 }
3167 else
John Durkop0e005192020-10-31 22:06:54 -07003168#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003169 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003170 status = PSA_ERROR_INVALID_ARGUMENT;
3171 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003172 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003173rsa_exit:
3174 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003175 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003176
Steven Cooremana2371e52020-07-28 14:30:39 +02003177 mbedtls_rsa_free( rsa );
3178 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003179 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003180 else
John Durkop9814fa22020-11-04 12:28:15 -08003181#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003182 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003183 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003184 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003185 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003186
3187exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003188 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003189
Ronald Cron5c522922020-11-14 16:35:34 +01003190 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003191}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003192
Ronald Croncf56a0a2020-08-04 09:51:30 +02003193psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003194 psa_algorithm_t alg,
3195 const uint8_t *input,
3196 size_t input_length,
3197 const uint8_t *salt,
3198 size_t salt_length,
3199 uint8_t *output,
3200 size_t output_size,
3201 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003202{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003203 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003204 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003205 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003206
Darryl Green5cc689a2018-07-24 15:34:10 +01003207 (void) input;
3208 (void) input_length;
3209 (void) salt;
3210 (void) output;
3211 (void) output_size;
3212
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003213 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003214
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003215 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3216 return( PSA_ERROR_INVALID_ARGUMENT );
3217
Ronald Cron5c522922020-11-14 16:35:34 +01003218 status = psa_get_and_lock_transparent_key_slot_with_policy(
3219 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003220 if( status != PSA_SUCCESS )
3221 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003222 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003223 {
3224 status = PSA_ERROR_INVALID_ARGUMENT;
3225 goto exit;
3226 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003227
John Durkop6ba40d12020-11-10 08:50:04 -08003228#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3229 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003230 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003231 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003232 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003233 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3234 slot->key.data,
3235 slot->key.bytes,
3236 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003237 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003238 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003239
Steven Cooremana2371e52020-07-28 14:30:39 +02003240 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003241 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003242 status = PSA_ERROR_INVALID_ARGUMENT;
3243 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003244 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003245
John Durkop0e005192020-10-31 22:06:54 -07003246#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003247 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003248 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003249 status = mbedtls_to_psa_error(
3250 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003251 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003252 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003253 MBEDTLS_RSA_PRIVATE,
3254 output_length,
3255 input,
3256 output,
3257 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003258 }
3259 else
John Durkop0e005192020-10-31 22:06:54 -07003260#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3261#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003262 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003263 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003264 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003265 status = mbedtls_to_psa_error(
3266 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003267 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003268 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003269 MBEDTLS_RSA_PRIVATE,
3270 salt, salt_length,
3271 output_length,
3272 input,
3273 output,
3274 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003275 }
3276 else
John Durkop0e005192020-10-31 22:06:54 -07003277#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003278 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003279 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003280 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003281
Steven Cooreman4fed4552020-08-03 14:46:03 +02003282rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003283 mbedtls_rsa_free( rsa );
3284 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003285 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003286 else
John Durkop6ba40d12020-11-10 08:50:04 -08003287#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3288 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003289 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003290 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003291 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003292
3293exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003294 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003295
Ronald Cron5c522922020-11-14 16:35:34 +01003296 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003297}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003298
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003299
3300
mohammad1603503973b2018-03-12 15:59:30 +02003301/****************************************************************/
3302/* Symmetric cryptography */
3303/****************************************************************/
3304
Ronald Cronab99ac22020-10-01 16:38:28 +02003305static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3306 mbedtls_svc_key_id_t key,
3307 psa_algorithm_t alg,
3308 mbedtls_operation_t cipher_operation )
3309{
3310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003312 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003313 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3314 PSA_KEY_USAGE_ENCRYPT :
3315 PSA_KEY_USAGE_DECRYPT );
3316
3317 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003318 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01003319 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003320 status = PSA_ERROR_BAD_STATE;
3321 goto exit;
3322 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003323
Ronald Cronab99ac22020-10-01 16:38:28 +02003324 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmandb861792021-06-24 16:17:43 +01003325 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003326 status = PSA_ERROR_INVALID_ARGUMENT;
3327 goto exit;
3328 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003329
Ronald Cronab99ac22020-10-01 16:38:28 +02003330 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3331 if( status != PSA_SUCCESS )
3332 goto exit;
3333
Ronald Cron49fafa92021-03-10 08:34:23 +01003334 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003335 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003336 * so we only set it (in the driver wrapper) after resources have been
3337 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003338 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003339 if( alg == PSA_ALG_ECB_NO_PADDING )
3340 operation->iv_required = 0;
3341 else
3342 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003343 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003344
Ronald Crona4af55f2020-12-14 14:36:06 +01003345 psa_key_attributes_t attributes = {
3346 .core = slot->attr
3347 };
3348
Ronald Cronab99ac22020-10-01 16:38:28 +02003349 /* Try doing the operation through a driver before using software fallback. */
3350 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003351 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3352 &attributes,
3353 slot->key.data,
3354 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003355 alg );
3356 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003357 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3358 &attributes,
3359 slot->key.data,
3360 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003361 alg );
3362
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003363exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003364 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003365 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003366
Ronald Cron5c522922020-11-14 16:35:34 +01003367 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003368
Ronald Cron5c522922020-11-14 16:35:34 +01003369 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003370}
3371
Gilles Peskinefe119512018-07-08 21:39:34 +02003372psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003373 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003374 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003375{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003376 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003377}
3378
Gilles Peskinefe119512018-07-08 21:39:34 +02003379psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003380 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003381 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003382{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003383 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003384}
3385
Gilles Peskinefe119512018-07-08 21:39:34 +02003386psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003387 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003388 size_t iv_size,
3389 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003390{
Ronald Cron6d051732020-10-01 14:10:20 +02003391 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003392
Ronald Cron5618a392021-03-26 09:52:26 +01003393 *iv_length = 0;
3394
Ronald Cron49fafa92021-03-10 08:34:23 +01003395 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003396 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003397 status = PSA_ERROR_BAD_STATE;
3398 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003399 }
3400
Steven Cooreman7df02922020-09-09 15:28:49 +02003401 if( operation->iv_set || ! operation->iv_required )
3402 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003403 status = PSA_ERROR_BAD_STATE;
3404 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003405 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003406
Ronald Cron5618a392021-03-26 09:52:26 +01003407 if( iv_size < operation->default_iv_length )
3408 {
3409 status = PSA_ERROR_BUFFER_TOO_SMALL;
3410 goto exit;
3411 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003412
Ronald Cron5618a392021-03-26 09:52:26 +01003413 status = psa_generate_random( iv, operation->default_iv_length );
3414 if( status != PSA_SUCCESS )
3415 goto exit;
3416
3417 status = psa_driver_wrapper_cipher_set_iv( operation,
3418 iv,
3419 operation->default_iv_length );
3420
3421exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003422 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003423 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003424 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003425 *iv_length = operation->default_iv_length;
3426 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003427 else
Moran Peker395db872018-05-31 14:07:14 +03003428 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003429
itayzafrir534bd7c2018-08-02 13:56:32 +03003430 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003431}
3432
Gilles Peskinefe119512018-07-08 21:39:34 +02003433psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003434 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003435 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003436{
Ronald Cron6d051732020-10-01 14:10:20 +02003437 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003438
Ronald Cron49fafa92021-03-10 08:34:23 +01003439 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01003440 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003441 status = PSA_ERROR_BAD_STATE;
3442 goto exit;
3443 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003444
Steven Cooreman7df02922020-09-09 15:28:49 +02003445 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmandb861792021-06-24 16:17:43 +01003446 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003447 status = PSA_ERROR_BAD_STATE;
3448 goto exit;
3449 }
Ronald Crona0d68172021-03-26 10:15:08 +01003450
3451 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmandb861792021-06-24 16:17:43 +01003452 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003453 status = PSA_ERROR_INVALID_ARGUMENT;
3454 goto exit;
3455 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003456
Ronald Crondd24c9b2020-12-15 14:10:01 +01003457 status = psa_driver_wrapper_cipher_set_iv( operation,
3458 iv,
3459 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003460
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003461exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003462 if( status == PSA_SUCCESS )
3463 operation->iv_set = 1;
3464 else
mohammad1603503973b2018-03-12 15:59:30 +02003465 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003466 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003467}
3468
Gilles Peskinee553c652018-06-04 16:22:46 +02003469psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3470 const uint8_t *input,
3471 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003472 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003473 size_t output_size,
3474 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003475{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003476 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003477
Ronald Cron49fafa92021-03-10 08:34:23 +01003478 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003479 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003480 status = PSA_ERROR_BAD_STATE;
3481 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003482 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003483
Steven Cooreman7df02922020-09-09 15:28:49 +02003484 if( operation->iv_required && ! operation->iv_set )
3485 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003486 status = PSA_ERROR_BAD_STATE;
3487 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003488 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003489
Ronald Crondd24c9b2020-12-15 14:10:01 +01003490 status = psa_driver_wrapper_cipher_update( operation,
3491 input,
3492 input_length,
3493 output,
3494 output_size,
3495 output_length );
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003496
3497exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003498 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003499 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003500
itayzafrir534bd7c2018-08-02 13:56:32 +03003501 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003502}
3503
Gilles Peskinee553c652018-06-04 16:22:46 +02003504psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3505 uint8_t *output,
3506 size_t output_size,
3507 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003508{
David Saadab4ecc272019-02-14 13:48:10 +02003509 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003510
Ronald Cron49fafa92021-03-10 08:34:23 +01003511 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003512 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003513 status = PSA_ERROR_BAD_STATE;
3514 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003515 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003516
Steven Cooreman7df02922020-09-09 15:28:49 +02003517 if( operation->iv_required && ! operation->iv_set )
3518 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003519 status = PSA_ERROR_BAD_STATE;
3520 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003521 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003522
Ronald Crondd24c9b2020-12-15 14:10:01 +01003523 status = psa_driver_wrapper_cipher_finish( operation,
3524 output,
3525 output_size,
3526 output_length );
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003527
3528exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003529 if( status == PSA_SUCCESS )
3530 return( psa_cipher_abort( operation ) );
3531 else
3532 {
3533 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003534 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003535
Steven Cooremanef8575e2020-09-11 11:44:50 +02003536 return( status );
3537 }
mohammad1603503973b2018-03-12 15:59:30 +02003538}
3539
Gilles Peskinee553c652018-06-04 16:22:46 +02003540psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3541{
Ronald Cron49fafa92021-03-10 08:34:23 +01003542 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003543 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003544 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003545 * in use. It's ok to call abort on such an object, and there's
3546 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003547 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003548 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003549
Ronald Crondd24c9b2020-12-15 14:10:01 +01003550 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003551
Ronald Cron49fafa92021-03-10 08:34:23 +01003552 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003553 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003554 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003555
Moran Peker395db872018-05-31 14:07:14 +03003556 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003557}
3558
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003559psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3560 psa_algorithm_t alg,
3561 const uint8_t *input,
3562 size_t input_length,
3563 uint8_t *output,
3564 size_t output_size,
3565 size_t *output_length )
3566{
3567 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003568 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3569 psa_key_slot_t *slot;
3570 psa_key_type_t key_type;
3571 size_t iv_length;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003572
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003573 *output_length = 0;
3574
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003575 if( ! PSA_ALG_IS_CIPHER( alg ) )
3576 return( PSA_ERROR_INVALID_ARGUMENT );
3577
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003578 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3579 PSA_KEY_USAGE_ENCRYPT,
3580 alg );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003581 if( status != PSA_SUCCESS )
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003582 return( status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003583
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003584 psa_key_attributes_t attributes = {
3585 .core = slot->attr
3586 };
3587
3588 key_type = slot->attr.type;
3589 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3590
3591 if( iv_length > 0 )
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003592 {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003593 if( output_size < iv_length )
3594 {
3595 status = PSA_ERROR_BUFFER_TOO_SMALL;
3596 goto exit;
3597 }
3598
3599 status = psa_generate_random( output, iv_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003600 if( status != PSA_SUCCESS )
3601 goto exit;
3602 }
3603
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003604 status = psa_driver_wrapper_cipher_encrypt(
3605 &attributes, slot->key.data, slot->key.bytes,
3606 alg, input, input_length,
3607 output, output_size, output_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003608
3609exit:
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003610 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003611
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003612 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003613}
3614
3615psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3616 psa_algorithm_t alg,
3617 const uint8_t *input,
3618 size_t input_length,
3619 uint8_t *output,
3620 size_t output_size,
3621 size_t *output_length )
3622{
3623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003624 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3625 psa_key_slot_t *slot;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003626
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003627 *output_length = 0;
3628
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003629 if( ! PSA_ALG_IS_CIPHER( alg ) )
3630 return( PSA_ERROR_INVALID_ARGUMENT );
3631
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003632 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3633 PSA_KEY_USAGE_DECRYPT,
3634 alg );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003635 if( status != PSA_SUCCESS )
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003636 return( status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003637
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003638 psa_key_attributes_t attributes = {
3639 .core = slot->attr
3640 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003641
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003642 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3643 {
3644 status = PSA_ERROR_INVALID_ARGUMENT;
3645 goto exit;
3646 }
3647
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003648 status = psa_driver_wrapper_cipher_decrypt(
3649 &attributes, slot->key.data, slot->key.bytes,
3650 alg, input, input_length,
3651 output, output_size, output_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003652
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003653exit:
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003654 unlock_status = psa_unlock_key_slot( slot );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003655
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003656 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003657}
3658
3659
mohammad16035955c982018-04-26 00:53:03 +03003660/****************************************************************/
3661/* AEAD */
3662/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003663
Ronald Croncf56a0a2020-08-04 09:51:30 +02003664psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003665 psa_algorithm_t alg,
3666 const uint8_t *nonce,
3667 size_t nonce_length,
3668 const uint8_t *additional_data,
3669 size_t additional_data_length,
3670 const uint8_t *plaintext,
3671 size_t plaintext_length,
3672 uint8_t *ciphertext,
3673 size_t ciphertext_size,
3674 size_t *ciphertext_length )
3675{
Ronald Cron215633c2021-03-16 17:15:37 +01003676 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3677 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003678
mohammad1603f08a5502018-06-03 15:05:47 +03003679 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003680
Steven Cooremanea7ab132021-03-17 16:28:00 +01003681 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3682 return( PSA_ERROR_NOT_SUPPORTED );
3683
Ronald Cron9a986162021-03-26 12:40:07 +01003684 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003685 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003686 if( status != PSA_SUCCESS )
3687 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003688
Ronald Cron215633c2021-03-16 17:15:37 +01003689 psa_key_attributes_t attributes = {
3690 .core = slot->attr
3691 };
mohammad16035955c982018-04-26 00:53:03 +03003692
Ronald Cronde822812021-03-17 16:08:20 +01003693 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003694 &attributes, slot->key.data, slot->key.bytes,
3695 alg,
3696 nonce, nonce_length,
3697 additional_data, additional_data_length,
3698 plaintext, plaintext_length,
3699 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003700
Gilles Peskineedf9a652018-08-17 18:11:56 +02003701 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3702 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003703
Ronald Cron9f310172021-03-16 16:36:37 +01003704 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003705
mohammad16035955c982018-04-26 00:53:03 +03003706 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003707}
3708
Ronald Croncf56a0a2020-08-04 09:51:30 +02003709psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003710 psa_algorithm_t alg,
3711 const uint8_t *nonce,
3712 size_t nonce_length,
3713 const uint8_t *additional_data,
3714 size_t additional_data_length,
3715 const uint8_t *ciphertext,
3716 size_t ciphertext_length,
3717 uint8_t *plaintext,
3718 size_t plaintext_size,
3719 size_t *plaintext_length )
3720{
Ronald Cron215633c2021-03-16 17:15:37 +01003721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3722 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003723
Gilles Peskineee652a32018-06-01 19:23:52 +02003724 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003725
Steven Cooremanea7ab132021-03-17 16:28:00 +01003726 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3727 return( PSA_ERROR_NOT_SUPPORTED );
3728
Ronald Cron9a986162021-03-26 12:40:07 +01003729 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003730 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003731 if( status != PSA_SUCCESS )
3732 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003733
Ronald Cron215633c2021-03-16 17:15:37 +01003734 psa_key_attributes_t attributes = {
3735 .core = slot->attr
3736 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003737
Ronald Cronde822812021-03-17 16:08:20 +01003738 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003739 &attributes, slot->key.data, slot->key.bytes,
3740 alg,
3741 nonce, nonce_length,
3742 additional_data, additional_data_length,
3743 ciphertext, ciphertext_length,
3744 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003745
Gilles Peskineedf9a652018-08-17 18:11:56 +02003746 if( status != PSA_SUCCESS && plaintext_size != 0 )
3747 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003748
Ronald Cron215633c2021-03-16 17:15:37 +01003749 psa_unlock_key_slot( slot );
3750
Gilles Peskineedf9a652018-08-17 18:11:56 +02003751 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003752}
3753
Gilles Peskinee59236f2018-01-27 23:32:46 +01003754/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003755/* Generators */
3756/****************************************************************/
3757
John Durkop07cc04a2020-11-16 22:08:34 -08003758#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3759 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3760 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3761#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003762#endif /* At least one builtin KDF */
3763
3764#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3765 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3766 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3767static psa_status_t psa_key_derivation_start_hmac(
3768 psa_mac_operation_t *operation,
3769 psa_algorithm_t hash_alg,
3770 const uint8_t *hmac_key,
3771 size_t hmac_key_length )
3772{
3773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3774 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3775 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3776 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3777 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3778
Steven Cooreman15f0d922021-05-07 14:14:37 +02003779 operation->is_sign = 1;
3780 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3781
Steven Cooreman9878a162021-05-06 17:58:36 +02003782 status = psa_driver_wrapper_mac_sign_setup( operation,
3783 &attributes,
3784 hmac_key, hmac_key_length,
3785 PSA_ALG_HMAC( hash_alg ) );
3786
3787 psa_reset_key_attributes( &attributes );
3788 return( status );
3789}
3790#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003791
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003792#define HKDF_STATE_INIT 0 /* no input yet */
3793#define HKDF_STATE_STARTED 1 /* got salt */
3794#define HKDF_STATE_KEYED 2 /* got key */
3795#define HKDF_STATE_OUTPUT 3 /* output started */
3796
Gilles Peskinecbe66502019-05-16 16:59:18 +02003797static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003798 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003799{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003800 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3801 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003802 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003803 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003804}
3805
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003806psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003807{
3808 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003809 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003810 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003811 {
3812 /* The object has (apparently) been initialized but it is not
3813 * in use. It's ok to call abort on such an object, and there's
3814 * nothing to do. */
3815 }
3816 else
John Durkopd0321952020-10-29 21:37:36 -07003817#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003818 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003819 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003820 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003821 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003822 }
John Durkop07cc04a2020-11-16 22:08:34 -08003823 else
3824#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3825#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3826 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3827 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003828 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003829 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003830 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003831 if( operation->ctx.tls12_prf.secret != NULL )
3832 {
3833 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3834 operation->ctx.tls12_prf.secret_length );
3835 mbedtls_free( operation->ctx.tls12_prf.secret );
3836 }
3837
Janos Follath6a1d2622019-06-11 10:37:28 +01003838 if( operation->ctx.tls12_prf.seed != NULL )
3839 {
3840 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3841 operation->ctx.tls12_prf.seed_length );
3842 mbedtls_free( operation->ctx.tls12_prf.seed );
3843 }
3844
3845 if( operation->ctx.tls12_prf.label != NULL )
3846 {
3847 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3848 operation->ctx.tls12_prf.label_length );
3849 mbedtls_free( operation->ctx.tls12_prf.label );
3850 }
3851
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003852 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003853
3854 /* We leave the fields Ai and output_block to be erased safely by the
3855 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003856 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003857 else
John Durkop07cc04a2020-11-16 22:08:34 -08003858#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3859 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003860 {
3861 status = PSA_ERROR_BAD_STATE;
3862 }
Janos Follath083036a2019-06-11 10:22:26 +01003863 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003864 return( status );
3865}
3866
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003867psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003868 size_t *capacity)
3869{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003870 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003871 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003872 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003873 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003874 }
3875
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003876 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003877 return( PSA_SUCCESS );
3878}
3879
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003880psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003881 size_t capacity )
3882{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003883 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003884 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003885 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003886 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003887 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003888 return( PSA_SUCCESS );
3889}
3890
John Durkopd0321952020-10-29 21:37:36 -07003891#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003892/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003893 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003894static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremanb27e3502021-04-29 19:11:25 +02003895 psa_algorithm_t hash_alg,
3896 uint8_t *output,
3897 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003898{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003899 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003900 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003901 psa_status_t status;
3902
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003903 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3904 return( PSA_ERROR_BAD_STATE );
3905 hkdf->state = HKDF_STATE_OUTPUT;
3906
Gilles Peskinebef7f142018-07-12 17:22:21 +02003907 while( output_length != 0 )
3908 {
3909 /* Copy what remains of the current block */
3910 uint8_t n = hash_length - hkdf->offset_in_block;
3911 if( n > output_length )
3912 n = (uint8_t) output_length;
3913 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3914 output += n;
3915 output_length -= n;
3916 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003917 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003918 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003919 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003920 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003921 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003922 * object was corrupted or if this function is called directly
3923 * inside the library. */
3924 if( hkdf->block_number == 0xff )
3925 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003926
3927 /* We need a new block */
3928 ++hkdf->block_number;
3929 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02003930
Steven Cooreman9878a162021-05-06 17:58:36 +02003931 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3932 hash_alg,
3933 hkdf->prk,
3934 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003935 if( status != PSA_SUCCESS )
3936 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003937
Gilles Peskinebef7f142018-07-12 17:22:21 +02003938 if( hkdf->block_number != 1 )
3939 {
Steven Cooremanb27e3502021-04-29 19:11:25 +02003940 status = psa_mac_update( &hkdf->hmac,
3941 hkdf->output_block,
3942 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003943 if( status != PSA_SUCCESS )
3944 return( status );
3945 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02003946 status = psa_mac_update( &hkdf->hmac,
3947 hkdf->info,
3948 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003949 if( status != PSA_SUCCESS )
3950 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003951 status = psa_mac_update( &hkdf->hmac,
3952 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003953 if( status != PSA_SUCCESS )
3954 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003955 status = psa_mac_sign_finish( &hkdf->hmac,
3956 hkdf->output_block,
3957 sizeof( hkdf->output_block ),
3958 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003959 if( status != PSA_SUCCESS )
3960 return( status );
3961 }
3962
3963 return( PSA_SUCCESS );
3964}
John Durkop07cc04a2020-11-16 22:08:34 -08003965#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003966
John Durkop07cc04a2020-11-16 22:08:34 -08003967#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3968 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003969static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3970 psa_tls12_prf_key_derivation_t *tls12_prf,
3971 psa_algorithm_t alg )
3972{
3973 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003974 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003975 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3976 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003977 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003978
Janos Follath7742fee2019-06-17 12:58:10 +01003979 /* We can't be wanting more output after block 0xff, otherwise
3980 * the capacity check in psa_key_derivation_output_bytes() would have
3981 * prevented this call. It could happen only if the operation
3982 * object was corrupted or if this function is called directly
3983 * inside the library. */
3984 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003985 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003986
3987 /* We need a new block */
3988 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003989 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003990
3991 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3992 *
3993 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3994 *
3995 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3996 * HMAC_hash(secret, A(2) + seed) +
3997 * HMAC_hash(secret, A(3) + seed) + ...
3998 *
3999 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004000 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004001 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004002 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004003 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004004 * is currently extracted as `output_block` and where i is
4005 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004006 */
4007
Steven Cooreman9878a162021-05-06 17:58:36 +02004008 status = psa_key_derivation_start_hmac( &hmac,
4009 hash_alg,
4010 tls12_prf->secret,
4011 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004012 if( status != PSA_SUCCESS )
4013 goto cleanup;
4014
4015 /* Calculate A(i) where i = tls12_prf->block_number. */
4016 if( tls12_prf->block_number == 1 )
4017 {
4018 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4019 * the variable seed and in this instance means it in the context of the
4020 * P_hash function, where seed = label + seed.) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004021 status = psa_mac_update( &hmac,
4022 tls12_prf->label,
4023 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004024 if( status != PSA_SUCCESS )
4025 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004026 status = psa_mac_update( &hmac,
4027 tls12_prf->seed,
4028 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004029 if( status != PSA_SUCCESS )
4030 goto cleanup;
4031 }
4032 else
4033 {
4034 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004035 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004036 if( status != PSA_SUCCESS )
4037 goto cleanup;
4038 }
4039
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004040 status = psa_mac_sign_finish( &hmac,
4041 tls12_prf->Ai, hash_length,
4042 &hmac_output_length );
4043 if( hmac_output_length != hash_length )
4044 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004045 if( status != PSA_SUCCESS )
4046 goto cleanup;
4047
4048 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman9878a162021-05-06 17:58:36 +02004049 status = psa_key_derivation_start_hmac( &hmac,
4050 hash_alg,
4051 tls12_prf->secret,
4052 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004053 if( status != PSA_SUCCESS )
4054 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004055 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004056 if( status != PSA_SUCCESS )
4057 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004058 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004059 if( status != PSA_SUCCESS )
4060 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004061 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004062 if( status != PSA_SUCCESS )
4063 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004064 status = psa_mac_sign_finish( &hmac,
4065 tls12_prf->output_block, hash_length,
4066 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004067 if( status != PSA_SUCCESS )
4068 goto cleanup;
4069
Janos Follath7742fee2019-06-17 12:58:10 +01004070
4071cleanup:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004072 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004073 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4074 status = cleanup_status;
4075
4076 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004077}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004078
Janos Follath844eb0e2019-06-19 12:10:49 +01004079static psa_status_t psa_key_derivation_tls12_prf_read(
4080 psa_tls12_prf_key_derivation_t *tls12_prf,
4081 psa_algorithm_t alg,
4082 uint8_t *output,
4083 size_t output_length )
4084{
4085 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004086 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004087 psa_status_t status;
4088 uint8_t offset, length;
4089
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004090 switch( tls12_prf->state )
4091 {
4092 case PSA_TLS12_PRF_STATE_LABEL_SET:
4093 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4094 break;
4095 case PSA_TLS12_PRF_STATE_OUTPUT:
4096 break;
4097 default:
4098 return( PSA_ERROR_BAD_STATE );
4099 }
4100
Janos Follath844eb0e2019-06-19 12:10:49 +01004101 while( output_length != 0 )
4102 {
4103 /* Check if we have fully processed the current block. */
4104 if( tls12_prf->left_in_block == 0 )
4105 {
4106 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4107 alg );
4108 if( status != PSA_SUCCESS )
4109 return( status );
4110
4111 continue;
4112 }
4113
4114 if( tls12_prf->left_in_block > output_length )
4115 length = (uint8_t) output_length;
4116 else
4117 length = tls12_prf->left_in_block;
4118
4119 offset = hash_length - tls12_prf->left_in_block;
4120 memcpy( output, tls12_prf->output_block + offset, length );
4121 output += length;
4122 output_length -= length;
4123 tls12_prf->left_in_block -= length;
4124 }
4125
4126 return( PSA_SUCCESS );
4127}
John Durkop07cc04a2020-11-16 22:08:34 -08004128#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4129 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004130
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004131psa_status_t psa_key_derivation_output_bytes(
4132 psa_key_derivation_operation_t *operation,
4133 uint8_t *output,
4134 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004135{
4136 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004137 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004138
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004139 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004140 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004141 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004142 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004143 }
4144
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004145 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004146 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004147 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004148 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004149 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004150 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004151 goto exit;
4152 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004153 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004154 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004155 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004156 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004157 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4158 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004159 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004160 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004161 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004162 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004163 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004164
John Durkopd0321952020-10-29 21:37:36 -07004165#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004166 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004167 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004168 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004169 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004170 output, output_length );
4171 }
Janos Follathadbec812019-06-14 11:05:39 +01004172 else
John Durkop07cc04a2020-11-16 22:08:34 -08004173#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4174#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4175 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004176 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004177 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004178 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004179 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004180 kdf_alg, output,
4181 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004182 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004183 else
John Durkop07cc04a2020-11-16 22:08:34 -08004184#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4185 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004186 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004187 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004188 return( PSA_ERROR_BAD_STATE );
4189 }
4190
4191exit:
4192 if( status != PSA_SUCCESS )
4193 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004194 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004195 * This allows us to differentiate between exhausted operations and
4196 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4197 * operations. */
4198 psa_algorithm_t alg = operation->alg;
4199 psa_key_derivation_abort( operation );
4200 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004201 memset( output, '!', output_length );
4202 }
4203 return( status );
4204}
4205
David Brown7807bf72021-02-09 16:28:23 -07004206#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004207static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4208{
4209 if( data_size >= 8 )
4210 mbedtls_des_key_set_parity( data );
4211 if( data_size >= 16 )
4212 mbedtls_des_key_set_parity( data + 8 );
4213 if( data_size >= 24 )
4214 mbedtls_des_key_set_parity( data + 16 );
4215}
David Brown7807bf72021-02-09 16:28:23 -07004216#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004217
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004218static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004219 psa_key_slot_t *slot,
4220 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004221 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004222{
4223 uint8_t *data = NULL;
4224 size_t bytes = PSA_BITS_TO_BYTES( bits );
4225 psa_status_t status;
4226
Gilles Peskine8e338702019-07-30 20:06:31 +02004227 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004228 return( PSA_ERROR_INVALID_ARGUMENT );
4229 if( bits % 8 != 0 )
4230 return( PSA_ERROR_INVALID_ARGUMENT );
4231 data = mbedtls_calloc( 1, bytes );
4232 if( data == NULL )
4233 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4234
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004235 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004236 if( status != PSA_SUCCESS )
4237 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004238#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004239 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004240 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004241#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004242
4243 status = psa_allocate_buffer_to_slot( slot, bytes );
4244 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004245 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004246
Ronald Cronbf33c932020-11-28 18:06:53 +01004247 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004248 psa_key_attributes_t attributes = {
4249 .core = slot->attr
4250 };
4251
Ronald Cronbf33c932020-11-28 18:06:53 +01004252 status = psa_driver_wrapper_import_key( &attributes,
4253 data, bytes,
4254 slot->key.data,
4255 slot->key.bytes,
4256 &slot->key.bytes, &bits );
4257 if( bits != slot->attr.bits )
4258 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004259
4260exit:
4261 mbedtls_free( data );
4262 return( status );
4263}
4264
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004265psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004266 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004267 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004268{
4269 psa_status_t status;
4270 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004271 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004272
Ronald Cron81709fc2020-11-14 12:10:32 +01004273 *key = MBEDTLS_SVC_KEY_ID_INIT;
4274
Gilles Peskine0f84d622019-09-12 19:03:13 +02004275 /* Reject any attempt to create a zero-length key so that we don't
4276 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4277 if( psa_get_key_bits( attributes ) == 0 )
4278 return( PSA_ERROR_INVALID_ARGUMENT );
4279
Dave Rodgman021e7242021-11-16 10:32:48 +00004280 if( operation->alg == PSA_ALG_NONE )
4281 return( PSA_ERROR_BAD_STATE );
4282
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004283 if( ! operation->can_output_key )
4284 return( PSA_ERROR_NOT_PERMITTED );
4285
Ronald Cron81709fc2020-11-14 12:10:32 +01004286 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4287 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004288#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4289 if( driver != NULL )
4290 {
4291 /* Deriving a key in a secure element is not implemented yet. */
4292 status = PSA_ERROR_NOT_SUPPORTED;
4293 }
4294#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004295 if( status == PSA_SUCCESS )
4296 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004297 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004298 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004299 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004300 }
4301 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004302 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004303 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004304 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004305
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004306 return( status );
4307}
4308
Gilles Peskineeab56e42018-07-12 17:12:33 +02004309
4310
4311/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004312/* Key derivation */
4313/****************************************************************/
4314
Steven Cooreman932ffb72021-02-15 12:14:32 +01004315#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004316static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004317 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004318 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004319{
John Durkop07cc04a2020-11-16 22:08:34 -08004320 int is_kdf_alg_supported;
4321
Janos Follath5fe19732019-06-20 15:09:30 +01004322 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4323 * initialisers for this union leave some bytes unspecified.) */
4324 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4325
Gilles Peskine969c5d62019-01-16 15:53:06 +01004326 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004327#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004328 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4329 is_kdf_alg_supported = 1;
4330 else
4331#endif
4332#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4333 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4334 is_kdf_alg_supported = 1;
4335 else
4336#endif
4337#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4338 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4339 is_kdf_alg_supported = 1;
4340 else
4341#endif
4342 is_kdf_alg_supported = 0;
4343
4344 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004345 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004346 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004347 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004348 if( hash_size == 0 )
4349 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004350 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4351 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004352 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004353 {
4354 return( PSA_ERROR_NOT_SUPPORTED );
4355 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004356 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004357 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004358 }
John Durkop07cc04a2020-11-16 22:08:34 -08004359
4360 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004361}
John Durkop07cc04a2020-11-16 22:08:34 -08004362#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004363
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004364psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004365 psa_algorithm_t alg )
4366{
4367 psa_status_t status;
4368
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004369 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004370 return( PSA_ERROR_BAD_STATE );
4371
Gilles Peskine6843c292019-01-18 16:44:49 +01004372 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4373 return( PSA_ERROR_INVALID_ARGUMENT );
4374 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004375 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004376#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004377 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004378 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004379#else
4380 return( PSA_ERROR_NOT_SUPPORTED );
4381#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004382 }
4383 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4384 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004385#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004386 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004387#else
4388 return( PSA_ERROR_NOT_SUPPORTED );
4389#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004390 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004391 else
4392 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004393
4394 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004395 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004396 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004397}
4398
John Durkopd0321952020-10-29 21:37:36 -07004399#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004400static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004401 psa_algorithm_t hash_alg,
4402 psa_key_derivation_step_t step,
4403 const uint8_t *data,
4404 size_t data_length )
4405{
4406 psa_status_t status;
4407 switch( step )
4408 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004409 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004410 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004411 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004412 else
4413 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004414 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4415 hash_alg,
4416 data, data_length );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004417 if( status != PSA_SUCCESS )
4418 return( status );
4419 hkdf->state = HKDF_STATE_STARTED;
4420 return( PSA_SUCCESS );
4421 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004422 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004423 /* If no salt was provided, use an empty salt. */
4424 if( hkdf->state == HKDF_STATE_INIT )
4425 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004426 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4427 hash_alg,
4428 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004429 if( status != PSA_SUCCESS )
4430 return( status );
4431 hkdf->state = HKDF_STATE_STARTED;
4432 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004433 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004434 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004435 status = psa_mac_update( &hkdf->hmac,
4436 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004437 if( status != PSA_SUCCESS )
4438 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004439 status = psa_mac_sign_finish( &hkdf->hmac,
4440 hkdf->prk,
4441 sizeof( hkdf->prk ),
4442 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004443 if( status != PSA_SUCCESS )
4444 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004445 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004446 hkdf->block_number = 0;
4447 hkdf->state = HKDF_STATE_KEYED;
4448 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004449 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004450 if( hkdf->state == HKDF_STATE_OUTPUT )
4451 return( PSA_ERROR_BAD_STATE );
4452 if( hkdf->info_set )
4453 return( PSA_ERROR_BAD_STATE );
4454 hkdf->info_length = data_length;
4455 if( data_length != 0 )
4456 {
4457 hkdf->info = mbedtls_calloc( 1, data_length );
4458 if( hkdf->info == NULL )
4459 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4460 memcpy( hkdf->info, data, data_length );
4461 }
4462 hkdf->info_set = 1;
4463 return( PSA_SUCCESS );
4464 default:
4465 return( PSA_ERROR_INVALID_ARGUMENT );
4466 }
4467}
John Durkop07cc04a2020-11-16 22:08:34 -08004468#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004469
John Durkop07cc04a2020-11-16 22:08:34 -08004470#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4471 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004472static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4473 const uint8_t *data,
4474 size_t data_length )
4475{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004476 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004477 return( PSA_ERROR_BAD_STATE );
4478
Janos Follathd6dce9f2019-07-04 09:11:38 +01004479 if( data_length != 0 )
4480 {
4481 prf->seed = mbedtls_calloc( 1, data_length );
4482 if( prf->seed == NULL )
4483 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004484
Janos Follathd6dce9f2019-07-04 09:11:38 +01004485 memcpy( prf->seed, data, data_length );
4486 prf->seed_length = data_length;
4487 }
Janos Follathf08e2652019-06-13 09:05:41 +01004488
Gilles Peskine43f958b2020-12-13 14:55:14 +01004489 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004490
4491 return( PSA_SUCCESS );
4492}
4493
Janos Follath81550542019-06-13 14:26:34 +01004494static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004495 const uint8_t *data,
4496 size_t data_length )
4497{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004498 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004499 return( PSA_ERROR_BAD_STATE );
4500
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004501 if( data_length != 0 )
4502 {
4503 prf->secret = mbedtls_calloc( 1, data_length );
4504 if( prf->secret == NULL )
4505 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4506
4507 memcpy( prf->secret, data, data_length );
4508 prf->secret_length = data_length;
4509 }
Janos Follath81550542019-06-13 14:26:34 +01004510
Gilles Peskine43f958b2020-12-13 14:55:14 +01004511 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004512
4513 return( PSA_SUCCESS );
4514}
4515
Janos Follath63028dd2019-06-13 09:15:47 +01004516static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4517 const uint8_t *data,
4518 size_t data_length )
4519{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004520 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004521 return( PSA_ERROR_BAD_STATE );
4522
Janos Follathd6dce9f2019-07-04 09:11:38 +01004523 if( data_length != 0 )
4524 {
4525 prf->label = mbedtls_calloc( 1, data_length );
4526 if( prf->label == NULL )
4527 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004528
Janos Follathd6dce9f2019-07-04 09:11:38 +01004529 memcpy( prf->label, data, data_length );
4530 prf->label_length = data_length;
4531 }
Janos Follath63028dd2019-06-13 09:15:47 +01004532
Gilles Peskine43f958b2020-12-13 14:55:14 +01004533 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004534
4535 return( PSA_SUCCESS );
4536}
4537
Janos Follathb03233e2019-06-11 15:30:30 +01004538static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004539 psa_key_derivation_step_t step,
4540 const uint8_t *data,
4541 size_t data_length )
4542{
Janos Follathb03233e2019-06-11 15:30:30 +01004543 switch( step )
4544 {
Janos Follathf08e2652019-06-13 09:05:41 +01004545 case PSA_KEY_DERIVATION_INPUT_SEED:
4546 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004547 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004548 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004549 case PSA_KEY_DERIVATION_INPUT_LABEL:
4550 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004551 default:
4552 return( PSA_ERROR_INVALID_ARGUMENT );
4553 }
4554}
John Durkop07cc04a2020-11-16 22:08:34 -08004555#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4556 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4557
4558#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4559static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4560 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004561 const uint8_t *data,
4562 size_t data_length )
4563{
4564 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004565 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004566 uint8_t *cur = pms;
4567
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004568 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004569 return( PSA_ERROR_INVALID_ARGUMENT );
4570
4571 /* Quoting RFC 4279, Section 2:
4572 *
4573 * The premaster secret is formed as follows: if the PSK is N octets
4574 * long, concatenate a uint16 with the value N, N zero octets, a second
4575 * uint16 with the value N, and the PSK itself.
4576 */
4577
Joe Subbiani2bbafda2021-06-24 13:00:03 +01004578 *cur++ = MBEDTLS_BYTE_1( data_length );
4579 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004580 memset( cur, 0, data_length );
4581 cur += data_length;
4582 *cur++ = pms[0];
4583 *cur++ = pms[1];
4584 memcpy( cur, data, data_length );
4585 cur += data_length;
4586
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004587 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004588
4589 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4590 return( status );
4591}
Janos Follath6660f0e2019-06-17 08:44:03 +01004592
4593static psa_status_t psa_tls12_prf_psk_to_ms_input(
4594 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004595 psa_key_derivation_step_t step,
4596 const uint8_t *data,
4597 size_t data_length )
4598{
4599 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004600 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004601 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004602 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004603 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004604
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004605 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004606}
John Durkop07cc04a2020-11-16 22:08:34 -08004607#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004608
Gilles Peskineb8965192019-09-24 16:21:10 +02004609/** Check whether the given key type is acceptable for the given
4610 * input step of a key derivation.
4611 *
4612 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4613 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4614 * Both secret and non-secret inputs can alternatively have the type
4615 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4616 * that the input was passed as a buffer rather than via a key object.
4617 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004618static int psa_key_derivation_check_input_type(
4619 psa_key_derivation_step_t step,
4620 psa_key_type_t key_type )
4621{
4622 switch( step )
4623 {
4624 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004625 if( key_type == PSA_KEY_TYPE_DERIVE )
4626 return( PSA_SUCCESS );
4627 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004628 return( PSA_SUCCESS );
4629 break;
4630 case PSA_KEY_DERIVATION_INPUT_LABEL:
4631 case PSA_KEY_DERIVATION_INPUT_SALT:
4632 case PSA_KEY_DERIVATION_INPUT_INFO:
4633 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004634 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4635 return( PSA_SUCCESS );
4636 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004637 return( PSA_SUCCESS );
4638 break;
4639 }
4640 return( PSA_ERROR_INVALID_ARGUMENT );
4641}
4642
Janos Follathb80a94e2019-06-12 15:54:46 +01004643static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004644 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004645 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004646 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004647 const uint8_t *data,
4648 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004649{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004650 psa_status_t status;
4651 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4652
4653 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004654 if( status != PSA_SUCCESS )
4655 goto exit;
4656
John Durkopd0321952020-10-29 21:37:36 -07004657#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004658 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004659 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004660 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004661 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004662 step, data, data_length );
4663 }
John Durkop07cc04a2020-11-16 22:08:34 -08004664 else
4665#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4666#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4667 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004668 {
Janos Follathb03233e2019-06-11 15:30:30 +01004669 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004670 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004671 }
John Durkop07cc04a2020-11-16 22:08:34 -08004672 else
4673#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4674#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4675 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004676 {
4677 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004678 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004679 }
4680 else
John Durkop07cc04a2020-11-16 22:08:34 -08004681#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004682 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004683 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004684 (void) data;
4685 (void) data_length;
4686 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004687 return( PSA_ERROR_BAD_STATE );
4688 }
4689
Gilles Peskine224b0d62019-09-23 18:13:17 +02004690exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004691 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004692 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004693 return( status );
4694}
4695
Janos Follath51f4a0f2019-06-14 11:35:55 +01004696psa_status_t psa_key_derivation_input_bytes(
4697 psa_key_derivation_operation_t *operation,
4698 psa_key_derivation_step_t step,
4699 const uint8_t *data,
4700 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004701{
Gilles Peskineb8965192019-09-24 16:21:10 +02004702 return( psa_key_derivation_input_internal( operation, step,
4703 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004704 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004705}
4706
Janos Follath51f4a0f2019-06-14 11:35:55 +01004707psa_status_t psa_key_derivation_input_key(
4708 psa_key_derivation_operation_t *operation,
4709 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004710 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004711{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004712 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004713 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004714 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004715
Ronald Cron5c522922020-11-14 16:35:34 +01004716 status = psa_get_and_lock_transparent_key_slot_with_policy(
4717 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004718 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004719 {
4720 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004721 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004722 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004723
4724 /* Passing a key object as a SECRET input unlocks the permission
4725 * to output to a key object. */
4726 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4727 operation->can_output_key = 1;
4728
Ronald Cronf95a2b12020-10-22 15:24:49 +02004729 status = psa_key_derivation_input_internal( operation,
4730 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004731 slot->key.data,
4732 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004733
Ronald Cron5c522922020-11-14 16:35:34 +01004734 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004735
Ronald Cron5c522922020-11-14 16:35:34 +01004736 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004737}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004738
4739
4740
4741/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004742/* Key agreement */
4743/****************************************************************/
4744
John Durkop6ba40d12020-11-10 08:50:04 -08004745#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004746static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4747 size_t peer_key_length,
4748 const mbedtls_ecp_keypair *our_key,
4749 uint8_t *shared_secret,
4750 size_t shared_secret_size,
4751 size_t *shared_secret_length )
4752{
Steven Cooremand4867872020-08-05 16:31:39 +02004753 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004754 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004755 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004756 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004757 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004758 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004759
Ronald Cron90857082020-11-25 14:58:33 +01004760 status = mbedtls_psa_ecp_load_representation(
4761 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004762 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004763 peer_key,
4764 peer_key_length,
4765 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004766 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004767 goto exit;
4768
Jaeden Amero97271b32019-01-10 19:38:51 +00004769 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004770 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004771 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004772 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004773 status = mbedtls_to_psa_error(
4774 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4775 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004776 goto exit;
4777
Jaeden Amero97271b32019-01-10 19:38:51 +00004778 status = mbedtls_to_psa_error(
4779 mbedtls_ecdh_calc_secret( &ecdh,
4780 shared_secret_length,
4781 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004782 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004783 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004784 if( status != PSA_SUCCESS )
4785 goto exit;
4786 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4787 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004788
4789exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004790 if( status != PSA_SUCCESS )
4791 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004792 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004793 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004794 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004795
Jaeden Amero97271b32019-01-10 19:38:51 +00004796 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004797}
John Durkop6ba40d12020-11-10 08:50:04 -08004798#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004799
Gilles Peskine01d718c2018-09-18 12:01:02 +02004800#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4801
Gilles Peskine0216fe12019-04-11 21:23:21 +02004802static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4803 psa_key_slot_t *private_key,
4804 const uint8_t *peer_key,
4805 size_t peer_key_length,
4806 uint8_t *shared_secret,
4807 size_t shared_secret_size,
4808 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004809{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004810 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004811 {
John Durkop6ba40d12020-11-10 08:50:04 -08004812#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004813 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004814 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004815 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004816 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004817 psa_status_t status = mbedtls_psa_ecp_load_representation(
4818 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004819 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004820 private_key->key.data,
4821 private_key->key.bytes,
4822 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004823 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004824 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004825 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004826 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004827 shared_secret, shared_secret_size,
4828 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004829 mbedtls_ecp_keypair_free( ecp );
4830 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004831 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004832#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004833 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004834 (void) private_key;
4835 (void) peer_key;
4836 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004837 (void) shared_secret;
4838 (void) shared_secret_size;
4839 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004840 return( PSA_ERROR_NOT_SUPPORTED );
4841 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004842}
4843
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004844/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004845 * to potentially free embedded data structures and wipe confidential data.
4846 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004847static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004848 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004849 psa_key_slot_t *private_key,
4850 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004851 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004852{
4853 psa_status_t status;
4854 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4855 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004856 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004857
4858 /* Step 1: run the secret agreement algorithm to generate the shared
4859 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004860 status = psa_key_agreement_raw_internal( ka_alg,
4861 private_key,
4862 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004863 shared_secret,
4864 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004865 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004866 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004867 goto exit;
4868
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004869 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004870 * the shared secret. A shared secret is permitted wherever a key
4871 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004872 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004873 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004874 shared_secret,
4875 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004876exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004877 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004878 return( status );
4879}
4880
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004881psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004882 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004883 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004884 const uint8_t *peer_key,
4885 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004886{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004887 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004888 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004889 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004890
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004891 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004892 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004893 status = psa_get_and_lock_transparent_key_slot_with_policy(
4894 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004895 if( status != PSA_SUCCESS )
4896 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004897 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004898 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004899 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004900 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004901 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004902 else
4903 {
4904 /* If a private key has been added as SECRET, we allow the derived
4905 * key material to be used as a key in PSA Crypto. */
4906 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4907 operation->can_output_key = 1;
4908 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004909
Ronald Cron5c522922020-11-14 16:35:34 +01004910 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004911
Ronald Cron5c522922020-11-14 16:35:34 +01004912 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004913}
4914
Gilles Peskinebe697d82019-05-16 18:00:41 +02004915psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004916 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004917 const uint8_t *peer_key,
4918 size_t peer_key_length,
4919 uint8_t *output,
4920 size_t output_size,
4921 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004922{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004923 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004924 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004925 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004926
4927 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4928 {
4929 status = PSA_ERROR_INVALID_ARGUMENT;
4930 goto exit;
4931 }
Ronald Cron5c522922020-11-14 16:35:34 +01004932 status = psa_get_and_lock_transparent_key_slot_with_policy(
4933 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004934 if( status != PSA_SUCCESS )
4935 goto exit;
4936
4937 status = psa_key_agreement_raw_internal( alg, slot,
4938 peer_key, peer_key_length,
4939 output, output_size,
4940 output_length );
4941
4942exit:
4943 if( status != PSA_SUCCESS )
4944 {
4945 /* If an error happens and is not handled properly, the output
4946 * may be used as a key to protect sensitive data. Arrange for such
4947 * a key to be random, which is likely to result in decryption or
4948 * verification errors. This is better than filling the buffer with
4949 * some constant data such as zeros, which would result in the data
4950 * being protected with a reproducible, easily knowable key.
4951 */
4952 psa_generate_random( output, output_size );
4953 *output_length = output_size;
4954 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004955
Ronald Cron5c522922020-11-14 16:35:34 +01004956 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004957
Ronald Cron5c522922020-11-14 16:35:34 +01004958 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004959}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004960
4961
Gilles Peskine30524eb2020-11-13 17:02:26 +01004962
Gilles Peskine86a440b2018-11-12 18:39:40 +01004963/****************************************************************/
4964/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004965/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004966
Gilles Peskine30524eb2020-11-13 17:02:26 +01004967/** Initialize the PSA random generator.
4968 */
4969static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4970{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004971#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4972 memset( rng, 0, sizeof( *rng ) );
4973#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4974
Gilles Peskine30524eb2020-11-13 17:02:26 +01004975 /* Set default configuration if
4976 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4977 if( rng->entropy_init == NULL )
4978 rng->entropy_init = mbedtls_entropy_init;
4979 if( rng->entropy_free == NULL )
4980 rng->entropy_free = mbedtls_entropy_free;
4981
4982 rng->entropy_init( &rng->entropy );
4983#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4984 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4985 /* The PSA entropy injection feature depends on using NV seed as an entropy
4986 * source. Add NV seed as an entropy source for PSA entropy injection. */
4987 mbedtls_entropy_add_source( &rng->entropy,
4988 mbedtls_nv_seed_poll, NULL,
4989 MBEDTLS_ENTROPY_BLOCK_SIZE,
4990 MBEDTLS_ENTROPY_SOURCE_STRONG );
4991#endif
4992
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004993 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004994#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004995}
4996
4997/** Deinitialize the PSA random generator.
4998 */
4999static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5000{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005001#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5002 memset( rng, 0, sizeof( *rng ) );
5003#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005004 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005005 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005006#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005007}
5008
5009/** Seed the PSA random generator.
5010 */
5011static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5012{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005013#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5014 /* Do nothing: the external RNG seeds itself. */
5015 (void) rng;
5016 return( PSA_SUCCESS );
5017#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005018 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005019 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5020 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005021 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005022#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005023}
5024
Gilles Peskinee59236f2018-01-27 23:32:46 +01005025psa_status_t psa_generate_random( uint8_t *output,
5026 size_t output_size )
5027{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005028 GUARD_MODULE_INITIALIZED;
5029
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005030#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5031
5032 size_t output_length = 0;
5033 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5034 output, output_size,
5035 &output_length );
5036 if( status != PSA_SUCCESS )
5037 return( status );
5038 /* Breaking up a request into smaller chunks is currently not supported
5039 * for the extrernal RNG interface. */
5040 if( output_length != output_size )
5041 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5042 return( PSA_SUCCESS );
5043
5044#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5045
Gilles Peskine71ddab92021-01-04 21:01:07 +01005046 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005047 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005048 size_t request_size =
5049 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5050 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5051 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005052 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5053 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005054 if( ret != 0 )
5055 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005056 output_size -= request_size;
5057 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005058 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005059 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005060#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005061}
5062
Gilles Peskine8814fc42020-12-14 15:33:44 +01005063/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005064 *
5065 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5066 * `psa_generate_random(...)`. The state parameter is ignored since the
5067 * PSA API doesn't support passing an explicit state.
5068 *
5069 * In the non-external case, psa_generate_random() calls an
5070 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5071 * and semantics as mbedtls_psa_get_random(). As an optimization,
5072 * instead of doing this back-and-forth between the PSA API and the
5073 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5074 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005075 */
5076#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5077int mbedtls_psa_get_random( void *p_rng,
5078 unsigned char *output,
5079 size_t output_size )
5080{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005081 /* This function takes a pointer to the RNG state because that's what
5082 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5083 * its own state internally and doesn't let the caller access that state.
5084 * So we just ignore the state parameter, and in practice we'll pass
5085 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005086 (void) p_rng;
5087 psa_status_t status = psa_generate_random( output, output_size );
5088 if( status == PSA_SUCCESS )
5089 return( 0 );
5090 else
5091 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5092}
5093#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5094
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005095#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5096#include "mbedtls/entropy_poll.h"
5097
Gilles Peskine7228da22019-07-15 11:06:15 +02005098psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005099 size_t seed_size )
5100{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005101 if( global_data.initialized )
5102 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005103
5104 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5105 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5106 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5107 return( PSA_ERROR_INVALID_ARGUMENT );
5108
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005109 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005110}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005111#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005112
Ronald Cron3772afe2021-02-08 16:10:05 +01005113/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005114 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005115 * \param type The key type
5116 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005117 *
5118 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005119 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005120 * \retval #PSA_ERROR_INVALID_ARGUMENT
5121 * The size in bits of the key is not valid.
5122 * \retval #PSA_ERROR_NOT_SUPPORTED
5123 * The type and/or the size in bits of the key or the combination of
5124 * the two is not supported.
5125 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005126static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5127 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005128{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005130
Gilles Peskinee59236f2018-01-27 23:32:46 +01005131 if( key_type_is_raw_bytes( type ) )
5132 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005133 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005134 if( status != PSA_SUCCESS )
5135 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005136 }
5137 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005138#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005139 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5140 {
5141 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5142 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005143
Ronald Cron01b2aba2020-10-05 09:42:02 +02005144 /* Accept only byte-aligned keys, for the same reasons as
5145 * in psa_import_rsa_key(). */
5146 if( bits % 8 != 0 )
5147 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005148 }
5149 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005150#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005151
Ronald Cron5c4d3862020-12-07 11:07:24 +01005152#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005153 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5154 {
Ronald Crond81ab562021-02-16 09:01:16 +01005155 /* To avoid empty block, return successfully here. */
5156 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005157 }
5158 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005159#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005160 {
5161 return( PSA_ERROR_NOT_SUPPORTED );
5162 }
5163
5164 return( PSA_SUCCESS );
5165}
5166
Ronald Cron55ed0592020-10-05 10:30:40 +02005167psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005168 const psa_key_attributes_t *attributes,
5169 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005170{
5171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005172 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005173
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005174 if( ( attributes->domain_parameters == NULL ) &&
5175 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005176 return( PSA_ERROR_INVALID_ARGUMENT );
5177
Ronald Cron01b2aba2020-10-05 09:42:02 +02005178 if( key_type_is_raw_bytes( type ) )
5179 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005180 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005181 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005182 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005183
David Brown12ca5032021-02-11 11:02:00 -07005184#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005185 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005186 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005187#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005188 }
5189 else
5190
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005191#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5192 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005193 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005194 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005195 return( mbedtls_psa_rsa_generate_key( attributes,
5196 key_buffer,
5197 key_buffer_size,
5198 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005199 }
5200 else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005201#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5202 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005203
John Durkop9814fa22020-11-04 12:28:15 -08005204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005205 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005206 {
Ronald Cron7023db52020-11-20 18:17:42 +01005207 return( mbedtls_psa_ecp_generate_key( attributes,
5208 key_buffer,
5209 key_buffer_size,
5210 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005211 }
5212 else
John Durkop9814fa22020-11-04 12:28:15 -08005213#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005214 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005215 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005216 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005217 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005218
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005219 return( PSA_SUCCESS );
5220}
Darryl Green0c6575a2018-11-07 16:05:30 +00005221
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005222psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005223 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005224{
5225 psa_status_t status;
5226 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005227 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005228 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005229
Ronald Cron81709fc2020-11-14 12:10:32 +01005230 *key = MBEDTLS_SVC_KEY_ID_INIT;
5231
Gilles Peskine0f84d622019-09-12 19:03:13 +02005232 /* Reject any attempt to create a zero-length key so that we don't
5233 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5234 if( psa_get_key_bits( attributes ) == 0 )
5235 return( PSA_ERROR_INVALID_ARGUMENT );
5236
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005237 /* Reject any attempt to create a public key. */
5238 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5239 return( PSA_ERROR_INVALID_ARGUMENT );
5240
Ronald Cron81709fc2020-11-14 12:10:32 +01005241 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5242 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005243 if( status != PSA_SUCCESS )
5244 goto exit;
5245
Ronald Cron977c2472020-10-13 08:32:21 +02005246 /* In the case of a transparent key or an opaque key stored in local
5247 * storage (thus not in the case of generating a key in a secure element
5248 * or cryptoprocessor with storage), we have to allocate a buffer to
5249 * hold the generated key material. */
5250 if( slot->key.data == NULL )
5251 {
5252 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5253 PSA_KEY_LOCATION_LOCAL_STORAGE )
5254 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005255 status = psa_validate_key_type_and_size_for_key_generation(
5256 attributes->core.type, attributes->core.bits );
5257 if( status != PSA_SUCCESS )
5258 goto exit;
5259
5260 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5261 attributes->core.type,
5262 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005263 }
5264 else
5265 {
5266 status = psa_driver_wrapper_get_key_buffer_size(
5267 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005268 if( status != PSA_SUCCESS )
5269 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005270 }
Ronald Cron977c2472020-10-13 08:32:21 +02005271
5272 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5273 if( status != PSA_SUCCESS )
5274 goto exit;
5275 }
5276
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005277 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005278 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005279
Ronald Cron2b56bc82020-10-05 10:02:26 +02005280 if( status != PSA_SUCCESS )
5281 psa_remove_key_data_from_memory( slot );
5282
Gilles Peskine11792082019-08-06 18:36:36 +02005283exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005284 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005285 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005286 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005287 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005288
Darryl Green0c6575a2018-11-07 16:05:30 +00005289 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005290}
5291
Gilles Peskinee59236f2018-01-27 23:32:46 +01005292/****************************************************************/
5293/* Module setup */
5294/****************************************************************/
5295
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005296#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005297psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5298 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5299 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5300{
5301 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5302 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005303 global_data.rng.entropy_init = entropy_init;
5304 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005305 return( PSA_SUCCESS );
5306}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005307#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005308
Gilles Peskinee59236f2018-01-27 23:32:46 +01005309void mbedtls_psa_crypto_free( void )
5310{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005311 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005312 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5313 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005314 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005315 }
5316 /* Wipe all remaining data, including configuration.
5317 * In particular, this sets all state indicator to the value
5318 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005319 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005320#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005321 /* Unregister all secure element drivers, so that we restart from
5322 * a pristine state. */
5323 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005324#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005325}
5326
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005327#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5328/** Recover a transaction that was interrupted by a power failure.
5329 *
5330 * This function is called during initialization, before psa_crypto_init()
5331 * returns. If this function returns a failure status, the initialization
5332 * fails.
5333 */
5334static psa_status_t psa_crypto_recover_transaction(
5335 const psa_crypto_transaction_t *transaction )
5336{
5337 switch( transaction->unknown.type )
5338 {
5339 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5340 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005341 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005342 * is implemented.
5343 * https://github.com/ARMmbed/mbed-crypto/issues/218
5344 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005345 default:
5346 /* We found an unsupported transaction in the storage.
5347 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005348 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005349 }
5350}
5351#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5352
Gilles Peskinee59236f2018-01-27 23:32:46 +01005353psa_status_t psa_crypto_init( void )
5354{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005355 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005356
Gilles Peskinec6b69072018-11-20 21:42:52 +01005357 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005358 if( global_data.initialized != 0 )
5359 return( PSA_SUCCESS );
5360
Gilles Peskine30524eb2020-11-13 17:02:26 +01005361 /* Initialize and seed the random generator. */
5362 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005363 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005364 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005365 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005366 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005367 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005368
Gilles Peskine66fb1262018-12-10 16:29:04 +01005369 status = psa_initialize_key_slots( );
5370 if( status != PSA_SUCCESS )
5371 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005372
Gilles Peskined9348f22019-10-01 15:22:29 +02005373#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5374 status = psa_init_all_se_drivers( );
5375 if( status != PSA_SUCCESS )
5376 goto exit;
5377#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5378
Gilles Peskine4b734222019-07-24 15:56:31 +02005379#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005380 status = psa_crypto_load_transaction( );
5381 if( status == PSA_SUCCESS )
5382 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005383 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5384 if( status != PSA_SUCCESS )
5385 goto exit;
5386 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005387 }
5388 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5389 {
5390 /* There's no transaction to complete. It's all good. */
5391 status = PSA_SUCCESS;
5392 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005393#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005394
Gilles Peskinec6b69072018-11-20 21:42:52 +01005395 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005396 global_data.initialized = 1;
5397
5398exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005399 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005400 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005401 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005402}
5403
5404#endif /* MBEDTLS_PSA_CRYPTO_C */