blob: fb74a0d852c9e21b122ed72023b41ef30c9c7e33 [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
1022 /*
1023 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001024 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001025 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1026 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001027 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001028 */
Ronald Cron5c522922020-11-14 16:35:34 +01001029 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001030 {
1031#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001032 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001033#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001034 status = PSA_ERROR_CORRUPTION_DETECTED;
1035 }
1036
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001037 /* Multipart operations may still be using the key. This is safe
1038 * because all multipart operation objects are independent from
1039 * the key slot: if they need to access the key after the setup
1040 * phase, they have a copy of the key. Note that this means that
1041 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001042 /* At this point, key material and other type-specific content has
1043 * been wiped. Clear remaining metadata. We can call memset and not
1044 * zeroize because the metadata is not particularly sensitive. */
1045 memset( slot, 0, sizeof( *slot ) );
1046 return( status );
1047}
1048
Ronald Croncf56a0a2020-08-04 09:51:30 +02001049psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001050{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001051 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001052 psa_status_t status; /* status of the last operation */
1053 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001054#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1055 psa_se_drv_table_entry_t *driver;
1056#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001057
Ronald Croncf56a0a2020-08-04 09:51:30 +02001058 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001059 return( PSA_SUCCESS );
1060
Ronald Cronf2911112020-10-29 17:51:10 +01001061 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001062 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001063 * key, this will load the key description from persistent memory if not
1064 * done yet. We cannot avoid this loading as without it we don't know if
1065 * the key is operated by an SE or not and this information is needed by
1066 * the current implementation.
1067 */
Ronald Cron5c522922020-11-14 16:35:34 +01001068 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001069 if( status != PSA_SUCCESS )
1070 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001071
Ronald Cronf2911112020-10-29 17:51:10 +01001072 /*
1073 * If the key slot containing the key description is under access by the
1074 * library (apart from the present access), the key cannot be destroyed
1075 * yet. For the time being, just return in error. Eventually (to be
1076 * implemented), the key should be destroyed when all accesses have
1077 * stopped.
1078 */
Ronald Cron5c522922020-11-14 16:35:34 +01001079 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001080 {
Ronald Cron5c522922020-11-14 16:35:34 +01001081 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001082 return( PSA_ERROR_GENERIC_ERROR );
1083 }
1084
Gilles Peskine354f7672019-07-12 23:46:38 +02001085#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001086 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001087 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001089 /* For a key in a secure element, we need to do three things:
1090 * remove the key file in internal storage, destroy the
1091 * key inside the secure element, and update the driver's
1092 * persistent data. Start a transaction that will encompass these
1093 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001094 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001095 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001096 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001097 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001098 status = psa_crypto_save_transaction( );
1099 if( status != PSA_SUCCESS )
1100 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001101 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001102 /* We should still try to destroy the key in the secure
1103 * element and the key metadata in storage. This is especially
1104 * important if the error is that the storage is full.
1105 * But how to do it exactly without risking an inconsistent
1106 * state after a reset?
1107 * https://github.com/ARMmbed/mbed-crypto/issues/215
1108 */
1109 overall_status = status;
1110 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001111 }
1112
Ronald Cronea0f8a62020-11-25 17:52:23 +01001113 status = psa_destroy_se_key( driver,
1114 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001115 if( overall_status == PSA_SUCCESS )
1116 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001117 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001118#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1119
Darryl Greend49a4992018-06-18 17:27:26 +01001120#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001121 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001122 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123 status = psa_destroy_persistent_key( slot->attr.id );
1124 if( overall_status == PSA_SUCCESS )
1125 overall_status = status;
1126
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001127 /* TODO: other slots may have a copy of the same key. We should
1128 * invalidate them.
1129 * https://github.com/ARMmbed/mbed-crypto/issues/214
1130 */
Darryl Greend49a4992018-06-18 17:27:26 +01001131 }
1132#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001133
Gilles Peskinefc762652019-07-22 19:30:34 +02001134#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1135 if( driver != NULL )
1136 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001137 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001138 if( overall_status == PSA_SUCCESS )
1139 overall_status = status;
1140 status = psa_crypto_stop_transaction( );
1141 if( overall_status == PSA_SUCCESS )
1142 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001143 }
1144#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1145
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001146#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1147exit:
1148#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001149 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001150 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1151 if( overall_status == PSA_SUCCESS )
1152 overall_status = status;
1153 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001154}
1155
John Durkop07cc04a2020-11-16 22:08:34 -08001156#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001157 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001158static psa_status_t psa_get_rsa_public_exponent(
1159 const mbedtls_rsa_context *rsa,
1160 psa_key_attributes_t *attributes )
1161{
1162 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001164 uint8_t *buffer = NULL;
1165 size_t buflen;
1166 mbedtls_mpi_init( &mpi );
1167
1168 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1169 if( ret != 0 )
1170 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001171 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1172 {
1173 /* It's the default value, which is reported as an empty string,
1174 * so there's nothing to do. */
1175 goto exit;
1176 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001177
1178 buflen = mbedtls_mpi_size( &mpi );
1179 buffer = mbedtls_calloc( 1, buflen );
1180 if( buffer == NULL )
1181 {
1182 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1183 goto exit;
1184 }
1185 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1186 if( ret != 0 )
1187 goto exit;
1188 attributes->domain_parameters = buffer;
1189 attributes->domain_parameters_size = buflen;
1190
1191exit:
1192 mbedtls_mpi_free( &mpi );
1193 if( ret != 0 )
1194 mbedtls_free( buffer );
1195 return( mbedtls_to_psa_error( ret ) );
1196}
John Durkop07cc04a2020-11-16 22:08:34 -08001197#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001198 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001200/** Retrieve all the publicly-accessible attributes of a key.
1201 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001202psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001203 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001204{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001206 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001207 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001208
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001209 psa_reset_key_attributes( attributes );
1210
Ronald Cron5c522922020-11-14 16:35:34 +01001211 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001212 if( status != PSA_SUCCESS )
1213 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001214
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001215 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001216 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1217 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1218
1219#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1220 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001221 psa_set_key_slot_number( attributes,
1222 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001223#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001224
Gilles Peskine8e338702019-07-30 20:06:31 +02001225 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001226 {
John Durkop07cc04a2020-11-16 22:08:34 -08001227#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001228 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001229 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001230 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001231#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001232 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001233 * is not yet implemented.
1234 * https://github.com/ARMmbed/mbed-crypto/issues/216
1235 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001236 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001237 break;
1238#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001239 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001240 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001241
Ronald Cron90857082020-11-25 14:58:33 +01001242 status = mbedtls_psa_rsa_load_representation(
1243 slot->attr.type,
1244 slot->key.data,
1245 slot->key.bytes,
1246 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001247 if( status != PSA_SUCCESS )
1248 break;
1249
Steven Cooremana2371e52020-07-28 14:30:39 +02001250 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001251 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001252 mbedtls_rsa_free( rsa );
1253 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001254 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001255 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001256#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001257 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001258 default:
1259 /* Nothing else to do. */
1260 break;
1261 }
1262
1263 if( status != PSA_SUCCESS )
1264 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001265
Ronald Cron5c522922020-11-14 16:35:34 +01001266 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001267
Ronald Cron5c522922020-11-14 16:35:34 +01001268 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001269}
1270
Gilles Peskinec8000c02019-08-02 20:15:51 +02001271#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1272psa_status_t psa_get_key_slot_number(
1273 const psa_key_attributes_t *attributes,
1274 psa_key_slot_number_t *slot_number )
1275{
1276 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1277 {
1278 *slot_number = attributes->slot_number;
1279 return( PSA_SUCCESS );
1280 }
1281 else
1282 return( PSA_ERROR_INVALID_ARGUMENT );
1283}
1284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1285
Ronald Crond18b5f82020-11-25 16:46:05 +01001286static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1287 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001288 uint8_t *data,
1289 size_t data_size,
1290 size_t *data_length )
1291{
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001293 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001294 memcpy( data, key_buffer, key_buffer_size );
1295 memset( data + key_buffer_size, 0,
1296 data_size - key_buffer_size );
1297 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001298 return( PSA_SUCCESS );
1299}
1300
Ronald Cron7285cda2020-11-26 14:46:37 +01001301psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001302 const psa_key_attributes_t *attributes,
1303 const uint8_t *key_buffer, size_t key_buffer_size,
1304 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001305{
Ronald Crond18b5f82020-11-25 16:46:05 +01001306 psa_key_type_t type = attributes->core.type;
1307
Ronald Crond18b5f82020-11-25 16:46:05 +01001308 if( key_type_is_raw_bytes( type ) ||
1309 PSA_KEY_TYPE_IS_RSA( type ) ||
1310 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001311 {
1312 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001313 key_buffer, key_buffer_size,
1314 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001315 }
1316 else
1317 {
1318 /* This shouldn't happen in the reference implementation, but
1319 it is valid for a special-purpose implementation to omit
1320 support for exporting certain key types. */
1321 return( PSA_ERROR_NOT_SUPPORTED );
1322 }
1323}
1324
1325psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1326 uint8_t *data,
1327 size_t data_size,
1328 size_t *data_length )
1329{
1330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1331 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1332 psa_key_slot_t *slot;
1333
Ronald Crone907e552021-01-18 13:22:38 +01001334 /* Reject a zero-length output buffer now, since this can never be a
1335 * valid key representation. This way we know that data must be a valid
1336 * pointer and we can do things like memset(data, ..., data_size). */
1337 if( data_size == 0 )
1338 return( PSA_ERROR_BUFFER_TOO_SMALL );
1339
Ronald Cron9486f9d2020-11-26 13:36:23 +01001340 /* Set the key to empty now, so that even when there are errors, we always
1341 * set data_length to a value between 0 and data_size. On error, setting
1342 * the key to empty is a good choice because an empty key representation is
1343 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001344 *data_length = 0;
1345
Ronald Cron9486f9d2020-11-26 13:36:23 +01001346 /* Export requires the EXPORT flag. There is an exception for public keys,
1347 * which don't require any flag, but
1348 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1349 */
1350 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1351 PSA_KEY_USAGE_EXPORT, 0 );
1352 if( status != PSA_SUCCESS )
1353 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001354
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 psa_key_attributes_t attributes = {
1356 .core = slot->attr
1357 };
Ronald Cron67227982020-11-26 15:16:05 +01001358 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 slot->key.data, slot->key.bytes,
1360 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001361
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362 unlock_status = psa_unlock_key_slot( slot );
1363
1364 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1365}
1366
Ronald Cron7285cda2020-11-26 14:46:37 +01001367psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 const psa_key_attributes_t *attributes,
1369 const uint8_t *key_buffer,
1370 size_t key_buffer_size,
1371 uint8_t *data,
1372 size_t data_size,
1373 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374{
Ronald Crond18b5f82020-11-25 16:46:05 +01001375 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001376
Ronald Crond18b5f82020-11-25 16:46:05 +01001377 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001378 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001379 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001380 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001381 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001382 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001383 key_buffer, key_buffer_size,
1384 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001385 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001386
Ronald Crond18b5f82020-11-25 16:46:05 +01001387 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001388 {
John Durkop0e005192020-10-31 22:06:54 -07001389#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1390 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001391 return( mbedtls_psa_rsa_export_public_key( attributes,
1392 key_buffer,
1393 key_buffer_size,
1394 data,
1395 data_size,
1396 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001397#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001398 /* We don't know how to convert a private RSA key to public. */
1399 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001400#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1401 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001402 }
1403 else
Moran Pekera998bc62018-04-16 18:16:20 +03001404 {
John Durkop6ba40d12020-11-10 08:50:04 -08001405#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1406 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001407 return( mbedtls_psa_ecp_export_public_key( attributes,
1408 key_buffer,
1409 key_buffer_size,
1410 data,
1411 data_size,
1412 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001413#else
1414 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001415 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001416#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1417 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001418 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001419 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001420 else
1421 {
1422 /* This shouldn't happen in the reference implementation, but
1423 it is valid for a special-purpose implementation to omit
1424 support for exporting certain key types. */
1425 return( PSA_ERROR_NOT_SUPPORTED );
1426 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001427}
Ronald Crond18b5f82020-11-25 16:46:05 +01001428
Ronald Croncf56a0a2020-08-04 09:51:30 +02001429psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001430 uint8_t *data,
1431 size_t data_size,
1432 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001433{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001435 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001436 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001437
Ronald Crone907e552021-01-18 13:22:38 +01001438 /* Reject a zero-length output buffer now, since this can never be a
1439 * valid key representation. This way we know that data must be a valid
1440 * pointer and we can do things like memset(data, ..., data_size). */
1441 if( data_size == 0 )
1442 return( PSA_ERROR_BUFFER_TOO_SMALL );
1443
Darryl Greendd8fb772018-11-07 16:00:44 +00001444 /* Set the key to empty now, so that even when there are errors, we always
1445 * set data_length to a value between 0 and data_size. On error, setting
1446 * the key to empty is a good choice because an empty key representation is
1447 * unlikely to be accepted anywhere. */
1448 *data_length = 0;
1449
1450 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001451 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001452 if( status != PSA_SUCCESS )
1453 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001454
Ronald Cron9486f9d2020-11-26 13:36:23 +01001455 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1456 {
1457 status = PSA_ERROR_INVALID_ARGUMENT;
1458 goto exit;
1459 }
1460
Ronald Crond18b5f82020-11-25 16:46:05 +01001461 psa_key_attributes_t attributes = {
1462 .core = slot->attr
1463 };
Ronald Cron67227982020-11-26 15:16:05 +01001464 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001465 &attributes, slot->key.data, slot->key.bytes,
1466 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001467
1468exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001469 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001470
Ronald Cron5c522922020-11-14 16:35:34 +01001471 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001472}
1473
Gilles Peskine91e8c332019-08-02 19:19:39 +02001474#if defined(static_assert)
1475static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1476 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001477static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001478 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001479static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001480 "One or more key attribute flag is listed as both internal-only and external-only" );
1481#endif
1482
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001483/** Validate that a key policy is internally well-formed.
1484 *
1485 * This function only rejects invalid policies. It does not validate the
1486 * consistency of the policy with respect to other attributes of the key
1487 * such as the key type.
1488 */
1489static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001490{
1491 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001492 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001493 PSA_KEY_USAGE_ENCRYPT |
1494 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001495 PSA_KEY_USAGE_SIGN_HASH |
1496 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001497 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001498 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1499 return( PSA_ERROR_INVALID_ARGUMENT );
1500
Gilles Peskine4747d192019-04-17 15:05:45 +02001501 return( PSA_SUCCESS );
1502}
1503
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001504/** Validate the internal consistency of key attributes.
1505 *
1506 * This function only rejects invalid attribute values. If does not
1507 * validate the consistency of the attributes with any key data that may
1508 * be involved in the creation of the key.
1509 *
1510 * Call this function early in the key creation process.
1511 *
1512 * \param[in] attributes Key attributes for the new key.
1513 * \param[out] p_drv On any return, the driver for the key, if any.
1514 * NULL for a transparent key.
1515 *
1516 */
1517static psa_status_t psa_validate_key_attributes(
1518 const psa_key_attributes_t *attributes,
1519 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001520{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001521 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001522 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001523 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001524
Ronald Cron54b90082020-10-29 15:26:43 +01001525 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001526 if( status != PSA_SUCCESS )
1527 return( status );
1528
Ronald Crond2ed4812020-07-17 16:11:30 +02001529 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001530 if( status != PSA_SUCCESS )
1531 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001532
Ronald Cron65f38a32020-10-23 17:11:13 +02001533 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1534 {
1535 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1536 return( PSA_ERROR_INVALID_ARGUMENT );
1537 }
1538 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001539 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001540 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1541 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001542 }
1543
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001544 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001545 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001546 return( status );
1547
1548 /* Refuse to create overly large keys.
1549 * Note that this doesn't trigger on import if the attributes don't
1550 * explicitly specify a size (so psa_get_key_bits returns 0), so
1551 * psa_import_key() needs its own checks. */
1552 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1553 return( PSA_ERROR_NOT_SUPPORTED );
1554
Gilles Peskine91e8c332019-08-02 19:19:39 +02001555 /* Reject invalid flags. These should not be reachable through the API. */
1556 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1557 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1558 return( PSA_ERROR_INVALID_ARGUMENT );
1559
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001560 return( PSA_SUCCESS );
1561}
1562
Gilles Peskine4747d192019-04-17 15:05:45 +02001563/** Prepare a key slot to receive key material.
1564 *
1565 * This function allocates a key slot and sets its metadata.
1566 *
1567 * If this function fails, call psa_fail_key_creation().
1568 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001569 * This function is intended to be used as follows:
1570 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001571 * it with the specified attributes, and in case of a volatile key assign it
1572 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001573 * -# Populate the slot with the key material.
1574 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1575 * In case of failure at any step, stop the sequence and call
1576 * psa_fail_key_creation().
1577 *
Ronald Cron5c522922020-11-14 16:35:34 +01001578 * On success, the key slot is locked. It is the responsibility of the caller
1579 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001580 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001581 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001582 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001583 * \param[out] p_slot On success, a pointer to the prepared slot.
1584 * \param[out] p_drv On any return, the driver for the key, if any.
1585 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001586 *
1587 * \retval #PSA_SUCCESS
1588 * The key slot is ready to receive key material.
1589 * \return If this function fails, the key slot is an invalid state.
1590 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001591 */
1592static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001593 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001594 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001595 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001596 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001597{
1598 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001599 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001600 psa_key_slot_t *slot;
1601
Gilles Peskinedf179142019-07-15 22:02:14 +02001602 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001603 *p_drv = NULL;
1604
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001605 status = psa_validate_key_attributes( attributes, p_drv );
1606 if( status != PSA_SUCCESS )
1607 return( status );
1608
Ronald Cronc4d1b512020-07-31 11:26:37 +02001609 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001610 if( status != PSA_SUCCESS )
1611 return( status );
1612 slot = *p_slot;
1613
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001614 /* We're storing the declared bit-size of the key. It's up to each
1615 * creation mechanism to verify that this information is correct.
1616 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001617 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001618 * is optional (import, copy). In case of a volatile key, assign it the
1619 * volatile key identifier associated to the slot returned to contain its
1620 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001621
1622 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001623 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1624 {
1625#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1626 slot->attr.id = volatile_key_id;
1627#else
1628 slot->attr.id.key_id = volatile_key_id;
1629#endif
1630 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001631
Gilles Peskine91e8c332019-08-02 19:19:39 +02001632 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001633 * external-only flags, query `attributes`. Thanks to the check
1634 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001635 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001636 * may have set. */
1637 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001638
Gilles Peskinecbaff462019-07-12 23:46:04 +02001639#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001640 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001641 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001642 * create the key file in internal storage, create the
1643 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644 * persistent data. This is done by starting a transaction that will
1645 * encompass these three actions.
1646 * For registering a volatile key, we just need to find an appropriate
1647 * slot number inside the SE. Since the key is designated volatile, creating
1648 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001649 /* The first thing to do is to find a slot number for the new key.
1650 * We save the slot number in persistent storage as part of the
1651 * transaction data. It will be needed to recover if the power
1652 * fails during the key creation process, to clean up on the secure
1653 * element side after restarting. Obtaining a slot number from the
1654 * secure element driver updates its persistent state, but we do not yet
1655 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001656 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001657 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001658 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001659 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001660 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001662 if( status != PSA_SUCCESS )
1663 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001664
1665 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001666 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001667 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1668 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001669 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001670 psa_crypto_transaction.key.id = slot->attr.id;
1671 status = psa_crypto_save_transaction( );
1672 if( status != PSA_SUCCESS )
1673 {
1674 (void) psa_crypto_stop_transaction( );
1675 return( status );
1676 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001677 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001678
1679 status = psa_copy_key_material_into_slot(
1680 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001681 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001682
1683 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1684 {
1685 /* Key registration only makes sense with a secure element. */
1686 return( PSA_ERROR_INVALID_ARGUMENT );
1687 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001688#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1689
Ronald Cronc4d1b512020-07-31 11:26:37 +02001690 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001691}
Gilles Peskine4747d192019-04-17 15:05:45 +02001692
1693/** Finalize the creation of a key once its key material has been set.
1694 *
1695 * This entails writing the key to persistent storage.
1696 *
1697 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001698 * See the documentation of psa_start_key_creation() for the intended use
1699 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001700 *
Ronald Cron5c522922020-11-14 16:35:34 +01001701 * If the finalization succeeds, the function unlocks the key slot (it was
1702 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1703 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001704 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001705 * \param[in,out] slot Pointer to the slot with key material.
1706 * \param[in] driver The secure element driver for the key,
1707 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001708 * \param[out] key On success, identifier of the key. Note that the
1709 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001710 *
1711 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001712 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001713 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1714 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1715 * \retval #PSA_ERROR_ALREADY_EXISTS
1716 * \retval #PSA_ERROR_DATA_INVALID
1717 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001718 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001719 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001720 * \return If this function fails, the key slot is an invalid state.
1721 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001722 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001723static psa_status_t psa_finish_key_creation(
1724 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001725 psa_se_drv_table_entry_t *driver,
1726 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001727{
1728 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001729 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001730 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001731
1732#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001733 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001734 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001735#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1736 if( driver != NULL )
1737 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001738 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 psa_key_slot_number_t slot_number =
1740 psa_key_slot_get_slot_number( slot ) ;
1741
Gilles Peskineb46bef22019-07-30 21:32:04 +02001742#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001743 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001744 sizeof( data.slot_number ),
1745 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001746#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001747 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001748 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001749 (uint8_t*) &data,
1750 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001751 }
1752 else
1753#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1754 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001755 /* Key material is saved in export representation in the slot, so
1756 * just pass the slot buffer for storage. */
1757 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001758 slot->key.data,
1759 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001760 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001761 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001762#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1763
Gilles Peskinecbaff462019-07-12 23:46:04 +02001764#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001765 /* Finish the transaction for a key creation. This does not
1766 * happen when registering an existing key. Detect this case
1767 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001768 * creation of a persistent key in a secure element requires a transaction,
1769 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001770 if( driver != NULL &&
1771 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001772 {
1773 status = psa_save_se_persistent_data( driver );
1774 if( status != PSA_SUCCESS )
1775 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001776 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001777 return( status );
1778 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001779 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001780 }
1781#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1782
Ronald Cron50972942020-11-14 11:28:25 +01001783 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001784 {
1785 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001786 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001787 if( status != PSA_SUCCESS )
1788 *key = MBEDTLS_SVC_KEY_ID_INIT;
1789 }
Ronald Cron50972942020-11-14 11:28:25 +01001790
Gilles Peskine4747d192019-04-17 15:05:45 +02001791 return( status );
1792}
1793
1794/** Abort the creation of a key.
1795 *
1796 * You may call this function after calling psa_start_key_creation(),
1797 * or after psa_finish_key_creation() fails. In other circumstances, this
1798 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001799 * See the documentation of psa_start_key_creation() for the intended use
1800 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001801 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001802 * \param[in,out] slot Pointer to the slot with key material.
1803 * \param[in] driver The secure element driver for the key,
1804 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001805 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001806static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001807 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001808{
Gilles Peskine011e4282019-06-26 18:34:38 +02001809 (void) driver;
1810
Gilles Peskine4747d192019-04-17 15:05:45 +02001811 if( slot == NULL )
1812 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001813
1814#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001815 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001816 * element, and the failure happened later (when saving metadata
1817 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001818 * element.
1819 * https://github.com/ARMmbed/mbed-crypto/issues/217
1820 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001821
Gilles Peskined7729582019-08-05 15:55:54 +02001822 /* Abort the ongoing transaction if any (there may not be one if
1823 * the creation process failed before starting one, or if the
1824 * key creation is a registration of a key in a secure element).
1825 * Earlier functions must already have done what it takes to undo any
1826 * partial creation. All that's left is to update the transaction data
1827 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001828 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001829#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1830
Gilles Peskine4747d192019-04-17 15:05:45 +02001831 psa_wipe_key_slot( slot );
1832}
1833
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001834/** Validate optional attributes during key creation.
1835 *
1836 * Some key attributes are optional during key creation. If they are
1837 * specified in the attributes structure, check that they are consistent
1838 * with the data in the slot.
1839 *
1840 * This function should be called near the end of key creation, after
1841 * the slot in memory is fully populated but before saving persistent data.
1842 */
1843static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844 const psa_key_slot_t *slot,
1845 const psa_key_attributes_t *attributes )
1846{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001847 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001849 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 return( PSA_ERROR_INVALID_ARGUMENT );
1851 }
1852
1853 if( attributes->domain_parameters_size != 0 )
1854 {
John Durkop0e005192020-10-31 22:06:54 -07001855#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1856 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001857 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001858 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001859 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001860 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001862
Ronald Cron90857082020-11-25 14:58:33 +01001863 psa_status_t status = mbedtls_psa_rsa_load_representation(
1864 slot->attr.type,
1865 slot->key.data,
1866 slot->key.bytes,
1867 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001868 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001869 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001870
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 mbedtls_mpi_init( &actual );
1872 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001873 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001874 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001875 mbedtls_rsa_free( rsa );
1876 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 if( ret != 0 )
1878 goto rsa_exit;
1879 ret = mbedtls_mpi_read_binary( &required,
1880 attributes->domain_parameters,
1881 attributes->domain_parameters_size );
1882 if( ret != 0 )
1883 goto rsa_exit;
1884 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1885 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1886 rsa_exit:
1887 mbedtls_mpi_free( &actual );
1888 mbedtls_mpi_free( &required );
1889 if( ret != 0)
1890 return( mbedtls_to_psa_error( ret ) );
1891 }
1892 else
John Durkop9814fa22020-11-04 12:28:15 -08001893#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1894 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 {
1896 return( PSA_ERROR_INVALID_ARGUMENT );
1897 }
1898 }
1899
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001900 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001902 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 return( PSA_ERROR_INVALID_ARGUMENT );
1904 }
1905
1906 return( PSA_SUCCESS );
1907}
1908
Gilles Peskine4747d192019-04-17 15:05:45 +02001909psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001910 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001911 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001912 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001913{
1914 psa_status_t status;
1915 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001916 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001917 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001918
Ronald Cron81709fc2020-11-14 12:10:32 +01001919 *key = MBEDTLS_SVC_KEY_ID_INIT;
1920
Gilles Peskine0f84d622019-09-12 19:03:13 +02001921 /* Reject zero-length symmetric keys (including raw data key objects).
1922 * This also rejects any key which might be encoded as an empty string,
1923 * which is never valid. */
1924 if( data_length == 0 )
1925 return( PSA_ERROR_INVALID_ARGUMENT );
1926
Gilles Peskinedf179142019-07-15 22:02:14 +02001927 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001928 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001929 if( status != PSA_SUCCESS )
1930 goto exit;
1931
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001932 /* In the case of a transparent key or an opaque key stored in local
1933 * storage (thus not in the case of generating a key in a secure element
1934 * or cryptoprocessor with storage), we have to allocate a buffer to
1935 * hold the generated key material. */
1936 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001937 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001938 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001939 if( status != PSA_SUCCESS )
1940 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001941 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001942
1943 bits = slot->attr.bits;
1944 status = psa_driver_wrapper_import_key( attributes,
1945 data, data_length,
1946 slot->key.data,
1947 slot->key.bytes,
1948 &slot->key.bytes, &bits );
1949 if( status != PSA_SUCCESS )
1950 goto exit;
1951
1952 if( slot->attr.bits == 0 )
1953 slot->attr.bits = (psa_key_bits_t) bits;
1954 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001955 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001956 status = PSA_ERROR_INVALID_ARGUMENT;
1957 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001958 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001959
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001960 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001961 if( status != PSA_SUCCESS )
1962 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001963
Ronald Cron81709fc2020-11-14 12:10:32 +01001964 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001965exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001966 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001967 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001968
Gilles Peskine4747d192019-04-17 15:05:45 +02001969 return( status );
1970}
1971
Gilles Peskined7729582019-08-05 15:55:54 +02001972#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1973psa_status_t mbedtls_psa_register_se_key(
1974 const psa_key_attributes_t *attributes )
1975{
1976 psa_status_t status;
1977 psa_key_slot_t *slot = NULL;
1978 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001979 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001980
1981 /* Leaving attributes unspecified is not currently supported.
1982 * It could make sense to query the key type and size from the
1983 * secure element, but not all secure elements support this
1984 * and the driver HAL doesn't currently support it. */
1985 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1986 return( PSA_ERROR_NOT_SUPPORTED );
1987 if( psa_get_key_bits( attributes ) == 0 )
1988 return( PSA_ERROR_NOT_SUPPORTED );
1989
1990 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001991 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001992 if( status != PSA_SUCCESS )
1993 goto exit;
1994
Ronald Cron81709fc2020-11-14 12:10:32 +01001995 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001996
1997exit:
1998 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001999 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002000
Gilles Peskined7729582019-08-05 15:55:54 +02002001 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002003 return( status );
2004}
2005#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2006
Gilles Peskinef603c712019-01-19 13:40:11 +01002007static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002008 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002009{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002010 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002011 source->key.data,
2012 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002013 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002014 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002015
Steven Cooreman398aee52020-10-13 14:35:45 +02002016 target->attr.type = source->attr.type;
2017 target->attr.bits = source->attr.bits;
2018
2019 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002020}
2021
Ronald Croncf56a0a2020-08-04 09:51:30 +02002022psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002023 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002024 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002025{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002028 psa_key_slot_t *source_slot = NULL;
2029 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002031 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002032
Ronald Cron81709fc2020-11-14 12:10:32 +01002033 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2034
Ronald Cron5c522922020-11-14 16:35:34 +01002035 status = psa_get_and_lock_transparent_key_slot_with_policy(
2036 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002037 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002038 goto exit;
2039
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002040 status = psa_validate_optional_attributes( source_slot,
2041 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002042 if( status != PSA_SUCCESS )
2043 goto exit;
2044
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002045 status = psa_restrict_key_policy( source_slot->attr.type,
2046 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002047 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002048 if( status != PSA_SUCCESS )
2049 goto exit;
2050
Ronald Cron81709fc2020-11-14 12:10:32 +01002051 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2052 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002053 if( status != PSA_SUCCESS )
2054 goto exit;
2055
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002056#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2057 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002058 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002059 /* Copying to a secure element is not implemented yet. */
2060 status = PSA_ERROR_NOT_SUPPORTED;
2061 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002062 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002063#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002064
Ronald Cron6cc66312021-04-02 12:27:47 +02002065 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2066 {
2067 /*
2068 * Copying through an opaque driver is not implemented yet, consider
2069 * a lifetime with an external location as an invalid parameter for
2070 * now.
2071 */
2072 status = PSA_ERROR_INVALID_ARGUMENT;
2073 goto exit;
2074 }
2075
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002076 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002077 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002078 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002079
Ronald Cron81709fc2020-11-14 12:10:32 +01002080 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002081exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002082 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002083 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002084
Ronald Cron5c522922020-11-14 16:35:34 +01002085 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002086
Ronald Cron5c522922020-11-14 16:35:34 +01002087 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002088}
2089
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002090
2091
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002092/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002093/* Message digests */
2094/****************************************************************/
2095
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002096psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2097{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002098 /* Aborting a non-active operation is allowed */
2099 if( operation->id == 0 )
2100 return( PSA_SUCCESS );
2101
2102 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2103 operation->id = 0;
2104
2105 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002106}
2107
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002108psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002109 psa_algorithm_t alg )
2110{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002111 /* A context must be freshly initialized before it can be set up. */
2112 if( operation->id != 0 )
2113 return( PSA_ERROR_BAD_STATE );
2114
2115 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002116 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002117
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002118 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2119 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002120 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2121
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002122 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002123}
2124
2125psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2126 const uint8_t *input,
2127 size_t input_length )
2128{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129 if( operation->id == 0 )
2130 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002131
Steven Cooremanc8288352021-03-04 14:02:19 +01002132 /* Don't require hash implementations to behave correctly on a
2133 * zero-length input, which may have an invalid pointer. */
2134 if( input_length == 0 )
2135 return( PSA_SUCCESS );
2136
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002137 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2138 input, input_length );
2139 if( status != PSA_SUCCESS )
2140 psa_hash_abort( operation );
2141
2142 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002143}
2144
2145psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2146 uint8_t *hash,
2147 size_t hash_size,
2148 size_t *hash_length )
2149{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002150 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002151 if( operation->id == 0 )
2152 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002153
Steven Cooreman1e582352021-02-18 17:24:37 +01002154 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002156 psa_hash_abort( operation );
2157 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002158}
2159
Gilles Peskine2d277862018-06-18 15:41:12 +02002160psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2161 const uint8_t *hash,
2162 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002163{
2164 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2165 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002166 psa_status_t status = psa_hash_finish(
2167 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002168 actual_hash, sizeof( actual_hash ),
2169 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170 if( status != PSA_SUCCESS )
2171 return( status );
2172 if( actual_hash_length != hash_length )
2173 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002174 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175 return( PSA_ERROR_INVALID_SIGNATURE );
2176 return( PSA_SUCCESS );
2177}
2178
Gilles Peskine0a749c82019-11-28 19:33:58 +01002179psa_status_t psa_hash_compute( psa_algorithm_t alg,
2180 const uint8_t *input, size_t input_length,
2181 uint8_t *hash, size_t hash_size,
2182 size_t *hash_length )
2183{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002184 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002185 if( !PSA_ALG_IS_HASH( alg ) )
2186 return( PSA_ERROR_INVALID_ARGUMENT );
2187
Steven Cooreman1e582352021-02-18 17:24:37 +01002188 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2189 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002190}
2191
2192psa_status_t psa_hash_compare( psa_algorithm_t alg,
2193 const uint8_t *input, size_t input_length,
2194 const uint8_t *hash, size_t hash_length )
2195{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002196 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2197 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002198
2199 if( !PSA_ALG_IS_HASH( alg ) )
2200 return( PSA_ERROR_INVALID_ARGUMENT );
2201
Steven Cooreman1e582352021-02-18 17:24:37 +01002202 psa_status_t status = psa_driver_wrapper_hash_compute(
2203 alg, input, input_length,
2204 actual_hash, sizeof(actual_hash),
2205 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002206 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002207 return( status );
2208 if( actual_hash_length != hash_length )
2209 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002210 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002211 return( PSA_ERROR_INVALID_SIGNATURE );
2212 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002213}
2214
Gilles Peskineeb35d782019-01-22 17:56:16 +01002215psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2216 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002217{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002218 if( source_operation->id == 0 ||
2219 target_operation->id != 0 )
2220 {
2221 return( PSA_ERROR_BAD_STATE );
2222 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002223
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002224 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2225 target_operation );
2226 if( status != PSA_SUCCESS )
2227 psa_hash_abort( target_operation );
2228
2229 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002230}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002231
2232
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002234/* MAC */
2235/****************************************************************/
2236
Steven Cooremane6804192021-03-19 18:28:56 +01002237psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002238{
Steven Cooremane6804192021-03-19 18:28:56 +01002239 /* Aborting a non-active operation is allowed */
2240 if( operation->id == 0 )
2241 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002242
Steven Cooremane6804192021-03-19 18:28:56 +01002243 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002244 operation->mac_size = 0;
2245 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002246 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002247
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002248 return( status );
2249}
2250
Steven Cooremane6804192021-03-19 18:28:56 +01002251static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002252 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002253 psa_algorithm_t alg,
2254 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002255{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002257 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002258 psa_key_slot_t *slot;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002259
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002260 /* A context must be freshly initialized before it can be set up. */
Steven Cooremane6804192021-03-19 18:28:56 +01002261 if( operation->id != 0 )
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002262 return( PSA_ERROR_BAD_STATE );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002263
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002264 if( ! PSA_ALG_IS_MAC( alg ) )
2265 return( PSA_ERROR_INVALID_ARGUMENT );
2266
Steven Cooremane6804192021-03-19 18:28:56 +01002267 status = psa_get_and_lock_key_slot_with_policy(
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002268 key,
2269 &slot,
2270 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2271 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002272 if( status != PSA_SUCCESS )
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002273 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002274
Steven Cooremane6804192021-03-19 18:28:56 +01002275 psa_key_attributes_t attributes = {
2276 .core = slot->attr
2277 };
2278
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002279 /* Validate the combination of key type and algorithm */
Steven Cooremane6804192021-03-19 18:28:56 +01002280 status = psa_mac_key_can_do( alg, psa_get_key_type( &attributes ) );
Steven Cooreman15472f82021-03-02 16:16:22 +01002281 if( status != PSA_SUCCESS )
2282 goto exit;
2283
Steven Cooreman72f736a2021-05-07 14:14:37 +02002284 operation->is_sign = is_sign;
2285
Steven Cooremand1a68f12021-05-10 11:13:41 +02002286 /* Get the output length for the algorithm and key combination */
Steven Cooreman72f736a2021-05-07 14:14:37 +02002287 operation->mac_size = PSA_MAC_LENGTH(
Steven Cooremand1a68f12021-05-10 11:13:41 +02002288 psa_get_key_type( &attributes ),
2289 psa_get_key_bits( &attributes ),
2290 alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002291
Steven Cooreman72f736a2021-05-07 14:14:37 +02002292 if( operation->mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002293 {
2294 /* A very short MAC is too short for security since it can be
2295 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2296 * so we make this our minimum, even though 32 bits is still
2297 * too small for security. */
2298 status = PSA_ERROR_NOT_SUPPORTED;
2299 goto exit;
2300 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002301
Steven Cooreman72f736a2021-05-07 14:14:37 +02002302 if( operation->mac_size > PSA_MAC_LENGTH( psa_get_key_type( &attributes ),
Steven Cooremand1a68f12021-05-10 11:13:41 +02002303 psa_get_key_bits( &attributes ),
Steven Cooreman72f736a2021-05-07 14:14:37 +02002304 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002305 {
2306 /* It's impossible to "truncate" to a larger length than the full length
2307 * of the algorithm. */
2308 status = PSA_ERROR_INVALID_ARGUMENT;
2309 goto exit;
2310 }
2311
Steven Cooremane6804192021-03-19 18:28:56 +01002312 /* Dispatch the MAC setup call with validated input */
2313 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002314 {
Steven Cooremane6804192021-03-19 18:28:56 +01002315 status = psa_driver_wrapper_mac_sign_setup( operation,
2316 &attributes,
2317 slot->key.data,
2318 slot->key.bytes,
2319 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002320 }
2321 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002322 {
Steven Cooremane6804192021-03-19 18:28:56 +01002323 status = psa_driver_wrapper_mac_verify_setup( operation,
2324 &attributes,
2325 slot->key.data,
2326 slot->key.bytes,
2327 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002328 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002329
Gilles Peskinefbfac682018-07-08 20:51:54 +02002330exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002331 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002332 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002333
Ronald Cron5c522922020-11-14 16:35:34 +01002334 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002335
Ronald Cron5c522922020-11-14 16:35:34 +01002336 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002337}
2338
Gilles Peskine89167cb2018-07-08 20:12:23 +02002339psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002340 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341 psa_algorithm_t alg )
2342{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002343 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002344}
2345
2346psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002347 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002348 psa_algorithm_t alg )
2349{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002350 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002351}
2352
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002353psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354 const uint8_t *input,
2355 size_t input_length )
2356{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002357 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002358 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002360 /* Don't require hash implementations to behave correctly on a
2361 * zero-length input, which may have an invalid pointer. */
2362 if( input_length == 0 )
2363 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002364
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002365 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2366 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002367 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002368 psa_mac_abort( operation );
2369
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002370 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002371}
2372
Steven Cooremana5b860a2021-03-19 19:04:39 +01002373psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002374 uint8_t *mac,
2375 size_t mac_size,
2376 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002377{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2379 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002380
Steven Cooreman72f736a2021-05-07 14:14:37 +02002381 /* Set the output length and content to a safe default, such that in
2382 * case the caller misses an error check, the output would be an
2383 * unachievable MAC. */
2384 *mac_length = mac_size;
2385
Steven Cooremana5b860a2021-03-19 19:04:39 +01002386 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002387 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002388
Steven Cooreman72f736a2021-05-07 14:14:37 +02002389 if( ! operation->is_sign )
2390 return( PSA_ERROR_BAD_STATE );
2391
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002392 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2393 * once all the error checks are done. */
2394 if( operation->mac_size == 0 )
2395 return( PSA_ERROR_BAD_STATE );
2396
2397 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002398 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002399
Steven Cooremana5b860a2021-03-19 19:04:39 +01002400 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002401 mac, operation->mac_size,
2402 mac_length );
2403
2404 if( status == PSA_SUCCESS )
2405 {
2406 /* Set the excess room in the output buffer to an invalid value, to
2407 * avoid potentially leaking a longer MAC. */
2408 if( mac_size > operation->mac_size )
2409 memset( &mac[operation->mac_size],
2410 '!',
2411 mac_size - operation->mac_size );
2412 }
2413 else
2414 {
2415 /* Set the output length and content to a safe default, such that in
2416 * case the caller misses an error check, the output would be an
2417 * unachievable MAC. */
2418 *mac_length = mac_size;
2419 memset( mac, '!', mac_size );
2420 }
mohammad16036df908f2018-04-02 08:34:15 -07002421
Steven Cooremana5b860a2021-03-19 19:04:39 +01002422 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002423
Steven Cooremana5b860a2021-03-19 19:04:39 +01002424 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002425}
2426
Steven Cooremana5b860a2021-03-19 19:04:39 +01002427psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002428 const uint8_t *mac,
2429 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002430{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2432 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002435 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002436
Steven Cooreman72f736a2021-05-07 14:14:37 +02002437 if( operation->is_sign )
2438 return( PSA_ERROR_BAD_STATE );
2439
2440 if( operation->mac_size != mac_length )
2441 {
2442 status = PSA_ERROR_INVALID_SIGNATURE;
2443 goto cleanup;
2444 }
2445
Steven Cooremana5b860a2021-03-19 19:04:39 +01002446 status = psa_driver_wrapper_mac_verify_finish( operation,
2447 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002448
2449cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002450 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002451
Steven Cooremana5b860a2021-03-19 19:04:39 +01002452 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002453}
2454
2455
Gilles Peskine20035e32018-02-03 22:44:14 +01002456
Gilles Peskine20035e32018-02-03 22:44:14 +01002457/****************************************************************/
2458/* Asymmetric cryptography */
2459/****************************************************************/
2460
Ronald Cron67b1eb32020-12-08 17:37:27 +01002461psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002462 const psa_key_attributes_t *attributes,
2463 const uint8_t *key_buffer, size_t key_buffer_size,
2464 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2465 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002466{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002467 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002468 {
Ronald Cron4501c982021-03-19 20:09:32 +01002469 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2470 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002471 {
Ronald Cron4501c982021-03-19 20:09:32 +01002472#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2473 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2474 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002475 attributes,
2476 key_buffer, key_buffer_size,
2477 alg, hash, hash_length,
2478 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002479#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2480 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002481 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002482 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002483 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002484 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002485 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002486 }
2487 else
Ronald Cron4501c982021-03-19 20:09:32 +01002488 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2489 {
2490 if( PSA_ALG_IS_ECDSA( alg ) )
2491 {
2492#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2493 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2494 return( mbedtls_psa_ecdsa_sign_hash(
2495 attributes,
2496 key_buffer, key_buffer_size,
2497 alg, hash, hash_length,
2498 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002499#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2500 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002501 }
2502 else
2503 {
2504 return( PSA_ERROR_INVALID_ARGUMENT );
2505 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002506 }
Ronald Cron4501c982021-03-19 20:09:32 +01002507
2508 (void)key_buffer;
2509 (void)key_buffer_size;
2510 (void)hash;
2511 (void)hash_length;
2512 (void)signature;
2513 (void)signature_size;
2514 (void)signature_length;
2515
2516 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002517}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002518
2519psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2520 psa_algorithm_t alg,
2521 const uint8_t *hash,
2522 size_t hash_length,
2523 uint8_t *signature,
2524 size_t signature_size,
2525 size_t *signature_length )
2526{
2527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2528 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2529 psa_key_slot_t *slot;
2530
2531 *signature_length = signature_size;
2532 /* Immediately reject a zero-length signature buffer. This guarantees
2533 * that signature must be a valid pointer. (On the other hand, the hash
2534 * buffer can in principle be empty since it doesn't actually have
2535 * to be a hash.) */
2536 if( signature_size == 0 )
2537 return( PSA_ERROR_BUFFER_TOO_SMALL );
2538
2539 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2540 PSA_KEY_USAGE_SIGN_HASH,
2541 alg );
2542 if( status != PSA_SUCCESS )
2543 goto exit;
2544 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2545 {
2546 status = PSA_ERROR_INVALID_ARGUMENT;
2547 goto exit;
2548 }
2549
Ronald Cron9f17aa42020-12-08 17:07:25 +01002550 psa_key_attributes_t attributes = {
2551 .core = slot->attr
2552 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002553
Ronald Cron9f17aa42020-12-08 17:07:25 +01002554 status = psa_driver_wrapper_sign_hash(
2555 &attributes, slot->key.data, slot->key.bytes,
2556 alg, hash, hash_length,
2557 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002558
2559exit:
2560 /* Fill the unused part of the output buffer (the whole buffer on error,
2561 * the trailing part on success) with something that isn't a valid mac
2562 * (barring an attack on the mac and deliberately-crafted input),
2563 * in case the caller doesn't check the return status properly. */
2564 if( status == PSA_SUCCESS )
2565 memset( signature + *signature_length, '!',
2566 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02002567 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002568 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002569 /* If signature_size is 0 then we have nothing to do. We must not call
2570 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02002571
Ronald Cron5c522922020-11-14 16:35:34 +01002572 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002573
Ronald Cron5c522922020-11-14 16:35:34 +01002574 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03002575}
2576
Ronald Cron67b1eb32020-12-08 17:37:27 +01002577psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002578 const psa_key_attributes_t *attributes,
2579 const uint8_t *key_buffer, size_t key_buffer_size,
2580 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2581 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002582{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002583 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002584 {
Ronald Cron4501c982021-03-19 20:09:32 +01002585 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2586 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002587 {
Ronald Cron4501c982021-03-19 20:09:32 +01002588#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2589 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2590 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002591 attributes,
2592 key_buffer, key_buffer_size,
2593 alg, hash, hash_length,
2594 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002595#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2596 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002597 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002598 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002599 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002600 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002601 }
itayzafrir5c753392018-05-08 11:18:38 +03002602 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002603 else
Ronald Cron4501c982021-03-19 20:09:32 +01002604 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002605 {
Ronald Cron4501c982021-03-19 20:09:32 +01002606 if( PSA_ALG_IS_ECDSA( alg ) )
2607 {
2608#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2609 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2610 return( mbedtls_psa_ecdsa_verify_hash(
2611 attributes,
2612 key_buffer, key_buffer_size,
2613 alg, hash, hash_length,
2614 signature, signature_length ) );
2615#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2616 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2617 }
2618 else
2619 {
2620 return( PSA_ERROR_INVALID_ARGUMENT );
2621 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002622 }
Ronald Cron4501c982021-03-19 20:09:32 +01002623
2624 (void)key_buffer;
2625 (void)key_buffer_size;
2626 (void)hash;
2627 (void)hash_length;
2628 (void)signature;
2629 (void)signature_length;
2630
2631 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002632}
2633
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002634psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2635 psa_algorithm_t alg,
2636 const uint8_t *hash,
2637 size_t hash_length,
2638 const uint8_t *signature,
2639 size_t signature_length )
2640{
2641 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2642 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002643 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002644
2645 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002646 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02002647 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002648 if( status != PSA_SUCCESS )
2649 return( status );
2650
Ronald Cron9f17aa42020-12-08 17:07:25 +01002651 psa_key_attributes_t attributes = {
2652 .core = slot->attr
2653 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002654
Ronald Cron9f17aa42020-12-08 17:07:25 +01002655 status = psa_driver_wrapper_verify_hash(
2656 &attributes, slot->key.data, slot->key.bytes,
2657 alg, hash, hash_length,
2658 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002659
Ronald Cron5c522922020-11-14 16:35:34 +01002660 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002661
Ronald Cron5c522922020-11-14 16:35:34 +01002662 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002663}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002664
John Durkop0e005192020-10-31 22:06:54 -07002665#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02002666static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2667 mbedtls_rsa_context *rsa )
2668{
2669 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2670 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2671 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2672 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2673}
John Durkop0e005192020-10-31 22:06:54 -07002674#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002675
Ronald Croncf56a0a2020-08-04 09:51:30 +02002676psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002677 psa_algorithm_t alg,
2678 const uint8_t *input,
2679 size_t input_length,
2680 const uint8_t *salt,
2681 size_t salt_length,
2682 uint8_t *output,
2683 size_t output_size,
2684 size_t *output_length )
2685{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002686 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002687 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002688 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002689
Darryl Green5cc689a2018-07-24 15:34:10 +01002690 (void) input;
2691 (void) input_length;
2692 (void) salt;
2693 (void) output;
2694 (void) output_size;
2695
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002696 *output_length = 0;
2697
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002698 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2699 return( PSA_ERROR_INVALID_ARGUMENT );
2700
Ronald Cron5c522922020-11-14 16:35:34 +01002701 status = psa_get_and_lock_transparent_key_slot_with_policy(
2702 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002703 if( status != PSA_SUCCESS )
2704 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002705 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2706 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002707 {
2708 status = PSA_ERROR_INVALID_ARGUMENT;
2709 goto exit;
2710 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002711
John Durkop6ba40d12020-11-10 08:50:04 -08002712#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2713 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002714 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002715 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002716 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002717 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2718 slot->key.data,
2719 slot->key.bytes,
2720 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002721 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02002722 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02002723
2724 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002725 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002726 status = PSA_ERROR_BUFFER_TOO_SMALL;
2727 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002728 }
John Durkop0e005192020-10-31 22:06:54 -07002729#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002730 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
2731 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002732 status = mbedtls_to_psa_error(
2733 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002734 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002735 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002736 MBEDTLS_RSA_PUBLIC,
2737 input_length,
2738 input,
2739 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002740 }
2741 else
John Durkop0e005192020-10-31 22:06:54 -07002742#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2743#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002744 if( PSA_ALG_IS_RSA_OAEP( alg ) )
2745 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002746 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02002747 status = mbedtls_to_psa_error(
2748 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002749 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002750 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002751 MBEDTLS_RSA_PUBLIC,
2752 salt, salt_length,
2753 input_length,
2754 input,
2755 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002756 }
2757 else
John Durkop0e005192020-10-31 22:06:54 -07002758#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002759 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002760 status = PSA_ERROR_INVALID_ARGUMENT;
2761 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002762 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02002763rsa_exit:
2764 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02002765 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002766
Steven Cooremana2371e52020-07-28 14:30:39 +02002767 mbedtls_rsa_free( rsa );
2768 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002769 }
2770 else
John Durkop9814fa22020-11-04 12:28:15 -08002771#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08002772 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002773 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002774 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002775 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002776
2777exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002778 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002779
Ronald Cron5c522922020-11-14 16:35:34 +01002780 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002781}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002782
Ronald Croncf56a0a2020-08-04 09:51:30 +02002783psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002784 psa_algorithm_t alg,
2785 const uint8_t *input,
2786 size_t input_length,
2787 const uint8_t *salt,
2788 size_t salt_length,
2789 uint8_t *output,
2790 size_t output_size,
2791 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002792{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002794 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002795 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002796
Darryl Green5cc689a2018-07-24 15:34:10 +01002797 (void) input;
2798 (void) input_length;
2799 (void) salt;
2800 (void) output;
2801 (void) output_size;
2802
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002803 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002804
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002805 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2806 return( PSA_ERROR_INVALID_ARGUMENT );
2807
Ronald Cron5c522922020-11-14 16:35:34 +01002808 status = psa_get_and_lock_transparent_key_slot_with_policy(
2809 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002810 if( status != PSA_SUCCESS )
2811 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002812 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002813 {
2814 status = PSA_ERROR_INVALID_ARGUMENT;
2815 goto exit;
2816 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002817
John Durkop6ba40d12020-11-10 08:50:04 -08002818#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2819 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002820 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002821 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002822 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002823 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2824 slot->key.data,
2825 slot->key.bytes,
2826 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002827 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002828 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002829
Steven Cooremana2371e52020-07-28 14:30:39 +02002830 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002831 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002832 status = PSA_ERROR_INVALID_ARGUMENT;
2833 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002834 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002835
John Durkop0e005192020-10-31 22:06:54 -07002836#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02002837 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002838 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002839 status = mbedtls_to_psa_error(
2840 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002841 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002842 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002843 MBEDTLS_RSA_PRIVATE,
2844 output_length,
2845 input,
2846 output,
2847 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002848 }
2849 else
John Durkop0e005192020-10-31 22:06:54 -07002850#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2851#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02002852 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002853 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002854 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02002855 status = mbedtls_to_psa_error(
2856 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002857 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002858 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002859 MBEDTLS_RSA_PRIVATE,
2860 salt, salt_length,
2861 output_length,
2862 input,
2863 output,
2864 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002865 }
2866 else
John Durkop0e005192020-10-31 22:06:54 -07002867#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002868 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002869 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002870 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002871
Steven Cooreman4fed4552020-08-03 14:46:03 +02002872rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02002873 mbedtls_rsa_free( rsa );
2874 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002875 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002876 else
John Durkop6ba40d12020-11-10 08:50:04 -08002877#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
2878 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002879 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002880 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002881 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002882
2883exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002884 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002885
Ronald Cron5c522922020-11-14 16:35:34 +01002886 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002887}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002888
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002889
2890
mohammad1603503973b2018-03-12 15:59:30 +02002891/****************************************************************/
2892/* Symmetric cryptography */
2893/****************************************************************/
2894
Ronald Cronab99ac22020-10-01 16:38:28 +02002895static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
2896 mbedtls_svc_key_id_t key,
2897 psa_algorithm_t alg,
2898 mbedtls_operation_t cipher_operation )
2899{
2900 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2901 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2902 psa_key_slot_t *slot;
2903 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
2904 PSA_KEY_USAGE_ENCRYPT :
2905 PSA_KEY_USAGE_DECRYPT );
2906
2907 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01002908 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02002909 return( PSA_ERROR_BAD_STATE );
2910
2911 /* The requested algorithm must be one that can be processed by cipher. */
2912 if( ! PSA_ALG_IS_CIPHER( alg ) )
2913 return( PSA_ERROR_INVALID_ARGUMENT );
2914
2915 /* Fetch key material from key storage. */
2916 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
2917 if( status != PSA_SUCCESS )
2918 goto exit;
2919
Ronald Cron49fafa92021-03-10 08:34:23 +01002920 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02002921 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01002922 * so we only set it (in the driver wrapper) after resources have been
2923 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02002924 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02002925 if( alg == PSA_ALG_ECB_NO_PADDING )
2926 operation->iv_required = 0;
2927 else
2928 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01002929 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02002930
Ronald Crona4af55f2020-12-14 14:36:06 +01002931 psa_key_attributes_t attributes = {
2932 .core = slot->attr
2933 };
2934
Ronald Cronab99ac22020-10-01 16:38:28 +02002935 /* Try doing the operation through a driver before using software fallback. */
2936 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01002937 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
2938 &attributes,
2939 slot->key.data,
2940 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02002941 alg );
2942 else
Ronald Crona4af55f2020-12-14 14:36:06 +01002943 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
2944 &attributes,
2945 slot->key.data,
2946 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02002947 alg );
2948
Gilles Peskine9ab61b62019-02-25 17:43:14 +01002949exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01002950 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01002951 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002952
Ronald Cron5c522922020-11-14 16:35:34 +01002953 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002954
Ronald Cron5c522922020-11-14 16:35:34 +01002955 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02002956}
2957
Gilles Peskinefe119512018-07-08 21:39:34 +02002958psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002959 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02002960 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02002961{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002962 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02002963}
2964
Gilles Peskinefe119512018-07-08 21:39:34 +02002965psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002966 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02002967 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02002968{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002969 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02002970}
2971
Gilles Peskinefe119512018-07-08 21:39:34 +02002972psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01002973 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02002974 size_t iv_size,
2975 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02002976{
Ronald Cron6d051732020-10-01 14:10:20 +02002977 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02002978
Ronald Cron5618a392021-03-26 09:52:26 +01002979 *iv_length = 0;
2980
Ronald Cron49fafa92021-03-10 08:34:23 +01002981 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02002982 {
2983 return( PSA_ERROR_BAD_STATE );
2984 }
2985
Steven Cooreman7df02922020-09-09 15:28:49 +02002986 if( operation->iv_set || ! operation->iv_required )
2987 {
2988 return( PSA_ERROR_BAD_STATE );
2989 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02002990
Ronald Cron5618a392021-03-26 09:52:26 +01002991 if( iv_size < operation->default_iv_length )
2992 {
2993 status = PSA_ERROR_BUFFER_TOO_SMALL;
2994 goto exit;
2995 }
Gilles Peskinee553c652018-06-04 16:22:46 +02002996
Ronald Cron5618a392021-03-26 09:52:26 +01002997 status = psa_generate_random( iv, operation->default_iv_length );
2998 if( status != PSA_SUCCESS )
2999 goto exit;
3000
3001 status = psa_driver_wrapper_cipher_set_iv( operation,
3002 iv,
3003 operation->default_iv_length );
3004
3005exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003006 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003007 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003008 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003009 *iv_length = operation->default_iv_length;
3010 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003011 else
Moran Peker395db872018-05-31 14:07:14 +03003012 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003013
itayzafrir534bd7c2018-08-02 13:56:32 +03003014 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003015}
3016
Gilles Peskinefe119512018-07-08 21:39:34 +02003017psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003018 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003019 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003020{
Ronald Cron6d051732020-10-01 14:10:20 +02003021 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003022
Ronald Cron49fafa92021-03-10 08:34:23 +01003023 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003024 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003025
Steven Cooreman7df02922020-09-09 15:28:49 +02003026 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003027 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003028
3029 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3030 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003031
Ronald Crondd24c9b2020-12-15 14:10:01 +01003032 status = psa_driver_wrapper_cipher_set_iv( operation,
3033 iv,
3034 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003035
itayzafrir534bd7c2018-08-02 13:56:32 +03003036 if( status == PSA_SUCCESS )
3037 operation->iv_set = 1;
3038 else
mohammad1603503973b2018-03-12 15:59:30 +02003039 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003040 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003041}
3042
Gilles Peskinee553c652018-06-04 16:22:46 +02003043psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3044 const uint8_t *input,
3045 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003046 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003047 size_t output_size,
3048 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003049{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003051
Ronald Cron49fafa92021-03-10 08:34:23 +01003052 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003053 {
3054 return( PSA_ERROR_BAD_STATE );
3055 }
3056 if( operation->iv_required && ! operation->iv_set )
3057 {
3058 return( PSA_ERROR_BAD_STATE );
3059 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003060
Ronald Crondd24c9b2020-12-15 14:10:01 +01003061 status = psa_driver_wrapper_cipher_update( operation,
3062 input,
3063 input_length,
3064 output,
3065 output_size,
3066 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003067 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003068 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003069
itayzafrir534bd7c2018-08-02 13:56:32 +03003070 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003071}
3072
Gilles Peskinee553c652018-06-04 16:22:46 +02003073psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3074 uint8_t *output,
3075 size_t output_size,
3076 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003077{
David Saadab4ecc272019-02-14 13:48:10 +02003078 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003079
Ronald Cron49fafa92021-03-10 08:34:23 +01003080 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003081 {
3082 return( PSA_ERROR_BAD_STATE );
3083 }
3084 if( operation->iv_required && ! operation->iv_set )
3085 {
3086 return( PSA_ERROR_BAD_STATE );
3087 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003088
Ronald Crondd24c9b2020-12-15 14:10:01 +01003089 status = psa_driver_wrapper_cipher_finish( operation,
3090 output,
3091 output_size,
3092 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003093 if( status == PSA_SUCCESS )
3094 return( psa_cipher_abort( operation ) );
3095 else
3096 {
3097 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003098 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003099
Steven Cooremanef8575e2020-09-11 11:44:50 +02003100 return( status );
3101 }
mohammad1603503973b2018-03-12 15:59:30 +02003102}
3103
Gilles Peskinee553c652018-06-04 16:22:46 +02003104psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3105{
Ronald Cron49fafa92021-03-10 08:34:23 +01003106 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003107 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003108 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003109 * in use. It's ok to call abort on such an object, and there's
3110 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003111 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003112 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003113
Ronald Crondd24c9b2020-12-15 14:10:01 +01003114 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003115
Ronald Cron49fafa92021-03-10 08:34:23 +01003116 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003117 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003118 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003119
Moran Peker395db872018-05-31 14:07:14 +03003120 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003121}
3122
mohammad16035955c982018-04-26 00:53:03 +03003123/****************************************************************/
3124/* AEAD */
3125/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003126
Ronald Croncf56a0a2020-08-04 09:51:30 +02003127psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003128 psa_algorithm_t alg,
3129 const uint8_t *nonce,
3130 size_t nonce_length,
3131 const uint8_t *additional_data,
3132 size_t additional_data_length,
3133 const uint8_t *plaintext,
3134 size_t plaintext_length,
3135 uint8_t *ciphertext,
3136 size_t ciphertext_size,
3137 size_t *ciphertext_length )
3138{
Ronald Cron215633c2021-03-16 17:15:37 +01003139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3140 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003141
mohammad1603f08a5502018-06-03 15:05:47 +03003142 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003143
Steven Cooremanea7ab132021-03-17 16:28:00 +01003144 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3145 return( PSA_ERROR_NOT_SUPPORTED );
3146
Ronald Cron9a986162021-03-26 12:40:07 +01003147 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003148 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003149 if( status != PSA_SUCCESS )
3150 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003151
Ronald Cron215633c2021-03-16 17:15:37 +01003152 psa_key_attributes_t attributes = {
3153 .core = slot->attr
3154 };
mohammad16035955c982018-04-26 00:53:03 +03003155
Ronald Cronde822812021-03-17 16:08:20 +01003156 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003157 &attributes, slot->key.data, slot->key.bytes,
3158 alg,
3159 nonce, nonce_length,
3160 additional_data, additional_data_length,
3161 plaintext, plaintext_length,
3162 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003163
Gilles Peskineedf9a652018-08-17 18:11:56 +02003164 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3165 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003166
Ronald Cron9f310172021-03-16 16:36:37 +01003167 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003168
mohammad16035955c982018-04-26 00:53:03 +03003169 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003170}
3171
Ronald Croncf56a0a2020-08-04 09:51:30 +02003172psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003173 psa_algorithm_t alg,
3174 const uint8_t *nonce,
3175 size_t nonce_length,
3176 const uint8_t *additional_data,
3177 size_t additional_data_length,
3178 const uint8_t *ciphertext,
3179 size_t ciphertext_length,
3180 uint8_t *plaintext,
3181 size_t plaintext_size,
3182 size_t *plaintext_length )
3183{
Ronald Cron215633c2021-03-16 17:15:37 +01003184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3185 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003186
Gilles Peskineee652a32018-06-01 19:23:52 +02003187 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003188
Steven Cooremanea7ab132021-03-17 16:28:00 +01003189 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3190 return( PSA_ERROR_NOT_SUPPORTED );
3191
Ronald Cron9a986162021-03-26 12:40:07 +01003192 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003193 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003194 if( status != PSA_SUCCESS )
3195 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003196
Ronald Cron215633c2021-03-16 17:15:37 +01003197 psa_key_attributes_t attributes = {
3198 .core = slot->attr
3199 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003200
Ronald Cronde822812021-03-17 16:08:20 +01003201 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003202 &attributes, slot->key.data, slot->key.bytes,
3203 alg,
3204 nonce, nonce_length,
3205 additional_data, additional_data_length,
3206 ciphertext, ciphertext_length,
3207 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003208
Gilles Peskineedf9a652018-08-17 18:11:56 +02003209 if( status != PSA_SUCCESS && plaintext_size != 0 )
3210 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003211
Ronald Cron215633c2021-03-16 17:15:37 +01003212 psa_unlock_key_slot( slot );
3213
Gilles Peskineedf9a652018-08-17 18:11:56 +02003214 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003215}
3216
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003217/* Helper function to get the base algorithm from its variants. */
3218static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
3219{
3220 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
3221 {
3222 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
3223 return( PSA_ALG_CCM );
3224
3225 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
3226 return( PSA_ALG_GCM );
3227
3228 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
3229 return( PSA_ALG_CHACHA20_POLY1305 );
3230
3231 default:
3232 return( PSA_ERROR_NOT_SUPPORTED );
3233 }
3234}
3235
Paul Elliott302ff6b2021-04-20 18:10:30 +01003236/* Set the key for a multipart authenticated encryption operation. */
3237psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3238 mbedtls_svc_key_id_t key,
3239 psa_algorithm_t alg )
3240{
3241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3242 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliotte715f882021-05-20 21:54:19 +01003243 psa_key_slot_t *slot = NULL;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003244
3245 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003246 {
Paul Elliott81231f32021-05-11 19:18:28 +01003247 status = PSA_ERROR_INVALID_ARGUMENT;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003248 goto exit;
3249 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01003250
Paul Elliottcee785c2021-05-20 14:29:20 +01003251 if( operation->id != 0 )
3252 {
3253 status = PSA_ERROR_BAD_STATE;
3254 goto exit;
3255 }
3256
Paul Elliott6eb95982021-05-21 17:41:41 +01003257 if( operation->nonce_set || operation->lengths_set ||
3258 operation->ad_started || operation->body_started )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003259 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003260 status = PSA_ERROR_BAD_STATE;
3261 goto exit;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003262 }
3263
Paul Elliott302ff6b2021-04-20 18:10:30 +01003264 status = psa_get_and_lock_key_slot_with_policy(
Paul Elliottc4e1dcf2021-04-23 18:59:23 +01003265 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003266
3267 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003268 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003269
3270 psa_key_attributes_t attributes = {
3271 .core = slot->attr
3272 };
3273
3274 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3275 &attributes, slot->key.data,
3276 slot->key.bytes, alg );
3277
Paul Elliott39dc6b82021-05-11 19:16:09 +01003278 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003279 goto exit;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003280
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003281 operation->key_type = psa_get_key_type( &attributes );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003282
Paul Elliottac1b3fd2021-05-20 14:33:13 +01003283exit:
3284
Paul Elliott6981fbc2021-05-21 17:13:50 +01003285 unlock_status = psa_unlock_key_slot( slot );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003286
Paul Elliott6981fbc2021-05-21 17:13:50 +01003287 if( status == PSA_SUCCESS )
3288 status = unlock_status;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003289
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003290 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003291 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003292 else
3293 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003294
Paul Elliott302ff6b2021-04-20 18:10:30 +01003295 return( status );
3296}
3297
3298/* Set the key for a multipart authenticated decryption operation. */
3299psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3300 mbedtls_svc_key_id_t key,
3301 psa_algorithm_t alg )
3302{
3303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3304 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliotte715f882021-05-20 21:54:19 +01003305 psa_key_slot_t *slot = NULL;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003306
3307 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003308 {
Paul Elliott81231f32021-05-11 19:18:28 +01003309 status = PSA_ERROR_INVALID_ARGUMENT;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003310 goto exit;
3311 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01003312
Paul Elliottcee785c2021-05-20 14:29:20 +01003313 if( operation->id != 0 )
3314 {
3315 status = PSA_ERROR_BAD_STATE;
3316 goto exit;
3317 }
3318
Paul Elliott6eb95982021-05-21 17:41:41 +01003319 if( operation->nonce_set || operation->lengths_set ||
3320 operation->ad_started || operation->body_started )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003321 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003322 status = PSA_ERROR_BAD_STATE;
3323 goto exit;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003324 }
3325
Paul Elliott302ff6b2021-04-20 18:10:30 +01003326 status = psa_get_and_lock_key_slot_with_policy(
3327 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
3328
3329 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003330 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003331
3332 psa_key_attributes_t attributes = {
3333 .core = slot->attr
3334 };
3335
3336 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3337 &attributes, slot->key.data,
3338 slot->key.bytes, alg );
3339
Paul Elliottac1b3fd2021-05-20 14:33:13 +01003340 if( status != PSA_SUCCESS )
3341 goto exit;
3342
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003343 operation->key_type = psa_get_key_type( &attributes );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003344
Paul Elliottac1b3fd2021-05-20 14:33:13 +01003345exit:
3346
Paul Elliott6981fbc2021-05-21 17:13:50 +01003347 unlock_status = psa_unlock_key_slot( slot );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003348
Paul Elliott6981fbc2021-05-21 17:13:50 +01003349 if( status == PSA_SUCCESS )
3350 status = unlock_status;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003351
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003352 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003353 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003354 else
3355 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003356
Paul Elliott302ff6b2021-04-20 18:10:30 +01003357 return( status );
3358}
3359
3360/* Generate a random nonce / IV for multipart AEAD operation */
3361psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3362 uint8_t *nonce,
3363 size_t nonce_size,
3364 size_t *nonce_length )
3365{
3366 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottb91da712021-05-20 14:43:47 +01003367 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003368
3369 *nonce_length = 0;
3370
Paul Elliottcee785c2021-05-20 14:29:20 +01003371 if( operation->id == 0 )
3372 {
3373 status = PSA_ERROR_BAD_STATE;
3374 goto exit;
3375 }
3376
Paul Elliott6eb95982021-05-21 17:41:41 +01003377 if( operation->nonce_set || operation->lengths_set ||
3378 operation->ad_started || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003379 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003380 status = PSA_ERROR_BAD_STATE;
3381 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003382 }
3383
Paul Elliottbbe90b52021-05-11 22:22:42 +01003384 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
3385 operation->alg );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003386
Paul Elliott39dc6b82021-05-11 19:16:09 +01003387 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003388 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003389 status = PSA_ERROR_BUFFER_TOO_SMALL;
3390 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003391 }
3392
3393 status = psa_generate_random( nonce, required_nonce_size );
3394
3395 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003396 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003397
Paul Elliott2df40052021-05-07 17:52:18 +01003398 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3399 required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003400
Paul Elliott39dc6b82021-05-11 19:16:09 +01003401exit:
Paul Elliott302ff6b2021-04-20 18:10:30 +01003402
Paul Elliott39dc6b82021-05-11 19:16:09 +01003403 if( status == PSA_SUCCESS )
3404 *nonce_length = required_nonce_size;
3405 else
3406 psa_aead_abort( operation );
3407
3408 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003409}
3410
3411/* Set the nonce for a multipart authenticated encryption or decryption
3412 operation.*/
3413psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3414 const uint8_t *nonce,
3415 size_t nonce_length )
3416{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003417 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3418
Paul Elliottcee785c2021-05-20 14:29:20 +01003419 if( operation->id == 0 )
3420 {
3421 status = PSA_ERROR_BAD_STATE;
3422 goto exit;
3423 }
3424
3425 if( operation->nonce_set || operation->ad_started ||
3426 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003427 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003428 status = PSA_ERROR_BAD_STATE;
3429 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003430 }
3431
Paul Elliott6eb95982021-05-21 17:41:41 +01003432 /* Not checking nonce size here as GCM spec allows almost arbitrarily
3433 * large nonces. Please note that we do not generally recommend the usage
3434 * of nonces of greater length than PSA_AEAD_NONCE_MAX_SIZE, as large
3435 * nonces are hashed to a shorter size, which can then lead to collisions
3436 * if you encrypt a very large number of messages.*/
Paul Elliott1a98aca2021-05-20 18:24:07 +01003437
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003438 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3439 nonce_length );
3440
Paul Elliott39dc6b82021-05-11 19:16:09 +01003441exit:
3442
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003443 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003444 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003445 else
3446 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003447
3448 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003449}
3450
3451/* Declare the lengths of the message and additional data for multipart AEAD. */
3452psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3453 size_t ad_length,
3454 size_t plaintext_length )
3455{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003456 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3457
Paul Elliottcee785c2021-05-20 14:29:20 +01003458 if( operation->id == 0 )
3459 {
3460 status = PSA_ERROR_BAD_STATE;
3461 goto exit;
3462 }
3463
Paul Elliott6eb95982021-05-21 17:41:41 +01003464 if( operation->lengths_set || operation->ad_started ||
3465 operation->body_started)
Paul Elliott302ff6b2021-04-20 18:10:30 +01003466 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003467 status = PSA_ERROR_BAD_STATE;
3468 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003469 }
3470
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003471 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3472 plaintext_length );
3473
Paul Elliott39dc6b82021-05-11 19:16:09 +01003474exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003475
Paul Elliott39dc6b82021-05-11 19:16:09 +01003476 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003477 {
3478 operation->ad_remaining = ad_length;
3479 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003480 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01003481 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003482 else
3483 psa_aead_abort( operation );
3484
3485 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003486}
3487 /* Pass additional data to an active multipart AEAD operation. */
3488psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
3489 const uint8_t *input,
3490 size_t input_length )
3491{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003492 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3493
Paul Elliottcee785c2021-05-20 14:29:20 +01003494 if( operation->id == 0 )
3495 {
3496 status = PSA_ERROR_BAD_STATE;
3497 goto exit;
3498 }
3499
Paul Elliott6eb95982021-05-21 17:41:41 +01003500 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003501 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003502 status = PSA_ERROR_BAD_STATE;
3503 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003504 }
3505
Paul Elliottee4ffe02021-05-20 17:25:06 +01003506 if( operation->lengths_set )
3507 {
Paul Elliott6eb95982021-05-21 17:41:41 +01003508 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003509 {
3510 status = PSA_ERROR_INVALID_ARGUMENT;
3511 goto exit;
3512 }
3513
3514 operation->ad_remaining -= input_length;
3515 }
3516
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003517 status = psa_driver_wrapper_aead_update_ad( operation, input,
3518 input_length );
3519
Paul Elliott39dc6b82021-05-11 19:16:09 +01003520exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003521
Paul Elliott39dc6b82021-05-11 19:16:09 +01003522 if( status == PSA_SUCCESS )
3523 operation->ad_started = 1;
3524 else
3525 psa_aead_abort( operation );
3526
3527 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003528}
3529
3530/* Encrypt or decrypt a message fragment in an active multipart AEAD
3531 operation.*/
3532psa_status_t psa_aead_update( psa_aead_operation_t *operation,
3533 const uint8_t *input,
3534 size_t input_length,
3535 uint8_t *output,
3536 size_t output_size,
3537 size_t *output_length )
3538{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003539 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003540
3541 *output_length = 0;
3542
Paul Elliottcee785c2021-05-20 14:29:20 +01003543 if( operation->id == 0 )
3544 {
3545 status = PSA_ERROR_BAD_STATE;
3546 goto exit;
3547 }
3548
Paul Elliott6eb95982021-05-21 17:41:41 +01003549 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003550 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003551 status = PSA_ERROR_BAD_STATE;
3552 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003553 }
3554
Paul Elliottee4ffe02021-05-20 17:25:06 +01003555 if( operation->lengths_set )
3556 {
3557 /* Additional data length was supplied, but not all the additional
3558 data was supplied.*/
3559 if( operation->ad_remaining != 0 )
3560 {
3561 status = PSA_ERROR_INVALID_ARGUMENT;
3562 goto exit;
3563 }
3564
3565 /* Too much data provided. */
3566 if( operation->body_remaining < input_length )
3567 {
3568 status = PSA_ERROR_INVALID_ARGUMENT;
3569 goto exit;
3570 }
3571
3572 operation->body_remaining -= input_length;
3573 }
3574
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003575 status = psa_driver_wrapper_aead_update( operation, input, input_length,
3576 output, output_size,
3577 output_length );
3578
Paul Elliott39dc6b82021-05-11 19:16:09 +01003579exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003580
Paul Elliott39dc6b82021-05-11 19:16:09 +01003581 if( status == PSA_SUCCESS )
3582 operation->body_started = 1;
3583 else
3584 psa_aead_abort( operation );
3585
3586 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003587}
3588
3589/* Finish encrypting a message in a multipart AEAD operation. */
3590psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
3591 uint8_t *ciphertext,
3592 size_t ciphertext_size,
3593 size_t *ciphertext_length,
3594 uint8_t *tag,
3595 size_t tag_size,
3596 size_t *tag_length )
3597{
Paul Elliott39dc6b82021-05-11 19:16:09 +01003598 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3599
Paul Elliott302ff6b2021-04-20 18:10:30 +01003600 *ciphertext_length = 0;
3601 *tag_length = 0;
3602
Paul Elliottcee785c2021-05-20 14:29:20 +01003603 if( operation->id == 0 )
3604 {
3605 status = PSA_ERROR_BAD_STATE;
3606 goto exit;
3607 }
3608
Paul Elliott6eb95982021-05-21 17:41:41 +01003609 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003610 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003611 status = PSA_ERROR_BAD_STATE;
3612 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003613 }
3614
Paul Elliottee4ffe02021-05-20 17:25:06 +01003615 if( operation->lengths_set && (operation->ad_remaining != 0 ||
3616 operation->body_remaining != 0 ) )
3617 {
Paul Elliott6eb95982021-05-21 17:41:41 +01003618 status = PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottee4ffe02021-05-20 17:25:06 +01003619 goto exit;
3620 }
3621
Paul Elliott39dc6b82021-05-11 19:16:09 +01003622 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
3623 ciphertext_size,
3624 ciphertext_length,
3625 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003626
Paul Elliott39dc6b82021-05-11 19:16:09 +01003627exit:
3628
3629 psa_aead_abort( operation );
3630
3631 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003632}
3633
3634/* Finish authenticating and decrypting a message in a multipart AEAD
3635 operation.*/
3636psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
3637 uint8_t *plaintext,
3638 size_t plaintext_size,
3639 size_t *plaintext_length,
3640 const uint8_t *tag,
3641 size_t tag_length )
3642{
Paul Elliott39dc6b82021-05-11 19:16:09 +01003643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3644
Paul Elliott302ff6b2021-04-20 18:10:30 +01003645 *plaintext_length = 0;
3646
Paul Elliottcee785c2021-05-20 14:29:20 +01003647 if( operation->id == 0 )
3648 {
3649 status = PSA_ERROR_BAD_STATE;
3650 goto exit;
3651 }
3652
Paul Elliott6eb95982021-05-21 17:41:41 +01003653 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003654 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003655 status = PSA_ERROR_BAD_STATE;
3656 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003657 }
3658
Paul Elliottee4ffe02021-05-20 17:25:06 +01003659 if( operation->lengths_set && (operation->ad_remaining != 0 ||
3660 operation->body_remaining != 0 ) )
3661 {
3662 status = PSA_ERROR_BAD_STATE;
3663 goto exit;
3664 }
3665
Paul Elliott39dc6b82021-05-11 19:16:09 +01003666 status = psa_driver_wrapper_aead_verify( operation, plaintext,
3667 plaintext_size,
3668 plaintext_length,
3669 tag, tag_length );
3670
3671exit:
3672
3673 psa_aead_abort( operation );
3674
3675 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003676}
3677
3678/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003679psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003680{
3681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3682
3683 if( operation->id == 0 )
3684 {
3685 /* The object has (apparently) been initialized but it is not (yet)
3686 * in use. It's ok to call abort on such an object, and there's
3687 * nothing to do. */
3688 return( PSA_SUCCESS );
3689 }
3690
3691 status = psa_driver_wrapper_aead_abort( operation );
3692
3693 operation->id = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003694 operation->nonce_set = 0;
3695 operation->lengths_set = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003696 operation->ad_started = 0;
3697 operation->body_started = 0;
3698
3699 return( status );
3700}
3701
Gilles Peskinee59236f2018-01-27 23:32:46 +01003702/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003703/* Generators */
3704/****************************************************************/
3705
John Durkop07cc04a2020-11-16 22:08:34 -08003706#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3707 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3708 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3709#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003710#endif /* At least one builtin KDF */
3711
3712#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3713 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3714 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3715static psa_status_t psa_key_derivation_start_hmac(
3716 psa_mac_operation_t *operation,
3717 psa_algorithm_t hash_alg,
3718 const uint8_t *hmac_key,
3719 size_t hmac_key_length )
3720{
3721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3722 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3723 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3724 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3725 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3726
Steven Cooreman72f736a2021-05-07 14:14:37 +02003727 operation->is_sign = 1;
3728 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3729
Steven Cooreman094a77e2021-05-06 17:58:36 +02003730 status = psa_driver_wrapper_mac_sign_setup( operation,
3731 &attributes,
3732 hmac_key, hmac_key_length,
3733 PSA_ALG_HMAC( hash_alg ) );
3734
3735 psa_reset_key_attributes( &attributes );
3736 return( status );
3737}
3738#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003739
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003740#define HKDF_STATE_INIT 0 /* no input yet */
3741#define HKDF_STATE_STARTED 1 /* got salt */
3742#define HKDF_STATE_KEYED 2 /* got key */
3743#define HKDF_STATE_OUTPUT 3 /* output started */
3744
Gilles Peskinecbe66502019-05-16 16:59:18 +02003745static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003746 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003747{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003748 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3749 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003750 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003751 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003752}
3753
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003754psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003755{
3756 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003757 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003758 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003759 {
3760 /* The object has (apparently) been initialized but it is not
3761 * in use. It's ok to call abort on such an object, and there's
3762 * nothing to do. */
3763 }
3764 else
John Durkopd0321952020-10-29 21:37:36 -07003765#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003766 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003767 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003768 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003769 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003770 }
John Durkop07cc04a2020-11-16 22:08:34 -08003771 else
3772#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3773#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3774 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3775 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003776 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003777 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003778 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003779 if( operation->ctx.tls12_prf.secret != NULL )
3780 {
3781 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3782 operation->ctx.tls12_prf.secret_length );
3783 mbedtls_free( operation->ctx.tls12_prf.secret );
3784 }
3785
Janos Follath6a1d2622019-06-11 10:37:28 +01003786 if( operation->ctx.tls12_prf.seed != NULL )
3787 {
3788 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3789 operation->ctx.tls12_prf.seed_length );
3790 mbedtls_free( operation->ctx.tls12_prf.seed );
3791 }
3792
3793 if( operation->ctx.tls12_prf.label != NULL )
3794 {
3795 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3796 operation->ctx.tls12_prf.label_length );
3797 mbedtls_free( operation->ctx.tls12_prf.label );
3798 }
3799
Steven Cooremana6df6042021-04-29 19:32:25 +02003800 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003801
3802 /* We leave the fields Ai and output_block to be erased safely by the
3803 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003804 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003805 else
John Durkop07cc04a2020-11-16 22:08:34 -08003806#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3807 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003808 {
3809 status = PSA_ERROR_BAD_STATE;
3810 }
Janos Follath083036a2019-06-11 10:22:26 +01003811 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003812 return( status );
3813}
3814
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003815psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003816 size_t *capacity)
3817{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003818 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003819 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003820 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003821 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003822 }
3823
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003824 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003825 return( PSA_SUCCESS );
3826}
3827
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003828psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003829 size_t capacity )
3830{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003831 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003832 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003833 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003834 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003835 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003836 return( PSA_SUCCESS );
3837}
3838
John Durkopd0321952020-10-29 21:37:36 -07003839#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003840/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003841 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003842static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003843 psa_algorithm_t hash_alg,
3844 uint8_t *output,
3845 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003846{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003847 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003848 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003849 psa_status_t status;
3850
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003851 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3852 return( PSA_ERROR_BAD_STATE );
3853 hkdf->state = HKDF_STATE_OUTPUT;
3854
Gilles Peskinebef7f142018-07-12 17:22:21 +02003855 while( output_length != 0 )
3856 {
3857 /* Copy what remains of the current block */
3858 uint8_t n = hash_length - hkdf->offset_in_block;
3859 if( n > output_length )
3860 n = (uint8_t) output_length;
3861 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3862 output += n;
3863 output_length -= n;
3864 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003865 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003866 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003867 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003868 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003869 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003870 * object was corrupted or if this function is called directly
3871 * inside the library. */
3872 if( hkdf->block_number == 0xff )
3873 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003874
3875 /* We need a new block */
3876 ++hkdf->block_number;
3877 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003878
Steven Cooreman094a77e2021-05-06 17:58:36 +02003879 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3880 hash_alg,
3881 hkdf->prk,
3882 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003883 if( status != PSA_SUCCESS )
3884 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003885
Gilles Peskinebef7f142018-07-12 17:22:21 +02003886 if( hkdf->block_number != 1 )
3887 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003888 status = psa_mac_update( &hkdf->hmac,
3889 hkdf->output_block,
3890 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003891 if( status != PSA_SUCCESS )
3892 return( status );
3893 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003894 status = psa_mac_update( &hkdf->hmac,
3895 hkdf->info,
3896 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003897 if( status != PSA_SUCCESS )
3898 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003899 status = psa_mac_update( &hkdf->hmac,
3900 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003901 if( status != PSA_SUCCESS )
3902 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003903 status = psa_mac_sign_finish( &hkdf->hmac,
3904 hkdf->output_block,
3905 sizeof( hkdf->output_block ),
3906 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003907 if( status != PSA_SUCCESS )
3908 return( status );
3909 }
3910
3911 return( PSA_SUCCESS );
3912}
John Durkop07cc04a2020-11-16 22:08:34 -08003913#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003914
John Durkop07cc04a2020-11-16 22:08:34 -08003915#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3916 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003917static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3918 psa_tls12_prf_key_derivation_t *tls12_prf,
3919 psa_algorithm_t alg )
3920{
3921 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003922 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003923 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3924 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003925 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003926
Janos Follath7742fee2019-06-17 12:58:10 +01003927 /* We can't be wanting more output after block 0xff, otherwise
3928 * the capacity check in psa_key_derivation_output_bytes() would have
3929 * prevented this call. It could happen only if the operation
3930 * object was corrupted or if this function is called directly
3931 * inside the library. */
3932 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003933 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003934
3935 /* We need a new block */
3936 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003937 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003938
3939 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3940 *
3941 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3942 *
3943 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3944 * HMAC_hash(secret, A(2) + seed) +
3945 * HMAC_hash(secret, A(3) + seed) + ...
3946 *
3947 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003948 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003949 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003950 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003951 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003952 * is currently extracted as `output_block` and where i is
3953 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003954 */
3955
Steven Cooreman094a77e2021-05-06 17:58:36 +02003956 status = psa_key_derivation_start_hmac( &hmac,
3957 hash_alg,
3958 tls12_prf->secret,
3959 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003960 if( status != PSA_SUCCESS )
3961 goto cleanup;
3962
3963 /* Calculate A(i) where i = tls12_prf->block_number. */
3964 if( tls12_prf->block_number == 1 )
3965 {
3966 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3967 * the variable seed and in this instance means it in the context of the
3968 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003969 status = psa_mac_update( &hmac,
3970 tls12_prf->label,
3971 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003972 if( status != PSA_SUCCESS )
3973 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003974 status = psa_mac_update( &hmac,
3975 tls12_prf->seed,
3976 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003977 if( status != PSA_SUCCESS )
3978 goto cleanup;
3979 }
3980 else
3981 {
3982 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003983 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003984 if( status != PSA_SUCCESS )
3985 goto cleanup;
3986 }
3987
Steven Cooremana6df6042021-04-29 19:32:25 +02003988 status = psa_mac_sign_finish( &hmac,
3989 tls12_prf->Ai, hash_length,
3990 &hmac_output_length );
3991 if( hmac_output_length != hash_length )
3992 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003993 if( status != PSA_SUCCESS )
3994 goto cleanup;
3995
3996 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003997 status = psa_key_derivation_start_hmac( &hmac,
3998 hash_alg,
3999 tls12_prf->secret,
4000 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004001 if( status != PSA_SUCCESS )
4002 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004003 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004004 if( status != PSA_SUCCESS )
4005 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004006 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004007 if( status != PSA_SUCCESS )
4008 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004009 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004010 if( status != PSA_SUCCESS )
4011 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004012 status = psa_mac_sign_finish( &hmac,
4013 tls12_prf->output_block, hash_length,
4014 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004015 if( status != PSA_SUCCESS )
4016 goto cleanup;
4017
Janos Follath7742fee2019-06-17 12:58:10 +01004018
4019cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004020 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004021 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4022 status = cleanup_status;
4023
4024 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004025}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004026
Janos Follath844eb0e2019-06-19 12:10:49 +01004027static psa_status_t psa_key_derivation_tls12_prf_read(
4028 psa_tls12_prf_key_derivation_t *tls12_prf,
4029 psa_algorithm_t alg,
4030 uint8_t *output,
4031 size_t output_length )
4032{
4033 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004034 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004035 psa_status_t status;
4036 uint8_t offset, length;
4037
4038 while( output_length != 0 )
4039 {
4040 /* Check if we have fully processed the current block. */
4041 if( tls12_prf->left_in_block == 0 )
4042 {
4043 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4044 alg );
4045 if( status != PSA_SUCCESS )
4046 return( status );
4047
4048 continue;
4049 }
4050
4051 if( tls12_prf->left_in_block > output_length )
4052 length = (uint8_t) output_length;
4053 else
4054 length = tls12_prf->left_in_block;
4055
4056 offset = hash_length - tls12_prf->left_in_block;
4057 memcpy( output, tls12_prf->output_block + offset, length );
4058 output += length;
4059 output_length -= length;
4060 tls12_prf->left_in_block -= length;
4061 }
4062
4063 return( PSA_SUCCESS );
4064}
John Durkop07cc04a2020-11-16 22:08:34 -08004065#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4066 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004067
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004068psa_status_t psa_key_derivation_output_bytes(
4069 psa_key_derivation_operation_t *operation,
4070 uint8_t *output,
4071 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004072{
4073 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004074 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004075
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004076 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004077 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004078 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004079 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004080 }
4081
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004082 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004083 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004084 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004085 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004086 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004087 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004088 goto exit;
4089 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004090 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004091 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004092 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004093 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004094 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4095 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004096 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004097 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004098 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004099 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004100 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004101
John Durkopd0321952020-10-29 21:37:36 -07004102#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004103 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004104 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004105 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004106 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004107 output, output_length );
4108 }
Janos Follathadbec812019-06-14 11:05:39 +01004109 else
John Durkop07cc04a2020-11-16 22:08:34 -08004110#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4111#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4112 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004113 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004114 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004115 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004116 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004117 kdf_alg, output,
4118 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004119 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004120 else
John Durkop07cc04a2020-11-16 22:08:34 -08004121#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4122 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004123 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004124 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004125 return( PSA_ERROR_BAD_STATE );
4126 }
4127
4128exit:
4129 if( status != PSA_SUCCESS )
4130 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004131 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004132 * This allows us to differentiate between exhausted operations and
4133 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4134 * operations. */
4135 psa_algorithm_t alg = operation->alg;
4136 psa_key_derivation_abort( operation );
4137 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004138 memset( output, '!', output_length );
4139 }
4140 return( status );
4141}
4142
David Brown7807bf72021-02-09 16:28:23 -07004143#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004144static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4145{
4146 if( data_size >= 8 )
4147 mbedtls_des_key_set_parity( data );
4148 if( data_size >= 16 )
4149 mbedtls_des_key_set_parity( data + 8 );
4150 if( data_size >= 24 )
4151 mbedtls_des_key_set_parity( data + 16 );
4152}
David Brown7807bf72021-02-09 16:28:23 -07004153#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004154
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004155static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004156 psa_key_slot_t *slot,
4157 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004158 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004159{
4160 uint8_t *data = NULL;
4161 size_t bytes = PSA_BITS_TO_BYTES( bits );
4162 psa_status_t status;
4163
Gilles Peskine8e338702019-07-30 20:06:31 +02004164 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004165 return( PSA_ERROR_INVALID_ARGUMENT );
4166 if( bits % 8 != 0 )
4167 return( PSA_ERROR_INVALID_ARGUMENT );
4168 data = mbedtls_calloc( 1, bytes );
4169 if( data == NULL )
4170 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4171
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004172 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004173 if( status != PSA_SUCCESS )
4174 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004175#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004176 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004177 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004178#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004179
4180 status = psa_allocate_buffer_to_slot( slot, bytes );
4181 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004182 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004183
Ronald Cronbf33c932020-11-28 18:06:53 +01004184 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004185 psa_key_attributes_t attributes = {
4186 .core = slot->attr
4187 };
4188
Ronald Cronbf33c932020-11-28 18:06:53 +01004189 status = psa_driver_wrapper_import_key( &attributes,
4190 data, bytes,
4191 slot->key.data,
4192 slot->key.bytes,
4193 &slot->key.bytes, &bits );
4194 if( bits != slot->attr.bits )
4195 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004196
4197exit:
4198 mbedtls_free( data );
4199 return( status );
4200}
4201
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004202psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004203 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004204 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004205{
4206 psa_status_t status;
4207 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004208 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004209
Ronald Cron81709fc2020-11-14 12:10:32 +01004210 *key = MBEDTLS_SVC_KEY_ID_INIT;
4211
Gilles Peskine0f84d622019-09-12 19:03:13 +02004212 /* Reject any attempt to create a zero-length key so that we don't
4213 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4214 if( psa_get_key_bits( attributes ) == 0 )
4215 return( PSA_ERROR_INVALID_ARGUMENT );
4216
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004217 if( ! operation->can_output_key )
4218 return( PSA_ERROR_NOT_PERMITTED );
4219
Ronald Cron81709fc2020-11-14 12:10:32 +01004220 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4221 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004222#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4223 if( driver != NULL )
4224 {
4225 /* Deriving a key in a secure element is not implemented yet. */
4226 status = PSA_ERROR_NOT_SUPPORTED;
4227 }
4228#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004229 if( status == PSA_SUCCESS )
4230 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004231 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004232 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004233 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004234 }
4235 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004236 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004237 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004238 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004239
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004240 return( status );
4241}
4242
Gilles Peskineeab56e42018-07-12 17:12:33 +02004243
4244
4245/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004246/* Key derivation */
4247/****************************************************************/
4248
Steven Cooreman932ffb72021-02-15 12:14:32 +01004249#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004250static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004251 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004252 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004253{
John Durkop07cc04a2020-11-16 22:08:34 -08004254 int is_kdf_alg_supported;
4255
Janos Follath5fe19732019-06-20 15:09:30 +01004256 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4257 * initialisers for this union leave some bytes unspecified.) */
4258 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4259
Gilles Peskine969c5d62019-01-16 15:53:06 +01004260 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004261#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004262 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4263 is_kdf_alg_supported = 1;
4264 else
4265#endif
4266#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4267 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4268 is_kdf_alg_supported = 1;
4269 else
4270#endif
4271#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4272 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4273 is_kdf_alg_supported = 1;
4274 else
4275#endif
4276 is_kdf_alg_supported = 0;
4277
4278 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004279 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004280 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004281 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004282 if( hash_size == 0 )
4283 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4285 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004286 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004287 {
4288 return( PSA_ERROR_NOT_SUPPORTED );
4289 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004290 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004291 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004292 }
John Durkop07cc04a2020-11-16 22:08:34 -08004293
4294 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004295}
John Durkop07cc04a2020-11-16 22:08:34 -08004296#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004297
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004298psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004299 psa_algorithm_t alg )
4300{
4301 psa_status_t status;
4302
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004303 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004304 return( PSA_ERROR_BAD_STATE );
4305
Gilles Peskine6843c292019-01-18 16:44:49 +01004306 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4307 return( PSA_ERROR_INVALID_ARGUMENT );
4308 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004310#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004311 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004313#else
4314 return( PSA_ERROR_NOT_SUPPORTED );
4315#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004316 }
4317 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4318 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004319#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004320 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004321#else
4322 return( PSA_ERROR_NOT_SUPPORTED );
4323#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004324 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004325 else
4326 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004327
4328 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004329 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004330 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004331}
4332
John Durkopd0321952020-10-29 21:37:36 -07004333#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004334static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004335 psa_algorithm_t hash_alg,
4336 psa_key_derivation_step_t step,
4337 const uint8_t *data,
4338 size_t data_length )
4339{
4340 psa_status_t status;
4341 switch( step )
4342 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004343 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004344 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004345 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004346 else
4347 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004348 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4349 hash_alg,
4350 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004351 if( status != PSA_SUCCESS )
4352 return( status );
4353 hkdf->state = HKDF_STATE_STARTED;
4354 return( PSA_SUCCESS );
4355 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004356 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004357 /* If no salt was provided, use an empty salt. */
4358 if( hkdf->state == HKDF_STATE_INIT )
4359 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004360 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4361 hash_alg,
4362 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004363 if( status != PSA_SUCCESS )
4364 return( status );
4365 hkdf->state = HKDF_STATE_STARTED;
4366 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004367 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004368 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004369 status = psa_mac_update( &hkdf->hmac,
4370 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004371 if( status != PSA_SUCCESS )
4372 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004373 status = psa_mac_sign_finish( &hkdf->hmac,
4374 hkdf->prk,
4375 sizeof( hkdf->prk ),
4376 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004377 if( status != PSA_SUCCESS )
4378 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004379 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004380 hkdf->block_number = 0;
4381 hkdf->state = HKDF_STATE_KEYED;
4382 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004383 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004384 if( hkdf->state == HKDF_STATE_OUTPUT )
4385 return( PSA_ERROR_BAD_STATE );
4386 if( hkdf->info_set )
4387 return( PSA_ERROR_BAD_STATE );
4388 hkdf->info_length = data_length;
4389 if( data_length != 0 )
4390 {
4391 hkdf->info = mbedtls_calloc( 1, data_length );
4392 if( hkdf->info == NULL )
4393 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4394 memcpy( hkdf->info, data, data_length );
4395 }
4396 hkdf->info_set = 1;
4397 return( PSA_SUCCESS );
4398 default:
4399 return( PSA_ERROR_INVALID_ARGUMENT );
4400 }
4401}
John Durkop07cc04a2020-11-16 22:08:34 -08004402#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004403
John Durkop07cc04a2020-11-16 22:08:34 -08004404#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4405 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004406static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4407 const uint8_t *data,
4408 size_t data_length )
4409{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004410 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004411 return( PSA_ERROR_BAD_STATE );
4412
Janos Follathd6dce9f2019-07-04 09:11:38 +01004413 if( data_length != 0 )
4414 {
4415 prf->seed = mbedtls_calloc( 1, data_length );
4416 if( prf->seed == NULL )
4417 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004418
Janos Follathd6dce9f2019-07-04 09:11:38 +01004419 memcpy( prf->seed, data, data_length );
4420 prf->seed_length = data_length;
4421 }
Janos Follathf08e2652019-06-13 09:05:41 +01004422
Gilles Peskine43f958b2020-12-13 14:55:14 +01004423 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004424
4425 return( PSA_SUCCESS );
4426}
4427
Janos Follath81550542019-06-13 14:26:34 +01004428static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004429 const uint8_t *data,
4430 size_t data_length )
4431{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004432 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004433 return( PSA_ERROR_BAD_STATE );
4434
Steven Cooremana6df6042021-04-29 19:32:25 +02004435 if( data_length != 0 )
4436 {
4437 prf->secret = mbedtls_calloc( 1, data_length );
4438 if( prf->secret == NULL )
4439 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4440
4441 memcpy( prf->secret, data, data_length );
4442 prf->secret_length = data_length;
4443 }
Janos Follath81550542019-06-13 14:26:34 +01004444
Gilles Peskine43f958b2020-12-13 14:55:14 +01004445 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004446
4447 return( PSA_SUCCESS );
4448}
4449
Janos Follath63028dd2019-06-13 09:15:47 +01004450static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4451 const uint8_t *data,
4452 size_t data_length )
4453{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004454 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004455 return( PSA_ERROR_BAD_STATE );
4456
Janos Follathd6dce9f2019-07-04 09:11:38 +01004457 if( data_length != 0 )
4458 {
4459 prf->label = mbedtls_calloc( 1, data_length );
4460 if( prf->label == NULL )
4461 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004462
Janos Follathd6dce9f2019-07-04 09:11:38 +01004463 memcpy( prf->label, data, data_length );
4464 prf->label_length = data_length;
4465 }
Janos Follath63028dd2019-06-13 09:15:47 +01004466
Gilles Peskine43f958b2020-12-13 14:55:14 +01004467 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004468
4469 return( PSA_SUCCESS );
4470}
4471
Janos Follathb03233e2019-06-11 15:30:30 +01004472static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004473 psa_key_derivation_step_t step,
4474 const uint8_t *data,
4475 size_t data_length )
4476{
Janos Follathb03233e2019-06-11 15:30:30 +01004477 switch( step )
4478 {
Janos Follathf08e2652019-06-13 09:05:41 +01004479 case PSA_KEY_DERIVATION_INPUT_SEED:
4480 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004481 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004482 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004483 case PSA_KEY_DERIVATION_INPUT_LABEL:
4484 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004485 default:
4486 return( PSA_ERROR_INVALID_ARGUMENT );
4487 }
4488}
John Durkop07cc04a2020-11-16 22:08:34 -08004489#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4490 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4491
4492#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4493static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4494 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004495 const uint8_t *data,
4496 size_t data_length )
4497{
4498 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004499 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004500 uint8_t *cur = pms;
4501
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004502 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004503 return( PSA_ERROR_INVALID_ARGUMENT );
4504
4505 /* Quoting RFC 4279, Section 2:
4506 *
4507 * The premaster secret is formed as follows: if the PSK is N octets
4508 * long, concatenate a uint16 with the value N, N zero octets, a second
4509 * uint16 with the value N, and the PSK itself.
4510 */
4511
4512 *cur++ = ( data_length >> 8 ) & 0xff;
4513 *cur++ = ( data_length >> 0 ) & 0xff;
4514 memset( cur, 0, data_length );
4515 cur += data_length;
4516 *cur++ = pms[0];
4517 *cur++ = pms[1];
4518 memcpy( cur, data, data_length );
4519 cur += data_length;
4520
Steven Cooremana6df6042021-04-29 19:32:25 +02004521 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004522
4523 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4524 return( status );
4525}
Janos Follath6660f0e2019-06-17 08:44:03 +01004526
4527static psa_status_t psa_tls12_prf_psk_to_ms_input(
4528 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004529 psa_key_derivation_step_t step,
4530 const uint8_t *data,
4531 size_t data_length )
4532{
4533 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004534 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004535 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004536 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004537 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004538
Steven Cooremana6df6042021-04-29 19:32:25 +02004539 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004540}
John Durkop07cc04a2020-11-16 22:08:34 -08004541#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004542
Gilles Peskineb8965192019-09-24 16:21:10 +02004543/** Check whether the given key type is acceptable for the given
4544 * input step of a key derivation.
4545 *
4546 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4547 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4548 * Both secret and non-secret inputs can alternatively have the type
4549 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4550 * that the input was passed as a buffer rather than via a key object.
4551 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004552static int psa_key_derivation_check_input_type(
4553 psa_key_derivation_step_t step,
4554 psa_key_type_t key_type )
4555{
4556 switch( step )
4557 {
4558 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004559 if( key_type == PSA_KEY_TYPE_DERIVE )
4560 return( PSA_SUCCESS );
4561 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004562 return( PSA_SUCCESS );
4563 break;
4564 case PSA_KEY_DERIVATION_INPUT_LABEL:
4565 case PSA_KEY_DERIVATION_INPUT_SALT:
4566 case PSA_KEY_DERIVATION_INPUT_INFO:
4567 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004568 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4569 return( PSA_SUCCESS );
4570 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004571 return( PSA_SUCCESS );
4572 break;
4573 }
4574 return( PSA_ERROR_INVALID_ARGUMENT );
4575}
4576
Janos Follathb80a94e2019-06-12 15:54:46 +01004577static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004578 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004579 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004580 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004581 const uint8_t *data,
4582 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004583{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004584 psa_status_t status;
4585 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4586
4587 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004588 if( status != PSA_SUCCESS )
4589 goto exit;
4590
John Durkopd0321952020-10-29 21:37:36 -07004591#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004592 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004593 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004594 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004595 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004596 step, data, data_length );
4597 }
John Durkop07cc04a2020-11-16 22:08:34 -08004598 else
4599#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4600#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4601 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004602 {
Janos Follathb03233e2019-06-11 15:30:30 +01004603 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004604 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004605 }
John Durkop07cc04a2020-11-16 22:08:34 -08004606 else
4607#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4608#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4609 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004610 {
4611 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004612 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004613 }
4614 else
John Durkop07cc04a2020-11-16 22:08:34 -08004615#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004616 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004617 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004618 (void) data;
4619 (void) data_length;
4620 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004621 return( PSA_ERROR_BAD_STATE );
4622 }
4623
Gilles Peskine224b0d62019-09-23 18:13:17 +02004624exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004625 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004626 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004627 return( status );
4628}
4629
Janos Follath51f4a0f2019-06-14 11:35:55 +01004630psa_status_t psa_key_derivation_input_bytes(
4631 psa_key_derivation_operation_t *operation,
4632 psa_key_derivation_step_t step,
4633 const uint8_t *data,
4634 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004635{
Gilles Peskineb8965192019-09-24 16:21:10 +02004636 return( psa_key_derivation_input_internal( operation, step,
4637 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004638 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004639}
4640
Janos Follath51f4a0f2019-06-14 11:35:55 +01004641psa_status_t psa_key_derivation_input_key(
4642 psa_key_derivation_operation_t *operation,
4643 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004644 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004645{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004647 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004648 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004649
Ronald Cron5c522922020-11-14 16:35:34 +01004650 status = psa_get_and_lock_transparent_key_slot_with_policy(
4651 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004652 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004653 {
4654 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004655 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004656 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004657
4658 /* Passing a key object as a SECRET input unlocks the permission
4659 * to output to a key object. */
4660 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4661 operation->can_output_key = 1;
4662
Ronald Cronf95a2b12020-10-22 15:24:49 +02004663 status = psa_key_derivation_input_internal( operation,
4664 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004665 slot->key.data,
4666 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004667
Ronald Cron5c522922020-11-14 16:35:34 +01004668 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004669
Ronald Cron5c522922020-11-14 16:35:34 +01004670 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004671}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004672
4673
4674
4675/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004676/* Key agreement */
4677/****************************************************************/
4678
John Durkop6ba40d12020-11-10 08:50:04 -08004679#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004680static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4681 size_t peer_key_length,
4682 const mbedtls_ecp_keypair *our_key,
4683 uint8_t *shared_secret,
4684 size_t shared_secret_size,
4685 size_t *shared_secret_length )
4686{
Steven Cooremand4867872020-08-05 16:31:39 +02004687 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004688 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004689 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004690 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004691 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004692 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004693
Ronald Cron90857082020-11-25 14:58:33 +01004694 status = mbedtls_psa_ecp_load_representation(
4695 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004696 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004697 peer_key,
4698 peer_key_length,
4699 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004700 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004701 goto exit;
4702
Jaeden Amero97271b32019-01-10 19:38:51 +00004703 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004704 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004705 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004706 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004707 status = mbedtls_to_psa_error(
4708 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4709 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004710 goto exit;
4711
Jaeden Amero97271b32019-01-10 19:38:51 +00004712 status = mbedtls_to_psa_error(
4713 mbedtls_ecdh_calc_secret( &ecdh,
4714 shared_secret_length,
4715 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004716 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004717 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004718 if( status != PSA_SUCCESS )
4719 goto exit;
4720 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4721 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004722
4723exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004724 if( status != PSA_SUCCESS )
4725 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004726 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004727 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004728 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004729
Jaeden Amero97271b32019-01-10 19:38:51 +00004730 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004731}
John Durkop6ba40d12020-11-10 08:50:04 -08004732#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004733
Gilles Peskine01d718c2018-09-18 12:01:02 +02004734#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4735
Gilles Peskine0216fe12019-04-11 21:23:21 +02004736static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4737 psa_key_slot_t *private_key,
4738 const uint8_t *peer_key,
4739 size_t peer_key_length,
4740 uint8_t *shared_secret,
4741 size_t shared_secret_size,
4742 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004743{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004744 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004745 {
John Durkop6ba40d12020-11-10 08:50:04 -08004746#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004747 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004748 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004749 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004750 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004751 psa_status_t status = mbedtls_psa_ecp_load_representation(
4752 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004753 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004754 private_key->key.data,
4755 private_key->key.bytes,
4756 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004757 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004758 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004759 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004760 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004761 shared_secret, shared_secret_size,
4762 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004763 mbedtls_ecp_keypair_free( ecp );
4764 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004765 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004766#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004767 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004768 (void) private_key;
4769 (void) peer_key;
4770 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004771 (void) shared_secret;
4772 (void) shared_secret_size;
4773 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004774 return( PSA_ERROR_NOT_SUPPORTED );
4775 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004776}
4777
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004778/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004779 * to potentially free embedded data structures and wipe confidential data.
4780 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004781static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004782 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004783 psa_key_slot_t *private_key,
4784 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004785 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004786{
4787 psa_status_t status;
4788 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4789 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004790 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004791
4792 /* Step 1: run the secret agreement algorithm to generate the shared
4793 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004794 status = psa_key_agreement_raw_internal( ka_alg,
4795 private_key,
4796 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004797 shared_secret,
4798 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004799 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004800 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004801 goto exit;
4802
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004803 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004804 * the shared secret. A shared secret is permitted wherever a key
4805 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004806 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004807 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004808 shared_secret,
4809 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004810exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004811 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004812 return( status );
4813}
4814
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004815psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004816 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004817 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004818 const uint8_t *peer_key,
4819 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004820{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004821 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004822 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004823 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004824
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004825 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004826 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004827 status = psa_get_and_lock_transparent_key_slot_with_policy(
4828 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004829 if( status != PSA_SUCCESS )
4830 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004831 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004832 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004833 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004834 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004835 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004836 else
4837 {
4838 /* If a private key has been added as SECRET, we allow the derived
4839 * key material to be used as a key in PSA Crypto. */
4840 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4841 operation->can_output_key = 1;
4842 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004843
Ronald Cron5c522922020-11-14 16:35:34 +01004844 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004845
Ronald Cron5c522922020-11-14 16:35:34 +01004846 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004847}
4848
Gilles Peskinebe697d82019-05-16 18:00:41 +02004849psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004850 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004851 const uint8_t *peer_key,
4852 size_t peer_key_length,
4853 uint8_t *output,
4854 size_t output_size,
4855 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004856{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004858 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004859 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004860
4861 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4862 {
4863 status = PSA_ERROR_INVALID_ARGUMENT;
4864 goto exit;
4865 }
Ronald Cron5c522922020-11-14 16:35:34 +01004866 status = psa_get_and_lock_transparent_key_slot_with_policy(
4867 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004868 if( status != PSA_SUCCESS )
4869 goto exit;
4870
4871 status = psa_key_agreement_raw_internal( alg, slot,
4872 peer_key, peer_key_length,
4873 output, output_size,
4874 output_length );
4875
4876exit:
4877 if( status != PSA_SUCCESS )
4878 {
4879 /* If an error happens and is not handled properly, the output
4880 * may be used as a key to protect sensitive data. Arrange for such
4881 * a key to be random, which is likely to result in decryption or
4882 * verification errors. This is better than filling the buffer with
4883 * some constant data such as zeros, which would result in the data
4884 * being protected with a reproducible, easily knowable key.
4885 */
4886 psa_generate_random( output, output_size );
4887 *output_length = output_size;
4888 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004889
Ronald Cron5c522922020-11-14 16:35:34 +01004890 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004891
Ronald Cron5c522922020-11-14 16:35:34 +01004892 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004893}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004894
4895
Gilles Peskine30524eb2020-11-13 17:02:26 +01004896
Gilles Peskine86a440b2018-11-12 18:39:40 +01004897/****************************************************************/
4898/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004899/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004900
Gilles Peskine30524eb2020-11-13 17:02:26 +01004901/** Initialize the PSA random generator.
4902 */
4903static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4904{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004905#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4906 memset( rng, 0, sizeof( *rng ) );
4907#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4908
Gilles Peskine30524eb2020-11-13 17:02:26 +01004909 /* Set default configuration if
4910 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4911 if( rng->entropy_init == NULL )
4912 rng->entropy_init = mbedtls_entropy_init;
4913 if( rng->entropy_free == NULL )
4914 rng->entropy_free = mbedtls_entropy_free;
4915
4916 rng->entropy_init( &rng->entropy );
4917#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4918 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4919 /* The PSA entropy injection feature depends on using NV seed as an entropy
4920 * source. Add NV seed as an entropy source for PSA entropy injection. */
4921 mbedtls_entropy_add_source( &rng->entropy,
4922 mbedtls_nv_seed_poll, NULL,
4923 MBEDTLS_ENTROPY_BLOCK_SIZE,
4924 MBEDTLS_ENTROPY_SOURCE_STRONG );
4925#endif
4926
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004927 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004928#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004929}
4930
4931/** Deinitialize the PSA random generator.
4932 */
4933static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4934{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004935#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4936 memset( rng, 0, sizeof( *rng ) );
4937#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004938 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004939 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004940#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004941}
4942
4943/** Seed the PSA random generator.
4944 */
4945static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4946{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004947#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4948 /* Do nothing: the external RNG seeds itself. */
4949 (void) rng;
4950 return( PSA_SUCCESS );
4951#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004952 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004953 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4954 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004955 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004956#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004957}
4958
Gilles Peskinee59236f2018-01-27 23:32:46 +01004959psa_status_t psa_generate_random( uint8_t *output,
4960 size_t output_size )
4961{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004962 GUARD_MODULE_INITIALIZED;
4963
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004964#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4965
4966 size_t output_length = 0;
4967 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4968 output, output_size,
4969 &output_length );
4970 if( status != PSA_SUCCESS )
4971 return( status );
4972 /* Breaking up a request into smaller chunks is currently not supported
4973 * for the extrernal RNG interface. */
4974 if( output_length != output_size )
4975 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4976 return( PSA_SUCCESS );
4977
4978#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4979
Gilles Peskine71ddab92021-01-04 21:01:07 +01004980 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004981 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004982 size_t request_size =
4983 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4984 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4985 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004986 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4987 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004988 if( ret != 0 )
4989 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004990 output_size -= request_size;
4991 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004992 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004993 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004994#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004995}
4996
Gilles Peskine8814fc42020-12-14 15:33:44 +01004997/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004998 *
4999 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5000 * `psa_generate_random(...)`. The state parameter is ignored since the
5001 * PSA API doesn't support passing an explicit state.
5002 *
5003 * In the non-external case, psa_generate_random() calls an
5004 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5005 * and semantics as mbedtls_psa_get_random(). As an optimization,
5006 * instead of doing this back-and-forth between the PSA API and the
5007 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5008 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005009 */
5010#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5011int mbedtls_psa_get_random( void *p_rng,
5012 unsigned char *output,
5013 size_t output_size )
5014{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005015 /* This function takes a pointer to the RNG state because that's what
5016 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5017 * its own state internally and doesn't let the caller access that state.
5018 * So we just ignore the state parameter, and in practice we'll pass
5019 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005020 (void) p_rng;
5021 psa_status_t status = psa_generate_random( output, output_size );
5022 if( status == PSA_SUCCESS )
5023 return( 0 );
5024 else
5025 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5026}
5027#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5028
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005029#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005030#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005031
Gilles Peskine7228da22019-07-15 11:06:15 +02005032psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005033 size_t seed_size )
5034{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005035 if( global_data.initialized )
5036 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005037
5038 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5039 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5040 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5041 return( PSA_ERROR_INVALID_ARGUMENT );
5042
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005043 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005044}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005045#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005046
Ronald Cron3772afe2021-02-08 16:10:05 +01005047/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005048 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005049 * \param type The key type
5050 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005051 *
5052 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005053 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005054 * \retval #PSA_ERROR_INVALID_ARGUMENT
5055 * The size in bits of the key is not valid.
5056 * \retval #PSA_ERROR_NOT_SUPPORTED
5057 * The type and/or the size in bits of the key or the combination of
5058 * the two is not supported.
5059 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005060static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5061 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005062{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005064
Gilles Peskinee59236f2018-01-27 23:32:46 +01005065 if( key_type_is_raw_bytes( type ) )
5066 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005067 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005068 if( status != PSA_SUCCESS )
5069 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005070 }
5071 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005072#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005073 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5074 {
5075 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5076 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005077
Ronald Cron01b2aba2020-10-05 09:42:02 +02005078 /* Accept only byte-aligned keys, for the same reasons as
5079 * in psa_import_rsa_key(). */
5080 if( bits % 8 != 0 )
5081 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005082 }
5083 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005084#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005085
Ronald Cron5c4d3862020-12-07 11:07:24 +01005086#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005087 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5088 {
Ronald Crond81ab562021-02-16 09:01:16 +01005089 /* To avoid empty block, return successfully here. */
5090 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005091 }
5092 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005093#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005094 {
5095 return( PSA_ERROR_NOT_SUPPORTED );
5096 }
5097
5098 return( PSA_SUCCESS );
5099}
5100
Ronald Cron55ed0592020-10-05 10:30:40 +02005101psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005102 const psa_key_attributes_t *attributes,
5103 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005104{
5105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005106 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005107
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005108 if( ( attributes->domain_parameters == NULL ) &&
5109 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005110 return( PSA_ERROR_INVALID_ARGUMENT );
5111
Ronald Cron01b2aba2020-10-05 09:42:02 +02005112 if( key_type_is_raw_bytes( type ) )
5113 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005114 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005115 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005116 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005117
David Brown12ca5032021-02-11 11:02:00 -07005118#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005119 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005120 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005121#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005122 }
5123 else
5124
John Durkop07cc04a2020-11-16 22:08:34 -08005125#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005126 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005127 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005128 return( mbedtls_psa_rsa_generate_key( attributes,
5129 key_buffer,
5130 key_buffer_size,
5131 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005132 }
5133 else
John Durkop07cc04a2020-11-16 22:08:34 -08005134#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005135
John Durkop9814fa22020-11-04 12:28:15 -08005136#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005137 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005138 {
Ronald Cron7023db52020-11-20 18:17:42 +01005139 return( mbedtls_psa_ecp_generate_key( attributes,
5140 key_buffer,
5141 key_buffer_size,
5142 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005143 }
5144 else
John Durkop9814fa22020-11-04 12:28:15 -08005145#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005146 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005147 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005148 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005149 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005150
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005151 return( PSA_SUCCESS );
5152}
Darryl Green0c6575a2018-11-07 16:05:30 +00005153
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005154psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005155 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005156{
5157 psa_status_t status;
5158 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005159 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005160 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005161
Ronald Cron81709fc2020-11-14 12:10:32 +01005162 *key = MBEDTLS_SVC_KEY_ID_INIT;
5163
Gilles Peskine0f84d622019-09-12 19:03:13 +02005164 /* Reject any attempt to create a zero-length key so that we don't
5165 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5166 if( psa_get_key_bits( attributes ) == 0 )
5167 return( PSA_ERROR_INVALID_ARGUMENT );
5168
Ronald Cron81709fc2020-11-14 12:10:32 +01005169 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5170 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005171 if( status != PSA_SUCCESS )
5172 goto exit;
5173
Ronald Cron977c2472020-10-13 08:32:21 +02005174 /* In the case of a transparent key or an opaque key stored in local
5175 * storage (thus not in the case of generating a key in a secure element
5176 * or cryptoprocessor with storage), we have to allocate a buffer to
5177 * hold the generated key material. */
5178 if( slot->key.data == NULL )
5179 {
5180 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5181 PSA_KEY_LOCATION_LOCAL_STORAGE )
5182 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005183 status = psa_validate_key_type_and_size_for_key_generation(
5184 attributes->core.type, attributes->core.bits );
5185 if( status != PSA_SUCCESS )
5186 goto exit;
5187
5188 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5189 attributes->core.type,
5190 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005191 }
5192 else
5193 {
5194 status = psa_driver_wrapper_get_key_buffer_size(
5195 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005196 if( status != PSA_SUCCESS )
5197 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005198 }
Ronald Cron977c2472020-10-13 08:32:21 +02005199
5200 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5201 if( status != PSA_SUCCESS )
5202 goto exit;
5203 }
5204
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005205 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005206 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005207
Ronald Cron2b56bc82020-10-05 10:02:26 +02005208 if( status != PSA_SUCCESS )
5209 psa_remove_key_data_from_memory( slot );
5210
Gilles Peskine11792082019-08-06 18:36:36 +02005211exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005212 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005213 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005214 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005215 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005216
Darryl Green0c6575a2018-11-07 16:05:30 +00005217 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005218}
5219
Gilles Peskinee59236f2018-01-27 23:32:46 +01005220/****************************************************************/
5221/* Module setup */
5222/****************************************************************/
5223
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005224#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005225psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5226 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5227 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5228{
5229 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5230 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005231 global_data.rng.entropy_init = entropy_init;
5232 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005233 return( PSA_SUCCESS );
5234}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005235#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005236
Gilles Peskinee59236f2018-01-27 23:32:46 +01005237void mbedtls_psa_crypto_free( void )
5238{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005239 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005240 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5241 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005242 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005243 }
5244 /* Wipe all remaining data, including configuration.
5245 * In particular, this sets all state indicator to the value
5246 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005247 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005248#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005249 /* Unregister all secure element drivers, so that we restart from
5250 * a pristine state. */
5251 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005253}
5254
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005255#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5256/** Recover a transaction that was interrupted by a power failure.
5257 *
5258 * This function is called during initialization, before psa_crypto_init()
5259 * returns. If this function returns a failure status, the initialization
5260 * fails.
5261 */
5262static psa_status_t psa_crypto_recover_transaction(
5263 const psa_crypto_transaction_t *transaction )
5264{
5265 switch( transaction->unknown.type )
5266 {
5267 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5268 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005269 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005270 * is implemented.
5271 * https://github.com/ARMmbed/mbed-crypto/issues/218
5272 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005273 default:
5274 /* We found an unsupported transaction in the storage.
5275 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005276 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005277 }
5278}
5279#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5280
Gilles Peskinee59236f2018-01-27 23:32:46 +01005281psa_status_t psa_crypto_init( void )
5282{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005283 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005284
Gilles Peskinec6b69072018-11-20 21:42:52 +01005285 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005286 if( global_data.initialized != 0 )
5287 return( PSA_SUCCESS );
5288
Gilles Peskine30524eb2020-11-13 17:02:26 +01005289 /* Initialize and seed the random generator. */
5290 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005291 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005292 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005293 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005294 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005295 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005296
Gilles Peskine66fb1262018-12-10 16:29:04 +01005297 status = psa_initialize_key_slots( );
5298 if( status != PSA_SUCCESS )
5299 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005300
Gilles Peskined9348f22019-10-01 15:22:29 +02005301#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5302 status = psa_init_all_se_drivers( );
5303 if( status != PSA_SUCCESS )
5304 goto exit;
5305#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5306
Gilles Peskine4b734222019-07-24 15:56:31 +02005307#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005308 status = psa_crypto_load_transaction( );
5309 if( status == PSA_SUCCESS )
5310 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005311 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5312 if( status != PSA_SUCCESS )
5313 goto exit;
5314 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005315 }
5316 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5317 {
5318 /* There's no transaction to complete. It's all good. */
5319 status = PSA_SUCCESS;
5320 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005321#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005322
Gilles Peskinec6b69072018-11-20 21:42:52 +01005323 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005324 global_data.initialized = 1;
5325
5326exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005327 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005328 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005329 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005330}
5331
5332#endif /* MBEDTLS_PSA_CRYPTO_C */