blob: 20f525bf439f0166d97c309fede04dff80afbf21 [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
John Durkop07cc04a2020-11-16 22:08:34 -0800388/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
389 * current test driver in key_management.c is using this function
390 * when accelerators are used for ECC key pair and public key.
391 * Once that dependency is resolved these guards can be removed.
392 */
John Durkop9814fa22020-11-04 12:28:15 -0800393#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800394 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
395 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
396 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100397mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 size_t bits,
399 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200400{
401 switch( curve )
402 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100403 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100404 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100406#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100407 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100409#endif
410#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100411 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100412 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100413#endif
414#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#endif
418#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100421#endif
422#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 case 528:
426 if( bits_is_sloppy )
427 return( MBEDTLS_ECP_DP_SECP521R1 );
428 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100429#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100430 }
431 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100432
Paul Elliott8ff510a2020-06-02 17:19:28 +0100433 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100437 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100438 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100439#endif
440#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100441 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100442 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100443#endif
444#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100445 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100446 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100447#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100448 }
449 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100450
Paul Elliott8ff510a2020-06-02 17:19:28 +0100451 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100452 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100454#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100455 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100456 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100457 case 256:
458 if( bits_is_sloppy )
459 return( MBEDTLS_ECP_DP_CURVE25519 );
460 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100461#endif
462#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100463 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100464 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100465#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100466 }
467 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100468
Paul Elliott8ff510a2020-06-02 17:19:28 +0100469 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100470 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100471 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100472#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100473 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100474 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100475#endif
476#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100477 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100478 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100479#endif
480#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100481 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100482 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100483#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100484 }
485 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200486 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100487
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100488 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100489 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200490}
John Durkop9814fa22020-11-04 12:28:15 -0800491#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800492 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
493 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
494 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200495
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200496static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
497 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498{
499 /* Check that the bit size is acceptable for the key type */
500 switch( type )
501 {
502 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200503 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200504 case PSA_KEY_TYPE_DERIVE:
505 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100506#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200507 case PSA_KEY_TYPE_AES:
508 if( bits != 128 && bits != 192 && bits != 256 )
509 return( PSA_ERROR_INVALID_ARGUMENT );
510 break;
511#endif
Gilles Peskine8890f642021-09-21 11:59:39 +0200512#if defined(PSA_WANT_KEY_TYPE_ARIA)
513 case PSA_KEY_TYPE_ARIA:
514 if( bits != 128 && bits != 192 && bits != 256 )
515 return( PSA_ERROR_INVALID_ARGUMENT );
516 break;
517#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100518#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200519 case PSA_KEY_TYPE_CAMELLIA:
520 if( bits != 128 && bits != 192 && bits != 256 )
521 return( PSA_ERROR_INVALID_ARGUMENT );
522 break;
523#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100524#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200525 case PSA_KEY_TYPE_DES:
526 if( bits != 64 && bits != 128 && bits != 192 )
527 return( PSA_ERROR_INVALID_ARGUMENT );
528 break;
529#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100530#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200531 case PSA_KEY_TYPE_ARC4:
532 if( bits < 8 || bits > 2048 )
533 return( PSA_ERROR_INVALID_ARGUMENT );
534 break;
535#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100536#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200537 case PSA_KEY_TYPE_CHACHA20:
538 if( bits != 256 )
539 return( PSA_ERROR_INVALID_ARGUMENT );
540 break;
541#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200542 default:
543 return( PSA_ERROR_NOT_SUPPORTED );
544 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200545 if( bits % 8 != 0 )
546 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200547
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200548 return( PSA_SUCCESS );
549}
550
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100551/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100552 *
Steven Cooremancd640932021-03-08 12:00:27 +0100553 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
554 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100555 *
556 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100557 * \param[in] key_type The key type of the key to be used with the
558 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100559 *
560 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100561 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100562 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100563 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100564 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100565MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100566 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100567 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100568{
Steven Cooremancd640932021-03-08 12:00:27 +0100569 if( PSA_ALG_IS_HMAC( algorithm ) )
570 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100571 if( key_type == PSA_KEY_TYPE_HMAC )
572 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100573 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100574
575 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100576 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100577 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
578 * key. */
579 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
580 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
581 {
582 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
583 * the block length (larger than 1) for block ciphers. */
584 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
585 return( PSA_SUCCESS );
586 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100587 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100588
589 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100590}
591
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200592psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
593 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200594{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100595 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200596 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200597
Ronald Cronea0f8a62020-11-25 17:52:23 +0100598 slot->key.data = mbedtls_calloc( 1, buffer_length );
599 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200600 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200601
Ronald Cronea0f8a62020-11-25 17:52:23 +0100602 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200603 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200604}
605
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200606psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
607 const uint8_t* data,
608 size_t data_length )
609{
610 psa_status_t status = psa_allocate_buffer_to_slot( slot,
611 data_length );
612 if( status != PSA_SUCCESS )
613 return( status );
614
Ronald Cronea0f8a62020-11-25 17:52:23 +0100615 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200616 return( PSA_SUCCESS );
617}
618
Ronald Crona0fe59f2020-11-29 11:14:53 +0100619psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100620 const psa_key_attributes_t *attributes,
621 const uint8_t *data, size_t data_length,
622 uint8_t *key_buffer, size_t key_buffer_size,
623 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100624{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100625 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
626 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100627
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200628 /* zero-length keys are never supported. */
629 if( data_length == 0 )
630 return( PSA_ERROR_NOT_SUPPORTED );
631
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100633 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100634 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200635
Steven Cooreman75b74362020-07-28 14:30:13 +0200636 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
637 if( data_length > SIZE_MAX / 8 )
638 return( PSA_ERROR_NOT_SUPPORTED );
639
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200640 /* Enforce a size limit, and in particular ensure that the bit
641 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100642 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200643 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200644
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100645 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200646 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200647 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200648
Ronald Crondd04d422020-11-28 15:14:42 +0100649 /* Copy the key material. */
650 memcpy( key_buffer, data, data_length );
651 *key_buffer_length = data_length;
652 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200653
Steven Cooreman40120f62020-10-29 11:42:22 +0100654 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100655 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100656 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200657 {
John Durkop9814fa22020-11-04 12:28:15 -0800658#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
659 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100660 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200661 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100662 return( mbedtls_psa_ecp_import_key( attributes,
663 data, data_length,
664 key_buffer, key_buffer_size,
665 key_buffer_length,
666 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100667 }
John Durkop9814fa22020-11-04 12:28:15 -0800668#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
669 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700670#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
671 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100672 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200673 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100674 return( mbedtls_psa_rsa_import_key( attributes,
675 data, data_length,
676 key_buffer, key_buffer_size,
677 key_buffer_length,
678 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200679 }
John Durkop9814fa22020-11-04 12:28:15 -0800680#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
681 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100682 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100683
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100684 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100685}
686
Gilles Peskinef603c712019-01-19 13:40:11 +0100687/** Calculate the intersection of two algorithm usage policies.
688 *
689 * Return 0 (which allows no operation) on incompatibility.
690 */
691static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100692 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100693 psa_algorithm_t alg1,
694 psa_algorithm_t alg2 )
695{
Gilles Peskine549ea862019-05-22 11:45:59 +0200696 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100697 if( alg1 == alg2 )
698 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100699 /* If the policies are from the same hash-and-sign family, check
700 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine8cb22c82021-09-22 16:15:05 +0200701 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
702 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100703 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100704 {
Steven Cooreman03488022021-02-18 12:07:20 +0100705 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
706 return( alg2 );
707 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
708 return( alg1 );
709 }
710 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100711 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100712 * restrictive tag length. */
713 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
714 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
715 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
716 {
717 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
718 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100719 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100720
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100721 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100722 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
723 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100724 {
Steven Cooremancd640932021-03-08 12:00:27 +0100725 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
726 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100727 }
728 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100729 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100730 ( alg1_len <= alg2_len ) )
731 {
732 return( alg2 );
733 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100734 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100735 ( alg2_len <= alg1_len ) )
736 {
737 return( alg1 );
738 }
739 }
740 /* If the policies are from the same MAC family, check whether one
741 * of them is a minimum-MAC-length policy. Calculate the most
742 * restrictive tag length. */
743 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
744 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
745 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
746 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100747 /* Validate the combination of key type and algorithm. Since the base
748 * algorithm of alg1 and alg2 are the same, we only need this once. */
749 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100750 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100751
Steven Cooreman31a876d2021-03-03 20:47:40 +0100752 /* Get the (exact or at-least) output lengths for both sides of the
753 * requested intersection. None of the currently supported algorithms
754 * have an output length dependent on the actual key size, so setting it
755 * to a bogus value of 0 is currently OK.
756 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100757 * Note that for at-least-this-length wildcard algorithms, the output
758 * length is set to the shortest allowed length, which allows us to
759 * calculate the most restrictive tag length for the intersection. */
760 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
761 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100762 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100763
Steven Cooremana1d83222021-02-25 10:20:29 +0100764 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100765 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
766 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100767 {
Steven Cooremancd640932021-03-08 12:00:27 +0100768 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100769 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100770
771 /* If only one is an at-least-this-length policy, the intersection would
772 * be the other (fixed-length) policy as long as said fixed length is
773 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100774 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100775 {
Steven Cooremancd640932021-03-08 12:00:27 +0100776 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100777 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100778 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100779 {
Steven Cooremancd640932021-03-08 12:00:27 +0100780 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100781 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100782
Steven Cooremancd640932021-03-08 12:00:27 +0100783 /* If none of them are wildcards, check whether they define the same tag
784 * length. This is still possible here when one is default-length and
785 * the other specific-length. Ensure to always return the
786 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100787 if( alg1_len == alg2_len )
788 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100789 }
790 /* If the policies are incompatible, allow nothing. */
791 return( 0 );
792}
793
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100794static int psa_key_algorithm_permits( psa_key_type_t key_type,
795 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200796 psa_algorithm_t requested_alg )
797{
Gilles Peskine549ea862019-05-22 11:45:59 +0200798 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200799 if( requested_alg == policy_alg )
800 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100801 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
802 * and requested_alg is the same hash-and-sign family with any hash,
803 * then requested_alg is compliant with policy_alg. */
Gilles Peskine8cb22c82021-09-22 16:15:05 +0200804 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100805 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200806 {
Steven Cooreman03488022021-02-18 12:07:20 +0100807 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
808 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
809 }
810 /* If policy_alg is a wildcard AEAD algorithm of the same base as
811 * the requested algorithm, check the requested tag length to be
812 * equal-length or longer than the wildcard-specified length. */
813 if( PSA_ALG_IS_AEAD( policy_alg ) &&
814 PSA_ALG_IS_AEAD( requested_alg ) &&
815 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
816 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100817 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100818 {
819 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
820 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
821 }
Steven Cooremancd640932021-03-08 12:00:27 +0100822 /* If policy_alg is a MAC algorithm of the same base as the requested
823 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100824 if( PSA_ALG_IS_MAC( policy_alg ) &&
825 PSA_ALG_IS_MAC( requested_alg ) &&
826 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100827 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100828 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100829 /* Validate the combination of key type and algorithm. Since the policy
830 * and requested algorithms are the same, we only need this once. */
831 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100832 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100833
Steven Cooreman31a876d2021-03-03 20:47:40 +0100834 /* Get both the requested output length for the algorithm which is to be
835 * verified, and the default output length for the base algorithm.
836 * Note that none of the currently supported algorithms have an output
837 * length dependent on actual key size, so setting it to a bogus value
838 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100839 size_t requested_output_length = PSA_MAC_LENGTH(
840 key_type, 0, requested_alg );
841 size_t default_output_length = PSA_MAC_LENGTH(
842 key_type, 0,
843 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100844
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100845 /* If the policy is default-length, only allow an algorithm with
846 * a declared exact-length matching the default. */
847 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100848 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100849
850 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100851 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100852 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
853 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
854 {
855 return( 1 );
856 }
857
Steven Cooremancd640932021-03-08 12:00:27 +0100858 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
859 * check for the requested MAC length to be equal to or longer than the
860 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100861 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
862 {
863 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100864 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100865 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200866 }
Steven Cooremance48e852020-10-05 16:02:45 +0200867 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200868 * a key derivation with that key agreement should also be allowed. This
869 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200870 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
871 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
872 {
873 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
874 policy_alg );
875 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100876 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200877 return( 0 );
878}
879
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100880/** Test whether a policy permits an algorithm.
881 *
882 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100883 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100884 * \note This function requires providing the key type for which the policy is
885 * being validated, since some algorithm policy definitions (e.g. MAC)
886 * have different properties depending on what kind of cipher it is
887 * combined with.
888 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100889 * \retval PSA_SUCCESS When \p alg is a specific algorithm
890 * allowed by the \p policy.
891 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
892 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
893 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100894 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100895static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100896 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100897 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100898{
Steven Cooremand788fab2021-02-25 11:29:17 +0100899 /* '0' is not a valid algorithm */
900 if( alg == 0 )
901 return( PSA_ERROR_INVALID_ARGUMENT );
902
Steven Cooreman7e39f052021-02-23 14:18:32 +0100903 /* A requested algorithm cannot be a wildcard. */
904 if( PSA_ALG_IS_WILDCARD( alg ) )
905 return( PSA_ERROR_INVALID_ARGUMENT );
906
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100907 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
908 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100909 return( PSA_SUCCESS );
910 else
911 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100912}
913
Gilles Peskinef603c712019-01-19 13:40:11 +0100914/** Restrict a key policy based on a constraint.
915 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100916 * \note This function requires providing the key type for which the policy is
917 * being restricted, since some algorithm policy definitions (e.g. MAC)
918 * have different properties depending on what kind of cipher it is
919 * combined with.
920 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100921 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100922 * \param[in,out] policy The policy to restrict.
923 * \param[in] constraint The policy constraint to apply.
924 *
925 * \retval #PSA_SUCCESS
926 * \c *policy contains the intersection of the original value of
927 * \c *policy and \c *constraint.
928 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100929 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100930 * \c *policy is unchanged.
931 */
932static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100933 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100934 psa_key_policy_t *policy,
935 const psa_key_policy_t *constraint )
936{
937 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100938 psa_key_policy_algorithm_intersection( key_type, policy->alg,
939 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200940 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100941 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
942 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100943 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
944 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200945 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
946 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100947 policy->usage &= constraint->usage;
948 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200949 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100950 return( PSA_SUCCESS );
951}
952
Ronald Cron5c522922020-11-14 16:35:34 +0100953/** Get the description of a key given its identifier and policy constraints
954 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200955 *
Ronald Cron5c522922020-11-14 16:35:34 +0100956 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100957 * nonzero, the key must allow operations with this algorithm. If \p alg is
958 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100959 *
Ronald Cron5c522922020-11-14 16:35:34 +0100960 * In case of a persistent key, the function loads the description of the key
961 * into a key slot if not already done.
962 *
963 * On success, the returned key slot is locked. It is the responsibility of
964 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200965 */
Ronald Cron5c522922020-11-14 16:35:34 +0100966static psa_status_t psa_get_and_lock_key_slot_with_policy(
967 mbedtls_svc_key_id_t key,
968 psa_key_slot_t **p_slot,
969 psa_key_usage_t usage,
970 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100971{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
973 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100974
Ronald Cron5c522922020-11-14 16:35:34 +0100975 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100976 if( status != PSA_SUCCESS )
977 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200978 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100979
980 /* Enforce that usage policy for the key slot contains all the flags
981 * required by the usage parameter. There is one exception: public
982 * keys can always be exported, so we treat public key objects as
983 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200984 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100985 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200986
Gilles Peskine8e338702019-07-30 20:06:31 +0200987 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100988 {
989 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200990 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100991 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100992
993 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100994 if( alg != 0 )
995 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100996 status = psa_key_policy_permits( &slot->attr.policy,
997 slot->attr.type,
998 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100999 if( status != PSA_SUCCESS )
1000 goto error;
1001 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001002
Darryl Green06fd18d2018-07-16 11:21:11 +01001003 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001004
1005error:
1006 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001007 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001008
1009 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001010}
Darryl Green940d72c2018-07-13 13:18:51 +01001011
Ronald Cron5c522922020-11-14 16:35:34 +01001012/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001013 *
1014 * A transparent key is a key for which the key material is directly
Ronald Cron8a0466a2021-08-24 15:39:44 +02001015 * available, as opposed to a key in a secure element and/or to be used
1016 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001017 *
Ronald Cron8a0466a2021-08-24 15:39:44 +02001018 * This is a temporary function that may be used instead of
1019 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1020 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001021 *
Ronald Cron5c522922020-11-14 16:35:34 +01001022 * On success, the returned key slot is locked. It is the responsibility of the
1023 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001024 */
Ronald Cron5c522922020-11-14 16:35:34 +01001025static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1026 mbedtls_svc_key_id_t key,
1027 psa_key_slot_t **p_slot,
1028 psa_key_usage_t usage,
1029 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001030{
Ronald Cron5c522922020-11-14 16:35:34 +01001031 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1032 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001033 if( status != PSA_SUCCESS )
1034 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001035
Ronald Cron8a0466a2021-08-24 15:39:44 +02001036 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001037 {
Ronald Cron5c522922020-11-14 16:35:34 +01001038 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001039 *p_slot = NULL;
1040 return( PSA_ERROR_NOT_SUPPORTED );
1041 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001042
Gilles Peskine28f8f302019-07-24 13:30:31 +02001043 return( PSA_SUCCESS );
1044}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001045
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001046psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001047{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001048 /* Data pointer will always be either a valid pointer or NULL in an
1049 * initialized slot, so we can just free it. */
1050 if( slot->key.data != NULL )
1051 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1052
1053 mbedtls_free( slot->key.data );
1054 slot->key.data = NULL;
1055 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001056
1057 return( PSA_SUCCESS );
1058}
1059
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001060/** Completely wipe a slot in memory, including its policy.
1061 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001062psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001063{
1064 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001065
1066 /*
1067 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001068 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001069 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1070 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001071 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001072 */
Ronald Cron5c522922020-11-14 16:35:34 +01001073 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001074 {
1075#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001076 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001077#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001078 status = PSA_ERROR_CORRUPTION_DETECTED;
1079 }
1080
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001081 /* Multipart operations may still be using the key. This is safe
1082 * because all multipart operation objects are independent from
1083 * the key slot: if they need to access the key after the setup
1084 * phase, they have a copy of the key. Note that this means that
1085 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001086 /* At this point, key material and other type-specific content has
1087 * been wiped. Clear remaining metadata. We can call memset and not
1088 * zeroize because the metadata is not particularly sensitive. */
1089 memset( slot, 0, sizeof( *slot ) );
1090 return( status );
1091}
1092
Ronald Croncf56a0a2020-08-04 09:51:30 +02001093psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001094{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001095 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001096 psa_status_t status; /* status of the last operation */
1097 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001098#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1099 psa_se_drv_table_entry_t *driver;
1100#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001101
Ronald Croncf56a0a2020-08-04 09:51:30 +02001102 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001103 return( PSA_SUCCESS );
1104
Ronald Cronf2911112020-10-29 17:51:10 +01001105 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001106 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001107 * key, this will load the key description from persistent memory if not
1108 * done yet. We cannot avoid this loading as without it we don't know if
1109 * the key is operated by an SE or not and this information is needed by
1110 * the current implementation.
1111 */
Ronald Cron5c522922020-11-14 16:35:34 +01001112 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001113 if( status != PSA_SUCCESS )
1114 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001115
Ronald Cronf2911112020-10-29 17:51:10 +01001116 /*
1117 * If the key slot containing the key description is under access by the
1118 * library (apart from the present access), the key cannot be destroyed
1119 * yet. For the time being, just return in error. Eventually (to be
1120 * implemented), the key should be destroyed when all accesses have
1121 * stopped.
1122 */
Ronald Cron5c522922020-11-14 16:35:34 +01001123 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001124 {
Ronald Cron5c522922020-11-14 16:35:34 +01001125 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001126 return( PSA_ERROR_GENERIC_ERROR );
1127 }
1128
Gilles Peskine251c7742021-04-21 22:32:05 +02001129 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1130 {
1131 /* Refuse the destruction of a read-only key (which may or may not work
1132 * if we attempt it, depending on whether the key is merely read-only
1133 * by policy or actually physically read-only).
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001134 * Just do the best we can, which is to wipe the copy in memory
1135 * (done in this function's cleanup code). */
1136 overall_status = PSA_ERROR_NOT_PERMITTED;
1137 goto exit;
Gilles Peskine251c7742021-04-21 22:32:05 +02001138 }
1139
Gilles Peskine354f7672019-07-12 23:46:38 +02001140#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001141 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001142 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001143 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001144 /* For a key in a secure element, we need to do three things:
1145 * remove the key file in internal storage, destroy the
1146 * key inside the secure element, and update the driver's
1147 * persistent data. Start a transaction that will encompass these
1148 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001149 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001150 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001151 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001152 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001153 status = psa_crypto_save_transaction( );
1154 if( status != PSA_SUCCESS )
1155 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001156 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001157 /* We should still try to destroy the key in the secure
1158 * element and the key metadata in storage. This is especially
1159 * important if the error is that the storage is full.
1160 * But how to do it exactly without risking an inconsistent
1161 * state after a reset?
1162 * https://github.com/ARMmbed/mbed-crypto/issues/215
1163 */
1164 overall_status = status;
1165 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001166 }
1167
Ronald Cronea0f8a62020-11-25 17:52:23 +01001168 status = psa_destroy_se_key( driver,
1169 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001170 if( overall_status == PSA_SUCCESS )
1171 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001172 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001173#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1174
Darryl Greend49a4992018-06-18 17:27:26 +01001175#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001176 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001177 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001178 status = psa_destroy_persistent_key( slot->attr.id );
1179 if( overall_status == PSA_SUCCESS )
1180 overall_status = status;
1181
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001182 /* TODO: other slots may have a copy of the same key. We should
1183 * invalidate them.
1184 * https://github.com/ARMmbed/mbed-crypto/issues/214
1185 */
Darryl Greend49a4992018-06-18 17:27:26 +01001186 }
1187#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001188
Gilles Peskinefc762652019-07-22 19:30:34 +02001189#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1190 if( driver != NULL )
1191 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001192 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001193 if( overall_status == PSA_SUCCESS )
1194 overall_status = status;
1195 status = psa_crypto_stop_transaction( );
1196 if( overall_status == PSA_SUCCESS )
1197 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001198 }
1199#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1200
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001201exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001202 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001203 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001204 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001205 overall_status = status;
1206 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001207}
1208
John Durkop07cc04a2020-11-16 22:08:34 -08001209#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001210 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001211static psa_status_t psa_get_rsa_public_exponent(
1212 const mbedtls_rsa_context *rsa,
1213 psa_key_attributes_t *attributes )
1214{
1215 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001216 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001217 uint8_t *buffer = NULL;
1218 size_t buflen;
1219 mbedtls_mpi_init( &mpi );
1220
1221 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1222 if( ret != 0 )
1223 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001224 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1225 {
1226 /* It's the default value, which is reported as an empty string,
1227 * so there's nothing to do. */
1228 goto exit;
1229 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001230
1231 buflen = mbedtls_mpi_size( &mpi );
1232 buffer = mbedtls_calloc( 1, buflen );
1233 if( buffer == NULL )
1234 {
1235 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1236 goto exit;
1237 }
1238 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1239 if( ret != 0 )
1240 goto exit;
1241 attributes->domain_parameters = buffer;
1242 attributes->domain_parameters_size = buflen;
1243
1244exit:
1245 mbedtls_mpi_free( &mpi );
1246 if( ret != 0 )
1247 mbedtls_free( buffer );
1248 return( mbedtls_to_psa_error( ret ) );
1249}
John Durkop07cc04a2020-11-16 22:08:34 -08001250#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001251 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001252
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001253/** Retrieve all the publicly-accessible attributes of a key.
1254 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001255psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001256 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001259 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001260 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001261
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001262 psa_reset_key_attributes( attributes );
1263
Ronald Cron5c522922020-11-14 16:35:34 +01001264 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001265 if( status != PSA_SUCCESS )
1266 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001267
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001268 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001269 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1270 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1271
1272#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron0518f612021-08-24 15:50:05 +02001273 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001274 psa_set_key_slot_number( attributes,
1275 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001276#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001277
Gilles Peskine8e338702019-07-30 20:06:31 +02001278 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001279 {
John Durkop07cc04a2020-11-16 22:08:34 -08001280#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001281 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001282 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001283 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001284 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001285 * is not yet implemented.
1286 * https://github.com/ARMmbed/mbed-crypto/issues/216
1287 */
Ronald Cron41e80062021-08-24 16:00:51 +02001288 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001289 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001290 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001291
Ronald Cron90857082020-11-25 14:58:33 +01001292 status = mbedtls_psa_rsa_load_representation(
1293 slot->attr.type,
1294 slot->key.data,
1295 slot->key.bytes,
1296 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001297 if( status != PSA_SUCCESS )
1298 break;
1299
Steven Cooremana2371e52020-07-28 14:30:39 +02001300 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001301 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001302 mbedtls_rsa_free( rsa );
1303 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001304 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001305 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001306#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001307 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001308 default:
1309 /* Nothing else to do. */
1310 break;
1311 }
1312
1313 if( status != PSA_SUCCESS )
1314 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001315
Ronald Cron5c522922020-11-14 16:35:34 +01001316 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001317
Ronald Cron5c522922020-11-14 16:35:34 +01001318 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001319}
1320
Gilles Peskinec8000c02019-08-02 20:15:51 +02001321#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1322psa_status_t psa_get_key_slot_number(
1323 const psa_key_attributes_t *attributes,
1324 psa_key_slot_number_t *slot_number )
1325{
1326 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1327 {
1328 *slot_number = attributes->slot_number;
1329 return( PSA_SUCCESS );
1330 }
1331 else
1332 return( PSA_ERROR_INVALID_ARGUMENT );
1333}
1334#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1335
Ronald Crond18b5f82020-11-25 16:46:05 +01001336static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1337 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001338 uint8_t *data,
1339 size_t data_size,
1340 size_t *data_length )
1341{
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001343 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001344 memcpy( data, key_buffer, key_buffer_size );
1345 memset( data + key_buffer_size, 0,
1346 data_size - key_buffer_size );
1347 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001348 return( PSA_SUCCESS );
1349}
1350
Ronald Cron7285cda2020-11-26 14:46:37 +01001351psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001352 const psa_key_attributes_t *attributes,
1353 const uint8_t *key_buffer, size_t key_buffer_size,
1354 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001355{
Ronald Crond18b5f82020-11-25 16:46:05 +01001356 psa_key_type_t type = attributes->core.type;
1357
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 if( key_type_is_raw_bytes( type ) ||
1359 PSA_KEY_TYPE_IS_RSA( type ) ||
1360 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001361 {
1362 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 key_buffer, key_buffer_size,
1364 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001365 }
1366 else
1367 {
1368 /* This shouldn't happen in the reference implementation, but
1369 it is valid for a special-purpose implementation to omit
1370 support for exporting certain key types. */
1371 return( PSA_ERROR_NOT_SUPPORTED );
1372 }
1373}
1374
1375psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1376 uint8_t *data,
1377 size_t data_size,
1378 size_t *data_length )
1379{
1380 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1381 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1382 psa_key_slot_t *slot;
1383
Ronald Crone907e552021-01-18 13:22:38 +01001384 /* Reject a zero-length output buffer now, since this can never be a
1385 * valid key representation. This way we know that data must be a valid
1386 * pointer and we can do things like memset(data, ..., data_size). */
1387 if( data_size == 0 )
1388 return( PSA_ERROR_BUFFER_TOO_SMALL );
1389
Ronald Cron9486f9d2020-11-26 13:36:23 +01001390 /* Set the key to empty now, so that even when there are errors, we always
1391 * set data_length to a value between 0 and data_size. On error, setting
1392 * the key to empty is a good choice because an empty key representation is
1393 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001394 *data_length = 0;
1395
Ronald Cron9486f9d2020-11-26 13:36:23 +01001396 /* Export requires the EXPORT flag. There is an exception for public keys,
1397 * which don't require any flag, but
1398 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1399 */
1400 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1401 PSA_KEY_USAGE_EXPORT, 0 );
1402 if( status != PSA_SUCCESS )
1403 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001404
Ronald Crond18b5f82020-11-25 16:46:05 +01001405 psa_key_attributes_t attributes = {
1406 .core = slot->attr
1407 };
Ronald Cron67227982020-11-26 15:16:05 +01001408 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001409 slot->key.data, slot->key.bytes,
1410 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001411
Ronald Cron9486f9d2020-11-26 13:36:23 +01001412 unlock_status = psa_unlock_key_slot( slot );
1413
1414 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1415}
1416
Ronald Cron7285cda2020-11-26 14:46:37 +01001417psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001418 const psa_key_attributes_t *attributes,
1419 const uint8_t *key_buffer,
1420 size_t key_buffer_size,
1421 uint8_t *data,
1422 size_t data_size,
1423 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001424{
Ronald Crond18b5f82020-11-25 16:46:05 +01001425 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001426
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001428 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001429 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001430 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001431 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001432 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 key_buffer, key_buffer_size,
1434 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001435 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001436
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001438 {
John Durkop0e005192020-10-31 22:06:54 -07001439#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1440 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001441 return( mbedtls_psa_rsa_export_public_key( attributes,
1442 key_buffer,
1443 key_buffer_size,
1444 data,
1445 data_size,
1446 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001447#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001448 /* We don't know how to convert a private RSA key to public. */
1449 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001450#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1451 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001452 }
1453 else
Moran Pekera998bc62018-04-16 18:16:20 +03001454 {
John Durkop6ba40d12020-11-10 08:50:04 -08001455#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1456 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001457 return( mbedtls_psa_ecp_export_public_key( attributes,
1458 key_buffer,
1459 key_buffer_size,
1460 data,
1461 data_size,
1462 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001463#else
1464 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001465 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001466#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1467 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001468 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001469 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001470 else
1471 {
1472 /* This shouldn't happen in the reference implementation, but
1473 it is valid for a special-purpose implementation to omit
1474 support for exporting certain key types. */
1475 return( PSA_ERROR_NOT_SUPPORTED );
1476 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001477}
Ronald Crond18b5f82020-11-25 16:46:05 +01001478
Ronald Croncf56a0a2020-08-04 09:51:30 +02001479psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001480 uint8_t *data,
1481 size_t data_size,
1482 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001483{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001484 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001485 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001486 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001487
Ronald Crone907e552021-01-18 13:22:38 +01001488 /* Reject a zero-length output buffer now, since this can never be a
1489 * valid key representation. This way we know that data must be a valid
1490 * pointer and we can do things like memset(data, ..., data_size). */
1491 if( data_size == 0 )
1492 return( PSA_ERROR_BUFFER_TOO_SMALL );
1493
Darryl Greendd8fb772018-11-07 16:00:44 +00001494 /* Set the key to empty now, so that even when there are errors, we always
1495 * set data_length to a value between 0 and data_size. On error, setting
1496 * the key to empty is a good choice because an empty key representation is
1497 * unlikely to be accepted anywhere. */
1498 *data_length = 0;
1499
1500 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001501 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001502 if( status != PSA_SUCCESS )
1503 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001504
Ronald Cron9486f9d2020-11-26 13:36:23 +01001505 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1506 {
1507 status = PSA_ERROR_INVALID_ARGUMENT;
1508 goto exit;
1509 }
1510
Ronald Crond18b5f82020-11-25 16:46:05 +01001511 psa_key_attributes_t attributes = {
1512 .core = slot->attr
1513 };
Ronald Cron67227982020-11-26 15:16:05 +01001514 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001515 &attributes, slot->key.data, slot->key.bytes,
1516 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001517
1518exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001519 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001520
Ronald Cron5c522922020-11-14 16:35:34 +01001521 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001522}
1523
Gilles Peskine91e8c332019-08-02 19:19:39 +02001524#if defined(static_assert)
1525static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1526 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001527static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001528 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001529static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001530 "One or more key attribute flag is listed as both internal-only and external-only" );
1531#endif
1532
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001533/** Validate that a key policy is internally well-formed.
1534 *
1535 * This function only rejects invalid policies. It does not validate the
1536 * consistency of the policy with respect to other attributes of the key
1537 * such as the key type.
1538 */
1539static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001540{
1541 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001542 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001543 PSA_KEY_USAGE_ENCRYPT |
1544 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arme8efa392021-04-14 21:14:28 +02001545 PSA_KEY_USAGE_SIGN_MESSAGE |
1546 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001547 PSA_KEY_USAGE_SIGN_HASH |
1548 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001549 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1550 return( PSA_ERROR_INVALID_ARGUMENT );
1551
Gilles Peskine4747d192019-04-17 15:05:45 +02001552 return( PSA_SUCCESS );
1553}
1554
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001555/** Validate the internal consistency of key attributes.
1556 *
1557 * This function only rejects invalid attribute values. If does not
1558 * validate the consistency of the attributes with any key data that may
1559 * be involved in the creation of the key.
1560 *
1561 * Call this function early in the key creation process.
1562 *
1563 * \param[in] attributes Key attributes for the new key.
1564 * \param[out] p_drv On any return, the driver for the key, if any.
1565 * NULL for a transparent key.
1566 *
1567 */
1568static psa_status_t psa_validate_key_attributes(
1569 const psa_key_attributes_t *attributes,
1570 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001571{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001572 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001573 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001574 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001575
Ronald Cron54b90082020-10-29 15:26:43 +01001576 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001577 if( status != PSA_SUCCESS )
1578 return( status );
1579
Ronald Crond2ed4812020-07-17 16:11:30 +02001580 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001581 if( status != PSA_SUCCESS )
1582 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001583
Ronald Cron65f38a32020-10-23 17:11:13 +02001584 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1585 {
1586 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1587 return( PSA_ERROR_INVALID_ARGUMENT );
1588 }
1589 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001590 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001591 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1592 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001593 }
1594
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001595 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001596 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001597 return( status );
1598
1599 /* Refuse to create overly large keys.
1600 * Note that this doesn't trigger on import if the attributes don't
1601 * explicitly specify a size (so psa_get_key_bits returns 0), so
1602 * psa_import_key() needs its own checks. */
1603 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1604 return( PSA_ERROR_NOT_SUPPORTED );
1605
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606 /* Reject invalid flags. These should not be reachable through the API. */
1607 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1608 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1609 return( PSA_ERROR_INVALID_ARGUMENT );
1610
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001611 return( PSA_SUCCESS );
1612}
1613
Gilles Peskine4747d192019-04-17 15:05:45 +02001614/** Prepare a key slot to receive key material.
1615 *
1616 * This function allocates a key slot and sets its metadata.
1617 *
1618 * If this function fails, call psa_fail_key_creation().
1619 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001620 * This function is intended to be used as follows:
1621 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001622 * it with the specified attributes, and in case of a volatile key assign it
1623 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001624 * -# Populate the slot with the key material.
1625 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1626 * In case of failure at any step, stop the sequence and call
1627 * psa_fail_key_creation().
1628 *
Ronald Cron5c522922020-11-14 16:35:34 +01001629 * On success, the key slot is locked. It is the responsibility of the caller
1630 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001631 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001632 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001633 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001634 * \param[out] p_slot On success, a pointer to the prepared slot.
1635 * \param[out] p_drv On any return, the driver for the key, if any.
1636 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001637 *
1638 * \retval #PSA_SUCCESS
1639 * The key slot is ready to receive key material.
1640 * \return If this function fails, the key slot is an invalid state.
1641 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001642 */
1643static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001644 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001645 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001646 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001647 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001648{
1649 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001650 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001651 psa_key_slot_t *slot;
1652
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 *p_drv = NULL;
1655
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001656 status = psa_validate_key_attributes( attributes, p_drv );
1657 if( status != PSA_SUCCESS )
1658 return( status );
1659
Ronald Cronc4d1b512020-07-31 11:26:37 +02001660 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001661 if( status != PSA_SUCCESS )
1662 return( status );
1663 slot = *p_slot;
1664
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001665 /* We're storing the declared bit-size of the key. It's up to each
1666 * creation mechanism to verify that this information is correct.
1667 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001668 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001669 * is optional (import, copy). In case of a volatile key, assign it the
1670 * volatile key identifier associated to the slot returned to contain its
1671 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001672
1673 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001674 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1675 {
1676#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1677 slot->attr.id = volatile_key_id;
1678#else
1679 slot->attr.id.key_id = volatile_key_id;
1680#endif
1681 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001682
Gilles Peskine91e8c332019-08-02 19:19:39 +02001683 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001684 * external-only flags, query `attributes`. Thanks to the check
1685 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001686 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001687 * may have set. */
1688 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001689
Gilles Peskinecbaff462019-07-12 23:46:04 +02001690#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001691 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001692 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001693 * create the key file in internal storage, create the
1694 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001695 * persistent data. This is done by starting a transaction that will
1696 * encompass these three actions.
1697 * For registering a volatile key, we just need to find an appropriate
1698 * slot number inside the SE. Since the key is designated volatile, creating
1699 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001700 /* The first thing to do is to find a slot number for the new key.
1701 * We save the slot number in persistent storage as part of the
1702 * transaction data. It will be needed to recover if the power
1703 * fails during the key creation process, to clean up on the secure
1704 * element side after restarting. Obtaining a slot number from the
1705 * secure element driver updates its persistent state, but we do not yet
1706 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001707 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001708 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001709 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001710 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001711 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001712 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001713 if( status != PSA_SUCCESS )
1714 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001715
1716 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001717 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001718 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1719 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001720 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001721 psa_crypto_transaction.key.id = slot->attr.id;
1722 status = psa_crypto_save_transaction( );
1723 if( status != PSA_SUCCESS )
1724 {
1725 (void) psa_crypto_stop_transaction( );
1726 return( status );
1727 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001728 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729
1730 status = psa_copy_key_material_into_slot(
1731 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001732 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001733
1734 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1735 {
1736 /* Key registration only makes sense with a secure element. */
1737 return( PSA_ERROR_INVALID_ARGUMENT );
1738 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001739#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1740
Ronald Cronc4d1b512020-07-31 11:26:37 +02001741 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001742}
Gilles Peskine4747d192019-04-17 15:05:45 +02001743
1744/** Finalize the creation of a key once its key material has been set.
1745 *
1746 * This entails writing the key to persistent storage.
1747 *
1748 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001749 * See the documentation of psa_start_key_creation() for the intended use
1750 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 *
Ronald Cron5c522922020-11-14 16:35:34 +01001752 * If the finalization succeeds, the function unlocks the key slot (it was
1753 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1754 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001755 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001756 * \param[in,out] slot Pointer to the slot with key material.
1757 * \param[in] driver The secure element driver for the key,
1758 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001759 * \param[out] key On success, identifier of the key. Note that the
1760 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001761 *
1762 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001763 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001764 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1765 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1766 * \retval #PSA_ERROR_ALREADY_EXISTS
1767 * \retval #PSA_ERROR_DATA_INVALID
1768 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001769 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001770 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001771 * \return If this function fails, the key slot is an invalid state.
1772 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001774static psa_status_t psa_finish_key_creation(
1775 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001776 psa_se_drv_table_entry_t *driver,
1777 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001778{
1779 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001780 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001782
1783#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001784 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001786#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1787 if( driver != NULL )
1788 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001789 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001790 psa_key_slot_number_t slot_number =
1791 psa_key_slot_get_slot_number( slot ) ;
1792
Gilles Peskineb46bef22019-07-30 21:32:04 +02001793#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001794 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001795 sizeof( data.slot_number ),
1796 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001798 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001799 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001800 (uint8_t*) &data,
1801 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001802 }
1803 else
1804#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1805 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001806 /* Key material is saved in export representation in the slot, so
1807 * just pass the slot buffer for storage. */
1808 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001809 slot->key.data,
1810 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001811 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001812 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001813#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1814
Gilles Peskinecbaff462019-07-12 23:46:04 +02001815#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001816 /* Finish the transaction for a key creation. This does not
1817 * happen when registering an existing key. Detect this case
1818 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001819 * creation of a persistent key in a secure element requires a transaction,
1820 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001821 if( driver != NULL &&
1822 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001823 {
1824 status = psa_save_se_persistent_data( driver );
1825 if( status != PSA_SUCCESS )
1826 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001827 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001828 return( status );
1829 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001830 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001831 }
1832#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1833
Ronald Cron50972942020-11-14 11:28:25 +01001834 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001835 {
1836 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001837 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001838 if( status != PSA_SUCCESS )
1839 *key = MBEDTLS_SVC_KEY_ID_INIT;
1840 }
Ronald Cron50972942020-11-14 11:28:25 +01001841
Gilles Peskine4747d192019-04-17 15:05:45 +02001842 return( status );
1843}
1844
1845/** Abort the creation of a key.
1846 *
1847 * You may call this function after calling psa_start_key_creation(),
1848 * or after psa_finish_key_creation() fails. In other circumstances, this
1849 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001850 * See the documentation of psa_start_key_creation() for the intended use
1851 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001852 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001853 * \param[in,out] slot Pointer to the slot with key material.
1854 * \param[in] driver The secure element driver for the key,
1855 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001856 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001857static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001858 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001859{
Gilles Peskine011e4282019-06-26 18:34:38 +02001860 (void) driver;
1861
Gilles Peskine4747d192019-04-17 15:05:45 +02001862 if( slot == NULL )
1863 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001864
1865#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001866 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001867 * element, and the failure happened later (when saving metadata
1868 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001869 * element.
1870 * https://github.com/ARMmbed/mbed-crypto/issues/217
1871 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001872
Gilles Peskined7729582019-08-05 15:55:54 +02001873 /* Abort the ongoing transaction if any (there may not be one if
1874 * the creation process failed before starting one, or if the
1875 * key creation is a registration of a key in a secure element).
1876 * Earlier functions must already have done what it takes to undo any
1877 * partial creation. All that's left is to update the transaction data
1878 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001879 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001880#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1881
Gilles Peskine4747d192019-04-17 15:05:45 +02001882 psa_wipe_key_slot( slot );
1883}
1884
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001885/** Validate optional attributes during key creation.
1886 *
1887 * Some key attributes are optional during key creation. If they are
1888 * specified in the attributes structure, check that they are consistent
1889 * with the data in the slot.
1890 *
1891 * This function should be called near the end of key creation, after
1892 * the slot in memory is fully populated but before saving persistent data.
1893 */
1894static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 const psa_key_slot_t *slot,
1896 const psa_key_attributes_t *attributes )
1897{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001898 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001899 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001900 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 return( PSA_ERROR_INVALID_ARGUMENT );
1902 }
1903
1904 if( attributes->domain_parameters_size != 0 )
1905 {
John Durkop0e005192020-10-31 22:06:54 -07001906#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1907 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001908 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001909 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001910 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001911 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001913
Ronald Cron90857082020-11-25 14:58:33 +01001914 psa_status_t status = mbedtls_psa_rsa_load_representation(
1915 slot->attr.type,
1916 slot->key.data,
1917 slot->key.bytes,
1918 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001919 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001920 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001921
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001922 mbedtls_mpi_init( &actual );
1923 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001924 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001925 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001926 mbedtls_rsa_free( rsa );
1927 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001928 if( ret != 0 )
1929 goto rsa_exit;
1930 ret = mbedtls_mpi_read_binary( &required,
1931 attributes->domain_parameters,
1932 attributes->domain_parameters_size );
1933 if( ret != 0 )
1934 goto rsa_exit;
1935 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1936 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1937 rsa_exit:
1938 mbedtls_mpi_free( &actual );
1939 mbedtls_mpi_free( &required );
1940 if( ret != 0)
1941 return( mbedtls_to_psa_error( ret ) );
1942 }
1943 else
John Durkop9814fa22020-11-04 12:28:15 -08001944#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1945 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001946 {
1947 return( PSA_ERROR_INVALID_ARGUMENT );
1948 }
1949 }
1950
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001951 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001953 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001954 return( PSA_ERROR_INVALID_ARGUMENT );
1955 }
1956
1957 return( PSA_SUCCESS );
1958}
1959
Gilles Peskine4747d192019-04-17 15:05:45 +02001960psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001962 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001963 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001964{
1965 psa_status_t status;
1966 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001967 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001968 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001969
Ronald Cron81709fc2020-11-14 12:10:32 +01001970 *key = MBEDTLS_SVC_KEY_ID_INIT;
1971
Gilles Peskine0f84d622019-09-12 19:03:13 +02001972 /* Reject zero-length symmetric keys (including raw data key objects).
1973 * This also rejects any key which might be encoded as an empty string,
1974 * which is never valid. */
1975 if( data_length == 0 )
1976 return( PSA_ERROR_INVALID_ARGUMENT );
1977
Gilles Peskinedf179142019-07-15 22:02:14 +02001978 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001979 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001980 if( status != PSA_SUCCESS )
1981 goto exit;
1982
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001983 /* In the case of a transparent key or an opaque key stored in local
1984 * storage (thus not in the case of generating a key in a secure element
1985 * or cryptoprocessor with storage), we have to allocate a buffer to
1986 * hold the generated key material. */
1987 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001988 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001989 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001990 if( status != PSA_SUCCESS )
1991 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001992 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001993
1994 bits = slot->attr.bits;
1995 status = psa_driver_wrapper_import_key( attributes,
1996 data, data_length,
1997 slot->key.data,
1998 slot->key.bytes,
1999 &slot->key.bytes, &bits );
2000 if( status != PSA_SUCCESS )
2001 goto exit;
2002
2003 if( slot->attr.bits == 0 )
2004 slot->attr.bits = (psa_key_bits_t) bits;
2005 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002006 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002007 status = PSA_ERROR_INVALID_ARGUMENT;
2008 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002009 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002010
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002011 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002012 if( status != PSA_SUCCESS )
2013 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002014
Ronald Cron81709fc2020-11-14 12:10:32 +01002015 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002016exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002017 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002018 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002019
Gilles Peskine4747d192019-04-17 15:05:45 +02002020 return( status );
2021}
2022
Gilles Peskined7729582019-08-05 15:55:54 +02002023#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2024psa_status_t mbedtls_psa_register_se_key(
2025 const psa_key_attributes_t *attributes )
2026{
2027 psa_status_t status;
2028 psa_key_slot_t *slot = NULL;
2029 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002030 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002031
2032 /* Leaving attributes unspecified is not currently supported.
2033 * It could make sense to query the key type and size from the
2034 * secure element, but not all secure elements support this
2035 * and the driver HAL doesn't currently support it. */
2036 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2037 return( PSA_ERROR_NOT_SUPPORTED );
2038 if( psa_get_key_bits( attributes ) == 0 )
2039 return( PSA_ERROR_NOT_SUPPORTED );
2040
2041 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002042 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002043 if( status != PSA_SUCCESS )
2044 goto exit;
2045
Ronald Cron81709fc2020-11-14 12:10:32 +01002046 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002047
2048exit:
2049 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002050 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002051
Gilles Peskined7729582019-08-05 15:55:54 +02002052 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002053 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002054 return( status );
2055}
2056#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2057
Gilles Peskinef603c712019-01-19 13:40:11 +01002058static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002059 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002060{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002061 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002062 source->key.data,
2063 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002064 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002065 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002066
Steven Cooreman398aee52020-10-13 14:35:45 +02002067 target->attr.type = source->attr.type;
2068 target->attr.bits = source->attr.bits;
2069
2070 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002071}
2072
Ronald Croncf56a0a2020-08-04 09:51:30 +02002073psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002075 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002076{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002078 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002079 psa_key_slot_t *source_slot = NULL;
2080 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002081 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002082 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002083
Ronald Cron81709fc2020-11-14 12:10:32 +01002084 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2085
Ronald Cron5c522922020-11-14 16:35:34 +01002086 status = psa_get_and_lock_transparent_key_slot_with_policy(
2087 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002088 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002089 goto exit;
2090
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002091 status = psa_validate_optional_attributes( source_slot,
2092 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002093 if( status != PSA_SUCCESS )
2094 goto exit;
2095
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002096 status = psa_restrict_key_policy( source_slot->attr.type,
2097 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002098 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002099 if( status != PSA_SUCCESS )
2100 goto exit;
2101
Ronald Cron81709fc2020-11-14 12:10:32 +01002102 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2103 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002104 if( status != PSA_SUCCESS )
2105 goto exit;
2106
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002107#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2108 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002109 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002110 /* Copying to a secure element is not implemented yet. */
2111 status = PSA_ERROR_NOT_SUPPORTED;
2112 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002113 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002114#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002115
Ronald Cron6cc66312021-04-02 12:27:47 +02002116 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2117 {
2118 /*
2119 * Copying through an opaque driver is not implemented yet, consider
2120 * a lifetime with an external location as an invalid parameter for
2121 * now.
2122 */
2123 status = PSA_ERROR_INVALID_ARGUMENT;
2124 goto exit;
2125 }
2126
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002127 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002128 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002129 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002130
Ronald Cron81709fc2020-11-14 12:10:32 +01002131 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002132exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002133 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002134 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002135
Ronald Cron5c522922020-11-14 16:35:34 +01002136 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002137
Ronald Cron5c522922020-11-14 16:35:34 +01002138 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002139}
2140
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002141
2142
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002143/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002144/* Message digests */
2145/****************************************************************/
2146
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2148{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002149 /* Aborting a non-active operation is allowed */
2150 if( operation->id == 0 )
2151 return( PSA_SUCCESS );
2152
2153 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2154 operation->id = 0;
2155
2156 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002157}
2158
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002159psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002160 psa_algorithm_t alg )
2161{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002164 /* A context must be freshly initialized before it can be set up. */
2165 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002166 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002167 status = PSA_ERROR_BAD_STATE;
2168 goto exit;
2169 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002170
2171 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmandb861792021-06-24 16:17:43 +01002172 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002173 status = PSA_ERROR_INVALID_ARGUMENT;
2174 goto exit;
2175 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002176
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002177 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2178 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002179 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2180
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002181 status = psa_driver_wrapper_hash_setup( operation, alg );
2182
2183exit:
2184 if( status != PSA_SUCCESS )
Dave Rodgmandb861792021-06-24 16:17:43 +01002185 psa_hash_abort( operation );
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002186
2187 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188}
2189
2190psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2191 const uint8_t *input,
2192 size_t input_length )
2193{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2195
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002196 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002197 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002198 status = PSA_ERROR_BAD_STATE;
2199 goto exit;
2200 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002201
Steven Cooremanc8288352021-03-04 14:02:19 +01002202 /* Don't require hash implementations to behave correctly on a
2203 * zero-length input, which may have an invalid pointer. */
2204 if( input_length == 0 )
2205 return( PSA_SUCCESS );
2206
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002207 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2208
2209exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002210 if( status != PSA_SUCCESS )
2211 psa_hash_abort( operation );
2212
2213 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214}
2215
2216psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2217 uint8_t *hash,
2218 size_t hash_size,
2219 size_t *hash_length )
2220{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002221 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002222 if( operation->id == 0 )
2223 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002224
Steven Cooreman1e582352021-02-18 17:24:37 +01002225 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002226 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002227 psa_hash_abort( operation );
2228 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002229}
2230
Gilles Peskine2d277862018-06-18 15:41:12 +02002231psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2232 const uint8_t *hash,
2233 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002234{
2235 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2236 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002237 psa_status_t status = psa_hash_finish(
2238 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002239 actual_hash, sizeof( actual_hash ),
2240 &actual_hash_length );
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002241
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242 if( status != PSA_SUCCESS )
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002243 goto exit;
2244
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245 if( actual_hash_length != hash_length )
Dave Rodgmandb861792021-06-24 16:17:43 +01002246 {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002247 status = PSA_ERROR_INVALID_SIGNATURE;
2248 goto exit;
2249 }
2250
Steven Cooremana2a1b802021-04-29 16:37:59 +02002251 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002252 status = PSA_ERROR_INVALID_SIGNATURE;
2253
2254exit:
2255 if( status != PSA_SUCCESS )
2256 psa_hash_abort(operation);
2257
2258 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259}
2260
Gilles Peskine0a749c82019-11-28 19:33:58 +01002261psa_status_t psa_hash_compute( psa_algorithm_t alg,
2262 const uint8_t *input, size_t input_length,
2263 uint8_t *hash, size_t hash_size,
2264 size_t *hash_length )
2265{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002266 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002267 if( !PSA_ALG_IS_HASH( alg ) )
2268 return( PSA_ERROR_INVALID_ARGUMENT );
2269
Steven Cooreman1e582352021-02-18 17:24:37 +01002270 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2271 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002272}
2273
2274psa_status_t psa_hash_compare( psa_algorithm_t alg,
2275 const uint8_t *input, size_t input_length,
2276 const uint8_t *hash, size_t hash_length )
2277{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002278 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2279 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002280
2281 if( !PSA_ALG_IS_HASH( alg ) )
2282 return( PSA_ERROR_INVALID_ARGUMENT );
2283
Steven Cooreman1e582352021-02-18 17:24:37 +01002284 psa_status_t status = psa_driver_wrapper_hash_compute(
2285 alg, input, input_length,
2286 actual_hash, sizeof(actual_hash),
2287 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002288 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002289 return( status );
2290 if( actual_hash_length != hash_length )
2291 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002292 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002293 return( PSA_ERROR_INVALID_SIGNATURE );
2294 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002295}
2296
Gilles Peskineeb35d782019-01-22 17:56:16 +01002297psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2298 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002299{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002300 if( source_operation->id == 0 ||
2301 target_operation->id != 0 )
2302 {
2303 return( PSA_ERROR_BAD_STATE );
2304 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002305
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002306 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2307 target_operation );
2308 if( status != PSA_SUCCESS )
2309 psa_hash_abort( target_operation );
2310
2311 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002312}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313
2314
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002315/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002316/* MAC */
2317/****************************************************************/
2318
Steven Cooreman07897832021-03-19 18:28:56 +01002319psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002320{
Steven Cooreman07897832021-03-19 18:28:56 +01002321 /* Aborting a non-active operation is allowed */
2322 if( operation->id == 0 )
2323 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002324
Steven Cooreman07897832021-03-19 18:28:56 +01002325 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002326 operation->mac_size = 0;
2327 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002328 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002329
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002330 return( status );
2331}
2332
Ronald Cron1c650a12021-06-17 16:33:22 +02002333static psa_status_t psa_mac_finalize_alg_and_key_validation(
2334 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002335 const psa_key_attributes_t *attributes,
2336 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002337{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondef68e72021-06-17 16:46:44 +02002339 psa_key_type_t key_type = psa_get_key_type( attributes );
2340 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002341
Ronald Cron48f875e2021-06-17 16:10:24 +02002342 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Crondef68e72021-06-17 16:46:44 +02002343 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman07897832021-03-19 18:28:56 +01002344
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002345 /* Validate the combination of key type and algorithm */
Ronald Crondef68e72021-06-17 16:46:44 +02002346 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002347 if( status != PSA_SUCCESS )
Ronald Crondef68e72021-06-17 16:46:44 +02002348 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002349
Steven Cooremana6474de2021-05-10 11:13:41 +02002350 /* Get the output length for the algorithm and key combination */
Ronald Crondef68e72021-06-17 16:46:44 +02002351 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002352
Ronald Crondef68e72021-06-17 16:46:44 +02002353 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002354 {
2355 /* A very short MAC is too short for security since it can be
2356 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2357 * so we make this our minimum, even though 32 bits is still
2358 * too small for security. */
Ronald Crondef68e72021-06-17 16:46:44 +02002359 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002360 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002361
Ronald Crondef68e72021-06-17 16:46:44 +02002362 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2363 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002364 {
2365 /* It's impossible to "truncate" to a larger length than the full length
2366 * of the algorithm. */
Ronald Crondef68e72021-06-17 16:46:44 +02002367 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002368 }
2369
Ronald Crondef68e72021-06-17 16:46:44 +02002370 return( PSA_SUCCESS );
Ronald Cron1c650a12021-06-17 16:33:22 +02002371}
2372
2373static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2374 mbedtls_svc_key_id_t key,
2375 psa_algorithm_t alg,
2376 int is_sign )
2377{
2378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2379 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002380 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002381
2382 /* A context must be freshly initialized before it can be set up. */
2383 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002384 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002385 status = PSA_ERROR_BAD_STATE;
2386 goto exit;
2387 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002388
2389 status = psa_get_and_lock_key_slot_with_policy(
2390 key,
2391 &slot,
Mateusz Starzykdd55b252021-08-17 15:24:32 +02002392 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Cron1c650a12021-06-17 16:33:22 +02002393 alg );
2394 if( status != PSA_SUCCESS )
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002395 goto exit;
Ronald Cron1c650a12021-06-17 16:33:22 +02002396
2397 psa_key_attributes_t attributes = {
2398 .core = slot->attr
2399 };
2400
Ronald Crondef68e72021-06-17 16:46:44 +02002401 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2402 &operation->mac_size );
Ronald Cron1c650a12021-06-17 16:33:22 +02002403 if( status != PSA_SUCCESS )
2404 goto exit;
2405
2406 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002407 /* Dispatch the MAC setup call with validated input */
2408 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002409 {
Steven Cooreman07897832021-03-19 18:28:56 +01002410 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002411 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002412 slot->key.data,
2413 slot->key.bytes,
2414 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002415 }
2416 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002417 {
Steven Cooreman07897832021-03-19 18:28:56 +01002418 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002419 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002420 slot->key.data,
2421 slot->key.bytes,
2422 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002424
Gilles Peskinefbfac682018-07-08 20:51:54 +02002425exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002426 if( status != PSA_SUCCESS )
Steven Cooreman07897832021-03-19 18:28:56 +01002427 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002428
Ronald Cron5c522922020-11-14 16:35:34 +01002429 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002430
Ronald Cron5c522922020-11-14 16:35:34 +01002431 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432}
2433
Gilles Peskine89167cb2018-07-08 20:12:23 +02002434psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002435 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002436 psa_algorithm_t alg )
2437{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002438 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002439}
2440
2441psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002442 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002443 psa_algorithm_t alg )
2444{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002445 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002446}
2447
Steven Cooreman11743f92021-03-19 18:38:46 +01002448psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002449 const uint8_t *input,
2450 size_t input_length )
2451{
Steven Cooreman11743f92021-03-19 18:38:46 +01002452 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002453 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454
Steven Cooreman11743f92021-03-19 18:38:46 +01002455 /* Don't require hash implementations to behave correctly on a
2456 * zero-length input, which may have an invalid pointer. */
2457 if( input_length == 0 )
2458 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002459
Steven Cooreman11743f92021-03-19 18:38:46 +01002460 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2461 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002462 if( status != PSA_SUCCESS )
Steven Cooreman11743f92021-03-19 18:38:46 +01002463 psa_mac_abort( operation );
2464
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002465 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466}
2467
Steven Cooreman87885df2021-03-19 19:04:39 +01002468psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002469 uint8_t *mac,
2470 size_t mac_size,
2471 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002472{
Steven Cooreman87885df2021-03-19 19:04:39 +01002473 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2474 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002475
Steven Cooreman87885df2021-03-19 19:04:39 +01002476 if( operation->id == 0 )
Dave Rodgmand73e1b02021-06-24 16:19:08 +01002477 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002478 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002479 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002480 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002481
Steven Cooreman15f0d922021-05-07 14:14:37 +02002482 if( ! operation->is_sign )
Dave Rodgmandb861792021-06-24 16:17:43 +01002483 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002484 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002485 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002486 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002487
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002488 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2489 * once all the error checks are done. */
2490 if( operation->mac_size == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002491 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002492 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002493 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002494 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002495
2496 if( mac_size < operation->mac_size )
Dave Rodgmandb861792021-06-24 16:17:43 +01002497 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002498 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002499 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002500 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002501
Steven Cooreman87885df2021-03-19 19:04:39 +01002502 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman15f0d922021-05-07 14:14:37 +02002503 mac, operation->mac_size,
2504 mac_length );
2505
Dave Rodgman478ab542021-06-25 09:09:02 +01002506exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002507 /* In case of success, set the potential excess room in the output buffer
2508 * to an invalid value, to avoid potentially leaking a longer MAC.
2509 * In case of error, set the output length and content to a safe default,
2510 * such that in case the caller misses an error check, the output would be
2511 * an unachievable MAC.
2512 */
2513 if( status != PSA_SUCCESS )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002514 {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002515 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002516 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002517 }
mohammad16036df908f2018-04-02 08:34:15 -07002518
Ronald Cron882eb782021-06-18 13:05:48 +02002519 if( mac_size > operation->mac_size )
2520 memset( &mac[operation->mac_size], '!',
2521 mac_size - operation->mac_size );
2522
Steven Cooreman87885df2021-03-19 19:04:39 +01002523 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002524
Steven Cooreman87885df2021-03-19 19:04:39 +01002525 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002526}
2527
Steven Cooreman87885df2021-03-19 19:04:39 +01002528psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002529 const uint8_t *mac,
2530 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531{
Steven Cooreman87885df2021-03-19 19:04:39 +01002532 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2533 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002534
Steven Cooreman87885df2021-03-19 19:04:39 +01002535 if( operation->id == 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01002536 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002537 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002538 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002539 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002540
Steven Cooreman15f0d922021-05-07 14:14:37 +02002541 if( operation->is_sign )
Dave Rodgmandb861792021-06-24 16:17:43 +01002542 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002543 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002544 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002545 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002546
2547 if( operation->mac_size != mac_length )
2548 {
2549 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002550 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002551 }
2552
Steven Cooreman87885df2021-03-19 19:04:39 +01002553 status = psa_driver_wrapper_mac_verify_finish( operation,
2554 mac, mac_length );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002555
Dave Rodgman478ab542021-06-25 09:09:02 +01002556exit:
Steven Cooreman87885df2021-03-19 19:04:39 +01002557 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002558
Steven Cooreman87885df2021-03-19 19:04:39 +01002559 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002560}
2561
Ronald Cronef0d8f12021-06-18 14:23:33 +02002562static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2563 psa_algorithm_t alg,
2564 const uint8_t *input,
2565 size_t input_length,
2566 uint8_t *mac,
2567 size_t mac_size,
2568 size_t *mac_length,
2569 int is_sign )
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002570{
2571 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002572 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2573 psa_key_slot_t *slot;
2574 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002575
Ronald Crondbb86462021-06-17 17:17:20 +02002576 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykdd55b252021-08-17 15:24:32 +02002577 key,
2578 &slot,
2579 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Cronef0d8f12021-06-18 14:23:33 +02002580 alg );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002581 if( status != PSA_SUCCESS )
2582 goto exit;
2583
Ronald Crondbb86462021-06-17 17:17:20 +02002584 psa_key_attributes_t attributes = {
2585 .core = slot->attr
2586 };
2587
2588 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2589 &operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002590 if( status != PSA_SUCCESS )
2591 goto exit;
2592
Ronald Crondbb86462021-06-17 17:17:20 +02002593 if( mac_size < operation_mac_size )
2594 {
2595 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002596 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002597 }
2598
2599 status = psa_driver_wrapper_mac_compute(
2600 &attributes,
2601 slot->key.data, slot->key.bytes,
2602 alg,
2603 input, input_length,
2604 mac, operation_mac_size, mac_length );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002605
2606exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002607 /* In case of success, set the potential excess room in the output buffer
2608 * to an invalid value, to avoid potentially leaking a longer MAC.
2609 * In case of error, set the output length and content to a safe default,
2610 * such that in case the caller misses an error check, the output would be
2611 * an unachievable MAC.
2612 */
2613 if( status != PSA_SUCCESS )
Ronald Crondbb86462021-06-17 17:17:20 +02002614 {
Ronald Crondbb86462021-06-17 17:17:20 +02002615 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002616 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002617 }
Ronald Cron882eb782021-06-18 13:05:48 +02002618 if( mac_size > operation_mac_size )
2619 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002620
Ronald Crondbb86462021-06-17 17:17:20 +02002621 unlock_status = psa_unlock_key_slot( slot );
2622
2623 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002624}
2625
Ronald Cronef0d8f12021-06-18 14:23:33 +02002626psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2627 psa_algorithm_t alg,
2628 const uint8_t *input,
2629 size_t input_length,
2630 uint8_t *mac,
2631 size_t mac_size,
2632 size_t *mac_length)
2633{
2634 return( psa_mac_compute_internal( key, alg,
2635 input, input_length,
2636 mac, mac_size, mac_length, 1 ) );
2637}
2638
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002639psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2640 psa_algorithm_t alg,
2641 const uint8_t *input,
2642 size_t input_length,
2643 const uint8_t *mac,
2644 size_t mac_length)
2645{
2646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002647 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2648 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002649
Ronald Cron4ed83682021-06-18 14:51:29 +02002650 status = psa_mac_compute_internal( key, alg,
2651 input, input_length,
2652 actual_mac, sizeof( actual_mac ),
2653 &actual_mac_length, 0 );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002654 if( status != PSA_SUCCESS )
2655 goto exit;
2656
Ronald Cron4ed83682021-06-18 14:51:29 +02002657 if( mac_length != actual_mac_length )
2658 {
2659 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002660 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002661 }
2662 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2663 {
2664 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002665 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002666 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002667
2668exit:
Ronald Cron4ed83682021-06-18 14:51:29 +02002669 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002670
2671 return ( status );
2672}
Gilles Peskine20035e32018-02-03 22:44:14 +01002673
Gilles Peskine20035e32018-02-03 22:44:14 +01002674/****************************************************************/
2675/* Asymmetric cryptography */
2676/****************************************************************/
2677
gabor-mezei-armc9795782021-05-12 11:03:09 +02002678static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm56980482021-05-05 13:56:27 +02002679 psa_algorithm_t alg )
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002680{
gabor-mezei-armc9795782021-05-12 11:03:09 +02002681 if( input_is_message )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002682 {
2683 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2684 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002685
Gilles Peskine8cb22c82021-09-22 16:15:05 +02002686 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002687 {
2688 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2689 return( PSA_ERROR_INVALID_ARGUMENT );
2690 }
2691 }
2692 else
2693 {
Mateusz Starzykd22362c2021-08-26 11:46:14 +02002694 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002695 return( PSA_ERROR_INVALID_ARGUMENT );
2696 }
2697
2698 return( PSA_SUCCESS );
2699}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002700
2701static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002702 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002703 psa_algorithm_t alg,
2704 const uint8_t * input,
2705 size_t input_length,
2706 uint8_t * signature,
2707 size_t signature_size,
2708 size_t * signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002709{
2710 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2711 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2712 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002713
2714 *signature_length = 0;
2715
gabor-mezei-armc9795782021-05-12 11:03:09 +02002716 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002717 if( status != PSA_SUCCESS )
2718 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002719
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002720 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002721 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002722 * buffer can in principle be empty since it doesn't actually have
2723 * to be a hash.) */
2724 if( signature_size == 0 )
2725 return( PSA_ERROR_BUFFER_TOO_SMALL );
2726
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002727 status = psa_get_and_lock_key_slot_with_policy(
2728 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002729 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2730 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002731 alg );
2732
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002733 if( status != PSA_SUCCESS )
2734 goto exit;
2735
2736 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2737 {
2738 status = PSA_ERROR_INVALID_ARGUMENT;
2739 goto exit;
2740 }
2741
2742 psa_key_attributes_t attributes = {
2743 .core = slot->attr
2744 };
2745
gabor-mezei-armc9795782021-05-12 11:03:09 +02002746 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002747 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002748 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002749 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002750 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002751 signature, signature_size, signature_length );
2752 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002753 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002754 {
2755
2756 status = psa_driver_wrapper_sign_hash(
2757 &attributes, slot->key.data, slot->key.bytes,
2758 alg, input, input_length,
2759 signature, signature_size, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002760 }
2761
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002762
2763exit:
2764 /* Fill the unused part of the output buffer (the whole buffer on error,
2765 * the trailing part on success) with something that isn't a valid signature
2766 * (barring an attack on the signature and deliberately-crafted input),
2767 * in case the caller doesn't check the return status properly. */
2768 if( status == PSA_SUCCESS )
2769 memset( signature + *signature_length, '!',
2770 signature_size - *signature_length );
2771 else
2772 memset( signature, '!', signature_size );
2773 /* If signature_size is 0 then we have nothing to do. We must not call
2774 * memset because signature may be NULL in this case. */
2775
2776 unlock_status = psa_unlock_key_slot( slot );
2777
2778 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2779}
2780
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002781static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002782 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002783 psa_algorithm_t alg,
2784 const uint8_t * input,
2785 size_t input_length,
2786 const uint8_t * signature,
2787 size_t signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002788{
2789 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2790 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2791 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002792
gabor-mezei-armc9795782021-05-12 11:03:09 +02002793 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002794 if( status != PSA_SUCCESS )
2795 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002796
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002797 status = psa_get_and_lock_key_slot_with_policy(
2798 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002799 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2800 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002801 alg );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002802
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002803 if( status != PSA_SUCCESS )
2804 return( status );
2805
2806 psa_key_attributes_t attributes = {
2807 .core = slot->attr
2808 };
2809
gabor-mezei-armc9795782021-05-12 11:03:09 +02002810 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002811 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002812 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002813 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002814 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002815 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002816 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002817 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002818 {
2819 status = psa_driver_wrapper_verify_hash(
2820 &attributes, slot->key.data, slot->key.bytes,
2821 alg, input, input_length,
2822 signature, signature_length );
2823 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002824
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002825 unlock_status = psa_unlock_key_slot( slot );
2826
2827 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002828
2829}
2830
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002831psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002832 const psa_key_attributes_t *attributes,
2833 const uint8_t *key_buffer,
2834 size_t key_buffer_size,
2835 psa_algorithm_t alg,
2836 const uint8_t *input,
2837 size_t input_length,
2838 uint8_t *signature,
2839 size_t signature_size,
2840 size_t *signature_length )
2841{
2842 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002843
Gilles Peskine8cb22c82021-09-22 16:15:05 +02002844 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002845 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002846 size_t hash_length;
2847 uint8_t hash[PSA_HASH_MAX_SIZE];
2848
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002849 status = psa_driver_wrapper_hash_compute(
2850 PSA_ALG_SIGN_GET_HASH( alg ),
2851 input, input_length,
2852 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002853
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002854 if( status != PSA_SUCCESS )
2855 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002856
2857 return psa_driver_wrapper_sign_hash(
2858 attributes, key_buffer, key_buffer_size,
2859 alg, hash, hash_length,
2860 signature, signature_size, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002861 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002862
gabor-mezei-arm56980482021-05-05 13:56:27 +02002863 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002864}
2865
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002866psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2867 psa_algorithm_t alg,
2868 const uint8_t * input,
2869 size_t input_length,
2870 uint8_t * signature,
2871 size_t signature_size,
2872 size_t * signature_length )
2873{
2874 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002875 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002876 signature, signature_size, signature_length );
2877}
2878
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002879psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002880 const psa_key_attributes_t *attributes,
2881 const uint8_t *key_buffer,
2882 size_t key_buffer_size,
2883 psa_algorithm_t alg,
2884 const uint8_t *input,
2885 size_t input_length,
2886 const uint8_t *signature,
2887 size_t signature_length )
2888{
2889 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002890
Gilles Peskine8cb22c82021-09-22 16:15:05 +02002891 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002892 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002893 size_t hash_length;
2894 uint8_t hash[PSA_HASH_MAX_SIZE];
2895
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002896 status = psa_driver_wrapper_hash_compute(
2897 PSA_ALG_SIGN_GET_HASH( alg ),
2898 input, input_length,
2899 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002900
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002901 if( status != PSA_SUCCESS )
2902 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002903
2904 return psa_driver_wrapper_verify_hash(
2905 attributes, key_buffer, key_buffer_size,
2906 alg, hash, hash_length,
2907 signature, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002908 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002909
gabor-mezei-armef6f2aa2021-05-05 13:59:01 +02002910 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002911}
2912
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002913psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2914 psa_algorithm_t alg,
2915 const uint8_t * input,
2916 size_t input_length,
2917 const uint8_t * signature,
2918 size_t signature_length )
2919{
2920 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002921 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002922 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002923}
2924
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002925psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002926 const psa_key_attributes_t *attributes,
2927 const uint8_t *key_buffer, size_t key_buffer_size,
2928 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2929 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002930{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002931 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002932 {
Ronald Cron4501c982021-03-19 20:09:32 +01002933 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2934 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002935 {
Ronald Cron4501c982021-03-19 20:09:32 +01002936#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2937 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2938 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002939 attributes,
2940 key_buffer, key_buffer_size,
2941 alg, hash, hash_length,
2942 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002943#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2944 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002945 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002946 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002947 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002948 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002949 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002950 }
2951 else
Ronald Cron4501c982021-03-19 20:09:32 +01002952 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2953 {
2954 if( PSA_ALG_IS_ECDSA( alg ) )
2955 {
2956#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2957 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2958 return( mbedtls_psa_ecdsa_sign_hash(
2959 attributes,
2960 key_buffer, key_buffer_size,
2961 alg, hash, hash_length,
2962 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002963#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2964 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002965 }
2966 else
2967 {
2968 return( PSA_ERROR_INVALID_ARGUMENT );
2969 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002970 }
Ronald Cron4501c982021-03-19 20:09:32 +01002971
2972 (void)key_buffer;
2973 (void)key_buffer_size;
2974 (void)hash;
2975 (void)hash_length;
2976 (void)signature;
2977 (void)signature_size;
2978 (void)signature_length;
2979
2980 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002981}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002982
2983psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2984 psa_algorithm_t alg,
2985 const uint8_t *hash,
2986 size_t hash_length,
2987 uint8_t *signature,
2988 size_t signature_size,
2989 size_t *signature_length )
2990{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002991 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002992 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002993 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002994}
2995
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002996psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002997 const psa_key_attributes_t *attributes,
2998 const uint8_t *key_buffer, size_t key_buffer_size,
2999 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
3000 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003001{
Ronald Cron99b8ed72021-02-17 10:33:32 +01003002 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003003 {
Ronald Cron4501c982021-03-19 20:09:32 +01003004 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
3005 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003006 {
Ronald Cron4501c982021-03-19 20:09:32 +01003007#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3008 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3009 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01003010 attributes,
3011 key_buffer, key_buffer_size,
3012 alg, hash, hash_length,
3013 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01003014#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3015 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02003016 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003017 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003018 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003019 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003020 }
itayzafrir5c753392018-05-08 11:18:38 +03003021 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01003022 else
Ronald Cron4501c982021-03-19 20:09:32 +01003023 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003024 {
Ronald Cron4501c982021-03-19 20:09:32 +01003025 if( PSA_ALG_IS_ECDSA( alg ) )
3026 {
3027#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3028 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3029 return( mbedtls_psa_ecdsa_verify_hash(
3030 attributes,
3031 key_buffer, key_buffer_size,
3032 alg, hash, hash_length,
3033 signature, signature_length ) );
3034#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3035 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3036 }
3037 else
3038 {
3039 return( PSA_ERROR_INVALID_ARGUMENT );
3040 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003041 }
Ronald Cron4501c982021-03-19 20:09:32 +01003042
3043 (void)key_buffer;
3044 (void)key_buffer_size;
3045 (void)hash;
3046 (void)hash_length;
3047 (void)signature;
3048 (void)signature_length;
3049
3050 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003051}
3052
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003053psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3054 psa_algorithm_t alg,
3055 const uint8_t *hash,
3056 size_t hash_length,
3057 const uint8_t *signature,
3058 size_t signature_length )
3059{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003060 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003061 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003062 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003063}
3064
John Durkop0e005192020-10-31 22:06:54 -07003065#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003066static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3067 mbedtls_rsa_context *rsa )
3068{
3069 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3070 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3071 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3072 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3073}
John Durkop0e005192020-10-31 22:06:54 -07003074#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003075
Ronald Croncf56a0a2020-08-04 09:51:30 +02003076psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003077 psa_algorithm_t alg,
3078 const uint8_t *input,
3079 size_t input_length,
3080 const uint8_t *salt,
3081 size_t salt_length,
3082 uint8_t *output,
3083 size_t output_size,
3084 size_t *output_length )
3085{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003087 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003088 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003089
Darryl Green5cc689a2018-07-24 15:34:10 +01003090 (void) input;
3091 (void) input_length;
3092 (void) salt;
3093 (void) output;
3094 (void) output_size;
3095
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096 *output_length = 0;
3097
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003098 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3099 return( PSA_ERROR_INVALID_ARGUMENT );
3100
Ronald Cron5c522922020-11-14 16:35:34 +01003101 status = psa_get_and_lock_transparent_key_slot_with_policy(
3102 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003103 if( status != PSA_SUCCESS )
3104 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003105 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3106 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003107 {
3108 status = PSA_ERROR_INVALID_ARGUMENT;
3109 goto exit;
3110 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111
John Durkop6ba40d12020-11-10 08:50:04 -08003112#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3113 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003114 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003115 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003116 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003117 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3118 slot->key.data,
3119 slot->key.bytes,
3120 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003121 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003122 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003123
3124 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003125 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003126 status = PSA_ERROR_BUFFER_TOO_SMALL;
3127 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003128 }
John Durkop0e005192020-10-31 22:06:54 -07003129#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003130 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3131 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003132 status = mbedtls_to_psa_error(
3133 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003134 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003135 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003136 MBEDTLS_RSA_PUBLIC,
3137 input_length,
3138 input,
3139 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003140 }
3141 else
John Durkop0e005192020-10-31 22:06:54 -07003142#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3143#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003144 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3145 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003146 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003147 status = mbedtls_to_psa_error(
3148 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003149 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003150 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003151 MBEDTLS_RSA_PUBLIC,
3152 salt, salt_length,
3153 input_length,
3154 input,
3155 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156 }
3157 else
John Durkop0e005192020-10-31 22:06:54 -07003158#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003159 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003160 status = PSA_ERROR_INVALID_ARGUMENT;
3161 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003162 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003163rsa_exit:
3164 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003165 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003166
Steven Cooremana2371e52020-07-28 14:30:39 +02003167 mbedtls_rsa_free( rsa );
3168 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003169 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003170 else
John Durkop9814fa22020-11-04 12:28:15 -08003171#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003172 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003174 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003175 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003176
3177exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003178 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003179
Ronald Cron5c522922020-11-14 16:35:34 +01003180 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003181}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003182
Ronald Croncf56a0a2020-08-04 09:51:30 +02003183psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003184 psa_algorithm_t alg,
3185 const uint8_t *input,
3186 size_t input_length,
3187 const uint8_t *salt,
3188 size_t salt_length,
3189 uint8_t *output,
3190 size_t output_size,
3191 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003192{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003194 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003195 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003196
Darryl Green5cc689a2018-07-24 15:34:10 +01003197 (void) input;
3198 (void) input_length;
3199 (void) salt;
3200 (void) output;
3201 (void) output_size;
3202
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003203 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003204
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003205 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3206 return( PSA_ERROR_INVALID_ARGUMENT );
3207
Ronald Cron5c522922020-11-14 16:35:34 +01003208 status = psa_get_and_lock_transparent_key_slot_with_policy(
3209 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003210 if( status != PSA_SUCCESS )
3211 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003212 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003213 {
3214 status = PSA_ERROR_INVALID_ARGUMENT;
3215 goto exit;
3216 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003217
John Durkop6ba40d12020-11-10 08:50:04 -08003218#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3219 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003220 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003221 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003222 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003223 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3224 slot->key.data,
3225 slot->key.bytes,
3226 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003227 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003228 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003229
Steven Cooremana2371e52020-07-28 14:30:39 +02003230 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003231 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003232 status = PSA_ERROR_INVALID_ARGUMENT;
3233 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003234 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003235
John Durkop0e005192020-10-31 22:06:54 -07003236#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003237 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003238 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003239 status = mbedtls_to_psa_error(
3240 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003241 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003242 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003243 MBEDTLS_RSA_PRIVATE,
3244 output_length,
3245 input,
3246 output,
3247 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003248 }
3249 else
John Durkop0e005192020-10-31 22:06:54 -07003250#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3251#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003252 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003253 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003254 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003255 status = mbedtls_to_psa_error(
3256 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003257 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003258 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003259 MBEDTLS_RSA_PRIVATE,
3260 salt, salt_length,
3261 output_length,
3262 input,
3263 output,
3264 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003265 }
3266 else
John Durkop0e005192020-10-31 22:06:54 -07003267#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003268 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003269 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003270 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003271
Steven Cooreman4fed4552020-08-03 14:46:03 +02003272rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003273 mbedtls_rsa_free( rsa );
3274 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003275 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003276 else
John Durkop6ba40d12020-11-10 08:50:04 -08003277#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3278 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003279 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003280 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003281 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003282
3283exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003284 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003285
Ronald Cron5c522922020-11-14 16:35:34 +01003286 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003287}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003288
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003289
3290
mohammad1603503973b2018-03-12 15:59:30 +02003291/****************************************************************/
3292/* Symmetric cryptography */
3293/****************************************************************/
3294
Ronald Cronab99ac22020-10-01 16:38:28 +02003295static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3296 mbedtls_svc_key_id_t key,
3297 psa_algorithm_t alg,
3298 mbedtls_operation_t cipher_operation )
3299{
3300 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3301 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003302 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003303 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3304 PSA_KEY_USAGE_ENCRYPT :
3305 PSA_KEY_USAGE_DECRYPT );
3306
3307 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003308 if( operation->id != 0 )
Dave Rodgmandb861792021-06-24 16:17:43 +01003309 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003310 status = PSA_ERROR_BAD_STATE;
3311 goto exit;
3312 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003313
Ronald Cronab99ac22020-10-01 16:38:28 +02003314 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmandb861792021-06-24 16:17:43 +01003315 {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003316 status = PSA_ERROR_INVALID_ARGUMENT;
3317 goto exit;
3318 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003319
Ronald Cronab99ac22020-10-01 16:38:28 +02003320 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3321 if( status != PSA_SUCCESS )
3322 goto exit;
3323
Ronald Cron49fafa92021-03-10 08:34:23 +01003324 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003325 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003326 * so we only set it (in the driver wrapper) after resources have been
3327 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003328 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003329 if( alg == PSA_ALG_ECB_NO_PADDING )
3330 operation->iv_required = 0;
3331 else
3332 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003333 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003334
Ronald Crona4af55f2020-12-14 14:36:06 +01003335 psa_key_attributes_t attributes = {
3336 .core = slot->attr
3337 };
3338
Ronald Cronab99ac22020-10-01 16:38:28 +02003339 /* Try doing the operation through a driver before using software fallback. */
3340 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003341 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3342 &attributes,
3343 slot->key.data,
3344 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003345 alg );
3346 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003347 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3348 &attributes,
3349 slot->key.data,
3350 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003351 alg );
3352
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003353exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003354 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003355 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003356
Ronald Cron5c522922020-11-14 16:35:34 +01003357 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003358
Ronald Cron5c522922020-11-14 16:35:34 +01003359 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003360}
3361
Gilles Peskinefe119512018-07-08 21:39:34 +02003362psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003363 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003364 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003365{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003366 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003367}
3368
Gilles Peskinefe119512018-07-08 21:39:34 +02003369psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003370 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003371 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003372{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003373 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003374}
3375
Gilles Peskinefe119512018-07-08 21:39:34 +02003376psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003377 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003378 size_t iv_size,
3379 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003380{
Ronald Cron6d051732020-10-01 14:10:20 +02003381 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc423acb2021-07-05 12:31:44 +02003382 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3383 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003384
Ronald Cron49fafa92021-03-10 08:34:23 +01003385 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003386 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003387 status = PSA_ERROR_BAD_STATE;
3388 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003389 }
3390
Steven Cooreman7df02922020-09-09 15:28:49 +02003391 if( operation->iv_set || ! operation->iv_required )
3392 {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003393 status = PSA_ERROR_BAD_STATE;
3394 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003395 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003396
Ronald Cronc423acb2021-07-05 12:31:44 +02003397 default_iv_length = operation->default_iv_length;
3398 if( iv_size < default_iv_length )
Ronald Cron5618a392021-03-26 09:52:26 +01003399 {
3400 status = PSA_ERROR_BUFFER_TOO_SMALL;
3401 goto exit;
3402 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003403
Ronald Cronc423acb2021-07-05 12:31:44 +02003404 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
3405 {
3406 status = PSA_ERROR_GENERIC_ERROR;
3407 goto exit;
3408 }
3409
3410 status = psa_generate_random( local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003411 if( status != PSA_SUCCESS )
3412 goto exit;
3413
3414 status = psa_driver_wrapper_cipher_set_iv( operation,
Ronald Cronc423acb2021-07-05 12:31:44 +02003415 local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003416
3417exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003418 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003419 {
Ronald Cronc423acb2021-07-05 12:31:44 +02003420 memcpy( iv, local_iv, default_iv_length );
3421 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003422 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003423 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003424 else
Ronald Cronc423acb2021-07-05 12:31:44 +02003425 {
3426 *iv_length = 0;
Moran Peker395db872018-05-31 14:07:14 +03003427 psa_cipher_abort( operation );
Ronald Cronc423acb2021-07-05 12:31:44 +02003428 }
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;
Ronald Cron16377072021-07-08 19:00:07 +02003569 psa_key_slot_t *slot = NULL;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003570 psa_key_type_t key_type;
3571 size_t iv_length;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003572
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003573 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron16377072021-07-08 19:00:07 +02003574 {
3575 status = PSA_ERROR_INVALID_ARGUMENT;
3576 goto exit;
3577 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003578
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003579 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3580 PSA_KEY_USAGE_ENCRYPT,
3581 alg );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003582 if( status != PSA_SUCCESS )
Ronald Cron16377072021-07-08 19:00:07 +02003583 goto exit;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003584
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003585 psa_key_attributes_t attributes = {
3586 .core = slot->attr
3587 };
3588
3589 key_type = slot->attr.type;
3590 iv_length = PSA_CIPHER_IV_LENGTH( key_type, alg );
3591
3592 if( iv_length > 0 )
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003593 {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003594 if( output_size < iv_length )
3595 {
3596 status = PSA_ERROR_BUFFER_TOO_SMALL;
3597 goto exit;
3598 }
3599
3600 status = psa_generate_random( output, iv_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003601 if( status != PSA_SUCCESS )
3602 goto exit;
3603 }
3604
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003605 status = psa_driver_wrapper_cipher_encrypt(
3606 &attributes, slot->key.data, slot->key.bytes,
3607 alg, input, input_length,
3608 output, output_size, output_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003609
3610exit:
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003611 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron16377072021-07-08 19:00:07 +02003612 if( status == PSA_SUCCESS )
3613 status = unlock_status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003614
Ronald Cron16377072021-07-08 19:00:07 +02003615 if( status != PSA_SUCCESS )
3616 *output_length = 0;
3617
3618 return( status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003619}
3620
3621psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3622 psa_algorithm_t alg,
3623 const uint8_t *input,
3624 size_t input_length,
3625 uint8_t *output,
3626 size_t output_size,
3627 size_t *output_length )
3628{
3629 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003630 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron16377072021-07-08 19:00:07 +02003631 psa_key_slot_t *slot = NULL;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003632
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003633 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron16377072021-07-08 19:00:07 +02003634 {
3635 status = PSA_ERROR_INVALID_ARGUMENT;
3636 goto exit;
3637 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003638
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003639 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3640 PSA_KEY_USAGE_DECRYPT,
3641 alg );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003642 if( status != PSA_SUCCESS )
Ronald Cron16377072021-07-08 19:00:07 +02003643 goto exit;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003644
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003645 psa_key_attributes_t attributes = {
3646 .core = slot->attr
3647 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003648
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003649 if( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
3650 {
3651 status = PSA_ERROR_INVALID_ARGUMENT;
3652 goto exit;
3653 }
3654
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003655 status = psa_driver_wrapper_cipher_decrypt(
3656 &attributes, slot->key.data, slot->key.bytes,
3657 alg, input, input_length,
3658 output, output_size, output_length );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003659
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003660exit:
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003661 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron16377072021-07-08 19:00:07 +02003662 if( status == PSA_SUCCESS )
3663 status = unlock_status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003664
Ronald Cron16377072021-07-08 19:00:07 +02003665 if( status != PSA_SUCCESS )
3666 *output_length = 0;
3667
3668 return( status );
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003669}
3670
3671
mohammad16035955c982018-04-26 00:53:03 +03003672/****************************************************************/
3673/* AEAD */
3674/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003675
Ronald Croncf56a0a2020-08-04 09:51:30 +02003676psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003677 psa_algorithm_t alg,
3678 const uint8_t *nonce,
3679 size_t nonce_length,
3680 const uint8_t *additional_data,
3681 size_t additional_data_length,
3682 const uint8_t *plaintext,
3683 size_t plaintext_length,
3684 uint8_t *ciphertext,
3685 size_t ciphertext_size,
3686 size_t *ciphertext_length )
3687{
Ronald Cron215633c2021-03-16 17:15:37 +01003688 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3689 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003690
mohammad1603f08a5502018-06-03 15:05:47 +03003691 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003692
Steven Cooremanea7ab132021-03-17 16:28:00 +01003693 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3694 return( PSA_ERROR_NOT_SUPPORTED );
3695
Ronald Cron9a986162021-03-26 12:40:07 +01003696 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003697 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003698 if( status != PSA_SUCCESS )
3699 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003700
Ronald Cron215633c2021-03-16 17:15:37 +01003701 psa_key_attributes_t attributes = {
3702 .core = slot->attr
3703 };
mohammad16035955c982018-04-26 00:53:03 +03003704
Ronald Cronde822812021-03-17 16:08:20 +01003705 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003706 &attributes, slot->key.data, slot->key.bytes,
3707 alg,
3708 nonce, nonce_length,
3709 additional_data, additional_data_length,
3710 plaintext, plaintext_length,
3711 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003712
Gilles Peskineedf9a652018-08-17 18:11:56 +02003713 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3714 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003715
Ronald Cron9f310172021-03-16 16:36:37 +01003716 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003717
mohammad16035955c982018-04-26 00:53:03 +03003718 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003719}
3720
Ronald Croncf56a0a2020-08-04 09:51:30 +02003721psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003722 psa_algorithm_t alg,
3723 const uint8_t *nonce,
3724 size_t nonce_length,
3725 const uint8_t *additional_data,
3726 size_t additional_data_length,
3727 const uint8_t *ciphertext,
3728 size_t ciphertext_length,
3729 uint8_t *plaintext,
3730 size_t plaintext_size,
3731 size_t *plaintext_length )
3732{
Ronald Cron215633c2021-03-16 17:15:37 +01003733 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3734 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003735
Gilles Peskineee652a32018-06-01 19:23:52 +02003736 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003737
Steven Cooremanea7ab132021-03-17 16:28:00 +01003738 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3739 return( PSA_ERROR_NOT_SUPPORTED );
3740
Ronald Cron9a986162021-03-26 12:40:07 +01003741 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003742 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003743 if( status != PSA_SUCCESS )
3744 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003745
Ronald Cron215633c2021-03-16 17:15:37 +01003746 psa_key_attributes_t attributes = {
3747 .core = slot->attr
3748 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003749
Ronald Cronde822812021-03-17 16:08:20 +01003750 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003751 &attributes, slot->key.data, slot->key.bytes,
3752 alg,
3753 nonce, nonce_length,
3754 additional_data, additional_data_length,
3755 ciphertext, ciphertext_length,
3756 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003757
Gilles Peskineedf9a652018-08-17 18:11:56 +02003758 if( status != PSA_SUCCESS && plaintext_size != 0 )
3759 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003760
Ronald Cron215633c2021-03-16 17:15:37 +01003761 psa_unlock_key_slot( slot );
3762
Gilles Peskineedf9a652018-08-17 18:11:56 +02003763 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003764}
3765
Gilles Peskinee59236f2018-01-27 23:32:46 +01003766/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003767/* Generators */
3768/****************************************************************/
3769
John Durkop07cc04a2020-11-16 22:08:34 -08003770#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3771 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3772 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3773#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003774#endif /* At least one builtin KDF */
3775
3776#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3777 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3778 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3779static psa_status_t psa_key_derivation_start_hmac(
3780 psa_mac_operation_t *operation,
3781 psa_algorithm_t hash_alg,
3782 const uint8_t *hmac_key,
3783 size_t hmac_key_length )
3784{
3785 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3786 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3787 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3788 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3789 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3790
Steven Cooreman15f0d922021-05-07 14:14:37 +02003791 operation->is_sign = 1;
3792 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3793
Steven Cooreman9878a162021-05-06 17:58:36 +02003794 status = psa_driver_wrapper_mac_sign_setup( operation,
3795 &attributes,
3796 hmac_key, hmac_key_length,
3797 PSA_ALG_HMAC( hash_alg ) );
3798
3799 psa_reset_key_attributes( &attributes );
3800 return( status );
3801}
3802#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003803
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003804#define HKDF_STATE_INIT 0 /* no input yet */
3805#define HKDF_STATE_STARTED 1 /* got salt */
3806#define HKDF_STATE_KEYED 2 /* got key */
3807#define HKDF_STATE_OUTPUT 3 /* output started */
3808
Gilles Peskinecbe66502019-05-16 16:59:18 +02003809static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003810 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003811{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003812 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3813 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003814 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003815 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003816}
3817
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003818psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003819{
3820 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003821 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003822 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003823 {
3824 /* The object has (apparently) been initialized but it is not
3825 * in use. It's ok to call abort on such an object, and there's
3826 * nothing to do. */
3827 }
3828 else
John Durkopd0321952020-10-29 21:37:36 -07003829#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003830 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003831 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003832 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003833 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003834 }
John Durkop07cc04a2020-11-16 22:08:34 -08003835 else
3836#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3837#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3838 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3839 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003840 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003841 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003842 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003843 if( operation->ctx.tls12_prf.secret != NULL )
3844 {
3845 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3846 operation->ctx.tls12_prf.secret_length );
3847 mbedtls_free( operation->ctx.tls12_prf.secret );
3848 }
3849
Janos Follath6a1d2622019-06-11 10:37:28 +01003850 if( operation->ctx.tls12_prf.seed != NULL )
3851 {
3852 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3853 operation->ctx.tls12_prf.seed_length );
3854 mbedtls_free( operation->ctx.tls12_prf.seed );
3855 }
3856
3857 if( operation->ctx.tls12_prf.label != NULL )
3858 {
3859 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3860 operation->ctx.tls12_prf.label_length );
3861 mbedtls_free( operation->ctx.tls12_prf.label );
3862 }
3863
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003864 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003865
3866 /* We leave the fields Ai and output_block to be erased safely by the
3867 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003868 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003869 else
John Durkop07cc04a2020-11-16 22:08:34 -08003870#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3871 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003872 {
3873 status = PSA_ERROR_BAD_STATE;
3874 }
Janos Follath083036a2019-06-11 10:22:26 +01003875 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003876 return( status );
3877}
3878
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003879psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003880 size_t *capacity)
3881{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003882 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003883 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003884 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003885 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003886 }
3887
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003888 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003889 return( PSA_SUCCESS );
3890}
3891
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003892psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003893 size_t capacity )
3894{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003895 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003896 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003897 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003898 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003899 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003900 return( PSA_SUCCESS );
3901}
3902
John Durkopd0321952020-10-29 21:37:36 -07003903#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003905 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003906static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremanb27e3502021-04-29 19:11:25 +02003907 psa_algorithm_t hash_alg,
3908 uint8_t *output,
3909 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003910{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003911 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003912 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003913 psa_status_t status;
3914
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003915 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3916 return( PSA_ERROR_BAD_STATE );
3917 hkdf->state = HKDF_STATE_OUTPUT;
3918
Gilles Peskinebef7f142018-07-12 17:22:21 +02003919 while( output_length != 0 )
3920 {
3921 /* Copy what remains of the current block */
3922 uint8_t n = hash_length - hkdf->offset_in_block;
3923 if( n > output_length )
3924 n = (uint8_t) output_length;
3925 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3926 output += n;
3927 output_length -= n;
3928 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003929 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003930 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003931 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003932 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003933 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003934 * object was corrupted or if this function is called directly
3935 * inside the library. */
3936 if( hkdf->block_number == 0xff )
3937 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003938
3939 /* We need a new block */
3940 ++hkdf->block_number;
3941 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02003942
Steven Cooreman9878a162021-05-06 17:58:36 +02003943 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3944 hash_alg,
3945 hkdf->prk,
3946 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003947 if( status != PSA_SUCCESS )
3948 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003949
Gilles Peskinebef7f142018-07-12 17:22:21 +02003950 if( hkdf->block_number != 1 )
3951 {
Steven Cooremanb27e3502021-04-29 19:11:25 +02003952 status = psa_mac_update( &hkdf->hmac,
3953 hkdf->output_block,
3954 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003955 if( status != PSA_SUCCESS )
3956 return( status );
3957 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02003958 status = psa_mac_update( &hkdf->hmac,
3959 hkdf->info,
3960 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003961 if( status != PSA_SUCCESS )
3962 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003963 status = psa_mac_update( &hkdf->hmac,
3964 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003965 if( status != PSA_SUCCESS )
3966 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003967 status = psa_mac_sign_finish( &hkdf->hmac,
3968 hkdf->output_block,
3969 sizeof( hkdf->output_block ),
3970 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003971 if( status != PSA_SUCCESS )
3972 return( status );
3973 }
3974
3975 return( PSA_SUCCESS );
3976}
John Durkop07cc04a2020-11-16 22:08:34 -08003977#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003978
John Durkop07cc04a2020-11-16 22:08:34 -08003979#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3980 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003981static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3982 psa_tls12_prf_key_derivation_t *tls12_prf,
3983 psa_algorithm_t alg )
3984{
3985 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003986 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003987 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3988 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003989 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003990
Janos Follath7742fee2019-06-17 12:58:10 +01003991 /* We can't be wanting more output after block 0xff, otherwise
3992 * the capacity check in psa_key_derivation_output_bytes() would have
3993 * prevented this call. It could happen only if the operation
3994 * object was corrupted or if this function is called directly
3995 * inside the library. */
3996 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003997 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003998
3999 /* We need a new block */
4000 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004001 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004002
4003 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4004 *
4005 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4006 *
4007 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4008 * HMAC_hash(secret, A(2) + seed) +
4009 * HMAC_hash(secret, A(3) + seed) + ...
4010 *
4011 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004012 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004013 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004014 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004015 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004016 * is currently extracted as `output_block` and where i is
4017 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004018 */
4019
Steven Cooreman9878a162021-05-06 17:58:36 +02004020 status = psa_key_derivation_start_hmac( &hmac,
4021 hash_alg,
4022 tls12_prf->secret,
4023 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004024 if( status != PSA_SUCCESS )
4025 goto cleanup;
4026
4027 /* Calculate A(i) where i = tls12_prf->block_number. */
4028 if( tls12_prf->block_number == 1 )
4029 {
4030 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4031 * the variable seed and in this instance means it in the context of the
4032 * P_hash function, where seed = label + seed.) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004033 status = psa_mac_update( &hmac,
4034 tls12_prf->label,
4035 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004036 if( status != PSA_SUCCESS )
4037 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004038 status = psa_mac_update( &hmac,
4039 tls12_prf->seed,
4040 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004041 if( status != PSA_SUCCESS )
4042 goto cleanup;
4043 }
4044 else
4045 {
4046 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004047 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004048 if( status != PSA_SUCCESS )
4049 goto cleanup;
4050 }
4051
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004052 status = psa_mac_sign_finish( &hmac,
4053 tls12_prf->Ai, hash_length,
4054 &hmac_output_length );
4055 if( hmac_output_length != hash_length )
4056 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004057 if( status != PSA_SUCCESS )
4058 goto cleanup;
4059
4060 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman9878a162021-05-06 17:58:36 +02004061 status = psa_key_derivation_start_hmac( &hmac,
4062 hash_alg,
4063 tls12_prf->secret,
4064 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004065 if( status != PSA_SUCCESS )
4066 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004067 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004068 if( status != PSA_SUCCESS )
4069 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004070 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004071 if( status != PSA_SUCCESS )
4072 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004073 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004074 if( status != PSA_SUCCESS )
4075 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004076 status = psa_mac_sign_finish( &hmac,
4077 tls12_prf->output_block, hash_length,
4078 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004079 if( status != PSA_SUCCESS )
4080 goto cleanup;
4081
Janos Follath7742fee2019-06-17 12:58:10 +01004082
4083cleanup:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004084 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004085 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4086 status = cleanup_status;
4087
4088 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004089}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004090
Janos Follath844eb0e2019-06-19 12:10:49 +01004091static psa_status_t psa_key_derivation_tls12_prf_read(
4092 psa_tls12_prf_key_derivation_t *tls12_prf,
4093 psa_algorithm_t alg,
4094 uint8_t *output,
4095 size_t output_length )
4096{
4097 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004098 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004099 psa_status_t status;
4100 uint8_t offset, length;
4101
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004102 switch( tls12_prf->state )
4103 {
4104 case PSA_TLS12_PRF_STATE_LABEL_SET:
4105 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4106 break;
4107 case PSA_TLS12_PRF_STATE_OUTPUT:
4108 break;
4109 default:
4110 return( PSA_ERROR_BAD_STATE );
4111 }
4112
Janos Follath844eb0e2019-06-19 12:10:49 +01004113 while( output_length != 0 )
4114 {
4115 /* Check if we have fully processed the current block. */
4116 if( tls12_prf->left_in_block == 0 )
4117 {
4118 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4119 alg );
4120 if( status != PSA_SUCCESS )
4121 return( status );
4122
4123 continue;
4124 }
4125
4126 if( tls12_prf->left_in_block > output_length )
4127 length = (uint8_t) output_length;
4128 else
4129 length = tls12_prf->left_in_block;
4130
4131 offset = hash_length - tls12_prf->left_in_block;
4132 memcpy( output, tls12_prf->output_block + offset, length );
4133 output += length;
4134 output_length -= length;
4135 tls12_prf->left_in_block -= length;
4136 }
4137
4138 return( PSA_SUCCESS );
4139}
John Durkop07cc04a2020-11-16 22:08:34 -08004140#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4141 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004142
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004143psa_status_t psa_key_derivation_output_bytes(
4144 psa_key_derivation_operation_t *operation,
4145 uint8_t *output,
4146 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004147{
4148 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004149 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004150
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004151 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004152 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004153 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004154 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004155 }
4156
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004157 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004158 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004159 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004160 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004161 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004162 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004163 goto exit;
4164 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004165 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004166 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004167 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004168 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004169 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4170 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004171 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004172 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004173 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004174 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004175 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004176
John Durkopd0321952020-10-29 21:37:36 -07004177#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004178 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004179 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004180 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004181 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004182 output, output_length );
4183 }
Janos Follathadbec812019-06-14 11:05:39 +01004184 else
John Durkop07cc04a2020-11-16 22:08:34 -08004185#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4186#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4187 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004188 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004189 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004190 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004191 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004192 kdf_alg, output,
4193 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004194 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004195 else
John Durkop07cc04a2020-11-16 22:08:34 -08004196#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4197 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004198 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004199 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004200 return( PSA_ERROR_BAD_STATE );
4201 }
4202
4203exit:
4204 if( status != PSA_SUCCESS )
4205 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004206 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004207 * This allows us to differentiate between exhausted operations and
4208 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4209 * operations. */
4210 psa_algorithm_t alg = operation->alg;
4211 psa_key_derivation_abort( operation );
4212 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004213 memset( output, '!', output_length );
4214 }
4215 return( status );
4216}
4217
David Brown7807bf72021-02-09 16:28:23 -07004218#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004219static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4220{
4221 if( data_size >= 8 )
4222 mbedtls_des_key_set_parity( data );
4223 if( data_size >= 16 )
4224 mbedtls_des_key_set_parity( data + 8 );
4225 if( data_size >= 24 )
4226 mbedtls_des_key_set_parity( data + 16 );
4227}
David Brown7807bf72021-02-09 16:28:23 -07004228#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004229
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004230static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004231 psa_key_slot_t *slot,
4232 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004233 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004234{
4235 uint8_t *data = NULL;
4236 size_t bytes = PSA_BITS_TO_BYTES( bits );
4237 psa_status_t status;
4238
Gilles Peskine8e338702019-07-30 20:06:31 +02004239 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004240 return( PSA_ERROR_INVALID_ARGUMENT );
4241 if( bits % 8 != 0 )
4242 return( PSA_ERROR_INVALID_ARGUMENT );
4243 data = mbedtls_calloc( 1, bytes );
4244 if( data == NULL )
4245 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4246
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004247 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004248 if( status != PSA_SUCCESS )
4249 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004250#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004251 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004252 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004253#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004254
4255 status = psa_allocate_buffer_to_slot( slot, bytes );
4256 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004257 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004258
Ronald Cronbf33c932020-11-28 18:06:53 +01004259 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004260 psa_key_attributes_t attributes = {
4261 .core = slot->attr
4262 };
4263
Ronald Cronbf33c932020-11-28 18:06:53 +01004264 status = psa_driver_wrapper_import_key( &attributes,
4265 data, bytes,
4266 slot->key.data,
4267 slot->key.bytes,
4268 &slot->key.bytes, &bits );
4269 if( bits != slot->attr.bits )
4270 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004271
4272exit:
4273 mbedtls_free( data );
4274 return( status );
4275}
4276
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004277psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004278 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004279 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004280{
4281 psa_status_t status;
4282 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004283 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004284
Ronald Cron81709fc2020-11-14 12:10:32 +01004285 *key = MBEDTLS_SVC_KEY_ID_INIT;
4286
Gilles Peskine0f84d622019-09-12 19:03:13 +02004287 /* Reject any attempt to create a zero-length key so that we don't
4288 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4289 if( psa_get_key_bits( attributes ) == 0 )
4290 return( PSA_ERROR_INVALID_ARGUMENT );
4291
Dave Rodgman021e7242021-11-16 10:32:48 +00004292 if( operation->alg == PSA_ALG_NONE )
4293 return( PSA_ERROR_BAD_STATE );
4294
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004295 if( ! operation->can_output_key )
4296 return( PSA_ERROR_NOT_PERMITTED );
4297
Ronald Cron81709fc2020-11-14 12:10:32 +01004298 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4299 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004300#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4301 if( driver != NULL )
4302 {
4303 /* Deriving a key in a secure element is not implemented yet. */
4304 status = PSA_ERROR_NOT_SUPPORTED;
4305 }
4306#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004307 if( status == PSA_SUCCESS )
4308 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004309 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004310 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004311 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004312 }
4313 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004314 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004315 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004316 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004317
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004318 return( status );
4319}
4320
Gilles Peskineeab56e42018-07-12 17:12:33 +02004321
4322
4323/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004324/* Key derivation */
4325/****************************************************************/
4326
Steven Cooreman932ffb72021-02-15 12:14:32 +01004327#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004328static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004329 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004330 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331{
John Durkop07cc04a2020-11-16 22:08:34 -08004332 int is_kdf_alg_supported;
4333
Janos Follath5fe19732019-06-20 15:09:30 +01004334 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4335 * initialisers for this union leave some bytes unspecified.) */
4336 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4337
Gilles Peskine969c5d62019-01-16 15:53:06 +01004338 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004339#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004340 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4341 is_kdf_alg_supported = 1;
4342 else
4343#endif
4344#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4345 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4346 is_kdf_alg_supported = 1;
4347 else
4348#endif
4349#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4350 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4351 is_kdf_alg_supported = 1;
4352 else
4353#endif
4354 is_kdf_alg_supported = 0;
4355
4356 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004357 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004358 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004359 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004360 if( hash_size == 0 )
4361 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004362 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4363 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004364 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004365 {
4366 return( PSA_ERROR_NOT_SUPPORTED );
4367 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004368 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004369 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004370 }
John Durkop07cc04a2020-11-16 22:08:34 -08004371
4372 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004373}
John Durkop07cc04a2020-11-16 22:08:34 -08004374#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004375
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004376psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004377 psa_algorithm_t alg )
4378{
4379 psa_status_t status;
4380
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004381 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004382 return( PSA_ERROR_BAD_STATE );
4383
Gilles Peskine6843c292019-01-18 16:44:49 +01004384 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4385 return( PSA_ERROR_INVALID_ARGUMENT );
4386 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004387 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004388#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004389 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004391#else
4392 return( PSA_ERROR_NOT_SUPPORTED );
4393#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004394 }
4395 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4396 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004397#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004398 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004399#else
4400 return( PSA_ERROR_NOT_SUPPORTED );
4401#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004402 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004403 else
4404 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004405
4406 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004407 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004408 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004409}
4410
John Durkopd0321952020-10-29 21:37:36 -07004411#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004412static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004413 psa_algorithm_t hash_alg,
4414 psa_key_derivation_step_t step,
4415 const uint8_t *data,
4416 size_t data_length )
4417{
4418 psa_status_t status;
4419 switch( step )
4420 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004421 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004422 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004423 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004424 else
4425 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004426 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4427 hash_alg,
4428 data, data_length );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004429 if( status != PSA_SUCCESS )
4430 return( status );
4431 hkdf->state = HKDF_STATE_STARTED;
4432 return( PSA_SUCCESS );
4433 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004434 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004435 /* If no salt was provided, use an empty salt. */
4436 if( hkdf->state == HKDF_STATE_INIT )
4437 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004438 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4439 hash_alg,
4440 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004441 if( status != PSA_SUCCESS )
4442 return( status );
4443 hkdf->state = HKDF_STATE_STARTED;
4444 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004445 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004446 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004447 status = psa_mac_update( &hkdf->hmac,
4448 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004449 if( status != PSA_SUCCESS )
4450 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004451 status = psa_mac_sign_finish( &hkdf->hmac,
4452 hkdf->prk,
4453 sizeof( hkdf->prk ),
4454 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004455 if( status != PSA_SUCCESS )
4456 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004457 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004458 hkdf->block_number = 0;
4459 hkdf->state = HKDF_STATE_KEYED;
4460 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004461 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004462 if( hkdf->state == HKDF_STATE_OUTPUT )
4463 return( PSA_ERROR_BAD_STATE );
4464 if( hkdf->info_set )
4465 return( PSA_ERROR_BAD_STATE );
4466 hkdf->info_length = data_length;
4467 if( data_length != 0 )
4468 {
4469 hkdf->info = mbedtls_calloc( 1, data_length );
4470 if( hkdf->info == NULL )
4471 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4472 memcpy( hkdf->info, data, data_length );
4473 }
4474 hkdf->info_set = 1;
4475 return( PSA_SUCCESS );
4476 default:
4477 return( PSA_ERROR_INVALID_ARGUMENT );
4478 }
4479}
John Durkop07cc04a2020-11-16 22:08:34 -08004480#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004481
John Durkop07cc04a2020-11-16 22:08:34 -08004482#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4483 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004484static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4485 const uint8_t *data,
4486 size_t data_length )
4487{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004488 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004489 return( PSA_ERROR_BAD_STATE );
4490
Janos Follathd6dce9f2019-07-04 09:11:38 +01004491 if( data_length != 0 )
4492 {
4493 prf->seed = mbedtls_calloc( 1, data_length );
4494 if( prf->seed == NULL )
4495 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004496
Janos Follathd6dce9f2019-07-04 09:11:38 +01004497 memcpy( prf->seed, data, data_length );
4498 prf->seed_length = data_length;
4499 }
Janos Follathf08e2652019-06-13 09:05:41 +01004500
Gilles Peskine43f958b2020-12-13 14:55:14 +01004501 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004502
4503 return( PSA_SUCCESS );
4504}
4505
Janos Follath81550542019-06-13 14:26:34 +01004506static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004507 const uint8_t *data,
4508 size_t data_length )
4509{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004510 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004511 return( PSA_ERROR_BAD_STATE );
4512
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004513 if( data_length != 0 )
4514 {
4515 prf->secret = mbedtls_calloc( 1, data_length );
4516 if( prf->secret == NULL )
4517 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4518
4519 memcpy( prf->secret, data, data_length );
4520 prf->secret_length = data_length;
4521 }
Janos Follath81550542019-06-13 14:26:34 +01004522
Gilles Peskine43f958b2020-12-13 14:55:14 +01004523 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004524
4525 return( PSA_SUCCESS );
4526}
4527
Janos Follath63028dd2019-06-13 09:15:47 +01004528static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4529 const uint8_t *data,
4530 size_t data_length )
4531{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004532 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004533 return( PSA_ERROR_BAD_STATE );
4534
Janos Follathd6dce9f2019-07-04 09:11:38 +01004535 if( data_length != 0 )
4536 {
4537 prf->label = mbedtls_calloc( 1, data_length );
4538 if( prf->label == NULL )
4539 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004540
Janos Follathd6dce9f2019-07-04 09:11:38 +01004541 memcpy( prf->label, data, data_length );
4542 prf->label_length = data_length;
4543 }
Janos Follath63028dd2019-06-13 09:15:47 +01004544
Gilles Peskine43f958b2020-12-13 14:55:14 +01004545 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004546
4547 return( PSA_SUCCESS );
4548}
4549
Janos Follathb03233e2019-06-11 15:30:30 +01004550static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004551 psa_key_derivation_step_t step,
4552 const uint8_t *data,
4553 size_t data_length )
4554{
Janos Follathb03233e2019-06-11 15:30:30 +01004555 switch( step )
4556 {
Janos Follathf08e2652019-06-13 09:05:41 +01004557 case PSA_KEY_DERIVATION_INPUT_SEED:
4558 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004559 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004560 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004561 case PSA_KEY_DERIVATION_INPUT_LABEL:
4562 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004563 default:
4564 return( PSA_ERROR_INVALID_ARGUMENT );
4565 }
4566}
John Durkop07cc04a2020-11-16 22:08:34 -08004567#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4568 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4569
4570#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4571static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4572 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004573 const uint8_t *data,
4574 size_t data_length )
4575{
4576 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004577 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004578 uint8_t *cur = pms;
4579
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004580 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004581 return( PSA_ERROR_INVALID_ARGUMENT );
4582
4583 /* Quoting RFC 4279, Section 2:
4584 *
4585 * The premaster secret is formed as follows: if the PSK is N octets
4586 * long, concatenate a uint16 with the value N, N zero octets, a second
4587 * uint16 with the value N, and the PSK itself.
4588 */
4589
Joe Subbiani2bbafda2021-06-24 13:00:03 +01004590 *cur++ = MBEDTLS_BYTE_1( data_length );
4591 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08004592 memset( cur, 0, data_length );
4593 cur += data_length;
4594 *cur++ = pms[0];
4595 *cur++ = pms[1];
4596 memcpy( cur, data, data_length );
4597 cur += data_length;
4598
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004599 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004600
4601 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4602 return( status );
4603}
Janos Follath6660f0e2019-06-17 08:44:03 +01004604
4605static psa_status_t psa_tls12_prf_psk_to_ms_input(
4606 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004607 psa_key_derivation_step_t step,
4608 const uint8_t *data,
4609 size_t data_length )
4610{
4611 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004612 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004613 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004614 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004615 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004616
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004617 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004618}
John Durkop07cc04a2020-11-16 22:08:34 -08004619#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004620
Gilles Peskineb8965192019-09-24 16:21:10 +02004621/** Check whether the given key type is acceptable for the given
4622 * input step of a key derivation.
4623 *
4624 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4625 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4626 * Both secret and non-secret inputs can alternatively have the type
4627 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4628 * that the input was passed as a buffer rather than via a key object.
4629 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004630static int psa_key_derivation_check_input_type(
4631 psa_key_derivation_step_t step,
4632 psa_key_type_t key_type )
4633{
4634 switch( step )
4635 {
4636 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004637 if( key_type == PSA_KEY_TYPE_DERIVE )
4638 return( PSA_SUCCESS );
4639 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004640 return( PSA_SUCCESS );
4641 break;
4642 case PSA_KEY_DERIVATION_INPUT_LABEL:
4643 case PSA_KEY_DERIVATION_INPUT_SALT:
4644 case PSA_KEY_DERIVATION_INPUT_INFO:
4645 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004646 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4647 return( PSA_SUCCESS );
4648 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004649 return( PSA_SUCCESS );
4650 break;
4651 }
4652 return( PSA_ERROR_INVALID_ARGUMENT );
4653}
4654
Janos Follathb80a94e2019-06-12 15:54:46 +01004655static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004657 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004658 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004659 const uint8_t *data,
4660 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004661{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004662 psa_status_t status;
4663 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4664
4665 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004666 if( status != PSA_SUCCESS )
4667 goto exit;
4668
John Durkopd0321952020-10-29 21:37:36 -07004669#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004670 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004671 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004672 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004673 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004674 step, data, data_length );
4675 }
John Durkop07cc04a2020-11-16 22:08:34 -08004676 else
4677#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4678#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4679 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004680 {
Janos Follathb03233e2019-06-11 15:30:30 +01004681 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004682 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004683 }
John Durkop07cc04a2020-11-16 22:08:34 -08004684 else
4685#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4686#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4687 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004688 {
4689 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004690 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004691 }
4692 else
John Durkop07cc04a2020-11-16 22:08:34 -08004693#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004694 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004695 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004696 (void) data;
4697 (void) data_length;
4698 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004699 return( PSA_ERROR_BAD_STATE );
4700 }
4701
Gilles Peskine224b0d62019-09-23 18:13:17 +02004702exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004703 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004704 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004705 return( status );
4706}
4707
Janos Follath51f4a0f2019-06-14 11:35:55 +01004708psa_status_t psa_key_derivation_input_bytes(
4709 psa_key_derivation_operation_t *operation,
4710 psa_key_derivation_step_t step,
4711 const uint8_t *data,
4712 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004713{
Gilles Peskineb8965192019-09-24 16:21:10 +02004714 return( psa_key_derivation_input_internal( operation, step,
4715 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004716 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004717}
4718
Janos Follath51f4a0f2019-06-14 11:35:55 +01004719psa_status_t psa_key_derivation_input_key(
4720 psa_key_derivation_operation_t *operation,
4721 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004722 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004723{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004725 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004726 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004727
Ronald Cron5c522922020-11-14 16:35:34 +01004728 status = psa_get_and_lock_transparent_key_slot_with_policy(
4729 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004730 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004731 {
4732 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004733 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004734 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004735
4736 /* Passing a key object as a SECRET input unlocks the permission
4737 * to output to a key object. */
4738 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4739 operation->can_output_key = 1;
4740
Ronald Cronf95a2b12020-10-22 15:24:49 +02004741 status = psa_key_derivation_input_internal( operation,
4742 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004743 slot->key.data,
4744 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004745
Ronald Cron5c522922020-11-14 16:35:34 +01004746 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004747
Ronald Cron5c522922020-11-14 16:35:34 +01004748 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004749}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004750
4751
4752
4753/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004754/* Key agreement */
4755/****************************************************************/
4756
John Durkop6ba40d12020-11-10 08:50:04 -08004757#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004758static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4759 size_t peer_key_length,
4760 const mbedtls_ecp_keypair *our_key,
4761 uint8_t *shared_secret,
4762 size_t shared_secret_size,
4763 size_t *shared_secret_length )
4764{
Steven Cooremand4867872020-08-05 16:31:39 +02004765 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004766 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004767 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004768 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004769 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004770 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004771
Ronald Cron90857082020-11-25 14:58:33 +01004772 status = mbedtls_psa_ecp_load_representation(
4773 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004774 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004775 peer_key,
4776 peer_key_length,
4777 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004778 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004779 goto exit;
4780
Jaeden Amero97271b32019-01-10 19:38:51 +00004781 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004782 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004783 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004784 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004785 status = mbedtls_to_psa_error(
4786 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4787 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004788 goto exit;
4789
Jaeden Amero97271b32019-01-10 19:38:51 +00004790 status = mbedtls_to_psa_error(
4791 mbedtls_ecdh_calc_secret( &ecdh,
4792 shared_secret_length,
4793 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004794 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004795 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004796 if( status != PSA_SUCCESS )
4797 goto exit;
4798 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4799 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004800
4801exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004802 if( status != PSA_SUCCESS )
4803 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004804 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004805 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004806 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004807
Jaeden Amero97271b32019-01-10 19:38:51 +00004808 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004809}
John Durkop6ba40d12020-11-10 08:50:04 -08004810#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004811
Gilles Peskine01d718c2018-09-18 12:01:02 +02004812#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4813
Gilles Peskine0216fe12019-04-11 21:23:21 +02004814static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4815 psa_key_slot_t *private_key,
4816 const uint8_t *peer_key,
4817 size_t peer_key_length,
4818 uint8_t *shared_secret,
4819 size_t shared_secret_size,
4820 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004821{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004822 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004823 {
John Durkop6ba40d12020-11-10 08:50:04 -08004824#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004825 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004826 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004827 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004828 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004829 psa_status_t status = mbedtls_psa_ecp_load_representation(
4830 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004831 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004832 private_key->key.data,
4833 private_key->key.bytes,
4834 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004835 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004836 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004837 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004838 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004839 shared_secret, shared_secret_size,
4840 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004841 mbedtls_ecp_keypair_free( ecp );
4842 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004843 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004844#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004845 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004846 (void) private_key;
4847 (void) peer_key;
4848 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004849 (void) shared_secret;
4850 (void) shared_secret_size;
4851 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004852 return( PSA_ERROR_NOT_SUPPORTED );
4853 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004854}
4855
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004856/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004857 * to potentially free embedded data structures and wipe confidential data.
4858 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004859static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004860 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004861 psa_key_slot_t *private_key,
4862 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004863 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004864{
4865 psa_status_t status;
4866 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4867 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004868 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004869
4870 /* Step 1: run the secret agreement algorithm to generate the shared
4871 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004872 status = psa_key_agreement_raw_internal( ka_alg,
4873 private_key,
4874 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004875 shared_secret,
4876 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004877 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004878 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004879 goto exit;
4880
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004881 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004882 * the shared secret. A shared secret is permitted wherever a key
4883 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004884 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004885 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004886 shared_secret,
4887 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004888exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004889 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004890 return( status );
4891}
4892
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004893psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004894 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004895 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004896 const uint8_t *peer_key,
4897 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004898{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004899 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004900 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004901 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004902
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004903 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004904 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004905 status = psa_get_and_lock_transparent_key_slot_with_policy(
4906 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004907 if( status != PSA_SUCCESS )
4908 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004909 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004910 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004911 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004912 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004913 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004914 else
4915 {
4916 /* If a private key has been added as SECRET, we allow the derived
4917 * key material to be used as a key in PSA Crypto. */
4918 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4919 operation->can_output_key = 1;
4920 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004921
Ronald Cron5c522922020-11-14 16:35:34 +01004922 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004923
Ronald Cron5c522922020-11-14 16:35:34 +01004924 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004925}
4926
Gilles Peskinebe697d82019-05-16 18:00:41 +02004927psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004928 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004929 const uint8_t *peer_key,
4930 size_t peer_key_length,
4931 uint8_t *output,
4932 size_t output_size,
4933 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004934{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004935 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004936 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004937 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004938
4939 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4940 {
4941 status = PSA_ERROR_INVALID_ARGUMENT;
4942 goto exit;
4943 }
Ronald Cron5c522922020-11-14 16:35:34 +01004944 status = psa_get_and_lock_transparent_key_slot_with_policy(
4945 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004946 if( status != PSA_SUCCESS )
4947 goto exit;
4948
4949 status = psa_key_agreement_raw_internal( alg, slot,
4950 peer_key, peer_key_length,
4951 output, output_size,
4952 output_length );
4953
4954exit:
4955 if( status != PSA_SUCCESS )
4956 {
4957 /* If an error happens and is not handled properly, the output
4958 * may be used as a key to protect sensitive data. Arrange for such
4959 * a key to be random, which is likely to result in decryption or
4960 * verification errors. This is better than filling the buffer with
4961 * some constant data such as zeros, which would result in the data
4962 * being protected with a reproducible, easily knowable key.
4963 */
4964 psa_generate_random( output, output_size );
4965 *output_length = output_size;
4966 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004967
Ronald Cron5c522922020-11-14 16:35:34 +01004968 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004969
Ronald Cron5c522922020-11-14 16:35:34 +01004970 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004971}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004972
4973
Gilles Peskine30524eb2020-11-13 17:02:26 +01004974
Gilles Peskine86a440b2018-11-12 18:39:40 +01004975/****************************************************************/
4976/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004977/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004978
Gilles Peskine30524eb2020-11-13 17:02:26 +01004979/** Initialize the PSA random generator.
4980 */
4981static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4982{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004983#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4984 memset( rng, 0, sizeof( *rng ) );
4985#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4986
Gilles Peskine30524eb2020-11-13 17:02:26 +01004987 /* Set default configuration if
4988 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4989 if( rng->entropy_init == NULL )
4990 rng->entropy_init = mbedtls_entropy_init;
4991 if( rng->entropy_free == NULL )
4992 rng->entropy_free = mbedtls_entropy_free;
4993
4994 rng->entropy_init( &rng->entropy );
4995#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4996 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4997 /* The PSA entropy injection feature depends on using NV seed as an entropy
4998 * source. Add NV seed as an entropy source for PSA entropy injection. */
4999 mbedtls_entropy_add_source( &rng->entropy,
5000 mbedtls_nv_seed_poll, NULL,
5001 MBEDTLS_ENTROPY_BLOCK_SIZE,
5002 MBEDTLS_ENTROPY_SOURCE_STRONG );
5003#endif
5004
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005005 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005006#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005007}
5008
5009/** Deinitialize the PSA random generator.
5010 */
5011static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5012{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005013#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5014 memset( rng, 0, sizeof( *rng ) );
5015#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005016 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005017 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005018#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005019}
5020
5021/** Seed the PSA random generator.
5022 */
5023static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5024{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005025#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5026 /* Do nothing: the external RNG seeds itself. */
5027 (void) rng;
5028 return( PSA_SUCCESS );
5029#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005030 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005031 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5032 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005033 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005034#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005035}
5036
Gilles Peskinee59236f2018-01-27 23:32:46 +01005037psa_status_t psa_generate_random( uint8_t *output,
5038 size_t output_size )
5039{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005040 GUARD_MODULE_INITIALIZED;
5041
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005042#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5043
5044 size_t output_length = 0;
5045 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5046 output, output_size,
5047 &output_length );
5048 if( status != PSA_SUCCESS )
5049 return( status );
5050 /* Breaking up a request into smaller chunks is currently not supported
5051 * for the extrernal RNG interface. */
5052 if( output_length != output_size )
5053 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5054 return( PSA_SUCCESS );
5055
5056#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5057
Gilles Peskine71ddab92021-01-04 21:01:07 +01005058 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005059 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005060 size_t request_size =
5061 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5062 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5063 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005064 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5065 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005066 if( ret != 0 )
5067 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005068 output_size -= request_size;
5069 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005070 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005071 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005072#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005073}
5074
Gilles Peskine8814fc42020-12-14 15:33:44 +01005075/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005076 *
5077 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5078 * `psa_generate_random(...)`. The state parameter is ignored since the
5079 * PSA API doesn't support passing an explicit state.
5080 *
5081 * In the non-external case, psa_generate_random() calls an
5082 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5083 * and semantics as mbedtls_psa_get_random(). As an optimization,
5084 * instead of doing this back-and-forth between the PSA API and the
5085 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5086 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005087 */
5088#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5089int mbedtls_psa_get_random( void *p_rng,
5090 unsigned char *output,
5091 size_t output_size )
5092{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005093 /* This function takes a pointer to the RNG state because that's what
5094 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5095 * its own state internally and doesn't let the caller access that state.
5096 * So we just ignore the state parameter, and in practice we'll pass
5097 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005098 (void) p_rng;
5099 psa_status_t status = psa_generate_random( output, output_size );
5100 if( status == PSA_SUCCESS )
5101 return( 0 );
5102 else
5103 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5104}
5105#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5106
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005107#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5108#include "mbedtls/entropy_poll.h"
5109
Gilles Peskine7228da22019-07-15 11:06:15 +02005110psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005111 size_t seed_size )
5112{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005113 if( global_data.initialized )
5114 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005115
5116 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5117 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5118 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5119 return( PSA_ERROR_INVALID_ARGUMENT );
5120
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005121 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005122}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005123#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005124
Ronald Cron3772afe2021-02-08 16:10:05 +01005125/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005126 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005127 * \param type The key type
5128 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005129 *
5130 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005131 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005132 * \retval #PSA_ERROR_INVALID_ARGUMENT
5133 * The size in bits of the key is not valid.
5134 * \retval #PSA_ERROR_NOT_SUPPORTED
5135 * The type and/or the size in bits of the key or the combination of
5136 * the two is not supported.
5137 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005138static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5139 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005140{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005142
Gilles Peskinee59236f2018-01-27 23:32:46 +01005143 if( key_type_is_raw_bytes( type ) )
5144 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005145 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005146 if( status != PSA_SUCCESS )
5147 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005148 }
5149 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005150#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005151 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5152 {
5153 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5154 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005155
Ronald Cron01b2aba2020-10-05 09:42:02 +02005156 /* Accept only byte-aligned keys, for the same reasons as
5157 * in psa_import_rsa_key(). */
5158 if( bits % 8 != 0 )
5159 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005160 }
5161 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005162#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005163
Ronald Cron5c4d3862020-12-07 11:07:24 +01005164#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005165 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5166 {
Ronald Crond81ab562021-02-16 09:01:16 +01005167 /* To avoid empty block, return successfully here. */
5168 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005169 }
5170 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005171#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005172 {
5173 return( PSA_ERROR_NOT_SUPPORTED );
5174 }
5175
5176 return( PSA_SUCCESS );
5177}
5178
Ronald Cron55ed0592020-10-05 10:30:40 +02005179psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005180 const psa_key_attributes_t *attributes,
5181 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005182{
5183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005184 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005185
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005186 if( ( attributes->domain_parameters == NULL ) &&
5187 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005188 return( PSA_ERROR_INVALID_ARGUMENT );
5189
Ronald Cron01b2aba2020-10-05 09:42:02 +02005190 if( key_type_is_raw_bytes( type ) )
5191 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005192 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005193 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005194 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005195
David Brown12ca5032021-02-11 11:02:00 -07005196#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005197 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005198 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005199#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005200 }
5201 else
5202
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005203#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5204 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005205 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005206 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005207 return( mbedtls_psa_rsa_generate_key( attributes,
5208 key_buffer,
5209 key_buffer_size,
5210 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005211 }
5212 else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005213#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5214 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005215
John Durkop9814fa22020-11-04 12:28:15 -08005216#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005217 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005218 {
Ronald Cron7023db52020-11-20 18:17:42 +01005219 return( mbedtls_psa_ecp_generate_key( attributes,
5220 key_buffer,
5221 key_buffer_size,
5222 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005223 }
5224 else
John Durkop9814fa22020-11-04 12:28:15 -08005225#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005226 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005227 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005228 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005229 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005230
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005231 return( PSA_SUCCESS );
5232}
Darryl Green0c6575a2018-11-07 16:05:30 +00005233
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005234psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005235 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005236{
5237 psa_status_t status;
5238 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005239 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005240 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005241
Ronald Cron81709fc2020-11-14 12:10:32 +01005242 *key = MBEDTLS_SVC_KEY_ID_INIT;
5243
Gilles Peskine0f84d622019-09-12 19:03:13 +02005244 /* Reject any attempt to create a zero-length key so that we don't
5245 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5246 if( psa_get_key_bits( attributes ) == 0 )
5247 return( PSA_ERROR_INVALID_ARGUMENT );
5248
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005249 /* Reject any attempt to create a public key. */
5250 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5251 return( PSA_ERROR_INVALID_ARGUMENT );
5252
Ronald Cron81709fc2020-11-14 12:10:32 +01005253 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5254 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005255 if( status != PSA_SUCCESS )
5256 goto exit;
5257
Ronald Cron977c2472020-10-13 08:32:21 +02005258 /* In the case of a transparent key or an opaque key stored in local
5259 * storage (thus not in the case of generating a key in a secure element
5260 * or cryptoprocessor with storage), we have to allocate a buffer to
5261 * hold the generated key material. */
5262 if( slot->key.data == NULL )
5263 {
5264 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5265 PSA_KEY_LOCATION_LOCAL_STORAGE )
5266 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005267 status = psa_validate_key_type_and_size_for_key_generation(
5268 attributes->core.type, attributes->core.bits );
5269 if( status != PSA_SUCCESS )
5270 goto exit;
5271
5272 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5273 attributes->core.type,
5274 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005275 }
5276 else
5277 {
5278 status = psa_driver_wrapper_get_key_buffer_size(
5279 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005280 if( status != PSA_SUCCESS )
5281 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005282 }
Ronald Cron977c2472020-10-13 08:32:21 +02005283
5284 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5285 if( status != PSA_SUCCESS )
5286 goto exit;
5287 }
5288
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005289 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005290 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005291
Ronald Cron2b56bc82020-10-05 10:02:26 +02005292 if( status != PSA_SUCCESS )
5293 psa_remove_key_data_from_memory( slot );
5294
Gilles Peskine11792082019-08-06 18:36:36 +02005295exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005296 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005297 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005298 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005299 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005300
Darryl Green0c6575a2018-11-07 16:05:30 +00005301 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005302}
5303
Gilles Peskinee59236f2018-01-27 23:32:46 +01005304/****************************************************************/
5305/* Module setup */
5306/****************************************************************/
5307
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005308#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005309psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5310 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5311 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5312{
5313 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5314 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005315 global_data.rng.entropy_init = entropy_init;
5316 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005317 return( PSA_SUCCESS );
5318}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005319#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005320
Gilles Peskinee59236f2018-01-27 23:32:46 +01005321void mbedtls_psa_crypto_free( void )
5322{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005323 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005324 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5325 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005326 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005327 }
5328 /* Wipe all remaining data, including configuration.
5329 * In particular, this sets all state indicator to the value
5330 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005331 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005332#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005333 /* Unregister all secure element drivers, so that we restart from
5334 * a pristine state. */
5335 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005336#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005337}
5338
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005339#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5340/** Recover a transaction that was interrupted by a power failure.
5341 *
5342 * This function is called during initialization, before psa_crypto_init()
5343 * returns. If this function returns a failure status, the initialization
5344 * fails.
5345 */
5346static psa_status_t psa_crypto_recover_transaction(
5347 const psa_crypto_transaction_t *transaction )
5348{
5349 switch( transaction->unknown.type )
5350 {
5351 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5352 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005353 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005354 * is implemented.
5355 * https://github.com/ARMmbed/mbed-crypto/issues/218
5356 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005357 default:
5358 /* We found an unsupported transaction in the storage.
5359 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005360 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005361 }
5362}
5363#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5364
Gilles Peskinee59236f2018-01-27 23:32:46 +01005365psa_status_t psa_crypto_init( void )
5366{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005367 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005368
Gilles Peskinec6b69072018-11-20 21:42:52 +01005369 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005370 if( global_data.initialized != 0 )
5371 return( PSA_SUCCESS );
5372
Gilles Peskine30524eb2020-11-13 17:02:26 +01005373 /* Initialize and seed the random generator. */
5374 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005375 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005376 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005377 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005378 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005379 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005380
Gilles Peskine66fb1262018-12-10 16:29:04 +01005381 status = psa_initialize_key_slots( );
5382 if( status != PSA_SUCCESS )
5383 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005384
Gilles Peskined9348f22019-10-01 15:22:29 +02005385#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5386 status = psa_init_all_se_drivers( );
5387 if( status != PSA_SUCCESS )
5388 goto exit;
5389#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5390
Gilles Peskine4b734222019-07-24 15:56:31 +02005391#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005392 status = psa_crypto_load_transaction( );
5393 if( status == PSA_SUCCESS )
5394 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005395 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5396 if( status != PSA_SUCCESS )
5397 goto exit;
5398 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005399 }
5400 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5401 {
5402 /* There's no transaction to complete. It's all good. */
5403 status = PSA_SUCCESS;
5404 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005405#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005406
Gilles Peskinec6b69072018-11-20 21:42:52 +01005407 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005408 global_data.initialized = 1;
5409
5410exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005411 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005412 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005413 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005414}
5415
5416#endif /* MBEDTLS_PSA_CRYPTO_C */