blob: 214c405b30369acf029ca69e61cf76dad4dec284 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020055#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056#define mbedtls_calloc calloc
57#define mbedtls_free free
58#endif
59
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010060#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020062#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000063#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020064#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/blowfish.h"
66#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020067#include "mbedtls/chacha20.h"
68#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/cipher.h"
70#include "mbedtls/ccm.h"
71#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020073#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010074#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010075#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/error.h"
77#include "mbedtls/gcm.h"
78#include "mbedtls/md2.h"
79#include "mbedtls/md4.h"
80#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010081#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000082#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010083#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000084#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010085#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000086#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010088#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010089#include "mbedtls/sha1.h"
90#include "mbedtls/sha256.h"
91#include "mbedtls/sha512.h"
92#include "mbedtls/xtea.h"
93
Gilles Peskine996deb12018-08-01 15:45:45 +020094#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
95
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010096/****************************************************************/
97/* Global data, support functions and library management */
98/****************************************************************/
99
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200100static int key_type_is_raw_bytes( psa_key_type_t type )
101{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200102 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200103}
104
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100105/* Values for psa_global_data_t::rng_state */
106#define RNG_NOT_INITIALIZED 0
107#define RNG_INITIALIZED 1
108#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100109
Gilles Peskine2d277862018-06-18 15:41:12 +0200110typedef struct
111{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100112 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100113 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100114 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100115} psa_global_data_t;
116
117static psa_global_data_t global_data;
118
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100119#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
120mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
121 &global_data.rng.drbg;
122#endif
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100130 /* Mbed TLS error codes can combine a high-level error code and a
131 * low-level error code. The low-level error usually reflects the
132 * root cause better, so dispatch on that preferably. */
133 int low_level_ret = - ( -ret & 0x007f );
134 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135 {
136 case 0:
137 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100138
139 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
140 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100141 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200142 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
143 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
144 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
145 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
146 case MBEDTLS_ERR_ASN1_INVALID_DATA:
147 return( PSA_ERROR_INVALID_ARGUMENT );
148 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
149 return( PSA_ERROR_INSUFFICIENT_MEMORY );
150 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
151 return( PSA_ERROR_BUFFER_TOO_SMALL );
152
Jaeden Amero93e21112019-02-20 13:57:28 +0000153#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000154 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000155#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100156 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
157 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100158
Jaeden Amero93e21112019-02-20 13:57:28 +0000159#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000160 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100162 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
163 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100164
165 case MBEDTLS_ERR_CCM_BAD_INPUT:
166 return( PSA_ERROR_INVALID_ARGUMENT );
167 case MBEDTLS_ERR_CCM_AUTH_FAILED:
168 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100169
Gilles Peskine26869f22019-05-06 15:25:00 +0200170 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
171 return( PSA_ERROR_INVALID_ARGUMENT );
172
173 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
174 return( PSA_ERROR_BAD_STATE );
175 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
176 return( PSA_ERROR_INVALID_SIGNATURE );
177
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
179 return( PSA_ERROR_NOT_SUPPORTED );
180 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
181 return( PSA_ERROR_INVALID_ARGUMENT );
182 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
183 return( PSA_ERROR_INSUFFICIENT_MEMORY );
184 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
185 return( PSA_ERROR_INVALID_PADDING );
186 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200187 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100188 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
189 return( PSA_ERROR_INVALID_SIGNATURE );
190 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200191 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100192
Gilles Peskine82e57d12020-11-13 21:31:17 +0100193#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
194 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100195 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
196 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
199 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
200 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
201 return( PSA_ERROR_NOT_SUPPORTED );
202 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
203 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100204#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100205
206 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
207 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208
Gilles Peskinee59236f2018-01-27 23:32:46 +0100209 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
210 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
211 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100213
214 case MBEDTLS_ERR_GCM_AUTH_FAILED:
215 return( PSA_ERROR_INVALID_SIGNATURE );
216 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100218
Gilles Peskine82e57d12020-11-13 21:31:17 +0100219#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
220 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100221 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
222 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100223 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
224 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
225 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
226 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
227 return( PSA_ERROR_NOT_SUPPORTED );
228 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
230#endif
231
Gilles Peskinea5905292018-02-07 20:59:33 +0100232 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
233 return( PSA_ERROR_NOT_SUPPORTED );
234 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
235 return( PSA_ERROR_INVALID_ARGUMENT );
236 case MBEDTLS_ERR_MD_ALLOC_FAILED:
237 return( PSA_ERROR_INSUFFICIENT_MEMORY );
238 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
239 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100240
Gilles Peskinef76aa772018-10-29 19:24:33 +0100241 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
242 return( PSA_ERROR_STORAGE_FAILURE );
243 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
244 return( PSA_ERROR_INVALID_ARGUMENT );
245 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
248 return( PSA_ERROR_BUFFER_TOO_SMALL );
249 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
252 return( PSA_ERROR_INVALID_ARGUMENT );
253 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
254 return( PSA_ERROR_INVALID_ARGUMENT );
255 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
256 return( PSA_ERROR_INSUFFICIENT_MEMORY );
257
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100258 case MBEDTLS_ERR_PK_ALLOC_FAILED:
259 return( PSA_ERROR_INSUFFICIENT_MEMORY );
260 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
261 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100264 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100265 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
266 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
269 return( PSA_ERROR_NOT_SUPPORTED );
270 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
271 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
272 return( PSA_ERROR_NOT_PERMITTED );
273 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
274 return( PSA_ERROR_INVALID_ARGUMENT );
275 case MBEDTLS_ERR_PK_INVALID_ALG:
276 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
277 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
278 return( PSA_ERROR_NOT_SUPPORTED );
279 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
280 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100281
Gilles Peskineff2d2002019-05-06 15:26:23 +0200282 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
283 return( PSA_ERROR_HARDWARE_FAILURE );
284 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
285 return( PSA_ERROR_NOT_SUPPORTED );
286
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_RSA_INVALID_PADDING:
290 return( PSA_ERROR_INVALID_PADDING );
291 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
292 return( PSA_ERROR_HARDWARE_FAILURE );
293 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
296 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200297 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
299 return( PSA_ERROR_INVALID_SIGNATURE );
300 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
301 return( PSA_ERROR_BUFFER_TOO_SMALL );
302 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100303 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
306 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100307
itayzafrir5c753392018-05-08 11:18:38 +0300308 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300309 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300310 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300311 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
312 return( PSA_ERROR_BUFFER_TOO_SMALL );
313 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
314 return( PSA_ERROR_NOT_SUPPORTED );
315 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
316 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
319 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100320 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100322
Janos Follatha13b9052019-11-22 12:48:59 +0000323 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
324 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300325
Gilles Peskinee59236f2018-01-27 23:32:46 +0100326 default:
David Saadab4ecc272019-02-14 13:48:10 +0200327 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100328 }
329}
330
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200331
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200332
333
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334/****************************************************************/
335/* Key management */
336/****************************************************************/
337
Gilles Peskine73167e12019-07-12 23:44:37 +0200338#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
339static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
340{
Gilles Peskine8e338702019-07-30 20:06:31 +0200341 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200342}
343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
344
John Durkop07cc04a2020-11-16 22:08:34 -0800345/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
346 * current test driver in key_management.c is using this function
347 * when accelerators are used for ECC key pair and public key.
348 * Once that dependency is resolved these guards can be removed.
349 */
John Durkop9814fa22020-11-04 12:28:15 -0800350#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800351 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
352 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
353 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100354mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 size_t bits,
356 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200357{
358 switch( curve )
359 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100360 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100362 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100363#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100364 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100365 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
367#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100368 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100370#endif
371#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100372 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#endif
375#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 528:
383 if( bits_is_sloppy )
384 return( MBEDTLS_ECP_DP_SECP521R1 );
385 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100386#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 }
388 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100389
Paul Elliott8ff510a2020-06-02 17:19:28 +0100390 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100393#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#endif
397#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
401#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100402 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100404#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 }
406 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100407
Paul Elliott8ff510a2020-06-02 17:19:28 +0100408 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 256:
415 if( bits_is_sloppy )
416 return( MBEDTLS_ECP_DP_CURVE25519 );
417 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 }
424 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100425
Paul Elliott8ff510a2020-06-02 17:19:28 +0100426 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100429#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100431 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100432#endif
433#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
437#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100438 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100440#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 }
442 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200443 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100445 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100446 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200447}
John Durkop9814fa22020-11-04 12:28:15 -0800448#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800449 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
450 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
451 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200452
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200453static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
454 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455{
456 /* Check that the bit size is acceptable for the key type */
457 switch( type )
458 {
459 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200461 case PSA_KEY_TYPE_DERIVE:
462 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_AES:
465 if( bits != 128 && bits != 192 && bits != 256 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200470 case PSA_KEY_TYPE_CAMELLIA:
471 if( bits != 128 && bits != 192 && bits != 256 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100475#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200476 case PSA_KEY_TYPE_DES:
477 if( bits != 64 && bits != 128 && bits != 192 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
479 break;
480#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100481#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200482 case PSA_KEY_TYPE_ARC4:
483 if( bits < 8 || bits > 2048 )
484 return( PSA_ERROR_INVALID_ARGUMENT );
485 break;
486#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100487#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200488 case PSA_KEY_TYPE_CHACHA20:
489 if( bits != 256 )
490 return( PSA_ERROR_INVALID_ARGUMENT );
491 break;
492#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200493 default:
494 return( PSA_ERROR_NOT_SUPPORTED );
495 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200496 if( bits % 8 != 0 )
497 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200499 return( PSA_SUCCESS );
500}
501
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 *
Steven Cooremancd640932021-03-08 12:00:27 +0100504 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
505 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 *
507 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100508 * \param[in] key_type The key type of the key to be used with the
509 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100510 *
511 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100512 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100513 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100514 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100516MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100517 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100518 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100519{
Steven Cooremancd640932021-03-08 12:00:27 +0100520 if( PSA_ALG_IS_HMAC( algorithm ) )
521 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100522 if( key_type == PSA_KEY_TYPE_HMAC )
523 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100524 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100525
526 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100527 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100528 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
529 * key. */
530 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
531 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
532 {
533 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
534 * the block length (larger than 1) for block ciphers. */
535 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
536 return( PSA_SUCCESS );
537 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100538 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100539
540 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100541}
542
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200543psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
544 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200545{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200547 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200548
Ronald Cronea0f8a62020-11-25 17:52:23 +0100549 slot->key.data = mbedtls_calloc( 1, buffer_length );
550 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200551 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200552
Ronald Cronea0f8a62020-11-25 17:52:23 +0100553 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200554 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200555}
556
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200557psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
558 const uint8_t* data,
559 size_t data_length )
560{
561 psa_status_t status = psa_allocate_buffer_to_slot( slot,
562 data_length );
563 if( status != PSA_SUCCESS )
564 return( status );
565
Ronald Cronea0f8a62020-11-25 17:52:23 +0100566 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200567 return( PSA_SUCCESS );
568}
569
Ronald Crona0fe59f2020-11-29 11:14:53 +0100570psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100571 const psa_key_attributes_t *attributes,
572 const uint8_t *data, size_t data_length,
573 uint8_t *key_buffer, size_t key_buffer_size,
574 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100575{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100576 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
577 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100578
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200579 /* zero-length keys are never supported. */
580 if( data_length == 0 )
581 return( PSA_ERROR_NOT_SUPPORTED );
582
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100583 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100584 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Steven Cooreman75b74362020-07-28 14:30:13 +0200587 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
588 if( data_length > SIZE_MAX / 8 )
589 return( PSA_ERROR_NOT_SUPPORTED );
590
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200591 /* Enforce a size limit, and in particular ensure that the bit
592 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200594 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200595
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100596 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200598 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200599
Ronald Crondd04d422020-11-28 15:14:42 +0100600 /* Copy the key material. */
601 memcpy( key_buffer, data, data_length );
602 *key_buffer_length = data_length;
603 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200604
Steven Cooreman40120f62020-10-29 11:42:22 +0100605 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100606 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200608 {
John Durkop9814fa22020-11-04 12:28:15 -0800609#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
610 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100611 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200612 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100613 return( mbedtls_psa_ecp_import_key( attributes,
614 data, data_length,
615 key_buffer, key_buffer_size,
616 key_buffer_length,
617 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100618 }
John Durkop9814fa22020-11-04 12:28:15 -0800619#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
620 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700621#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
622 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100623 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200624 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100625 return( mbedtls_psa_rsa_import_key( attributes,
626 data, data_length,
627 key_buffer, key_buffer_size,
628 key_buffer_length,
629 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200630 }
John Durkop9814fa22020-11-04 12:28:15 -0800631#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
632 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100633 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100634
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100636}
637
Gilles Peskinef603c712019-01-19 13:40:11 +0100638/** Calculate the intersection of two algorithm usage policies.
639 *
640 * Return 0 (which allows no operation) on incompatibility.
641 */
642static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100643 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100644 psa_algorithm_t alg1,
645 psa_algorithm_t alg2 )
646{
Gilles Peskine549ea862019-05-22 11:45:59 +0200647 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100648 if( alg1 == alg2 )
649 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
652 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
653 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
654 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100655 {
Steven Cooreman03488022021-02-18 12:07:20 +0100656 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
657 return( alg2 );
658 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
659 return( alg1 );
660 }
661 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100662 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100663 * restrictive tag length. */
664 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
665 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
666 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
667 {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100673 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
674 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100675 {
Steven Cooremancd640932021-03-08 12:00:27 +0100676 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
677 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100678 }
679 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100680 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100681 ( alg1_len <= alg2_len ) )
682 {
683 return( alg2 );
684 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100685 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100686 ( alg2_len <= alg1_len ) )
687 {
688 return( alg1 );
689 }
690 }
691 /* If the policies are from the same MAC family, check whether one
692 * of them is a minimum-MAC-length policy. Calculate the most
693 * restrictive tag length. */
694 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
695 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
696 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
697 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100698 /* Validate the combination of key type and algorithm. Since the base
699 * algorithm of alg1 and alg2 are the same, we only need this once. */
700 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100702
Steven Cooreman31a876d2021-03-03 20:47:40 +0100703 /* Get the (exact or at-least) output lengths for both sides of the
704 * requested intersection. None of the currently supported algorithms
705 * have an output length dependent on the actual key size, so setting it
706 * to a bogus value of 0 is currently OK.
707 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100708 * Note that for at-least-this-length wildcard algorithms, the output
709 * length is set to the shortest allowed length, which allows us to
710 * calculate the most restrictive tag length for the intersection. */
711 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
712 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100713 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100714
Steven Cooremana1d83222021-02-25 10:20:29 +0100715 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100716 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
717 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100718 {
Steven Cooremancd640932021-03-08 12:00:27 +0100719 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100720 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100721
722 /* If only one is an at-least-this-length policy, the intersection would
723 * be the other (fixed-length) policy as long as said fixed length is
724 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100725 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100726 {
Steven Cooremancd640932021-03-08 12:00:27 +0100727 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100729 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100730 {
Steven Cooremancd640932021-03-08 12:00:27 +0100731 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100732 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100733
Steven Cooremancd640932021-03-08 12:00:27 +0100734 /* If none of them are wildcards, check whether they define the same tag
735 * length. This is still possible here when one is default-length and
736 * the other specific-length. Ensure to always return the
737 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100738 if( alg1_len == alg2_len )
739 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100740 }
741 /* If the policies are incompatible, allow nothing. */
742 return( 0 );
743}
744
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100745static int psa_key_algorithm_permits( psa_key_type_t key_type,
746 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200747 psa_algorithm_t requested_alg )
748{
Gilles Peskine549ea862019-05-22 11:45:59 +0200749 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200750 if( requested_alg == policy_alg )
751 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100752 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
753 * and requested_alg is the same hash-and-sign family with any hash,
754 * then requested_alg is compliant with policy_alg. */
755 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
756 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200757 {
Steven Cooreman03488022021-02-18 12:07:20 +0100758 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
759 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
760 }
761 /* If policy_alg is a wildcard AEAD algorithm of the same base as
762 * the requested algorithm, check the requested tag length to be
763 * equal-length or longer than the wildcard-specified length. */
764 if( PSA_ALG_IS_AEAD( policy_alg ) &&
765 PSA_ALG_IS_AEAD( requested_alg ) &&
766 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
767 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100768 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100769 {
770 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
771 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
772 }
Steven Cooremancd640932021-03-08 12:00:27 +0100773 /* If policy_alg is a MAC algorithm of the same base as the requested
774 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100775 if( PSA_ALG_IS_MAC( policy_alg ) &&
776 PSA_ALG_IS_MAC( requested_alg ) &&
777 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100778 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100779 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 /* Validate the combination of key type and algorithm. Since the policy
781 * and requested algorithms are the same, we only need this once. */
782 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784
Steven Cooreman31a876d2021-03-03 20:47:40 +0100785 /* Get both the requested output length for the algorithm which is to be
786 * verified, and the default output length for the base algorithm.
787 * Note that none of the currently supported algorithms have an output
788 * length dependent on actual key size, so setting it to a bogus value
789 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100790 size_t requested_output_length = PSA_MAC_LENGTH(
791 key_type, 0, requested_alg );
792 size_t default_output_length = PSA_MAC_LENGTH(
793 key_type, 0,
794 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100795
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796 /* If the policy is default-length, only allow an algorithm with
797 * a declared exact-length matching the default. */
798 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100799 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100800
801 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100802 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100803 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
804 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
805 {
806 return( 1 );
807 }
808
Steven Cooremancd640932021-03-08 12:00:27 +0100809 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
810 * check for the requested MAC length to be equal to or longer than the
811 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100812 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
813 {
814 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100815 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100816 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200817 }
Steven Cooremance48e852020-10-05 16:02:45 +0200818 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200819 * a key derivation with that key agreement should also be allowed. This
820 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200821 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
822 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
823 {
824 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
825 policy_alg );
826 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100827 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200828 return( 0 );
829}
830
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831/** Test whether a policy permits an algorithm.
832 *
833 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being validated, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100840 * \retval PSA_SUCCESS When \p alg is a specific algorithm
841 * allowed by the \p policy.
842 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
843 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
844 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100845 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100846static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100847 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100848 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100849{
Steven Cooremand788fab2021-02-25 11:29:17 +0100850 /* '0' is not a valid algorithm */
851 if( alg == 0 )
852 return( PSA_ERROR_INVALID_ARGUMENT );
853
Steven Cooreman7e39f052021-02-23 14:18:32 +0100854 /* A requested algorithm cannot be a wildcard. */
855 if( PSA_ALG_IS_WILDCARD( alg ) )
856 return( PSA_ERROR_INVALID_ARGUMENT );
857
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100858 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
859 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100860 return( PSA_SUCCESS );
861 else
862 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100863}
864
Gilles Peskinef603c712019-01-19 13:40:11 +0100865/** Restrict a key policy based on a constraint.
866 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100867 * \note This function requires providing the key type for which the policy is
868 * being restricted, since some algorithm policy definitions (e.g. MAC)
869 * have different properties depending on what kind of cipher it is
870 * combined with.
871 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100872 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 * \param[in,out] policy The policy to restrict.
874 * \param[in] constraint The policy constraint to apply.
875 *
876 * \retval #PSA_SUCCESS
877 * \c *policy contains the intersection of the original value of
878 * \c *policy and \c *constraint.
879 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100880 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100881 * \c *policy is unchanged.
882 */
883static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100884 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100885 psa_key_policy_t *policy,
886 const psa_key_policy_t *constraint )
887{
888 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100889 psa_key_policy_algorithm_intersection( key_type, policy->alg,
890 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200891 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100892 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
893 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100894 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
895 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200896 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
897 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100898 policy->usage &= constraint->usage;
899 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200900 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100901 return( PSA_SUCCESS );
902}
903
Ronald Cron5c522922020-11-14 16:35:34 +0100904/** Get the description of a key given its identifier and policy constraints
905 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200906 *
Ronald Cron5c522922020-11-14 16:35:34 +0100907 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100908 * nonzero, the key must allow operations with this algorithm. If \p alg is
909 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100910 *
Ronald Cron5c522922020-11-14 16:35:34 +0100911 * In case of a persistent key, the function loads the description of the key
912 * into a key slot if not already done.
913 *
914 * On success, the returned key slot is locked. It is the responsibility of
915 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200916 */
Ronald Cron5c522922020-11-14 16:35:34 +0100917static psa_status_t psa_get_and_lock_key_slot_with_policy(
918 mbedtls_svc_key_id_t key,
919 psa_key_slot_t **p_slot,
920 psa_key_usage_t usage,
921 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100922{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200923 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
924 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Ronald Cron5c522922020-11-14 16:35:34 +0100926 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100927 if( status != PSA_SUCCESS )
928 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100930
931 /* Enforce that usage policy for the key slot contains all the flags
932 * required by the usage parameter. There is one exception: public
933 * keys can always be exported, so we treat public key objects as
934 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200935 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100936 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
Gilles Peskine8e338702019-07-30 20:06:31 +0200938 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100939 {
940 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200941 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100942 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100943
944 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945 if( alg != 0 )
946 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100947 status = psa_key_policy_permits( &slot->attr.policy,
948 slot->attr.type,
949 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100950 if( status != PSA_SUCCESS )
951 goto error;
952 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100953
Darryl Green06fd18d2018-07-16 11:21:11 +0100954 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200955
956error:
957 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100958 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
960 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100961}
Darryl Green940d72c2018-07-13 13:18:51 +0100962
Ronald Cron5c522922020-11-14 16:35:34 +0100963/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 *
965 * A transparent key is a key for which the key material is directly
966 * available, as opposed to a key in a secure element.
967 *
Ronald Cron5c522922020-11-14 16:35:34 +0100968 * This is a temporary function to use instead of
969 * psa_get_and_lock_key_slot_with_policy() until secure element support is
970 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 *
Ronald Cron5c522922020-11-14 16:35:34 +0100972 * On success, the returned key slot is locked. It is the responsibility of the
973 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200974 */
975#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
980 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981{
Ronald Cron5c522922020-11-14 16:35:34 +0100982 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
983 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200984 if( status != PSA_SUCCESS )
985 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200986
Gilles Peskineadad8132019-07-25 11:31:23 +0200987 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200988 {
Ronald Cron5c522922020-11-14 16:35:34 +0100989 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200990 *p_slot = NULL;
991 return( PSA_ERROR_NOT_SUPPORTED );
992 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200993
Gilles Peskine28f8f302019-07-24 13:30:31 +0200994 return( PSA_SUCCESS );
995}
996#else /* MBEDTLS_PSA_CRYPTO_SE_C */
997/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100998#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
999 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001000#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1001
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001002psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001003{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001004 /* Data pointer will always be either a valid pointer or NULL in an
1005 * initialized slot, so we can just free it. */
1006 if( slot->key.data != NULL )
1007 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1008
1009 mbedtls_free( slot->key.data );
1010 slot->key.data = NULL;
1011 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001012
1013 return( PSA_SUCCESS );
1014}
1015
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001016/** Completely wipe a slot in memory, including its policy.
1017 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001018psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001019{
1020 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001021
Ronald Cron5c522922020-11-14 16:35:34 +01001022 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001023 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001024 status = PSA_ERROR_CORRUPTION_DETECTED;
1025 }
1026
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001027 /* Multipart operations may still be using the key. This is safe
1028 * because all multipart operation objects are independent from
1029 * the key slot: if they need to access the key after the setup
1030 * phase, they have a copy of the key. Note that this means that
1031 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001032 /* At this point, key material and other type-specific content has
1033 * been wiped. Clear remaining metadata. We can call memset and not
1034 * zeroize because the metadata is not particularly sensitive. */
1035 memset( slot, 0, sizeof( *slot ) );
1036 return( status );
1037}
1038
Ronald Croncf56a0a2020-08-04 09:51:30 +02001039psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001041 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001042 psa_status_t status; /* status of the last operation */
1043 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001044#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1045 psa_se_drv_table_entry_t *driver;
1046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001047
Ronald Croncf56a0a2020-08-04 09:51:30 +02001048 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001049 return( PSA_SUCCESS );
1050
Ronald Cronf2911112020-10-29 17:51:10 +01001051 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001052 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001053 * key, this will load the key description from persistent memory if not
1054 * done yet. We cannot avoid this loading as without it we don't know if
1055 * the key is operated by an SE or not and this information is needed by
1056 * the current implementation.
1057 */
Ronald Cron5c522922020-11-14 16:35:34 +01001058 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001059 if( status != PSA_SUCCESS )
1060 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001061
Ronald Cronf2911112020-10-29 17:51:10 +01001062 /*
1063 * If the key slot containing the key description is under access by the
1064 * library (apart from the present access), the key cannot be destroyed
1065 * yet. For the time being, just return in error. Eventually (to be
1066 * implemented), the key should be destroyed when all accesses have
1067 * stopped.
1068 */
Ronald Cron5c522922020-11-14 16:35:34 +01001069 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001070 {
Ronald Cron5c522922020-11-14 16:35:34 +01001071 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001072 return( PSA_ERROR_GENERIC_ERROR );
1073 }
1074
Gilles Peskine354f7672019-07-12 23:46:38 +02001075#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001077 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001078 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001079 /* For a key in a secure element, we need to do three things:
1080 * remove the key file in internal storage, destroy the
1081 * key inside the secure element, and update the driver's
1082 * persistent data. Start a transaction that will encompass these
1083 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001085 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001086 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001087 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 status = psa_crypto_save_transaction( );
1089 if( status != PSA_SUCCESS )
1090 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001091 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 /* We should still try to destroy the key in the secure
1093 * element and the key metadata in storage. This is especially
1094 * important if the error is that the storage is full.
1095 * But how to do it exactly without risking an inconsistent
1096 * state after a reset?
1097 * https://github.com/ARMmbed/mbed-crypto/issues/215
1098 */
1099 overall_status = status;
1100 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001101 }
1102
Ronald Cronea0f8a62020-11-25 17:52:23 +01001103 status = psa_destroy_se_key( driver,
1104 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001105 if( overall_status == PSA_SUCCESS )
1106 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001107 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001108#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1109
Darryl Greend49a4992018-06-18 17:27:26 +01001110#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001111 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001112 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001113 status = psa_destroy_persistent_key( slot->attr.id );
1114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
1116
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001117 /* TODO: other slots may have a copy of the same key. We should
1118 * invalidate them.
1119 * https://github.com/ARMmbed/mbed-crypto/issues/214
1120 */
Darryl Greend49a4992018-06-18 17:27:26 +01001121 }
1122#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001123
Gilles Peskinefc762652019-07-22 19:30:34 +02001124#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1125 if( driver != NULL )
1126 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001127 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128 if( overall_status == PSA_SUCCESS )
1129 overall_status = status;
1130 status = psa_crypto_stop_transaction( );
1131 if( overall_status == PSA_SUCCESS )
1132 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001133 }
1134#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1135
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1137exit:
1138#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001139 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1141 if( overall_status == PSA_SUCCESS )
1142 overall_status = status;
1143 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001144}
1145
John Durkop07cc04a2020-11-16 22:08:34 -08001146#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001147 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001148static psa_status_t psa_get_rsa_public_exponent(
1149 const mbedtls_rsa_context *rsa,
1150 psa_key_attributes_t *attributes )
1151{
1152 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001154 uint8_t *buffer = NULL;
1155 size_t buflen;
1156 mbedtls_mpi_init( &mpi );
1157
1158 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1159 if( ret != 0 )
1160 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001161 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1162 {
1163 /* It's the default value, which is reported as an empty string,
1164 * so there's nothing to do. */
1165 goto exit;
1166 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001167
1168 buflen = mbedtls_mpi_size( &mpi );
1169 buffer = mbedtls_calloc( 1, buflen );
1170 if( buffer == NULL )
1171 {
1172 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1173 goto exit;
1174 }
1175 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1176 if( ret != 0 )
1177 goto exit;
1178 attributes->domain_parameters = buffer;
1179 attributes->domain_parameters_size = buflen;
1180
1181exit:
1182 mbedtls_mpi_free( &mpi );
1183 if( ret != 0 )
1184 mbedtls_free( buffer );
1185 return( mbedtls_to_psa_error( ret ) );
1186}
John Durkop07cc04a2020-11-16 22:08:34 -08001187#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001188 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001189
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001190/** Retrieve all the publicly-accessible attributes of a key.
1191 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001192psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001193 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001194{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001196 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001197 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001198
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001199 psa_reset_key_attributes( attributes );
1200
Ronald Cron5c522922020-11-14 16:35:34 +01001201 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001202 if( status != PSA_SUCCESS )
1203 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001204
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001205 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1207 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1208
1209#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1210 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001211 psa_set_key_slot_number( attributes,
1212 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001213#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001214
Gilles Peskine8e338702019-07-30 20:06:31 +02001215 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001216 {
John Durkop07cc04a2020-11-16 22:08:34 -08001217#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001218 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001219 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001220 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001221#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001222 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001223 * is not yet implemented.
1224 * https://github.com/ARMmbed/mbed-crypto/issues/216
1225 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001226 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001227 break;
1228#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001229 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001230 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001231
Ronald Cron90857082020-11-25 14:58:33 +01001232 status = mbedtls_psa_rsa_load_representation(
1233 slot->attr.type,
1234 slot->key.data,
1235 slot->key.bytes,
1236 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001237 if( status != PSA_SUCCESS )
1238 break;
1239
Steven Cooremana2371e52020-07-28 14:30:39 +02001240 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001241 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001242 mbedtls_rsa_free( rsa );
1243 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001244 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001245 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001246#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001247 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248 default:
1249 /* Nothing else to do. */
1250 break;
1251 }
1252
1253 if( status != PSA_SUCCESS )
1254 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Ronald Cron5c522922020-11-14 16:35:34 +01001256 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001257
Ronald Cron5c522922020-11-14 16:35:34 +01001258 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001259}
1260
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1262psa_status_t psa_get_key_slot_number(
1263 const psa_key_attributes_t *attributes,
1264 psa_key_slot_number_t *slot_number )
1265{
1266 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1267 {
1268 *slot_number = attributes->slot_number;
1269 return( PSA_SUCCESS );
1270 }
1271 else
1272 return( PSA_ERROR_INVALID_ARGUMENT );
1273}
1274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1275
Ronald Crond18b5f82020-11-25 16:46:05 +01001276static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1277 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001278 uint8_t *data,
1279 size_t data_size,
1280 size_t *data_length )
1281{
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001283 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001284 memcpy( data, key_buffer, key_buffer_size );
1285 memset( data + key_buffer_size, 0,
1286 data_size - key_buffer_size );
1287 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001288 return( PSA_SUCCESS );
1289}
1290
Ronald Cron7285cda2020-11-26 14:46:37 +01001291psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 const psa_key_attributes_t *attributes,
1293 const uint8_t *key_buffer, size_t key_buffer_size,
1294 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Ronald Crond18b5f82020-11-25 16:46:05 +01001296 psa_key_type_t type = attributes->core.type;
1297
Ronald Crond18b5f82020-11-25 16:46:05 +01001298 if( key_type_is_raw_bytes( type ) ||
1299 PSA_KEY_TYPE_IS_RSA( type ) ||
1300 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001301 {
1302 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001303 key_buffer, key_buffer_size,
1304 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001305 }
1306 else
1307 {
1308 /* This shouldn't happen in the reference implementation, but
1309 it is valid for a special-purpose implementation to omit
1310 support for exporting certain key types. */
1311 return( PSA_ERROR_NOT_SUPPORTED );
1312 }
1313}
1314
1315psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1316 uint8_t *data,
1317 size_t data_size,
1318 size_t *data_length )
1319{
1320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1321 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1322 psa_key_slot_t *slot;
1323
Ronald Crone907e552021-01-18 13:22:38 +01001324 /* Reject a zero-length output buffer now, since this can never be a
1325 * valid key representation. This way we know that data must be a valid
1326 * pointer and we can do things like memset(data, ..., data_size). */
1327 if( data_size == 0 )
1328 return( PSA_ERROR_BUFFER_TOO_SMALL );
1329
Ronald Cron9486f9d2020-11-26 13:36:23 +01001330 /* Set the key to empty now, so that even when there are errors, we always
1331 * set data_length to a value between 0 and data_size. On error, setting
1332 * the key to empty is a good choice because an empty key representation is
1333 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001334 *data_length = 0;
1335
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 /* Export requires the EXPORT flag. There is an exception for public keys,
1337 * which don't require any flag, but
1338 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1339 */
1340 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1341 PSA_KEY_USAGE_EXPORT, 0 );
1342 if( status != PSA_SUCCESS )
1343 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 psa_key_attributes_t attributes = {
1346 .core = slot->attr
1347 };
Ronald Cron67227982020-11-26 15:16:05 +01001348 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 slot->key.data, slot->key.bytes,
1350 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352 unlock_status = psa_unlock_key_slot( slot );
1353
1354 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer,
1360 size_t key_buffer_size,
1361 uint8_t *data,
1362 size_t data_size,
1363 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001368 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001369 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001370 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001371 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001373 key_buffer, key_buffer_size,
1374 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001375 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001376
Ronald Crond18b5f82020-11-25 16:46:05 +01001377 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001378 {
John Durkop0e005192020-10-31 22:06:54 -07001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001381 return( mbedtls_psa_rsa_export_public_key( attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001387#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001388 /* We don't know how to convert a private RSA key to public. */
1389 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001392 }
1393 else
Moran Pekera998bc62018-04-16 18:16:20 +03001394 {
John Durkop6ba40d12020-11-10 08:50:04 -08001395#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1396 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001397 return( mbedtls_psa_ecp_export_public_key( attributes,
1398 key_buffer,
1399 key_buffer_size,
1400 data,
1401 data_size,
1402 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001403#else
1404 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001405 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001406#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1407 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001408 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001409 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001410 else
1411 {
1412 /* This shouldn't happen in the reference implementation, but
1413 it is valid for a special-purpose implementation to omit
1414 support for exporting certain key types. */
1415 return( PSA_ERROR_NOT_SUPPORTED );
1416 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001417}
Ronald Crond18b5f82020-11-25 16:46:05 +01001418
Ronald Croncf56a0a2020-08-04 09:51:30 +02001419psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001420 uint8_t *data,
1421 size_t data_size,
1422 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001423{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001426 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001427
Ronald Crone907e552021-01-18 13:22:38 +01001428 /* Reject a zero-length output buffer now, since this can never be a
1429 * valid key representation. This way we know that data must be a valid
1430 * pointer and we can do things like memset(data, ..., data_size). */
1431 if( data_size == 0 )
1432 return( PSA_ERROR_BUFFER_TOO_SMALL );
1433
Darryl Greendd8fb772018-11-07 16:00:44 +00001434 /* Set the key to empty now, so that even when there are errors, we always
1435 * set data_length to a value between 0 and data_size. On error, setting
1436 * the key to empty is a good choice because an empty key representation is
1437 * unlikely to be accepted anywhere. */
1438 *data_length = 0;
1439
1440 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001441 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001442 if( status != PSA_SUCCESS )
1443 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001444
Ronald Cron9486f9d2020-11-26 13:36:23 +01001445 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1446 {
1447 status = PSA_ERROR_INVALID_ARGUMENT;
1448 goto exit;
1449 }
1450
Ronald Crond18b5f82020-11-25 16:46:05 +01001451 psa_key_attributes_t attributes = {
1452 .core = slot->attr
1453 };
Ronald Cron67227982020-11-26 15:16:05 +01001454 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001455 &attributes, slot->key.data, slot->key.bytes,
1456 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001457
1458exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001459 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001460
Ronald Cron5c522922020-11-14 16:35:34 +01001461 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001462}
1463
Gilles Peskine91e8c332019-08-02 19:19:39 +02001464#if defined(static_assert)
1465static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1466 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001467static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001468 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001469static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001470 "One or more key attribute flag is listed as both internal-only and external-only" );
1471#endif
1472
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001473/** Validate that a key policy is internally well-formed.
1474 *
1475 * This function only rejects invalid policies. It does not validate the
1476 * consistency of the policy with respect to other attributes of the key
1477 * such as the key type.
1478 */
1479static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001480{
1481 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001482 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001483 PSA_KEY_USAGE_ENCRYPT |
1484 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001485 PSA_KEY_USAGE_SIGN_MESSAGE |
1486 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001487 PSA_KEY_USAGE_SIGN_HASH |
1488 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001489 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001490 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1491 return( PSA_ERROR_INVALID_ARGUMENT );
1492
Gilles Peskine4747d192019-04-17 15:05:45 +02001493 return( PSA_SUCCESS );
1494}
1495
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001496/** Validate the internal consistency of key attributes.
1497 *
1498 * This function only rejects invalid attribute values. If does not
1499 * validate the consistency of the attributes with any key data that may
1500 * be involved in the creation of the key.
1501 *
1502 * Call this function early in the key creation process.
1503 *
1504 * \param[in] attributes Key attributes for the new key.
1505 * \param[out] p_drv On any return, the driver for the key, if any.
1506 * NULL for a transparent key.
1507 *
1508 */
1509static psa_status_t psa_validate_key_attributes(
1510 const psa_key_attributes_t *attributes,
1511 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001512{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001513 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001514 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001515 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516
Ronald Cron54b90082020-10-29 15:26:43 +01001517 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001518 if( status != PSA_SUCCESS )
1519 return( status );
1520
Ronald Crond2ed4812020-07-17 16:11:30 +02001521 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001522 if( status != PSA_SUCCESS )
1523 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001524
Ronald Cron65f38a32020-10-23 17:11:13 +02001525 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1526 {
1527 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1528 return( PSA_ERROR_INVALID_ARGUMENT );
1529 }
1530 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001531 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001532 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1533 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001534 }
1535
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001537 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001538 return( status );
1539
1540 /* Refuse to create overly large keys.
1541 * Note that this doesn't trigger on import if the attributes don't
1542 * explicitly specify a size (so psa_get_key_bits returns 0), so
1543 * psa_import_key() needs its own checks. */
1544 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1545 return( PSA_ERROR_NOT_SUPPORTED );
1546
Gilles Peskine91e8c332019-08-02 19:19:39 +02001547 /* Reject invalid flags. These should not be reachable through the API. */
1548 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1549 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1550 return( PSA_ERROR_INVALID_ARGUMENT );
1551
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001552 return( PSA_SUCCESS );
1553}
1554
Gilles Peskine4747d192019-04-17 15:05:45 +02001555/** Prepare a key slot to receive key material.
1556 *
1557 * This function allocates a key slot and sets its metadata.
1558 *
1559 * If this function fails, call psa_fail_key_creation().
1560 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001561 * This function is intended to be used as follows:
1562 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001563 * it with the specified attributes, and in case of a volatile key assign it
1564 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001565 * -# Populate the slot with the key material.
1566 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1567 * In case of failure at any step, stop the sequence and call
1568 * psa_fail_key_creation().
1569 *
Ronald Cron5c522922020-11-14 16:35:34 +01001570 * On success, the key slot is locked. It is the responsibility of the caller
1571 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001572 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001573 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001574 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001575 * \param[out] p_slot On success, a pointer to the prepared slot.
1576 * \param[out] p_drv On any return, the driver for the key, if any.
1577 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001578 *
1579 * \retval #PSA_SUCCESS
1580 * The key slot is ready to receive key material.
1581 * \return If this function fails, the key slot is an invalid state.
1582 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 */
1584static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001587 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001588 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001589{
1590 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001591 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001592 psa_key_slot_t *slot;
1593
Gilles Peskinedf179142019-07-15 22:02:14 +02001594 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001595 *p_drv = NULL;
1596
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001597 status = psa_validate_key_attributes( attributes, p_drv );
1598 if( status != PSA_SUCCESS )
1599 return( status );
1600
Ronald Cronc4d1b512020-07-31 11:26:37 +02001601 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001602 if( status != PSA_SUCCESS )
1603 return( status );
1604 slot = *p_slot;
1605
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001606 /* We're storing the declared bit-size of the key. It's up to each
1607 * creation mechanism to verify that this information is correct.
1608 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001609 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001610 * is optional (import, copy). In case of a volatile key, assign it the
1611 * volatile key identifier associated to the slot returned to contain its
1612 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001613
1614 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001615 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1616 {
1617#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1618 slot->attr.id = volatile_key_id;
1619#else
1620 slot->attr.id.key_id = volatile_key_id;
1621#endif
1622 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001623
Gilles Peskine91e8c332019-08-02 19:19:39 +02001624 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001625 * external-only flags, query `attributes`. Thanks to the check
1626 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001627 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001628 * may have set. */
1629 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001630
Gilles Peskinecbaff462019-07-12 23:46:04 +02001631#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001632 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001633 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001634 * create the key file in internal storage, create the
1635 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001636 * persistent data. This is done by starting a transaction that will
1637 * encompass these three actions.
1638 * For registering a volatile key, we just need to find an appropriate
1639 * slot number inside the SE. Since the key is designated volatile, creating
1640 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001641 /* The first thing to do is to find a slot number for the new key.
1642 * We save the slot number in persistent storage as part of the
1643 * transaction data. It will be needed to recover if the power
1644 * fails during the key creation process, to clean up on the secure
1645 * element side after restarting. Obtaining a slot number from the
1646 * secure element driver updates its persistent state, but we do not yet
1647 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001648 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001649 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001650 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001652 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001653 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001654 if( status != PSA_SUCCESS )
1655 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001656
1657 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001658 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001659 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1660 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001662 psa_crypto_transaction.key.id = slot->attr.id;
1663 status = psa_crypto_save_transaction( );
1664 if( status != PSA_SUCCESS )
1665 {
1666 (void) psa_crypto_stop_transaction( );
1667 return( status );
1668 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001669 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001670
1671 status = psa_copy_key_material_into_slot(
1672 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001673 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001674
1675 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1676 {
1677 /* Key registration only makes sense with a secure element. */
1678 return( PSA_ERROR_INVALID_ARGUMENT );
1679 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001680#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1681
Ronald Cronc4d1b512020-07-31 11:26:37 +02001682 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001683}
Gilles Peskine4747d192019-04-17 15:05:45 +02001684
1685/** Finalize the creation of a key once its key material has been set.
1686 *
1687 * This entails writing the key to persistent storage.
1688 *
1689 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001690 * See the documentation of psa_start_key_creation() for the intended use
1691 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 *
Ronald Cron5c522922020-11-14 16:35:34 +01001693 * If the finalization succeeds, the function unlocks the key slot (it was
1694 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1695 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001696 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001697 * \param[in,out] slot Pointer to the slot with key material.
1698 * \param[in] driver The secure element driver for the key,
1699 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001700 * \param[out] key On success, identifier of the key. Note that the
1701 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 *
1703 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001704 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001705 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1706 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1707 * \retval #PSA_ERROR_ALREADY_EXISTS
1708 * \retval #PSA_ERROR_DATA_INVALID
1709 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001710 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001711 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001712 * \return If this function fails, the key slot is an invalid state.
1713 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001714 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001715static psa_status_t psa_finish_key_creation(
1716 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001717 psa_se_drv_table_entry_t *driver,
1718 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001719{
1720 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001721 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001722 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001723
1724#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001725 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1728 if( driver != NULL )
1729 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001730 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 psa_key_slot_number_t slot_number =
1732 psa_key_slot_get_slot_number( slot ) ;
1733
Gilles Peskineb46bef22019-07-30 21:32:04 +02001734#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001735 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001736 sizeof( data.slot_number ),
1737 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001738#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001740 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001741 (uint8_t*) &data,
1742 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001743 }
1744 else
1745#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1746 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001747 /* Key material is saved in export representation in the slot, so
1748 * just pass the slot buffer for storage. */
1749 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001750 slot->key.data,
1751 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001752 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001753 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001754#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1755
Gilles Peskinecbaff462019-07-12 23:46:04 +02001756#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001757 /* Finish the transaction for a key creation. This does not
1758 * happen when registering an existing key. Detect this case
1759 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001760 * creation of a persistent key in a secure element requires a transaction,
1761 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001762 if( driver != NULL &&
1763 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001764 {
1765 status = psa_save_se_persistent_data( driver );
1766 if( status != PSA_SUCCESS )
1767 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001768 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001769 return( status );
1770 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001771 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001772 }
1773#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1774
Ronald Cron50972942020-11-14 11:28:25 +01001775 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001776 {
1777 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001778 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001779 if( status != PSA_SUCCESS )
1780 *key = MBEDTLS_SVC_KEY_ID_INIT;
1781 }
Ronald Cron50972942020-11-14 11:28:25 +01001782
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 return( status );
1784}
1785
1786/** Abort the creation of a key.
1787 *
1788 * You may call this function after calling psa_start_key_creation(),
1789 * or after psa_finish_key_creation() fails. In other circumstances, this
1790 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001791 * See the documentation of psa_start_key_creation() for the intended use
1792 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001794 * \param[in,out] slot Pointer to the slot with key material.
1795 * \param[in] driver The secure element driver for the key,
1796 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001797 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001798static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001799 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001800{
Gilles Peskine011e4282019-06-26 18:34:38 +02001801 (void) driver;
1802
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 if( slot == NULL )
1804 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001805
1806#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001807 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001808 * element, and the failure happened later (when saving metadata
1809 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001810 * element.
1811 * https://github.com/ARMmbed/mbed-crypto/issues/217
1812 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001813
Gilles Peskined7729582019-08-05 15:55:54 +02001814 /* Abort the ongoing transaction if any (there may not be one if
1815 * the creation process failed before starting one, or if the
1816 * key creation is a registration of a key in a secure element).
1817 * Earlier functions must already have done what it takes to undo any
1818 * partial creation. All that's left is to update the transaction data
1819 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001820 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001821#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1822
Gilles Peskine4747d192019-04-17 15:05:45 +02001823 psa_wipe_key_slot( slot );
1824}
1825
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001826/** Validate optional attributes during key creation.
1827 *
1828 * Some key attributes are optional during key creation. If they are
1829 * specified in the attributes structure, check that they are consistent
1830 * with the data in the slot.
1831 *
1832 * This function should be called near the end of key creation, after
1833 * the slot in memory is fully populated but before saving persistent data.
1834 */
1835static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001836 const psa_key_slot_t *slot,
1837 const psa_key_attributes_t *attributes )
1838{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001839 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001841 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842 return( PSA_ERROR_INVALID_ARGUMENT );
1843 }
1844
1845 if( attributes->domain_parameters_size != 0 )
1846 {
John Durkop0e005192020-10-31 22:06:54 -07001847#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1848 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001849 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001851 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001852 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001854
Ronald Cron90857082020-11-25 14:58:33 +01001855 psa_status_t status = mbedtls_psa_rsa_load_representation(
1856 slot->attr.type,
1857 slot->key.data,
1858 slot->key.bytes,
1859 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001860 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001861 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001862
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 mbedtls_mpi_init( &actual );
1864 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001865 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001866 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001867 mbedtls_rsa_free( rsa );
1868 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 if( ret != 0 )
1870 goto rsa_exit;
1871 ret = mbedtls_mpi_read_binary( &required,
1872 attributes->domain_parameters,
1873 attributes->domain_parameters_size );
1874 if( ret != 0 )
1875 goto rsa_exit;
1876 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1877 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1878 rsa_exit:
1879 mbedtls_mpi_free( &actual );
1880 mbedtls_mpi_free( &required );
1881 if( ret != 0)
1882 return( mbedtls_to_psa_error( ret ) );
1883 }
1884 else
John Durkop9814fa22020-11-04 12:28:15 -08001885#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1886 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887 {
1888 return( PSA_ERROR_INVALID_ARGUMENT );
1889 }
1890 }
1891
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001892 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001894 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 return( PSA_ERROR_INVALID_ARGUMENT );
1896 }
1897
1898 return( PSA_SUCCESS );
1899}
1900
Gilles Peskine4747d192019-04-17 15:05:45 +02001901psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001902 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001903 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001904 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001905{
1906 psa_status_t status;
1907 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001908 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001909 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910
Ronald Cron81709fc2020-11-14 12:10:32 +01001911 *key = MBEDTLS_SVC_KEY_ID_INIT;
1912
Gilles Peskine0f84d622019-09-12 19:03:13 +02001913 /* Reject zero-length symmetric keys (including raw data key objects).
1914 * This also rejects any key which might be encoded as an empty string,
1915 * which is never valid. */
1916 if( data_length == 0 )
1917 return( PSA_ERROR_INVALID_ARGUMENT );
1918
Gilles Peskinedf179142019-07-15 22:02:14 +02001919 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001920 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 if( status != PSA_SUCCESS )
1922 goto exit;
1923
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001924 /* In the case of a transparent key or an opaque key stored in local
1925 * storage (thus not in the case of generating a key in a secure element
1926 * or cryptoprocessor with storage), we have to allocate a buffer to
1927 * hold the generated key material. */
1928 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001929 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001931 if( status != PSA_SUCCESS )
1932 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001933 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001934
1935 bits = slot->attr.bits;
1936 status = psa_driver_wrapper_import_key( attributes,
1937 data, data_length,
1938 slot->key.data,
1939 slot->key.bytes,
1940 &slot->key.bytes, &bits );
1941 if( status != PSA_SUCCESS )
1942 goto exit;
1943
1944 if( slot->attr.bits == 0 )
1945 slot->attr.bits = (psa_key_bits_t) bits;
1946 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001947 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001948 status = PSA_ERROR_INVALID_ARGUMENT;
1949 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001950 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001951
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001952 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001953 if( status != PSA_SUCCESS )
1954 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955
Ronald Cron81709fc2020-11-14 12:10:32 +01001956 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001957exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001959 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001960
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 return( status );
1962}
1963
Gilles Peskined7729582019-08-05 15:55:54 +02001964#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1965psa_status_t mbedtls_psa_register_se_key(
1966 const psa_key_attributes_t *attributes )
1967{
1968 psa_status_t status;
1969 psa_key_slot_t *slot = NULL;
1970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001972
1973 /* Leaving attributes unspecified is not currently supported.
1974 * It could make sense to query the key type and size from the
1975 * secure element, but not all secure elements support this
1976 * and the driver HAL doesn't currently support it. */
1977 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1978 return( PSA_ERROR_NOT_SUPPORTED );
1979 if( psa_get_key_bits( attributes ) == 0 )
1980 return( PSA_ERROR_NOT_SUPPORTED );
1981
1982 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001983 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001984 if( status != PSA_SUCCESS )
1985 goto exit;
1986
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001988
1989exit:
1990 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001991 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskined7729582019-08-05 15:55:54 +02001993 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001995 return( status );
1996}
1997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1998
Gilles Peskinef603c712019-01-19 13:40:11 +01001999static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002000 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002001{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002002 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002003 source->key.data,
2004 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002005 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002006 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002007
Steven Cooreman398aee52020-10-13 14:35:45 +02002008 target->attr.type = source->attr.type;
2009 target->attr.bits = source->attr.bits;
2010
2011 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002012}
2013
Ronald Croncf56a0a2020-08-04 09:51:30 +02002014psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002015 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002016 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002017{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002019 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002020 psa_key_slot_t *source_slot = NULL;
2021 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002022 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002023 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002024
Ronald Cron81709fc2020-11-14 12:10:32 +01002025 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2026
Ronald Cron5c522922020-11-14 16:35:34 +01002027 status = psa_get_and_lock_transparent_key_slot_with_policy(
2028 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002029 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 goto exit;
2031
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002032 status = psa_validate_optional_attributes( source_slot,
2033 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002034 if( status != PSA_SUCCESS )
2035 goto exit;
2036
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002037 status = psa_restrict_key_policy( source_slot->attr.type,
2038 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002039 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040 if( status != PSA_SUCCESS )
2041 goto exit;
2042
Ronald Cron81709fc2020-11-14 12:10:32 +01002043 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2044 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002045 if( status != PSA_SUCCESS )
2046 goto exit;
2047
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002048#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2049 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002050 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002051 /* Copying to a secure element is not implemented yet. */
2052 status = PSA_ERROR_NOT_SUPPORTED;
2053 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002054 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002055#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002056
Ronald Cron6cc66312021-04-02 12:27:47 +02002057 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2058 {
2059 /*
2060 * Copying through an opaque driver is not implemented yet, consider
2061 * a lifetime with an external location as an invalid parameter for
2062 * now.
2063 */
2064 status = PSA_ERROR_INVALID_ARGUMENT;
2065 goto exit;
2066 }
2067
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002069 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002070 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002071
Ronald Cron81709fc2020-11-14 12:10:32 +01002072 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002073exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002075 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002076
Ronald Cron5c522922020-11-14 16:35:34 +01002077 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002078
Ronald Cron5c522922020-11-14 16:35:34 +01002079 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002080}
2081
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002082
2083
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002084/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002085/* Message digests */
2086/****************************************************************/
2087
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002088psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2089{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002090 /* Aborting a non-active operation is allowed */
2091 if( operation->id == 0 )
2092 return( PSA_SUCCESS );
2093
2094 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2095 operation->id = 0;
2096
2097 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098}
2099
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002100psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002101 psa_algorithm_t alg )
2102{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002103 /* A context must be freshly initialized before it can be set up. */
2104 if( operation->id != 0 )
2105 return( PSA_ERROR_BAD_STATE );
2106
2107 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002108 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002109
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002110 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2111 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002112 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2113
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002114 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115}
2116
2117psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2118 const uint8_t *input,
2119 size_t input_length )
2120{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002121 if( operation->id == 0 )
2122 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002123
Steven Cooremanc8288352021-03-04 14:02:19 +01002124 /* Don't require hash implementations to behave correctly on a
2125 * zero-length input, which may have an invalid pointer. */
2126 if( input_length == 0 )
2127 return( PSA_SUCCESS );
2128
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2130 input, input_length );
2131 if( status != PSA_SUCCESS )
2132 psa_hash_abort( operation );
2133
2134 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135}
2136
2137psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2138 uint8_t *hash,
2139 size_t hash_size,
2140 size_t *hash_length )
2141{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002142 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002143 if( operation->id == 0 )
2144 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002145
Steven Cooreman1e582352021-02-18 17:24:37 +01002146 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002148 psa_hash_abort( operation );
2149 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002150}
2151
Gilles Peskine2d277862018-06-18 15:41:12 +02002152psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2153 const uint8_t *hash,
2154 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155{
2156 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2157 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158 psa_status_t status = psa_hash_finish(
2159 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002160 actual_hash, sizeof( actual_hash ),
2161 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002162 if( status != PSA_SUCCESS )
2163 return( status );
2164 if( actual_hash_length != hash_length )
2165 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002166 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167 return( PSA_ERROR_INVALID_SIGNATURE );
2168 return( PSA_SUCCESS );
2169}
2170
Gilles Peskine0a749c82019-11-28 19:33:58 +01002171psa_status_t psa_hash_compute( psa_algorithm_t alg,
2172 const uint8_t *input, size_t input_length,
2173 uint8_t *hash, size_t hash_size,
2174 size_t *hash_length )
2175{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002176 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002177 if( !PSA_ALG_IS_HASH( alg ) )
2178 return( PSA_ERROR_INVALID_ARGUMENT );
2179
Steven Cooreman1e582352021-02-18 17:24:37 +01002180 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2181 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002182}
2183
2184psa_status_t psa_hash_compare( psa_algorithm_t alg,
2185 const uint8_t *input, size_t input_length,
2186 const uint8_t *hash, size_t hash_length )
2187{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002188 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2189 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002190
2191 if( !PSA_ALG_IS_HASH( alg ) )
2192 return( PSA_ERROR_INVALID_ARGUMENT );
2193
Steven Cooreman1e582352021-02-18 17:24:37 +01002194 psa_status_t status = psa_driver_wrapper_hash_compute(
2195 alg, input, input_length,
2196 actual_hash, sizeof(actual_hash),
2197 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002198 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002199 return( status );
2200 if( actual_hash_length != hash_length )
2201 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002202 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002203 return( PSA_ERROR_INVALID_SIGNATURE );
2204 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002205}
2206
Gilles Peskineeb35d782019-01-22 17:56:16 +01002207psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2208 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002209{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002210 if( source_operation->id == 0 ||
2211 target_operation->id != 0 )
2212 {
2213 return( PSA_ERROR_BAD_STATE );
2214 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002215
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002216 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2217 target_operation );
2218 if( status != PSA_SUCCESS )
2219 psa_hash_abort( target_operation );
2220
2221 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002222}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223
2224
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002226/* MAC */
2227/****************************************************************/
2228
Steven Cooremane6804192021-03-19 18:28:56 +01002229psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002230{
Steven Cooremane6804192021-03-19 18:28:56 +01002231 /* Aborting a non-active operation is allowed */
2232 if( operation->id == 0 )
2233 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002234
Steven Cooremane6804192021-03-19 18:28:56 +01002235 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002236 operation->mac_size = 0;
2237 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002238 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002239
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002240 return( status );
2241}
2242
Steven Cooremane6804192021-03-19 18:28:56 +01002243static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002244 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002245 psa_algorithm_t alg,
2246 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002247{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002249 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002250 psa_key_slot_t *slot;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002251
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002252 /* A context must be freshly initialized before it can be set up. */
Steven Cooremane6804192021-03-19 18:28:56 +01002253 if( operation->id != 0 )
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002254 return( PSA_ERROR_BAD_STATE );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002255
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002256 if( ! PSA_ALG_IS_MAC( alg ) )
2257 return( PSA_ERROR_INVALID_ARGUMENT );
2258
Steven Cooremane6804192021-03-19 18:28:56 +01002259 status = psa_get_and_lock_key_slot_with_policy(
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002260 key,
2261 &slot,
2262 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2263 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002264 if( status != PSA_SUCCESS )
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002265 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002266
Steven Cooremane6804192021-03-19 18:28:56 +01002267 psa_key_attributes_t attributes = {
2268 .core = slot->attr
2269 };
2270
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002271 /* Validate the combination of key type and algorithm */
Steven Cooremane6804192021-03-19 18:28:56 +01002272 status = psa_mac_key_can_do( alg, psa_get_key_type( &attributes ) );
Steven Cooreman15472f82021-03-02 16:16:22 +01002273 if( status != PSA_SUCCESS )
2274 goto exit;
2275
Steven Cooreman72f736a2021-05-07 14:14:37 +02002276 operation->is_sign = is_sign;
2277
Steven Cooremand1a68f12021-05-10 11:13:41 +02002278 /* Get the output length for the algorithm and key combination */
Steven Cooreman72f736a2021-05-07 14:14:37 +02002279 operation->mac_size = PSA_MAC_LENGTH(
Steven Cooremand1a68f12021-05-10 11:13:41 +02002280 psa_get_key_type( &attributes ),
2281 psa_get_key_bits( &attributes ),
2282 alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002283
Steven Cooreman72f736a2021-05-07 14:14:37 +02002284 if( operation->mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002285 {
2286 /* A very short MAC is too short for security since it can be
2287 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2288 * so we make this our minimum, even though 32 bits is still
2289 * too small for security. */
2290 status = PSA_ERROR_NOT_SUPPORTED;
2291 goto exit;
2292 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002293
Steven Cooreman72f736a2021-05-07 14:14:37 +02002294 if( operation->mac_size > PSA_MAC_LENGTH( psa_get_key_type( &attributes ),
Steven Cooremand1a68f12021-05-10 11:13:41 +02002295 psa_get_key_bits( &attributes ),
Steven Cooreman72f736a2021-05-07 14:14:37 +02002296 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002297 {
2298 /* It's impossible to "truncate" to a larger length than the full length
2299 * of the algorithm. */
2300 status = PSA_ERROR_INVALID_ARGUMENT;
2301 goto exit;
2302 }
2303
Steven Cooremane6804192021-03-19 18:28:56 +01002304 /* Dispatch the MAC setup call with validated input */
2305 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002306 {
Steven Cooremane6804192021-03-19 18:28:56 +01002307 status = psa_driver_wrapper_mac_sign_setup( operation,
2308 &attributes,
2309 slot->key.data,
2310 slot->key.bytes,
2311 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002312 }
2313 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002314 {
Steven Cooremane6804192021-03-19 18:28:56 +01002315 status = psa_driver_wrapper_mac_verify_setup( operation,
2316 &attributes,
2317 slot->key.data,
2318 slot->key.bytes,
2319 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002320 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002321
Gilles Peskinefbfac682018-07-08 20:51:54 +02002322exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002323 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002324 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002325
Ronald Cron5c522922020-11-14 16:35:34 +01002326 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002327
Ronald Cron5c522922020-11-14 16:35:34 +01002328 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002329}
2330
Gilles Peskine89167cb2018-07-08 20:12:23 +02002331psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002332 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002333 psa_algorithm_t alg )
2334{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002335 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002336}
2337
2338psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002339 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002340 psa_algorithm_t alg )
2341{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002342 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002343}
2344
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002345psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002346 const uint8_t *input,
2347 size_t input_length )
2348{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002349 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002350 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002351
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002352 /* Don't require hash implementations to behave correctly on a
2353 * zero-length input, which may have an invalid pointer. */
2354 if( input_length == 0 )
2355 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002356
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002357 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2358 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002359 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002360 psa_mac_abort( operation );
2361
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002362 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002363}
2364
Steven Cooremana5b860a2021-03-19 19:04:39 +01002365psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002366 uint8_t *mac,
2367 size_t mac_size,
2368 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002369{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002370 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2371 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002372
Steven Cooreman72f736a2021-05-07 14:14:37 +02002373 /* Set the output length and content to a safe default, such that in
2374 * case the caller misses an error check, the output would be an
2375 * unachievable MAC. */
2376 *mac_length = mac_size;
2377
Steven Cooremana5b860a2021-03-19 19:04:39 +01002378 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002379 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002380
Steven Cooreman72f736a2021-05-07 14:14:37 +02002381 if( ! operation->is_sign )
2382 return( PSA_ERROR_BAD_STATE );
2383
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002384 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2385 * once all the error checks are done. */
2386 if( operation->mac_size == 0 )
2387 return( PSA_ERROR_BAD_STATE );
2388
2389 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002390 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002391
Steven Cooremana5b860a2021-03-19 19:04:39 +01002392 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002393 mac, operation->mac_size,
2394 mac_length );
2395
2396 if( status == PSA_SUCCESS )
2397 {
2398 /* Set the excess room in the output buffer to an invalid value, to
2399 * avoid potentially leaking a longer MAC. */
2400 if( mac_size > operation->mac_size )
2401 memset( &mac[operation->mac_size],
2402 '!',
2403 mac_size - operation->mac_size );
2404 }
2405 else
2406 {
2407 /* Set the output length and content to a safe default, such that in
2408 * case the caller misses an error check, the output would be an
2409 * unachievable MAC. */
2410 *mac_length = mac_size;
2411 memset( mac, '!', mac_size );
2412 }
mohammad16036df908f2018-04-02 08:34:15 -07002413
Steven Cooremana5b860a2021-03-19 19:04:39 +01002414 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002415
Steven Cooremana5b860a2021-03-19 19:04:39 +01002416 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002417}
2418
Steven Cooremana5b860a2021-03-19 19:04:39 +01002419psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002420 const uint8_t *mac,
2421 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002422{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2424 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002425
Steven Cooremana5b860a2021-03-19 19:04:39 +01002426 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002427 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002428
Steven Cooreman72f736a2021-05-07 14:14:37 +02002429 if( operation->is_sign )
2430 return( PSA_ERROR_BAD_STATE );
2431
2432 if( operation->mac_size != mac_length )
2433 {
2434 status = PSA_ERROR_INVALID_SIGNATURE;
2435 goto cleanup;
2436 }
2437
Steven Cooremana5b860a2021-03-19 19:04:39 +01002438 status = psa_driver_wrapper_mac_verify_finish( operation,
2439 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002440
2441cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002442 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002443
Steven Cooremana5b860a2021-03-19 19:04:39 +01002444 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002445}
2446
2447
Gilles Peskine20035e32018-02-03 22:44:14 +01002448
Gilles Peskine20035e32018-02-03 22:44:14 +01002449/****************************************************************/
2450/* Asymmetric cryptography */
2451/****************************************************************/
2452
gabor-mezei-armf0486182021-05-12 11:03:09 +02002453static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002454 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002455{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002456 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002457 {
2458 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2459 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002460
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002461 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2462 {
2463 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2464 return( PSA_ERROR_INVALID_ARGUMENT );
2465 }
2466 }
2467 else
2468 {
2469 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2470 return( PSA_ERROR_INVALID_ARGUMENT );
2471 }
2472
2473 return( PSA_SUCCESS );
2474}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002475
2476static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002477 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002478 psa_algorithm_t alg,
2479 const uint8_t * input,
2480 size_t input_length,
2481 uint8_t * signature,
2482 size_t signature_size,
2483 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002484{
2485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2486 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2487 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002488
2489 *signature_length = 0;
2490
gabor-mezei-armf0486182021-05-12 11:03:09 +02002491 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002492 if( status != PSA_SUCCESS )
2493 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002494
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002495 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002496 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002497 * buffer can in principle be empty since it doesn't actually have
2498 * to be a hash.) */
2499 if( signature_size == 0 )
2500 return( PSA_ERROR_BUFFER_TOO_SMALL );
2501
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002502 status = psa_get_and_lock_key_slot_with_policy(
2503 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002504 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2505 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002506 alg );
2507
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002508 if( status != PSA_SUCCESS )
2509 goto exit;
2510
2511 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2512 {
2513 status = PSA_ERROR_INVALID_ARGUMENT;
2514 goto exit;
2515 }
2516
2517 psa_key_attributes_t attributes = {
2518 .core = slot->attr
2519 };
2520
gabor-mezei-armf0486182021-05-12 11:03:09 +02002521 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002522 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002523 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002524 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002525 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002526 signature, signature_size, signature_length );
2527 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002528 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002529 {
2530
2531 status = psa_driver_wrapper_sign_hash(
2532 &attributes, slot->key.data, slot->key.bytes,
2533 alg, input, input_length,
2534 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002535 }
2536
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002537
2538exit:
2539 /* Fill the unused part of the output buffer (the whole buffer on error,
2540 * the trailing part on success) with something that isn't a valid signature
2541 * (barring an attack on the signature and deliberately-crafted input),
2542 * in case the caller doesn't check the return status properly. */
2543 if( status == PSA_SUCCESS )
2544 memset( signature + *signature_length, '!',
2545 signature_size - *signature_length );
2546 else
2547 memset( signature, '!', signature_size );
2548 /* If signature_size is 0 then we have nothing to do. We must not call
2549 * memset because signature may be NULL in this case. */
2550
2551 unlock_status = psa_unlock_key_slot( slot );
2552
2553 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2554}
2555
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002556static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002557 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002558 psa_algorithm_t alg,
2559 const uint8_t * input,
2560 size_t input_length,
2561 const uint8_t * signature,
2562 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002563{
2564 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2565 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2566 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002567
gabor-mezei-armf0486182021-05-12 11:03:09 +02002568 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002569 if( status != PSA_SUCCESS )
2570 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002571
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002572 status = psa_get_and_lock_key_slot_with_policy(
2573 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002574 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2575 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002576 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002577
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002578 if( status != PSA_SUCCESS )
2579 return( status );
2580
2581 psa_key_attributes_t attributes = {
2582 .core = slot->attr
2583 };
2584
gabor-mezei-armf0486182021-05-12 11:03:09 +02002585 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002586 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002587 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002588 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002589 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002590 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002591 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002592 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002593 {
2594 status = psa_driver_wrapper_verify_hash(
2595 &attributes, slot->key.data, slot->key.bytes,
2596 alg, input, input_length,
2597 signature, signature_length );
2598 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002599
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002600 unlock_status = psa_unlock_key_slot( slot );
2601
2602 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002603
2604}
2605
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002606psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002607 const psa_key_attributes_t *attributes,
2608 const uint8_t *key_buffer,
2609 size_t key_buffer_size,
2610 psa_algorithm_t alg,
2611 const uint8_t *input,
2612 size_t input_length,
2613 uint8_t *signature,
2614 size_t signature_size,
2615 size_t *signature_length )
2616{
2617 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002618
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002619 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2620 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002621 size_t hash_length;
2622 uint8_t hash[PSA_HASH_MAX_SIZE];
2623
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002624 status = psa_driver_wrapper_hash_compute(
2625 PSA_ALG_SIGN_GET_HASH( alg ),
2626 input, input_length,
2627 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002628
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002629 if( status != PSA_SUCCESS )
2630 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002631
2632 return psa_driver_wrapper_sign_hash(
2633 attributes, key_buffer, key_buffer_size,
2634 alg, hash, hash_length,
2635 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002636 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002637
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002638 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002639}
2640
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002641psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2642 psa_algorithm_t alg,
2643 const uint8_t * input,
2644 size_t input_length,
2645 uint8_t * signature,
2646 size_t signature_size,
2647 size_t * signature_length )
2648{
2649 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002650 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002651 signature, signature_size, signature_length );
2652}
2653
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002654psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002655 const psa_key_attributes_t *attributes,
2656 const uint8_t *key_buffer,
2657 size_t key_buffer_size,
2658 psa_algorithm_t alg,
2659 const uint8_t *input,
2660 size_t input_length,
2661 const uint8_t *signature,
2662 size_t signature_length )
2663{
2664 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002665
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002666 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2667 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002668 size_t hash_length;
2669 uint8_t hash[PSA_HASH_MAX_SIZE];
2670
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002671 status = psa_driver_wrapper_hash_compute(
2672 PSA_ALG_SIGN_GET_HASH( alg ),
2673 input, input_length,
2674 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002675
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002676 if( status != PSA_SUCCESS )
2677 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002678
2679 return psa_driver_wrapper_verify_hash(
2680 attributes, key_buffer, key_buffer_size,
2681 alg, hash, hash_length,
2682 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002683 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002684
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002685 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002686}
2687
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002688psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2689 psa_algorithm_t alg,
2690 const uint8_t * input,
2691 size_t input_length,
2692 const uint8_t * signature,
2693 size_t signature_length )
2694{
2695 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002696 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002697 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002698}
2699
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002700psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002701 const psa_key_attributes_t *attributes,
2702 const uint8_t *key_buffer, size_t key_buffer_size,
2703 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2704 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002705{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002706 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002707 {
Ronald Cron4501c982021-03-19 20:09:32 +01002708 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2709 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002710 {
Ronald Cron4501c982021-03-19 20:09:32 +01002711#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2712 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2713 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002714 attributes,
2715 key_buffer, key_buffer_size,
2716 alg, hash, hash_length,
2717 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002718#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2719 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002720 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002721 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002722 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002723 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002724 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002725 }
2726 else
Ronald Cron4501c982021-03-19 20:09:32 +01002727 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2728 {
2729 if( PSA_ALG_IS_ECDSA( alg ) )
2730 {
2731#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2732 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2733 return( mbedtls_psa_ecdsa_sign_hash(
2734 attributes,
2735 key_buffer, key_buffer_size,
2736 alg, hash, hash_length,
2737 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002738#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2739 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002740 }
2741 else
2742 {
2743 return( PSA_ERROR_INVALID_ARGUMENT );
2744 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002745 }
Ronald Cron4501c982021-03-19 20:09:32 +01002746
2747 (void)key_buffer;
2748 (void)key_buffer_size;
2749 (void)hash;
2750 (void)hash_length;
2751 (void)signature;
2752 (void)signature_size;
2753 (void)signature_length;
2754
2755 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002756}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002757
2758psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2759 psa_algorithm_t alg,
2760 const uint8_t *hash,
2761 size_t hash_length,
2762 uint8_t *signature,
2763 size_t signature_size,
2764 size_t *signature_length )
2765{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002766 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002767 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002768 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002769}
2770
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002771psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002772 const psa_key_attributes_t *attributes,
2773 const uint8_t *key_buffer, size_t key_buffer_size,
2774 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2775 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002776{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002777 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002778 {
Ronald Cron4501c982021-03-19 20:09:32 +01002779 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2780 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002781 {
Ronald Cron4501c982021-03-19 20:09:32 +01002782#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2783 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2784 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002785 attributes,
2786 key_buffer, key_buffer_size,
2787 alg, hash, hash_length,
2788 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002789#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2790 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002791 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002792 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002793 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002794 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002795 }
itayzafrir5c753392018-05-08 11:18:38 +03002796 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002797 else
Ronald Cron4501c982021-03-19 20:09:32 +01002798 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002799 {
Ronald Cron4501c982021-03-19 20:09:32 +01002800 if( PSA_ALG_IS_ECDSA( alg ) )
2801 {
2802#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2803 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2804 return( mbedtls_psa_ecdsa_verify_hash(
2805 attributes,
2806 key_buffer, key_buffer_size,
2807 alg, hash, hash_length,
2808 signature, signature_length ) );
2809#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2810 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2811 }
2812 else
2813 {
2814 return( PSA_ERROR_INVALID_ARGUMENT );
2815 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002816 }
Ronald Cron4501c982021-03-19 20:09:32 +01002817
2818 (void)key_buffer;
2819 (void)key_buffer_size;
2820 (void)hash;
2821 (void)hash_length;
2822 (void)signature;
2823 (void)signature_length;
2824
2825 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002826}
2827
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002828psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2829 psa_algorithm_t alg,
2830 const uint8_t *hash,
2831 size_t hash_length,
2832 const uint8_t *signature,
2833 size_t signature_length )
2834{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002835 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002836 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002837 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002838}
2839
John Durkop0e005192020-10-31 22:06:54 -07002840#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02002841static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2842 mbedtls_rsa_context *rsa )
2843{
2844 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2845 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2846 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2847 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2848}
John Durkop0e005192020-10-31 22:06:54 -07002849#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002850
Ronald Croncf56a0a2020-08-04 09:51:30 +02002851psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002852 psa_algorithm_t alg,
2853 const uint8_t *input,
2854 size_t input_length,
2855 const uint8_t *salt,
2856 size_t salt_length,
2857 uint8_t *output,
2858 size_t output_size,
2859 size_t *output_length )
2860{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002861 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002862 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002863 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002864
Darryl Green5cc689a2018-07-24 15:34:10 +01002865 (void) input;
2866 (void) input_length;
2867 (void) salt;
2868 (void) output;
2869 (void) output_size;
2870
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002871 *output_length = 0;
2872
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002873 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2874 return( PSA_ERROR_INVALID_ARGUMENT );
2875
Ronald Cron5c522922020-11-14 16:35:34 +01002876 status = psa_get_and_lock_transparent_key_slot_with_policy(
2877 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002878 if( status != PSA_SUCCESS )
2879 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002880 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2881 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002882 {
2883 status = PSA_ERROR_INVALID_ARGUMENT;
2884 goto exit;
2885 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002886
John Durkop6ba40d12020-11-10 08:50:04 -08002887#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2888 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002889 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002890 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002891 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002892 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2893 slot->key.data,
2894 slot->key.bytes,
2895 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002896 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02002897 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02002898
2899 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002900 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002901 status = PSA_ERROR_BUFFER_TOO_SMALL;
2902 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002903 }
John Durkop0e005192020-10-31 22:06:54 -07002904#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002905 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
2906 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002907 status = mbedtls_to_psa_error(
2908 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002909 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002910 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002911 input_length,
2912 input,
2913 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002914 }
2915 else
John Durkop0e005192020-10-31 22:06:54 -07002916#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2917#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002918 if( PSA_ALG_IS_RSA_OAEP( alg ) )
2919 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002920 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02002921 status = mbedtls_to_psa_error(
2922 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002923 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002924 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002925 salt, salt_length,
2926 input_length,
2927 input,
2928 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002929 }
2930 else
John Durkop0e005192020-10-31 22:06:54 -07002931#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002932 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002933 status = PSA_ERROR_INVALID_ARGUMENT;
2934 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002935 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02002936rsa_exit:
2937 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02002938 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002939
Steven Cooremana2371e52020-07-28 14:30:39 +02002940 mbedtls_rsa_free( rsa );
2941 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002942 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002943 else
John Durkop9814fa22020-11-04 12:28:15 -08002944#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08002945 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002946 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002947 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002948 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002949
2950exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002951 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002952
Ronald Cron5c522922020-11-14 16:35:34 +01002953 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002954}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002955
Ronald Croncf56a0a2020-08-04 09:51:30 +02002956psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002957 psa_algorithm_t alg,
2958 const uint8_t *input,
2959 size_t input_length,
2960 const uint8_t *salt,
2961 size_t salt_length,
2962 uint8_t *output,
2963 size_t output_size,
2964 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002965{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002966 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002967 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002968 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002969
Darryl Green5cc689a2018-07-24 15:34:10 +01002970 (void) input;
2971 (void) input_length;
2972 (void) salt;
2973 (void) output;
2974 (void) output_size;
2975
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002976 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002977
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002978 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2979 return( PSA_ERROR_INVALID_ARGUMENT );
2980
Ronald Cron5c522922020-11-14 16:35:34 +01002981 status = psa_get_and_lock_transparent_key_slot_with_policy(
2982 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002983 if( status != PSA_SUCCESS )
2984 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002985 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002986 {
2987 status = PSA_ERROR_INVALID_ARGUMENT;
2988 goto exit;
2989 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002990
John Durkop6ba40d12020-11-10 08:50:04 -08002991#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2992 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002993 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002994 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002995 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002996 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2997 slot->key.data,
2998 slot->key.bytes,
2999 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003000 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003001 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003002
Steven Cooremana2371e52020-07-28 14:30:39 +02003003 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003004 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003005 status = PSA_ERROR_INVALID_ARGUMENT;
3006 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003007 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003008
John Durkop0e005192020-10-31 22:06:54 -07003009#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003010 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003011 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003012 status = mbedtls_to_psa_error(
3013 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003014 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003015 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003016 output_length,
3017 input,
3018 output,
3019 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003020 }
3021 else
John Durkop0e005192020-10-31 22:06:54 -07003022#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3023#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003024 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003025 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003026 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003027 status = mbedtls_to_psa_error(
3028 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003029 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003030 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003031 salt, salt_length,
3032 output_length,
3033 input,
3034 output,
3035 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003036 }
3037 else
John Durkop0e005192020-10-31 22:06:54 -07003038#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003039 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003040 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003042
Steven Cooreman4fed4552020-08-03 14:46:03 +02003043rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003044 mbedtls_rsa_free( rsa );
3045 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003046 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003047 else
John Durkop6ba40d12020-11-10 08:50:04 -08003048#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3049 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003050 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003051 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003052 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003053
3054exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003055 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003056
Ronald Cron5c522922020-11-14 16:35:34 +01003057 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003058}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003059
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003060
3061
mohammad1603503973b2018-03-12 15:59:30 +02003062/****************************************************************/
3063/* Symmetric cryptography */
3064/****************************************************************/
3065
Ronald Cronab99ac22020-10-01 16:38:28 +02003066static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3067 mbedtls_svc_key_id_t key,
3068 psa_algorithm_t alg,
3069 mbedtls_operation_t cipher_operation )
3070{
3071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3072 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3073 psa_key_slot_t *slot;
3074 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3075 PSA_KEY_USAGE_ENCRYPT :
3076 PSA_KEY_USAGE_DECRYPT );
3077
3078 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003079 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003080 return( PSA_ERROR_BAD_STATE );
3081
3082 /* The requested algorithm must be one that can be processed by cipher. */
3083 if( ! PSA_ALG_IS_CIPHER( alg ) )
3084 return( PSA_ERROR_INVALID_ARGUMENT );
3085
3086 /* Fetch key material from key storage. */
3087 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3088 if( status != PSA_SUCCESS )
3089 goto exit;
3090
Ronald Cron49fafa92021-03-10 08:34:23 +01003091 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003092 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003093 * so we only set it (in the driver wrapper) after resources have been
3094 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003095 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003096 if( alg == PSA_ALG_ECB_NO_PADDING )
3097 operation->iv_required = 0;
3098 else
3099 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003100 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003101
Ronald Crona4af55f2020-12-14 14:36:06 +01003102 psa_key_attributes_t attributes = {
3103 .core = slot->attr
3104 };
3105
Ronald Cronab99ac22020-10-01 16:38:28 +02003106 /* Try doing the operation through a driver before using software fallback. */
3107 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003108 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3109 &attributes,
3110 slot->key.data,
3111 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003112 alg );
3113 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003114 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3115 &attributes,
3116 slot->key.data,
3117 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003118 alg );
3119
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003120exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003121 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003122 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003123
Ronald Cron5c522922020-11-14 16:35:34 +01003124 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003125
Ronald Cron5c522922020-11-14 16:35:34 +01003126 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003127}
3128
Gilles Peskinefe119512018-07-08 21:39:34 +02003129psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003130 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003131 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003132{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003133 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003134}
3135
Gilles Peskinefe119512018-07-08 21:39:34 +02003136psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003137 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003138 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003139{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003140 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003141}
3142
Gilles Peskinefe119512018-07-08 21:39:34 +02003143psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003144 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003145 size_t iv_size,
3146 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003147{
Ronald Cron6d051732020-10-01 14:10:20 +02003148 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003149
Ronald Cron5618a392021-03-26 09:52:26 +01003150 *iv_length = 0;
3151
Ronald Cron49fafa92021-03-10 08:34:23 +01003152 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003153 {
3154 return( PSA_ERROR_BAD_STATE );
3155 }
3156
Steven Cooreman7df02922020-09-09 15:28:49 +02003157 if( operation->iv_set || ! operation->iv_required )
3158 {
3159 return( PSA_ERROR_BAD_STATE );
3160 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003161
Ronald Cron5618a392021-03-26 09:52:26 +01003162 if( iv_size < operation->default_iv_length )
3163 {
3164 status = PSA_ERROR_BUFFER_TOO_SMALL;
3165 goto exit;
3166 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003167
Ronald Cron5618a392021-03-26 09:52:26 +01003168 status = psa_generate_random( iv, operation->default_iv_length );
3169 if( status != PSA_SUCCESS )
3170 goto exit;
3171
3172 status = psa_driver_wrapper_cipher_set_iv( operation,
3173 iv,
3174 operation->default_iv_length );
3175
3176exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003177 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003178 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003179 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003180 *iv_length = operation->default_iv_length;
3181 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003182 else
Moran Peker395db872018-05-31 14:07:14 +03003183 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003184
itayzafrir534bd7c2018-08-02 13:56:32 +03003185 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003186}
3187
Gilles Peskinefe119512018-07-08 21:39:34 +02003188psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003189 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003190 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003191{
Ronald Cron6d051732020-10-01 14:10:20 +02003192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003193
Ronald Cron49fafa92021-03-10 08:34:23 +01003194 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003195 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003196
Steven Cooreman7df02922020-09-09 15:28:49 +02003197 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003198 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003199
3200 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3201 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003202
Ronald Crondd24c9b2020-12-15 14:10:01 +01003203 status = psa_driver_wrapper_cipher_set_iv( operation,
3204 iv,
3205 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003206
itayzafrir534bd7c2018-08-02 13:56:32 +03003207 if( status == PSA_SUCCESS )
3208 operation->iv_set = 1;
3209 else
mohammad1603503973b2018-03-12 15:59:30 +02003210 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003211 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003212}
3213
Gilles Peskinee553c652018-06-04 16:22:46 +02003214psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3215 const uint8_t *input,
3216 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003217 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003218 size_t output_size,
3219 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003220{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003222
Ronald Cron49fafa92021-03-10 08:34:23 +01003223 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003224 {
3225 return( PSA_ERROR_BAD_STATE );
3226 }
3227 if( operation->iv_required && ! operation->iv_set )
3228 {
3229 return( PSA_ERROR_BAD_STATE );
3230 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003231
Ronald Crondd24c9b2020-12-15 14:10:01 +01003232 status = psa_driver_wrapper_cipher_update( operation,
3233 input,
3234 input_length,
3235 output,
3236 output_size,
3237 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003238 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003239 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003240
itayzafrir534bd7c2018-08-02 13:56:32 +03003241 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003242}
3243
Gilles Peskinee553c652018-06-04 16:22:46 +02003244psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3245 uint8_t *output,
3246 size_t output_size,
3247 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003248{
David Saadab4ecc272019-02-14 13:48:10 +02003249 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003250
Ronald Cron49fafa92021-03-10 08:34:23 +01003251 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003252 {
3253 return( PSA_ERROR_BAD_STATE );
3254 }
3255 if( operation->iv_required && ! operation->iv_set )
3256 {
3257 return( PSA_ERROR_BAD_STATE );
3258 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003259
Ronald Crondd24c9b2020-12-15 14:10:01 +01003260 status = psa_driver_wrapper_cipher_finish( operation,
3261 output,
3262 output_size,
3263 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003264 if( status == PSA_SUCCESS )
3265 return( psa_cipher_abort( operation ) );
3266 else
3267 {
3268 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003269 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003270
Steven Cooremanef8575e2020-09-11 11:44:50 +02003271 return( status );
3272 }
mohammad1603503973b2018-03-12 15:59:30 +02003273}
3274
Gilles Peskinee553c652018-06-04 16:22:46 +02003275psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3276{
Ronald Cron49fafa92021-03-10 08:34:23 +01003277 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003278 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003279 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003280 * in use. It's ok to call abort on such an object, and there's
3281 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003282 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003283 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003284
Ronald Crondd24c9b2020-12-15 14:10:01 +01003285 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003286
Ronald Cron49fafa92021-03-10 08:34:23 +01003287 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003288 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003289 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003290
Moran Peker395db872018-05-31 14:07:14 +03003291 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003292}
3293
mohammad16035955c982018-04-26 00:53:03 +03003294/****************************************************************/
3295/* AEAD */
3296/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003297
Ronald Croncf56a0a2020-08-04 09:51:30 +02003298psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003299 psa_algorithm_t alg,
3300 const uint8_t *nonce,
3301 size_t nonce_length,
3302 const uint8_t *additional_data,
3303 size_t additional_data_length,
3304 const uint8_t *plaintext,
3305 size_t plaintext_length,
3306 uint8_t *ciphertext,
3307 size_t ciphertext_size,
3308 size_t *ciphertext_length )
3309{
Ronald Cron215633c2021-03-16 17:15:37 +01003310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3311 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003312
mohammad1603f08a5502018-06-03 15:05:47 +03003313 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003314
Steven Cooremanea7ab132021-03-17 16:28:00 +01003315 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3316 return( PSA_ERROR_NOT_SUPPORTED );
3317
Ronald Cron9a986162021-03-26 12:40:07 +01003318 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003319 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003320 if( status != PSA_SUCCESS )
3321 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003322
Ronald Cron215633c2021-03-16 17:15:37 +01003323 psa_key_attributes_t attributes = {
3324 .core = slot->attr
3325 };
mohammad16035955c982018-04-26 00:53:03 +03003326
Ronald Cronde822812021-03-17 16:08:20 +01003327 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003328 &attributes, slot->key.data, slot->key.bytes,
3329 alg,
3330 nonce, nonce_length,
3331 additional_data, additional_data_length,
3332 plaintext, plaintext_length,
3333 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003334
Gilles Peskineedf9a652018-08-17 18:11:56 +02003335 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3336 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003337
Ronald Cron9f310172021-03-16 16:36:37 +01003338 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003339
mohammad16035955c982018-04-26 00:53:03 +03003340 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003341}
3342
Ronald Croncf56a0a2020-08-04 09:51:30 +02003343psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003344 psa_algorithm_t alg,
3345 const uint8_t *nonce,
3346 size_t nonce_length,
3347 const uint8_t *additional_data,
3348 size_t additional_data_length,
3349 const uint8_t *ciphertext,
3350 size_t ciphertext_length,
3351 uint8_t *plaintext,
3352 size_t plaintext_size,
3353 size_t *plaintext_length )
3354{
Ronald Cron215633c2021-03-16 17:15:37 +01003355 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3356 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003357
Gilles Peskineee652a32018-06-01 19:23:52 +02003358 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003359
Steven Cooremanea7ab132021-03-17 16:28:00 +01003360 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3361 return( PSA_ERROR_NOT_SUPPORTED );
3362
Ronald Cron9a986162021-03-26 12:40:07 +01003363 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003364 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003365 if( status != PSA_SUCCESS )
3366 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003367
Ronald Cron215633c2021-03-16 17:15:37 +01003368 psa_key_attributes_t attributes = {
3369 .core = slot->attr
3370 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003371
Ronald Cronde822812021-03-17 16:08:20 +01003372 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003373 &attributes, slot->key.data, slot->key.bytes,
3374 alg,
3375 nonce, nonce_length,
3376 additional_data, additional_data_length,
3377 ciphertext, ciphertext_length,
3378 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003379
Gilles Peskineedf9a652018-08-17 18:11:56 +02003380 if( status != PSA_SUCCESS && plaintext_size != 0 )
3381 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003382
Ronald Cron215633c2021-03-16 17:15:37 +01003383 psa_unlock_key_slot( slot );
3384
Gilles Peskineedf9a652018-08-17 18:11:56 +02003385 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003386}
3387
Gilles Peskinee59236f2018-01-27 23:32:46 +01003388/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003389/* Generators */
3390/****************************************************************/
3391
John Durkop07cc04a2020-11-16 22:08:34 -08003392#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3393 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3394 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3395#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003396#endif /* At least one builtin KDF */
3397
3398#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3399 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3400 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3401static psa_status_t psa_key_derivation_start_hmac(
3402 psa_mac_operation_t *operation,
3403 psa_algorithm_t hash_alg,
3404 const uint8_t *hmac_key,
3405 size_t hmac_key_length )
3406{
3407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3408 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3409 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3410 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3411 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3412
Steven Cooreman72f736a2021-05-07 14:14:37 +02003413 operation->is_sign = 1;
3414 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3415
Steven Cooreman094a77e2021-05-06 17:58:36 +02003416 status = psa_driver_wrapper_mac_sign_setup( operation,
3417 &attributes,
3418 hmac_key, hmac_key_length,
3419 PSA_ALG_HMAC( hash_alg ) );
3420
3421 psa_reset_key_attributes( &attributes );
3422 return( status );
3423}
3424#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003425
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003426#define HKDF_STATE_INIT 0 /* no input yet */
3427#define HKDF_STATE_STARTED 1 /* got salt */
3428#define HKDF_STATE_KEYED 2 /* got key */
3429#define HKDF_STATE_OUTPUT 3 /* output started */
3430
Gilles Peskinecbe66502019-05-16 16:59:18 +02003431static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003432 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003433{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003434 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3435 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003436 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003437 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003438}
3439
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003440psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003441{
3442 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003443 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003444 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003445 {
3446 /* The object has (apparently) been initialized but it is not
3447 * in use. It's ok to call abort on such an object, and there's
3448 * nothing to do. */
3449 }
3450 else
John Durkopd0321952020-10-29 21:37:36 -07003451#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003452 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003453 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003454 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003455 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003456 }
John Durkop07cc04a2020-11-16 22:08:34 -08003457 else
3458#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3459#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3460 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3461 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003462 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003463 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003464 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003465 if( operation->ctx.tls12_prf.secret != NULL )
3466 {
3467 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3468 operation->ctx.tls12_prf.secret_length );
3469 mbedtls_free( operation->ctx.tls12_prf.secret );
3470 }
3471
Janos Follath6a1d2622019-06-11 10:37:28 +01003472 if( operation->ctx.tls12_prf.seed != NULL )
3473 {
3474 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3475 operation->ctx.tls12_prf.seed_length );
3476 mbedtls_free( operation->ctx.tls12_prf.seed );
3477 }
3478
3479 if( operation->ctx.tls12_prf.label != NULL )
3480 {
3481 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3482 operation->ctx.tls12_prf.label_length );
3483 mbedtls_free( operation->ctx.tls12_prf.label );
3484 }
3485
Steven Cooremana6df6042021-04-29 19:32:25 +02003486 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003487
3488 /* We leave the fields Ai and output_block to be erased safely by the
3489 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003490 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003491 else
John Durkop07cc04a2020-11-16 22:08:34 -08003492#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3493 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003494 {
3495 status = PSA_ERROR_BAD_STATE;
3496 }
Janos Follath083036a2019-06-11 10:22:26 +01003497 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003498 return( status );
3499}
3500
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003501psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003502 size_t *capacity)
3503{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003504 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003505 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003506 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003507 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003508 }
3509
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003510 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003511 return( PSA_SUCCESS );
3512}
3513
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003514psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003515 size_t capacity )
3516{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003517 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003518 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003519 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003520 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003521 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003522 return( PSA_SUCCESS );
3523}
3524
John Durkopd0321952020-10-29 21:37:36 -07003525#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003526/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003527 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003528static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003529 psa_algorithm_t hash_alg,
3530 uint8_t *output,
3531 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003532{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003533 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003534 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003535 psa_status_t status;
3536
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003537 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3538 return( PSA_ERROR_BAD_STATE );
3539 hkdf->state = HKDF_STATE_OUTPUT;
3540
Gilles Peskinebef7f142018-07-12 17:22:21 +02003541 while( output_length != 0 )
3542 {
3543 /* Copy what remains of the current block */
3544 uint8_t n = hash_length - hkdf->offset_in_block;
3545 if( n > output_length )
3546 n = (uint8_t) output_length;
3547 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3548 output += n;
3549 output_length -= n;
3550 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003551 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003552 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003553 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003554 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003555 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003556 * object was corrupted or if this function is called directly
3557 * inside the library. */
3558 if( hkdf->block_number == 0xff )
3559 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003560
3561 /* We need a new block */
3562 ++hkdf->block_number;
3563 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003564
Steven Cooreman094a77e2021-05-06 17:58:36 +02003565 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3566 hash_alg,
3567 hkdf->prk,
3568 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003569 if( status != PSA_SUCCESS )
3570 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003571
Gilles Peskinebef7f142018-07-12 17:22:21 +02003572 if( hkdf->block_number != 1 )
3573 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003574 status = psa_mac_update( &hkdf->hmac,
3575 hkdf->output_block,
3576 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003577 if( status != PSA_SUCCESS )
3578 return( status );
3579 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003580 status = psa_mac_update( &hkdf->hmac,
3581 hkdf->info,
3582 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003583 if( status != PSA_SUCCESS )
3584 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003585 status = psa_mac_update( &hkdf->hmac,
3586 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003587 if( status != PSA_SUCCESS )
3588 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003589 status = psa_mac_sign_finish( &hkdf->hmac,
3590 hkdf->output_block,
3591 sizeof( hkdf->output_block ),
3592 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003593 if( status != PSA_SUCCESS )
3594 return( status );
3595 }
3596
3597 return( PSA_SUCCESS );
3598}
John Durkop07cc04a2020-11-16 22:08:34 -08003599#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003600
John Durkop07cc04a2020-11-16 22:08:34 -08003601#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3602 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003603static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3604 psa_tls12_prf_key_derivation_t *tls12_prf,
3605 psa_algorithm_t alg )
3606{
3607 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003608 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003609 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3610 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003611 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003612
Janos Follath7742fee2019-06-17 12:58:10 +01003613 /* We can't be wanting more output after block 0xff, otherwise
3614 * the capacity check in psa_key_derivation_output_bytes() would have
3615 * prevented this call. It could happen only if the operation
3616 * object was corrupted or if this function is called directly
3617 * inside the library. */
3618 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003619 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003620
3621 /* We need a new block */
3622 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003623 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003624
3625 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3626 *
3627 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3628 *
3629 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3630 * HMAC_hash(secret, A(2) + seed) +
3631 * HMAC_hash(secret, A(3) + seed) + ...
3632 *
3633 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003634 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003635 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003636 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003637 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003638 * is currently extracted as `output_block` and where i is
3639 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003640 */
3641
Steven Cooreman094a77e2021-05-06 17:58:36 +02003642 status = psa_key_derivation_start_hmac( &hmac,
3643 hash_alg,
3644 tls12_prf->secret,
3645 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003646 if( status != PSA_SUCCESS )
3647 goto cleanup;
3648
3649 /* Calculate A(i) where i = tls12_prf->block_number. */
3650 if( tls12_prf->block_number == 1 )
3651 {
3652 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3653 * the variable seed and in this instance means it in the context of the
3654 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003655 status = psa_mac_update( &hmac,
3656 tls12_prf->label,
3657 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003658 if( status != PSA_SUCCESS )
3659 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003660 status = psa_mac_update( &hmac,
3661 tls12_prf->seed,
3662 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003663 if( status != PSA_SUCCESS )
3664 goto cleanup;
3665 }
3666 else
3667 {
3668 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003669 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003670 if( status != PSA_SUCCESS )
3671 goto cleanup;
3672 }
3673
Steven Cooremana6df6042021-04-29 19:32:25 +02003674 status = psa_mac_sign_finish( &hmac,
3675 tls12_prf->Ai, hash_length,
3676 &hmac_output_length );
3677 if( hmac_output_length != hash_length )
3678 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003679 if( status != PSA_SUCCESS )
3680 goto cleanup;
3681
3682 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003683 status = psa_key_derivation_start_hmac( &hmac,
3684 hash_alg,
3685 tls12_prf->secret,
3686 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003687 if( status != PSA_SUCCESS )
3688 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003689 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003690 if( status != PSA_SUCCESS )
3691 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003692 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003693 if( status != PSA_SUCCESS )
3694 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003695 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003696 if( status != PSA_SUCCESS )
3697 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003698 status = psa_mac_sign_finish( &hmac,
3699 tls12_prf->output_block, hash_length,
3700 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003701 if( status != PSA_SUCCESS )
3702 goto cleanup;
3703
Janos Follath7742fee2019-06-17 12:58:10 +01003704
3705cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003706 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003707 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3708 status = cleanup_status;
3709
3710 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003711}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003712
Janos Follath844eb0e2019-06-19 12:10:49 +01003713static psa_status_t psa_key_derivation_tls12_prf_read(
3714 psa_tls12_prf_key_derivation_t *tls12_prf,
3715 psa_algorithm_t alg,
3716 uint8_t *output,
3717 size_t output_length )
3718{
3719 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003720 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003721 psa_status_t status;
3722 uint8_t offset, length;
3723
3724 while( output_length != 0 )
3725 {
3726 /* Check if we have fully processed the current block. */
3727 if( tls12_prf->left_in_block == 0 )
3728 {
3729 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3730 alg );
3731 if( status != PSA_SUCCESS )
3732 return( status );
3733
3734 continue;
3735 }
3736
3737 if( tls12_prf->left_in_block > output_length )
3738 length = (uint8_t) output_length;
3739 else
3740 length = tls12_prf->left_in_block;
3741
3742 offset = hash_length - tls12_prf->left_in_block;
3743 memcpy( output, tls12_prf->output_block + offset, length );
3744 output += length;
3745 output_length -= length;
3746 tls12_prf->left_in_block -= length;
3747 }
3748
3749 return( PSA_SUCCESS );
3750}
John Durkop07cc04a2020-11-16 22:08:34 -08003751#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3752 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003753
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003754psa_status_t psa_key_derivation_output_bytes(
3755 psa_key_derivation_operation_t *operation,
3756 uint8_t *output,
3757 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003758{
3759 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003760 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003761
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003762 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003763 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003764 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003765 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003766 }
3767
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003768 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003769 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003770 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003771 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003772 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003773 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003774 goto exit;
3775 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003776 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003777 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003778 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003779 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003780 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3781 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003782 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003783 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003784 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003785 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003786 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003787
John Durkopd0321952020-10-29 21:37:36 -07003788#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003789 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003790 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003791 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003792 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003793 output, output_length );
3794 }
Janos Follathadbec812019-06-14 11:05:39 +01003795 else
John Durkop07cc04a2020-11-16 22:08:34 -08003796#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3797#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3798 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003799 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003800 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003801 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003802 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003803 kdf_alg, output,
3804 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003805 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003806 else
John Durkop07cc04a2020-11-16 22:08:34 -08003807#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3808 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003809 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003810 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003811 return( PSA_ERROR_BAD_STATE );
3812 }
3813
3814exit:
3815 if( status != PSA_SUCCESS )
3816 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003817 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003818 * This allows us to differentiate between exhausted operations and
3819 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3820 * operations. */
3821 psa_algorithm_t alg = operation->alg;
3822 psa_key_derivation_abort( operation );
3823 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003824 memset( output, '!', output_length );
3825 }
3826 return( status );
3827}
3828
David Brown7807bf72021-02-09 16:28:23 -07003829#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003830static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3831{
3832 if( data_size >= 8 )
3833 mbedtls_des_key_set_parity( data );
3834 if( data_size >= 16 )
3835 mbedtls_des_key_set_parity( data + 8 );
3836 if( data_size >= 24 )
3837 mbedtls_des_key_set_parity( data + 16 );
3838}
David Brown7807bf72021-02-09 16:28:23 -07003839#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003840
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003841static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003842 psa_key_slot_t *slot,
3843 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003844 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003845{
3846 uint8_t *data = NULL;
3847 size_t bytes = PSA_BITS_TO_BYTES( bits );
3848 psa_status_t status;
3849
Gilles Peskine8e338702019-07-30 20:06:31 +02003850 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003851 return( PSA_ERROR_INVALID_ARGUMENT );
3852 if( bits % 8 != 0 )
3853 return( PSA_ERROR_INVALID_ARGUMENT );
3854 data = mbedtls_calloc( 1, bytes );
3855 if( data == NULL )
3856 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3857
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003858 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003859 if( status != PSA_SUCCESS )
3860 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003861#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003862 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003863 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003864#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003865
3866 status = psa_allocate_buffer_to_slot( slot, bytes );
3867 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003868 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003869
Ronald Cronbf33c932020-11-28 18:06:53 +01003870 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003871 psa_key_attributes_t attributes = {
3872 .core = slot->attr
3873 };
3874
Ronald Cronbf33c932020-11-28 18:06:53 +01003875 status = psa_driver_wrapper_import_key( &attributes,
3876 data, bytes,
3877 slot->key.data,
3878 slot->key.bytes,
3879 &slot->key.bytes, &bits );
3880 if( bits != slot->attr.bits )
3881 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003882
3883exit:
3884 mbedtls_free( data );
3885 return( status );
3886}
3887
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003888psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003889 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003890 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003891{
3892 psa_status_t status;
3893 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02003894 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02003895
Ronald Cron81709fc2020-11-14 12:10:32 +01003896 *key = MBEDTLS_SVC_KEY_ID_INIT;
3897
Gilles Peskine0f84d622019-09-12 19:03:13 +02003898 /* Reject any attempt to create a zero-length key so that we don't
3899 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
3900 if( psa_get_key_bits( attributes ) == 0 )
3901 return( PSA_ERROR_INVALID_ARGUMENT );
3902
Gilles Peskine178c9aa2019-09-24 18:21:06 +02003903 if( ! operation->can_output_key )
3904 return( PSA_ERROR_NOT_PERMITTED );
3905
Ronald Cron81709fc2020-11-14 12:10:32 +01003906 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
3907 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02003908#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3909 if( driver != NULL )
3910 {
3911 /* Deriving a key in a secure element is not implemented yet. */
3912 status = PSA_ERROR_NOT_SUPPORTED;
3913 }
3914#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003915 if( status == PSA_SUCCESS )
3916 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003917 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02003918 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003919 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003920 }
3921 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01003922 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003923 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02003924 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003925
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003926 return( status );
3927}
3928
Gilles Peskineeab56e42018-07-12 17:12:33 +02003929
3930
3931/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02003932/* Key derivation */
3933/****************************************************************/
3934
Steven Cooreman932ffb72021-02-15 12:14:32 +01003935#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003936static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003937 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003938 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003939{
John Durkop07cc04a2020-11-16 22:08:34 -08003940 int is_kdf_alg_supported;
3941
Janos Follath5fe19732019-06-20 15:09:30 +01003942 /* Make sure that operation->ctx is properly zero-initialised. (Macro
3943 * initialisers for this union leave some bytes unspecified.) */
3944 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
3945
Gilles Peskine969c5d62019-01-16 15:53:06 +01003946 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07003947#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08003948 if( PSA_ALG_IS_HKDF( kdf_alg ) )
3949 is_kdf_alg_supported = 1;
3950 else
3951#endif
3952#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
3953 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
3954 is_kdf_alg_supported = 1;
3955 else
3956#endif
3957#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3958 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
3959 is_kdf_alg_supported = 1;
3960 else
3961#endif
3962 is_kdf_alg_supported = 0;
3963
3964 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003965 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003966 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003967 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003968 if( hash_size == 0 )
3969 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003970 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
3971 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02003972 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003973 {
3974 return( PSA_ERROR_NOT_SUPPORTED );
3975 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003976 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01003977 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003978 }
John Durkop07cc04a2020-11-16 22:08:34 -08003979
3980 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003981}
John Durkop07cc04a2020-11-16 22:08:34 -08003982#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003983
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003984psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003985 psa_algorithm_t alg )
3986{
3987 psa_status_t status;
3988
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003989 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003990 return( PSA_ERROR_BAD_STATE );
3991
Gilles Peskine6843c292019-01-18 16:44:49 +01003992 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
3993 return( PSA_ERROR_INVALID_ARGUMENT );
3994 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003995 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01003996#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003997 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003998 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01003999#else
4000 return( PSA_ERROR_NOT_SUPPORTED );
4001#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004002 }
4003 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4004 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004005#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004006 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004007#else
4008 return( PSA_ERROR_NOT_SUPPORTED );
4009#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004010 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004011 else
4012 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004013
4014 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004015 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004016 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004017}
4018
John Durkopd0321952020-10-29 21:37:36 -07004019#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004020static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004021 psa_algorithm_t hash_alg,
4022 psa_key_derivation_step_t step,
4023 const uint8_t *data,
4024 size_t data_length )
4025{
4026 psa_status_t status;
4027 switch( step )
4028 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004029 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004030 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004031 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004032 else
4033 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004034 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4035 hash_alg,
4036 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004037 if( status != PSA_SUCCESS )
4038 return( status );
4039 hkdf->state = HKDF_STATE_STARTED;
4040 return( PSA_SUCCESS );
4041 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004042 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004043 /* If no salt was provided, use an empty salt. */
4044 if( hkdf->state == HKDF_STATE_INIT )
4045 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004046 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4047 hash_alg,
4048 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004049 if( status != PSA_SUCCESS )
4050 return( status );
4051 hkdf->state = HKDF_STATE_STARTED;
4052 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004053 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004054 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004055 status = psa_mac_update( &hkdf->hmac,
4056 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004057 if( status != PSA_SUCCESS )
4058 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004059 status = psa_mac_sign_finish( &hkdf->hmac,
4060 hkdf->prk,
4061 sizeof( hkdf->prk ),
4062 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004063 if( status != PSA_SUCCESS )
4064 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004065 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004066 hkdf->block_number = 0;
4067 hkdf->state = HKDF_STATE_KEYED;
4068 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004069 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004070 if( hkdf->state == HKDF_STATE_OUTPUT )
4071 return( PSA_ERROR_BAD_STATE );
4072 if( hkdf->info_set )
4073 return( PSA_ERROR_BAD_STATE );
4074 hkdf->info_length = data_length;
4075 if( data_length != 0 )
4076 {
4077 hkdf->info = mbedtls_calloc( 1, data_length );
4078 if( hkdf->info == NULL )
4079 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4080 memcpy( hkdf->info, data, data_length );
4081 }
4082 hkdf->info_set = 1;
4083 return( PSA_SUCCESS );
4084 default:
4085 return( PSA_ERROR_INVALID_ARGUMENT );
4086 }
4087}
John Durkop07cc04a2020-11-16 22:08:34 -08004088#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004089
John Durkop07cc04a2020-11-16 22:08:34 -08004090#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4091 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004092static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4093 const uint8_t *data,
4094 size_t data_length )
4095{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004096 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004097 return( PSA_ERROR_BAD_STATE );
4098
Janos Follathd6dce9f2019-07-04 09:11:38 +01004099 if( data_length != 0 )
4100 {
4101 prf->seed = mbedtls_calloc( 1, data_length );
4102 if( prf->seed == NULL )
4103 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004104
Janos Follathd6dce9f2019-07-04 09:11:38 +01004105 memcpy( prf->seed, data, data_length );
4106 prf->seed_length = data_length;
4107 }
Janos Follathf08e2652019-06-13 09:05:41 +01004108
Gilles Peskine43f958b2020-12-13 14:55:14 +01004109 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004110
4111 return( PSA_SUCCESS );
4112}
4113
Janos Follath81550542019-06-13 14:26:34 +01004114static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004115 const uint8_t *data,
4116 size_t data_length )
4117{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004118 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004119 return( PSA_ERROR_BAD_STATE );
4120
Steven Cooremana6df6042021-04-29 19:32:25 +02004121 if( data_length != 0 )
4122 {
4123 prf->secret = mbedtls_calloc( 1, data_length );
4124 if( prf->secret == NULL )
4125 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4126
4127 memcpy( prf->secret, data, data_length );
4128 prf->secret_length = data_length;
4129 }
Janos Follath81550542019-06-13 14:26:34 +01004130
Gilles Peskine43f958b2020-12-13 14:55:14 +01004131 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004132
4133 return( PSA_SUCCESS );
4134}
4135
Janos Follath63028dd2019-06-13 09:15:47 +01004136static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4137 const uint8_t *data,
4138 size_t data_length )
4139{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004140 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004141 return( PSA_ERROR_BAD_STATE );
4142
Janos Follathd6dce9f2019-07-04 09:11:38 +01004143 if( data_length != 0 )
4144 {
4145 prf->label = mbedtls_calloc( 1, data_length );
4146 if( prf->label == NULL )
4147 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004148
Janos Follathd6dce9f2019-07-04 09:11:38 +01004149 memcpy( prf->label, data, data_length );
4150 prf->label_length = data_length;
4151 }
Janos Follath63028dd2019-06-13 09:15:47 +01004152
Gilles Peskine43f958b2020-12-13 14:55:14 +01004153 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004154
4155 return( PSA_SUCCESS );
4156}
4157
Janos Follathb03233e2019-06-11 15:30:30 +01004158static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004159 psa_key_derivation_step_t step,
4160 const uint8_t *data,
4161 size_t data_length )
4162{
Janos Follathb03233e2019-06-11 15:30:30 +01004163 switch( step )
4164 {
Janos Follathf08e2652019-06-13 09:05:41 +01004165 case PSA_KEY_DERIVATION_INPUT_SEED:
4166 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004167 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004168 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004169 case PSA_KEY_DERIVATION_INPUT_LABEL:
4170 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004171 default:
4172 return( PSA_ERROR_INVALID_ARGUMENT );
4173 }
4174}
John Durkop07cc04a2020-11-16 22:08:34 -08004175#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4176 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4177
4178#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4179static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4180 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004181 const uint8_t *data,
4182 size_t data_length )
4183{
4184 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004185 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004186 uint8_t *cur = pms;
4187
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004188 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004189 return( PSA_ERROR_INVALID_ARGUMENT );
4190
4191 /* Quoting RFC 4279, Section 2:
4192 *
4193 * The premaster secret is formed as follows: if the PSK is N octets
4194 * long, concatenate a uint16 with the value N, N zero octets, a second
4195 * uint16 with the value N, and the PSK itself.
4196 */
4197
4198 *cur++ = ( data_length >> 8 ) & 0xff;
4199 *cur++ = ( data_length >> 0 ) & 0xff;
4200 memset( cur, 0, data_length );
4201 cur += data_length;
4202 *cur++ = pms[0];
4203 *cur++ = pms[1];
4204 memcpy( cur, data, data_length );
4205 cur += data_length;
4206
Steven Cooremana6df6042021-04-29 19:32:25 +02004207 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004208
4209 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4210 return( status );
4211}
Janos Follath6660f0e2019-06-17 08:44:03 +01004212
4213static psa_status_t psa_tls12_prf_psk_to_ms_input(
4214 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004215 psa_key_derivation_step_t step,
4216 const uint8_t *data,
4217 size_t data_length )
4218{
4219 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004220 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004221 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004222 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004223 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004224
Steven Cooremana6df6042021-04-29 19:32:25 +02004225 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004226}
John Durkop07cc04a2020-11-16 22:08:34 -08004227#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004228
Gilles Peskineb8965192019-09-24 16:21:10 +02004229/** Check whether the given key type is acceptable for the given
4230 * input step of a key derivation.
4231 *
4232 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4233 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4234 * Both secret and non-secret inputs can alternatively have the type
4235 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4236 * that the input was passed as a buffer rather than via a key object.
4237 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004238static int psa_key_derivation_check_input_type(
4239 psa_key_derivation_step_t step,
4240 psa_key_type_t key_type )
4241{
4242 switch( step )
4243 {
4244 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004245 if( key_type == PSA_KEY_TYPE_DERIVE )
4246 return( PSA_SUCCESS );
4247 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004248 return( PSA_SUCCESS );
4249 break;
4250 case PSA_KEY_DERIVATION_INPUT_LABEL:
4251 case PSA_KEY_DERIVATION_INPUT_SALT:
4252 case PSA_KEY_DERIVATION_INPUT_INFO:
4253 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004254 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4255 return( PSA_SUCCESS );
4256 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004257 return( PSA_SUCCESS );
4258 break;
4259 }
4260 return( PSA_ERROR_INVALID_ARGUMENT );
4261}
4262
Janos Follathb80a94e2019-06-12 15:54:46 +01004263static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004264 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004265 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004266 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004267 const uint8_t *data,
4268 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004269{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004270 psa_status_t status;
4271 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4272
4273 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004274 if( status != PSA_SUCCESS )
4275 goto exit;
4276
John Durkopd0321952020-10-29 21:37:36 -07004277#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004278 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004279 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004280 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004281 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004282 step, data, data_length );
4283 }
John Durkop07cc04a2020-11-16 22:08:34 -08004284 else
4285#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4286#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4287 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004288 {
Janos Follathb03233e2019-06-11 15:30:30 +01004289 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004290 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004291 }
John Durkop07cc04a2020-11-16 22:08:34 -08004292 else
4293#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4294#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4295 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004296 {
4297 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004298 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004299 }
4300 else
John Durkop07cc04a2020-11-16 22:08:34 -08004301#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004302 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004303 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004304 (void) data;
4305 (void) data_length;
4306 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004307 return( PSA_ERROR_BAD_STATE );
4308 }
4309
Gilles Peskine224b0d62019-09-23 18:13:17 +02004310exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004311 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004313 return( status );
4314}
4315
Janos Follath51f4a0f2019-06-14 11:35:55 +01004316psa_status_t psa_key_derivation_input_bytes(
4317 psa_key_derivation_operation_t *operation,
4318 psa_key_derivation_step_t step,
4319 const uint8_t *data,
4320 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004321{
Gilles Peskineb8965192019-09-24 16:21:10 +02004322 return( psa_key_derivation_input_internal( operation, step,
4323 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004324 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004325}
4326
Janos Follath51f4a0f2019-06-14 11:35:55 +01004327psa_status_t psa_key_derivation_input_key(
4328 psa_key_derivation_operation_t *operation,
4329 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004330 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004333 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004334 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004335
Ronald Cron5c522922020-11-14 16:35:34 +01004336 status = psa_get_and_lock_transparent_key_slot_with_policy(
4337 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004338 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004339 {
4340 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004341 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004342 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004343
4344 /* Passing a key object as a SECRET input unlocks the permission
4345 * to output to a key object. */
4346 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4347 operation->can_output_key = 1;
4348
Ronald Cronf95a2b12020-10-22 15:24:49 +02004349 status = psa_key_derivation_input_internal( operation,
4350 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004351 slot->key.data,
4352 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004353
Ronald Cron5c522922020-11-14 16:35:34 +01004354 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004355
Ronald Cron5c522922020-11-14 16:35:34 +01004356 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004357}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004358
4359
4360
4361/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004362/* Key agreement */
4363/****************************************************************/
4364
John Durkop6ba40d12020-11-10 08:50:04 -08004365#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004366static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4367 size_t peer_key_length,
4368 const mbedtls_ecp_keypair *our_key,
4369 uint8_t *shared_secret,
4370 size_t shared_secret_size,
4371 size_t *shared_secret_length )
4372{
Steven Cooremand4867872020-08-05 16:31:39 +02004373 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004374 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004375 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004376 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004377 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004378 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004379
Ronald Cron90857082020-11-25 14:58:33 +01004380 status = mbedtls_psa_ecp_load_representation(
4381 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004382 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004383 peer_key,
4384 peer_key_length,
4385 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004386 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004387 goto exit;
4388
Jaeden Amero97271b32019-01-10 19:38:51 +00004389 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004390 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004391 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004392 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004393 status = mbedtls_to_psa_error(
4394 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4395 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004396 goto exit;
4397
Jaeden Amero97271b32019-01-10 19:38:51 +00004398 status = mbedtls_to_psa_error(
4399 mbedtls_ecdh_calc_secret( &ecdh,
4400 shared_secret_length,
4401 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004402 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004403 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004404 if( status != PSA_SUCCESS )
4405 goto exit;
4406 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4407 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004408
4409exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004410 if( status != PSA_SUCCESS )
4411 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004412 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004413 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004414 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004415
Jaeden Amero97271b32019-01-10 19:38:51 +00004416 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004417}
John Durkop6ba40d12020-11-10 08:50:04 -08004418#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004419
Gilles Peskine01d718c2018-09-18 12:01:02 +02004420#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4421
Gilles Peskine0216fe12019-04-11 21:23:21 +02004422static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4423 psa_key_slot_t *private_key,
4424 const uint8_t *peer_key,
4425 size_t peer_key_length,
4426 uint8_t *shared_secret,
4427 size_t shared_secret_size,
4428 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004429{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004430 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004431 {
John Durkop6ba40d12020-11-10 08:50:04 -08004432#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004433 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004434 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004435 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004436 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004437 psa_status_t status = mbedtls_psa_ecp_load_representation(
4438 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004439 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004440 private_key->key.data,
4441 private_key->key.bytes,
4442 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004443 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004444 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004445 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004446 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004447 shared_secret, shared_secret_size,
4448 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004449 mbedtls_ecp_keypair_free( ecp );
4450 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004451 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004452#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004453 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004454 (void) private_key;
4455 (void) peer_key;
4456 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004457 (void) shared_secret;
4458 (void) shared_secret_size;
4459 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004460 return( PSA_ERROR_NOT_SUPPORTED );
4461 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004462}
4463
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004464/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004465 * to potentially free embedded data structures and wipe confidential data.
4466 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004467static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004468 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004469 psa_key_slot_t *private_key,
4470 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004471 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004472{
4473 psa_status_t status;
4474 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4475 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004476 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004477
4478 /* Step 1: run the secret agreement algorithm to generate the shared
4479 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004480 status = psa_key_agreement_raw_internal( ka_alg,
4481 private_key,
4482 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004483 shared_secret,
4484 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004485 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004486 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004487 goto exit;
4488
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004489 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004490 * the shared secret. A shared secret is permitted wherever a key
4491 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004492 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004493 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004494 shared_secret,
4495 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004496exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004497 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004498 return( status );
4499}
4500
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004501psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004502 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004503 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004504 const uint8_t *peer_key,
4505 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004506{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004508 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004509 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004510
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004511 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004512 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004513 status = psa_get_and_lock_transparent_key_slot_with_policy(
4514 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004515 if( status != PSA_SUCCESS )
4516 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004517 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004518 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004519 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004520 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004521 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004522 else
4523 {
4524 /* If a private key has been added as SECRET, we allow the derived
4525 * key material to be used as a key in PSA Crypto. */
4526 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4527 operation->can_output_key = 1;
4528 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004529
Ronald Cron5c522922020-11-14 16:35:34 +01004530 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004531
Ronald Cron5c522922020-11-14 16:35:34 +01004532 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004533}
4534
Gilles Peskinebe697d82019-05-16 18:00:41 +02004535psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004536 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004537 const uint8_t *peer_key,
4538 size_t peer_key_length,
4539 uint8_t *output,
4540 size_t output_size,
4541 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004542{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004544 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004545 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004546
4547 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4548 {
4549 status = PSA_ERROR_INVALID_ARGUMENT;
4550 goto exit;
4551 }
Ronald Cron5c522922020-11-14 16:35:34 +01004552 status = psa_get_and_lock_transparent_key_slot_with_policy(
4553 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004554 if( status != PSA_SUCCESS )
4555 goto exit;
4556
4557 status = psa_key_agreement_raw_internal( alg, slot,
4558 peer_key, peer_key_length,
4559 output, output_size,
4560 output_length );
4561
4562exit:
4563 if( status != PSA_SUCCESS )
4564 {
4565 /* If an error happens and is not handled properly, the output
4566 * may be used as a key to protect sensitive data. Arrange for such
4567 * a key to be random, which is likely to result in decryption or
4568 * verification errors. This is better than filling the buffer with
4569 * some constant data such as zeros, which would result in the data
4570 * being protected with a reproducible, easily knowable key.
4571 */
4572 psa_generate_random( output, output_size );
4573 *output_length = output_size;
4574 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004575
Ronald Cron5c522922020-11-14 16:35:34 +01004576 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004577
Ronald Cron5c522922020-11-14 16:35:34 +01004578 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004579}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004580
4581
Gilles Peskine30524eb2020-11-13 17:02:26 +01004582
Gilles Peskine86a440b2018-11-12 18:39:40 +01004583/****************************************************************/
4584/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004585/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004586
Gilles Peskine30524eb2020-11-13 17:02:26 +01004587/** Initialize the PSA random generator.
4588 */
4589static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4590{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004591#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4592 memset( rng, 0, sizeof( *rng ) );
4593#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4594
Gilles Peskine30524eb2020-11-13 17:02:26 +01004595 /* Set default configuration if
4596 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4597 if( rng->entropy_init == NULL )
4598 rng->entropy_init = mbedtls_entropy_init;
4599 if( rng->entropy_free == NULL )
4600 rng->entropy_free = mbedtls_entropy_free;
4601
4602 rng->entropy_init( &rng->entropy );
4603#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4604 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4605 /* The PSA entropy injection feature depends on using NV seed as an entropy
4606 * source. Add NV seed as an entropy source for PSA entropy injection. */
4607 mbedtls_entropy_add_source( &rng->entropy,
4608 mbedtls_nv_seed_poll, NULL,
4609 MBEDTLS_ENTROPY_BLOCK_SIZE,
4610 MBEDTLS_ENTROPY_SOURCE_STRONG );
4611#endif
4612
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004613 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004614#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004615}
4616
4617/** Deinitialize the PSA random generator.
4618 */
4619static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4620{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004621#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4622 memset( rng, 0, sizeof( *rng ) );
4623#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004624 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004625 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004626#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004627}
4628
4629/** Seed the PSA random generator.
4630 */
4631static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4632{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004633#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4634 /* Do nothing: the external RNG seeds itself. */
4635 (void) rng;
4636 return( PSA_SUCCESS );
4637#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004638 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004639 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4640 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004641 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004642#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004643}
4644
Gilles Peskinee59236f2018-01-27 23:32:46 +01004645psa_status_t psa_generate_random( uint8_t *output,
4646 size_t output_size )
4647{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004648 GUARD_MODULE_INITIALIZED;
4649
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004650#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4651
4652 size_t output_length = 0;
4653 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4654 output, output_size,
4655 &output_length );
4656 if( status != PSA_SUCCESS )
4657 return( status );
4658 /* Breaking up a request into smaller chunks is currently not supported
4659 * for the extrernal RNG interface. */
4660 if( output_length != output_size )
4661 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4662 return( PSA_SUCCESS );
4663
4664#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4665
Gilles Peskine71ddab92021-01-04 21:01:07 +01004666 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004667 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004668 size_t request_size =
4669 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4670 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4671 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004672 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4673 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004674 if( ret != 0 )
4675 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004676 output_size -= request_size;
4677 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004678 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004679 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004680#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004681}
4682
Gilles Peskine8814fc42020-12-14 15:33:44 +01004683/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004684 *
4685 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4686 * `psa_generate_random(...)`. The state parameter is ignored since the
4687 * PSA API doesn't support passing an explicit state.
4688 *
4689 * In the non-external case, psa_generate_random() calls an
4690 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4691 * and semantics as mbedtls_psa_get_random(). As an optimization,
4692 * instead of doing this back-and-forth between the PSA API and the
4693 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4694 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004695 */
4696#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4697int mbedtls_psa_get_random( void *p_rng,
4698 unsigned char *output,
4699 size_t output_size )
4700{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004701 /* This function takes a pointer to the RNG state because that's what
4702 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4703 * its own state internally and doesn't let the caller access that state.
4704 * So we just ignore the state parameter, and in practice we'll pass
4705 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004706 (void) p_rng;
4707 psa_status_t status = psa_generate_random( output, output_size );
4708 if( status == PSA_SUCCESS )
4709 return( 0 );
4710 else
4711 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4712}
4713#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4714
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004715#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004716#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004717
Gilles Peskine7228da22019-07-15 11:06:15 +02004718psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004719 size_t seed_size )
4720{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004721 if( global_data.initialized )
4722 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004723
4724 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4725 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4726 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4727 return( PSA_ERROR_INVALID_ARGUMENT );
4728
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004729 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004730}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004731#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004732
Ronald Cron3772afe2021-02-08 16:10:05 +01004733/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004734 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004735 * \param type The key type
4736 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004737 *
4738 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004739 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004740 * \retval #PSA_ERROR_INVALID_ARGUMENT
4741 * The size in bits of the key is not valid.
4742 * \retval #PSA_ERROR_NOT_SUPPORTED
4743 * The type and/or the size in bits of the key or the combination of
4744 * the two is not supported.
4745 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004746static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4747 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004748{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004749 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004750
Gilles Peskinee59236f2018-01-27 23:32:46 +01004751 if( key_type_is_raw_bytes( type ) )
4752 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004753 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004754 if( status != PSA_SUCCESS )
4755 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004756 }
4757 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004758#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004759 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4760 {
4761 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4762 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004763
Ronald Cron01b2aba2020-10-05 09:42:02 +02004764 /* Accept only byte-aligned keys, for the same reasons as
4765 * in psa_import_rsa_key(). */
4766 if( bits % 8 != 0 )
4767 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004768 }
4769 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004770#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004771
Ronald Cron5c4d3862020-12-07 11:07:24 +01004772#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004773 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4774 {
Ronald Crond81ab562021-02-16 09:01:16 +01004775 /* To avoid empty block, return successfully here. */
4776 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004777 }
4778 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004779#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004780 {
4781 return( PSA_ERROR_NOT_SUPPORTED );
4782 }
4783
4784 return( PSA_SUCCESS );
4785}
4786
Ronald Cron55ed0592020-10-05 10:30:40 +02004787psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004788 const psa_key_attributes_t *attributes,
4789 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004790{
4791 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004792 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004793
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004794 if( ( attributes->domain_parameters == NULL ) &&
4795 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004796 return( PSA_ERROR_INVALID_ARGUMENT );
4797
Ronald Cron01b2aba2020-10-05 09:42:02 +02004798 if( key_type_is_raw_bytes( type ) )
4799 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004800 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004801 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004802 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004803
David Brown12ca5032021-02-11 11:02:00 -07004804#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004805 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004806 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004807#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004808 }
4809 else
4810
Jaeden Amero424fa932021-05-14 08:34:32 +01004811#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4812 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004813 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004814 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004815 return( mbedtls_psa_rsa_generate_key( attributes,
4816 key_buffer,
4817 key_buffer_size,
4818 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004819 }
4820 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004821#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4822 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004823
John Durkop9814fa22020-11-04 12:28:15 -08004824#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004825 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004826 {
Ronald Cron7023db52020-11-20 18:17:42 +01004827 return( mbedtls_psa_ecp_generate_key( attributes,
4828 key_buffer,
4829 key_buffer_size,
4830 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004831 }
4832 else
John Durkop9814fa22020-11-04 12:28:15 -08004833#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004834 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004835 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004836 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004837 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004838
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004839 return( PSA_SUCCESS );
4840}
Darryl Green0c6575a2018-11-07 16:05:30 +00004841
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004842psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004843 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004844{
4845 psa_status_t status;
4846 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004847 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004848 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004849
Ronald Cron81709fc2020-11-14 12:10:32 +01004850 *key = MBEDTLS_SVC_KEY_ID_INIT;
4851
Gilles Peskine0f84d622019-09-12 19:03:13 +02004852 /* Reject any attempt to create a zero-length key so that we don't
4853 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4854 if( psa_get_key_bits( attributes ) == 0 )
4855 return( PSA_ERROR_INVALID_ARGUMENT );
4856
Ronald Cron81709fc2020-11-14 12:10:32 +01004857 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4858 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004859 if( status != PSA_SUCCESS )
4860 goto exit;
4861
Ronald Cron977c2472020-10-13 08:32:21 +02004862 /* In the case of a transparent key or an opaque key stored in local
4863 * storage (thus not in the case of generating a key in a secure element
4864 * or cryptoprocessor with storage), we have to allocate a buffer to
4865 * hold the generated key material. */
4866 if( slot->key.data == NULL )
4867 {
4868 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4869 PSA_KEY_LOCATION_LOCAL_STORAGE )
4870 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004871 status = psa_validate_key_type_and_size_for_key_generation(
4872 attributes->core.type, attributes->core.bits );
4873 if( status != PSA_SUCCESS )
4874 goto exit;
4875
4876 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
4877 attributes->core.type,
4878 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02004879 }
4880 else
4881 {
4882 status = psa_driver_wrapper_get_key_buffer_size(
4883 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01004884 if( status != PSA_SUCCESS )
4885 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02004886 }
Ronald Cron977c2472020-10-13 08:32:21 +02004887
4888 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
4889 if( status != PSA_SUCCESS )
4890 goto exit;
4891 }
4892
Steven Cooreman2a1664c2020-07-20 15:33:08 +02004893 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02004894 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02004895
Ronald Cron2b56bc82020-10-05 10:02:26 +02004896 if( status != PSA_SUCCESS )
4897 psa_remove_key_data_from_memory( slot );
4898
Gilles Peskine11792082019-08-06 18:36:36 +02004899exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004900 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004901 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004902 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004903 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004904
Darryl Green0c6575a2018-11-07 16:05:30 +00004905 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004906}
4907
Gilles Peskinee59236f2018-01-27 23:32:46 +01004908/****************************************************************/
4909/* Module setup */
4910/****************************************************************/
4911
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004912#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01004913psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
4914 void (* entropy_init )( mbedtls_entropy_context *ctx ),
4915 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
4916{
4917 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4918 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004919 global_data.rng.entropy_init = entropy_init;
4920 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01004921 return( PSA_SUCCESS );
4922}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004923#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01004924
Gilles Peskinee59236f2018-01-27 23:32:46 +01004925void mbedtls_psa_crypto_free( void )
4926{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004927 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004928 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4929 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01004930 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004931 }
4932 /* Wipe all remaining data, including configuration.
4933 * In particular, this sets all state indicator to the value
4934 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01004935 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02004936#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02004937 /* Unregister all secure element drivers, so that we restart from
4938 * a pristine state. */
4939 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02004940#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004941}
4942
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004943#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
4944/** Recover a transaction that was interrupted by a power failure.
4945 *
4946 * This function is called during initialization, before psa_crypto_init()
4947 * returns. If this function returns a failure status, the initialization
4948 * fails.
4949 */
4950static psa_status_t psa_crypto_recover_transaction(
4951 const psa_crypto_transaction_t *transaction )
4952{
4953 switch( transaction->unknown.type )
4954 {
4955 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
4956 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01004957 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02004958 * is implemented.
4959 * https://github.com/ARMmbed/mbed-crypto/issues/218
4960 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004961 default:
4962 /* We found an unsupported transaction in the storage.
4963 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01004964 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004965 }
4966}
4967#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
4968
Gilles Peskinee59236f2018-01-27 23:32:46 +01004969psa_status_t psa_crypto_init( void )
4970{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004971 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004972
Gilles Peskinec6b69072018-11-20 21:42:52 +01004973 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004974 if( global_data.initialized != 0 )
4975 return( PSA_SUCCESS );
4976
Gilles Peskine30524eb2020-11-13 17:02:26 +01004977 /* Initialize and seed the random generator. */
4978 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004979 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01004980 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01004981 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004982 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004983 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004984
Gilles Peskine66fb1262018-12-10 16:29:04 +01004985 status = psa_initialize_key_slots( );
4986 if( status != PSA_SUCCESS )
4987 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004988
Gilles Peskined9348f22019-10-01 15:22:29 +02004989#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4990 status = psa_init_all_se_drivers( );
4991 if( status != PSA_SUCCESS )
4992 goto exit;
4993#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
4994
Gilles Peskine4b734222019-07-24 15:56:31 +02004995#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02004996 status = psa_crypto_load_transaction( );
4997 if( status == PSA_SUCCESS )
4998 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004999 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5000 if( status != PSA_SUCCESS )
5001 goto exit;
5002 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005003 }
5004 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5005 {
5006 /* There's no transaction to complete. It's all good. */
5007 status = PSA_SUCCESS;
5008 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005009#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005010
Gilles Peskinec6b69072018-11-20 21:42:52 +01005011 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005012 global_data.initialized = 1;
5013
5014exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005015 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005016 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005017 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005018}
5019
5020#endif /* MBEDTLS_PSA_CRYPTO_C */