blob: 664b8aecce5bd9193170e9888849d25c3a8a4426 [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 |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001495 PSA_KEY_USAGE_SIGN_MESSAGE |
1496 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001497 PSA_KEY_USAGE_SIGN_HASH |
1498 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001499 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001500 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1501 return( PSA_ERROR_INVALID_ARGUMENT );
1502
Gilles Peskine4747d192019-04-17 15:05:45 +02001503 return( PSA_SUCCESS );
1504}
1505
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506/** Validate the internal consistency of key attributes.
1507 *
1508 * This function only rejects invalid attribute values. If does not
1509 * validate the consistency of the attributes with any key data that may
1510 * be involved in the creation of the key.
1511 *
1512 * Call this function early in the key creation process.
1513 *
1514 * \param[in] attributes Key attributes for the new key.
1515 * \param[out] p_drv On any return, the driver for the key, if any.
1516 * NULL for a transparent key.
1517 *
1518 */
1519static psa_status_t psa_validate_key_attributes(
1520 const psa_key_attributes_t *attributes,
1521 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001522{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001523 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001524 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001525 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001526
Ronald Cron54b90082020-10-29 15:26:43 +01001527 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001528 if( status != PSA_SUCCESS )
1529 return( status );
1530
Ronald Crond2ed4812020-07-17 16:11:30 +02001531 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001532 if( status != PSA_SUCCESS )
1533 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534
Ronald Cron65f38a32020-10-23 17:11:13 +02001535 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1536 {
1537 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1538 return( PSA_ERROR_INVALID_ARGUMENT );
1539 }
1540 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001541 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001542 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1543 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001544 }
1545
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001546 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001547 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001548 return( status );
1549
1550 /* Refuse to create overly large keys.
1551 * Note that this doesn't trigger on import if the attributes don't
1552 * explicitly specify a size (so psa_get_key_bits returns 0), so
1553 * psa_import_key() needs its own checks. */
1554 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1555 return( PSA_ERROR_NOT_SUPPORTED );
1556
Gilles Peskine91e8c332019-08-02 19:19:39 +02001557 /* Reject invalid flags. These should not be reachable through the API. */
1558 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1559 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1560 return( PSA_ERROR_INVALID_ARGUMENT );
1561
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001562 return( PSA_SUCCESS );
1563}
1564
Gilles Peskine4747d192019-04-17 15:05:45 +02001565/** Prepare a key slot to receive key material.
1566 *
1567 * This function allocates a key slot and sets its metadata.
1568 *
1569 * If this function fails, call psa_fail_key_creation().
1570 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001571 * This function is intended to be used as follows:
1572 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001573 * it with the specified attributes, and in case of a volatile key assign it
1574 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001575 * -# Populate the slot with the key material.
1576 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1577 * In case of failure at any step, stop the sequence and call
1578 * psa_fail_key_creation().
1579 *
Ronald Cron5c522922020-11-14 16:35:34 +01001580 * On success, the key slot is locked. It is the responsibility of the caller
1581 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001582 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001583 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001584 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001585 * \param[out] p_slot On success, a pointer to the prepared slot.
1586 * \param[out] p_drv On any return, the driver for the key, if any.
1587 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001588 *
1589 * \retval #PSA_SUCCESS
1590 * The key slot is ready to receive key material.
1591 * \return If this function fails, the key slot is an invalid state.
1592 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001593 */
1594static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001595 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001596 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001597 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001598 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001599{
1600 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001601 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001602 psa_key_slot_t *slot;
1603
Gilles Peskinedf179142019-07-15 22:02:14 +02001604 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001605 *p_drv = NULL;
1606
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001607 status = psa_validate_key_attributes( attributes, p_drv );
1608 if( status != PSA_SUCCESS )
1609 return( status );
1610
Ronald Cronc4d1b512020-07-31 11:26:37 +02001611 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001612 if( status != PSA_SUCCESS )
1613 return( status );
1614 slot = *p_slot;
1615
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001616 /* We're storing the declared bit-size of the key. It's up to each
1617 * creation mechanism to verify that this information is correct.
1618 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001619 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001620 * is optional (import, copy). In case of a volatile key, assign it the
1621 * volatile key identifier associated to the slot returned to contain its
1622 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001623
1624 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001625 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1626 {
1627#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1628 slot->attr.id = volatile_key_id;
1629#else
1630 slot->attr.id.key_id = volatile_key_id;
1631#endif
1632 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001633
Gilles Peskine91e8c332019-08-02 19:19:39 +02001634 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001635 * external-only flags, query `attributes`. Thanks to the check
1636 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001637 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001638 * may have set. */
1639 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001640
Gilles Peskinecbaff462019-07-12 23:46:04 +02001641#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001642 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001643 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001644 * create the key file in internal storage, create the
1645 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646 * persistent data. This is done by starting a transaction that will
1647 * encompass these three actions.
1648 * For registering a volatile key, we just need to find an appropriate
1649 * slot number inside the SE. Since the key is designated volatile, creating
1650 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001651 /* The first thing to do is to find a slot number for the new key.
1652 * We save the slot number in persistent storage as part of the
1653 * transaction data. It will be needed to recover if the power
1654 * fails during the key creation process, to clean up on the secure
1655 * element side after restarting. Obtaining a slot number from the
1656 * secure element driver updates its persistent state, but we do not yet
1657 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001658 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001659 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001660 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001662 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001663 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001664 if( status != PSA_SUCCESS )
1665 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001666
1667 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001668 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001669 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1670 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001671 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001672 psa_crypto_transaction.key.id = slot->attr.id;
1673 status = psa_crypto_save_transaction( );
1674 if( status != PSA_SUCCESS )
1675 {
1676 (void) psa_crypto_stop_transaction( );
1677 return( status );
1678 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001679 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001680
1681 status = psa_copy_key_material_into_slot(
1682 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001683 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001684
1685 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1686 {
1687 /* Key registration only makes sense with a secure element. */
1688 return( PSA_ERROR_INVALID_ARGUMENT );
1689 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001690#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1691
Ronald Cronc4d1b512020-07-31 11:26:37 +02001692 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001693}
Gilles Peskine4747d192019-04-17 15:05:45 +02001694
1695/** Finalize the creation of a key once its key material has been set.
1696 *
1697 * This entails writing the key to persistent storage.
1698 *
1699 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001700 * See the documentation of psa_start_key_creation() for the intended use
1701 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001702 *
Ronald Cron5c522922020-11-14 16:35:34 +01001703 * If the finalization succeeds, the function unlocks the key slot (it was
1704 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1705 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001706 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001707 * \param[in,out] slot Pointer to the slot with key material.
1708 * \param[in] driver The secure element driver for the key,
1709 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001710 * \param[out] key On success, identifier of the key. Note that the
1711 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001712 *
1713 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001714 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001715 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1716 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1717 * \retval #PSA_ERROR_ALREADY_EXISTS
1718 * \retval #PSA_ERROR_DATA_INVALID
1719 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001720 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001721 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001722 * \return If this function fails, the key slot is an invalid state.
1723 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001724 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001725static psa_status_t psa_finish_key_creation(
1726 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001727 psa_se_drv_table_entry_t *driver,
1728 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001729{
1730 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001731 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001732 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001733
1734#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001735 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001736 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001737#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1738 if( driver != NULL )
1739 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001740 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 psa_key_slot_number_t slot_number =
1742 psa_key_slot_get_slot_number( slot ) ;
1743
Gilles Peskineb46bef22019-07-30 21:32:04 +02001744#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001745 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001746 sizeof( data.slot_number ),
1747 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001748#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001750 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001751 (uint8_t*) &data,
1752 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001753 }
1754 else
1755#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1756 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001757 /* Key material is saved in export representation in the slot, so
1758 * just pass the slot buffer for storage. */
1759 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001760 slot->key.data,
1761 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001762 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001763 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001764#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1765
Gilles Peskinecbaff462019-07-12 23:46:04 +02001766#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001767 /* Finish the transaction for a key creation. This does not
1768 * happen when registering an existing key. Detect this case
1769 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001770 * creation of a persistent key in a secure element requires a transaction,
1771 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001772 if( driver != NULL &&
1773 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001774 {
1775 status = psa_save_se_persistent_data( driver );
1776 if( status != PSA_SUCCESS )
1777 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001778 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001779 return( status );
1780 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001781 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001782 }
1783#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1784
Ronald Cron50972942020-11-14 11:28:25 +01001785 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001786 {
1787 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001788 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001789 if( status != PSA_SUCCESS )
1790 *key = MBEDTLS_SVC_KEY_ID_INIT;
1791 }
Ronald Cron50972942020-11-14 11:28:25 +01001792
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 return( status );
1794}
1795
1796/** Abort the creation of a key.
1797 *
1798 * You may call this function after calling psa_start_key_creation(),
1799 * or after psa_finish_key_creation() fails. In other circumstances, this
1800 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001801 * See the documentation of psa_start_key_creation() for the intended use
1802 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001804 * \param[in,out] slot Pointer to the slot with key material.
1805 * \param[in] driver The secure element driver for the key,
1806 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001807 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001808static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001809 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001810{
Gilles Peskine011e4282019-06-26 18:34:38 +02001811 (void) driver;
1812
Gilles Peskine4747d192019-04-17 15:05:45 +02001813 if( slot == NULL )
1814 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001815
1816#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001817 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001818 * element, and the failure happened later (when saving metadata
1819 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001820 * element.
1821 * https://github.com/ARMmbed/mbed-crypto/issues/217
1822 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001823
Gilles Peskined7729582019-08-05 15:55:54 +02001824 /* Abort the ongoing transaction if any (there may not be one if
1825 * the creation process failed before starting one, or if the
1826 * key creation is a registration of a key in a secure element).
1827 * Earlier functions must already have done what it takes to undo any
1828 * partial creation. All that's left is to update the transaction data
1829 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001830 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001831#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1832
Gilles Peskine4747d192019-04-17 15:05:45 +02001833 psa_wipe_key_slot( slot );
1834}
1835
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001836/** Validate optional attributes during key creation.
1837 *
1838 * Some key attributes are optional during key creation. If they are
1839 * specified in the attributes structure, check that they are consistent
1840 * with the data in the slot.
1841 *
1842 * This function should be called near the end of key creation, after
1843 * the slot in memory is fully populated but before saving persistent data.
1844 */
1845static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001846 const psa_key_slot_t *slot,
1847 const psa_key_attributes_t *attributes )
1848{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001849 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001851 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001852 return( PSA_ERROR_INVALID_ARGUMENT );
1853 }
1854
1855 if( attributes->domain_parameters_size != 0 )
1856 {
John Durkop0e005192020-10-31 22:06:54 -07001857#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1858 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001859 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001861 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001862 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001864
Ronald Cron90857082020-11-25 14:58:33 +01001865 psa_status_t status = mbedtls_psa_rsa_load_representation(
1866 slot->attr.type,
1867 slot->key.data,
1868 slot->key.bytes,
1869 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001870 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001871 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001872
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001873 mbedtls_mpi_init( &actual );
1874 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001875 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001877 mbedtls_rsa_free( rsa );
1878 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001879 if( ret != 0 )
1880 goto rsa_exit;
1881 ret = mbedtls_mpi_read_binary( &required,
1882 attributes->domain_parameters,
1883 attributes->domain_parameters_size );
1884 if( ret != 0 )
1885 goto rsa_exit;
1886 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1887 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1888 rsa_exit:
1889 mbedtls_mpi_free( &actual );
1890 mbedtls_mpi_free( &required );
1891 if( ret != 0)
1892 return( mbedtls_to_psa_error( ret ) );
1893 }
1894 else
John Durkop9814fa22020-11-04 12:28:15 -08001895#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1896 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001897 {
1898 return( PSA_ERROR_INVALID_ARGUMENT );
1899 }
1900 }
1901
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001902 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001903 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001904 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001905 return( PSA_ERROR_INVALID_ARGUMENT );
1906 }
1907
1908 return( PSA_SUCCESS );
1909}
1910
Gilles Peskine4747d192019-04-17 15:05:45 +02001911psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001912 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001913 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001914 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001915{
1916 psa_status_t status;
1917 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001918 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001919 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001920
Ronald Cron81709fc2020-11-14 12:10:32 +01001921 *key = MBEDTLS_SVC_KEY_ID_INIT;
1922
Gilles Peskine0f84d622019-09-12 19:03:13 +02001923 /* Reject zero-length symmetric keys (including raw data key objects).
1924 * This also rejects any key which might be encoded as an empty string,
1925 * which is never valid. */
1926 if( data_length == 0 )
1927 return( PSA_ERROR_INVALID_ARGUMENT );
1928
Gilles Peskinedf179142019-07-15 22:02:14 +02001929 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001930 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931 if( status != PSA_SUCCESS )
1932 goto exit;
1933
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001934 /* In the case of a transparent key or an opaque key stored in local
1935 * storage (thus not in the case of generating a key in a secure element
1936 * or cryptoprocessor with storage), we have to allocate a buffer to
1937 * hold the generated key material. */
1938 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001939 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001940 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001941 if( status != PSA_SUCCESS )
1942 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001943 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001944
1945 bits = slot->attr.bits;
1946 status = psa_driver_wrapper_import_key( attributes,
1947 data, data_length,
1948 slot->key.data,
1949 slot->key.bytes,
1950 &slot->key.bytes, &bits );
1951 if( status != PSA_SUCCESS )
1952 goto exit;
1953
1954 if( slot->attr.bits == 0 )
1955 slot->attr.bits = (psa_key_bits_t) bits;
1956 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001957 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001958 status = PSA_ERROR_INVALID_ARGUMENT;
1959 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001960 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001961
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001962 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001963 if( status != PSA_SUCCESS )
1964 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001965
Ronald Cron81709fc2020-11-14 12:10:32 +01001966 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001967exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001968 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001969 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001970
Gilles Peskine4747d192019-04-17 15:05:45 +02001971 return( status );
1972}
1973
Gilles Peskined7729582019-08-05 15:55:54 +02001974#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1975psa_status_t mbedtls_psa_register_se_key(
1976 const psa_key_attributes_t *attributes )
1977{
1978 psa_status_t status;
1979 psa_key_slot_t *slot = NULL;
1980 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001981 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001982
1983 /* Leaving attributes unspecified is not currently supported.
1984 * It could make sense to query the key type and size from the
1985 * secure element, but not all secure elements support this
1986 * and the driver HAL doesn't currently support it. */
1987 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1988 return( PSA_ERROR_NOT_SUPPORTED );
1989 if( psa_get_key_bits( attributes ) == 0 )
1990 return( PSA_ERROR_NOT_SUPPORTED );
1991
1992 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001993 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001994 if( status != PSA_SUCCESS )
1995 goto exit;
1996
Ronald Cron81709fc2020-11-14 12:10:32 +01001997 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001998
1999exit:
2000 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002001 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002002
Gilles Peskined7729582019-08-05 15:55:54 +02002003 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002004 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002005 return( status );
2006}
2007#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2008
Gilles Peskinef603c712019-01-19 13:40:11 +01002009static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002010 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002011{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002012 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002013 source->key.data,
2014 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002015 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002016 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002017
Steven Cooreman398aee52020-10-13 14:35:45 +02002018 target->attr.type = source->attr.type;
2019 target->attr.bits = source->attr.bits;
2020
2021 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002022}
2023
Ronald Croncf56a0a2020-08-04 09:51:30 +02002024psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002025 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002026 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002027{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002029 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002030 psa_key_slot_t *source_slot = NULL;
2031 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002032 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002033 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002034
Ronald Cron81709fc2020-11-14 12:10:32 +01002035 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2036
Ronald Cron5c522922020-11-14 16:35:34 +01002037 status = psa_get_and_lock_transparent_key_slot_with_policy(
2038 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002039 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040 goto exit;
2041
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002042 status = psa_validate_optional_attributes( source_slot,
2043 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002044 if( status != PSA_SUCCESS )
2045 goto exit;
2046
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002047 status = psa_restrict_key_policy( source_slot->attr.type,
2048 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002049 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002050 if( status != PSA_SUCCESS )
2051 goto exit;
2052
Ronald Cron81709fc2020-11-14 12:10:32 +01002053 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2054 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002055 if( status != PSA_SUCCESS )
2056 goto exit;
2057
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002058#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2059 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002060 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002061 /* Copying to a secure element is not implemented yet. */
2062 status = PSA_ERROR_NOT_SUPPORTED;
2063 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002064 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002065#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002066
Ronald Cron6cc66312021-04-02 12:27:47 +02002067 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2068 {
2069 /*
2070 * Copying through an opaque driver is not implemented yet, consider
2071 * a lifetime with an external location as an invalid parameter for
2072 * now.
2073 */
2074 status = PSA_ERROR_INVALID_ARGUMENT;
2075 goto exit;
2076 }
2077
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002078 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002079 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002081
Ronald Cron81709fc2020-11-14 12:10:32 +01002082 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002083exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002084 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002085 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002086
Ronald Cron5c522922020-11-14 16:35:34 +01002087 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002088
Ronald Cron5c522922020-11-14 16:35:34 +01002089 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002090}
2091
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002092
2093
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002094/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002095/* Message digests */
2096/****************************************************************/
2097
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2099{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002100 /* Aborting a non-active operation is allowed */
2101 if( operation->id == 0 )
2102 return( PSA_SUCCESS );
2103
2104 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2105 operation->id = 0;
2106
2107 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002108}
2109
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002110psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002111 psa_algorithm_t alg )
2112{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002113 /* A context must be freshly initialized before it can be set up. */
2114 if( operation->id != 0 )
2115 return( PSA_ERROR_BAD_STATE );
2116
2117 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002118 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002119
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002120 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2121 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002122 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2123
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002124 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002125}
2126
2127psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2128 const uint8_t *input,
2129 size_t input_length )
2130{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131 if( operation->id == 0 )
2132 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002133
Steven Cooremanc8288352021-03-04 14:02:19 +01002134 /* Don't require hash implementations to behave correctly on a
2135 * zero-length input, which may have an invalid pointer. */
2136 if( input_length == 0 )
2137 return( PSA_SUCCESS );
2138
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002139 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2140 input, input_length );
2141 if( status != PSA_SUCCESS )
2142 psa_hash_abort( operation );
2143
2144 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002145}
2146
2147psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2148 uint8_t *hash,
2149 size_t hash_size,
2150 size_t *hash_length )
2151{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002152 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002153 if( operation->id == 0 )
2154 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155
Steven Cooreman1e582352021-02-18 17:24:37 +01002156 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002157 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002158 psa_hash_abort( operation );
2159 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002160}
2161
Gilles Peskine2d277862018-06-18 15:41:12 +02002162psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2163 const uint8_t *hash,
2164 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165{
2166 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2167 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168 psa_status_t status = psa_hash_finish(
2169 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002170 actual_hash, sizeof( actual_hash ),
2171 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172 if( status != PSA_SUCCESS )
2173 return( status );
2174 if( actual_hash_length != hash_length )
2175 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002176 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 return( PSA_ERROR_INVALID_SIGNATURE );
2178 return( PSA_SUCCESS );
2179}
2180
Gilles Peskine0a749c82019-11-28 19:33:58 +01002181psa_status_t psa_hash_compute( psa_algorithm_t alg,
2182 const uint8_t *input, size_t input_length,
2183 uint8_t *hash, size_t hash_size,
2184 size_t *hash_length )
2185{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002186 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002187 if( !PSA_ALG_IS_HASH( alg ) )
2188 return( PSA_ERROR_INVALID_ARGUMENT );
2189
Steven Cooreman1e582352021-02-18 17:24:37 +01002190 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2191 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002192}
2193
2194psa_status_t psa_hash_compare( psa_algorithm_t alg,
2195 const uint8_t *input, size_t input_length,
2196 const uint8_t *hash, size_t hash_length )
2197{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002198 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2199 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002200
2201 if( !PSA_ALG_IS_HASH( alg ) )
2202 return( PSA_ERROR_INVALID_ARGUMENT );
2203
Steven Cooreman1e582352021-02-18 17:24:37 +01002204 psa_status_t status = psa_driver_wrapper_hash_compute(
2205 alg, input, input_length,
2206 actual_hash, sizeof(actual_hash),
2207 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002208 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002209 return( status );
2210 if( actual_hash_length != hash_length )
2211 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002212 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002213 return( PSA_ERROR_INVALID_SIGNATURE );
2214 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002215}
2216
Gilles Peskineeb35d782019-01-22 17:56:16 +01002217psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2218 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002219{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002220 if( source_operation->id == 0 ||
2221 target_operation->id != 0 )
2222 {
2223 return( PSA_ERROR_BAD_STATE );
2224 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002225
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002226 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2227 target_operation );
2228 if( status != PSA_SUCCESS )
2229 psa_hash_abort( target_operation );
2230
2231 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002232}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233
2234
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002236/* MAC */
2237/****************************************************************/
2238
Steven Cooremane6804192021-03-19 18:28:56 +01002239psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002240{
Steven Cooremane6804192021-03-19 18:28:56 +01002241 /* Aborting a non-active operation is allowed */
2242 if( operation->id == 0 )
2243 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002244
Steven Cooremane6804192021-03-19 18:28:56 +01002245 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002246 operation->mac_size = 0;
2247 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002248 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002249
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002250 return( status );
2251}
2252
Steven Cooremane6804192021-03-19 18:28:56 +01002253static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002254 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002255 psa_algorithm_t alg,
2256 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002257{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002259 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002260 psa_key_slot_t *slot;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002261
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002262 /* A context must be freshly initialized before it can be set up. */
Steven Cooremane6804192021-03-19 18:28:56 +01002263 if( operation->id != 0 )
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002264 return( PSA_ERROR_BAD_STATE );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002265
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002266 if( ! PSA_ALG_IS_MAC( alg ) )
2267 return( PSA_ERROR_INVALID_ARGUMENT );
2268
Steven Cooremane6804192021-03-19 18:28:56 +01002269 status = psa_get_and_lock_key_slot_with_policy(
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002270 key,
2271 &slot,
2272 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2273 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002274 if( status != PSA_SUCCESS )
Steven Cooremanba9a5bf2021-04-29 16:21:24 +02002275 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002276
Steven Cooremane6804192021-03-19 18:28:56 +01002277 psa_key_attributes_t attributes = {
2278 .core = slot->attr
2279 };
2280
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002281 /* Validate the combination of key type and algorithm */
Steven Cooremane6804192021-03-19 18:28:56 +01002282 status = psa_mac_key_can_do( alg, psa_get_key_type( &attributes ) );
Steven Cooreman15472f82021-03-02 16:16:22 +01002283 if( status != PSA_SUCCESS )
2284 goto exit;
2285
Steven Cooreman72f736a2021-05-07 14:14:37 +02002286 operation->is_sign = is_sign;
2287
Steven Cooremand1a68f12021-05-10 11:13:41 +02002288 /* Get the output length for the algorithm and key combination */
Steven Cooreman72f736a2021-05-07 14:14:37 +02002289 operation->mac_size = PSA_MAC_LENGTH(
Steven Cooremand1a68f12021-05-10 11:13:41 +02002290 psa_get_key_type( &attributes ),
2291 psa_get_key_bits( &attributes ),
2292 alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002293
Steven Cooreman72f736a2021-05-07 14:14:37 +02002294 if( operation->mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002295 {
2296 /* A very short MAC is too short for security since it can be
2297 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2298 * so we make this our minimum, even though 32 bits is still
2299 * too small for security. */
2300 status = PSA_ERROR_NOT_SUPPORTED;
2301 goto exit;
2302 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002303
Steven Cooreman72f736a2021-05-07 14:14:37 +02002304 if( operation->mac_size > PSA_MAC_LENGTH( psa_get_key_type( &attributes ),
Steven Cooremand1a68f12021-05-10 11:13:41 +02002305 psa_get_key_bits( &attributes ),
Steven Cooreman72f736a2021-05-07 14:14:37 +02002306 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002307 {
2308 /* It's impossible to "truncate" to a larger length than the full length
2309 * of the algorithm. */
2310 status = PSA_ERROR_INVALID_ARGUMENT;
2311 goto exit;
2312 }
2313
Steven Cooremane6804192021-03-19 18:28:56 +01002314 /* Dispatch the MAC setup call with validated input */
2315 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002316 {
Steven Cooremane6804192021-03-19 18:28:56 +01002317 status = psa_driver_wrapper_mac_sign_setup( operation,
2318 &attributes,
2319 slot->key.data,
2320 slot->key.bytes,
2321 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002322 }
2323 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002324 {
Steven Cooremane6804192021-03-19 18:28:56 +01002325 status = psa_driver_wrapper_mac_verify_setup( operation,
2326 &attributes,
2327 slot->key.data,
2328 slot->key.bytes,
2329 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002330 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002331
Gilles Peskinefbfac682018-07-08 20:51:54 +02002332exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002333 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002334 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002335
Ronald Cron5c522922020-11-14 16:35:34 +01002336 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002337
Ronald Cron5c522922020-11-14 16:35:34 +01002338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339}
2340
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002342 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002343 psa_algorithm_t alg )
2344{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002345 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002346}
2347
2348psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002349 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002350 psa_algorithm_t alg )
2351{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002352 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002353}
2354
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002355psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356 const uint8_t *input,
2357 size_t input_length )
2358{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002359 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002360 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002362 /* Don't require hash implementations to behave correctly on a
2363 * zero-length input, which may have an invalid pointer. */
2364 if( input_length == 0 )
2365 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002366
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002367 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2368 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002369 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002370 psa_mac_abort( operation );
2371
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002372 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373}
2374
Steven Cooremana5b860a2021-03-19 19:04:39 +01002375psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002376 uint8_t *mac,
2377 size_t mac_size,
2378 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002379{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002380 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2381 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002382
Steven Cooreman72f736a2021-05-07 14:14:37 +02002383 /* Set the output length and content to a safe default, such that in
2384 * case the caller misses an error check, the output would be an
2385 * unachievable MAC. */
2386 *mac_length = mac_size;
2387
Steven Cooremana5b860a2021-03-19 19:04:39 +01002388 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002389 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002390
Steven Cooreman72f736a2021-05-07 14:14:37 +02002391 if( ! operation->is_sign )
2392 return( PSA_ERROR_BAD_STATE );
2393
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002394 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2395 * once all the error checks are done. */
2396 if( operation->mac_size == 0 )
2397 return( PSA_ERROR_BAD_STATE );
2398
2399 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002400 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002401
Steven Cooremana5b860a2021-03-19 19:04:39 +01002402 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002403 mac, operation->mac_size,
2404 mac_length );
2405
2406 if( status == PSA_SUCCESS )
2407 {
2408 /* Set the excess room in the output buffer to an invalid value, to
2409 * avoid potentially leaking a longer MAC. */
2410 if( mac_size > operation->mac_size )
2411 memset( &mac[operation->mac_size],
2412 '!',
2413 mac_size - operation->mac_size );
2414 }
2415 else
2416 {
2417 /* Set the output length and content to a safe default, such that in
2418 * case the caller misses an error check, the output would be an
2419 * unachievable MAC. */
2420 *mac_length = mac_size;
2421 memset( mac, '!', mac_size );
2422 }
mohammad16036df908f2018-04-02 08:34:15 -07002423
Steven Cooremana5b860a2021-03-19 19:04:39 +01002424 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002425
Steven Cooremana5b860a2021-03-19 19:04:39 +01002426 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002427}
2428
Steven Cooremana5b860a2021-03-19 19:04:39 +01002429psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002430 const uint8_t *mac,
2431 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2434 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002435
Steven Cooremana5b860a2021-03-19 19:04:39 +01002436 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002437 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002438
Steven Cooreman72f736a2021-05-07 14:14:37 +02002439 if( operation->is_sign )
2440 return( PSA_ERROR_BAD_STATE );
2441
2442 if( operation->mac_size != mac_length )
2443 {
2444 status = PSA_ERROR_INVALID_SIGNATURE;
2445 goto cleanup;
2446 }
2447
Steven Cooremana5b860a2021-03-19 19:04:39 +01002448 status = psa_driver_wrapper_mac_verify_finish( operation,
2449 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002450
2451cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002452 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002453
Steven Cooremana5b860a2021-03-19 19:04:39 +01002454 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002455}
2456
2457
Gilles Peskine20035e32018-02-03 22:44:14 +01002458
Gilles Peskine20035e32018-02-03 22:44:14 +01002459/****************************************************************/
2460/* Asymmetric cryptography */
2461/****************************************************************/
2462
gabor-mezei-armf0486182021-05-12 11:03:09 +02002463static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002464 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002465{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002466 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002467 {
2468 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2469 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002470
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002471 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2472 {
2473 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2474 return( PSA_ERROR_INVALID_ARGUMENT );
2475 }
2476 }
2477 else
2478 {
2479 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2480 return( PSA_ERROR_INVALID_ARGUMENT );
2481 }
2482
2483 return( PSA_SUCCESS );
2484}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002485
2486static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002487 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002488 psa_algorithm_t alg,
2489 const uint8_t * input,
2490 size_t input_length,
2491 uint8_t * signature,
2492 size_t signature_size,
2493 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002494{
2495 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2496 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2497 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002498
2499 *signature_length = 0;
2500
gabor-mezei-armf0486182021-05-12 11:03:09 +02002501 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002502 if( status != PSA_SUCCESS )
2503 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002504
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002505 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002506 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002507 * buffer can in principle be empty since it doesn't actually have
2508 * to be a hash.) */
2509 if( signature_size == 0 )
2510 return( PSA_ERROR_BUFFER_TOO_SMALL );
2511
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002512 status = psa_get_and_lock_key_slot_with_policy(
2513 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002514 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2515 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002516 alg );
2517
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002518 if( status != PSA_SUCCESS )
2519 goto exit;
2520
2521 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2522 {
2523 status = PSA_ERROR_INVALID_ARGUMENT;
2524 goto exit;
2525 }
2526
2527 psa_key_attributes_t attributes = {
2528 .core = slot->attr
2529 };
2530
gabor-mezei-armf0486182021-05-12 11:03:09 +02002531 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002532 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002533 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002534 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002535 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002536 signature, signature_size, signature_length );
2537 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002538 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002539 {
2540
2541 status = psa_driver_wrapper_sign_hash(
2542 &attributes, slot->key.data, slot->key.bytes,
2543 alg, input, input_length,
2544 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002545 }
2546
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002547
2548exit:
2549 /* Fill the unused part of the output buffer (the whole buffer on error,
2550 * the trailing part on success) with something that isn't a valid signature
2551 * (barring an attack on the signature and deliberately-crafted input),
2552 * in case the caller doesn't check the return status properly. */
2553 if( status == PSA_SUCCESS )
2554 memset( signature + *signature_length, '!',
2555 signature_size - *signature_length );
2556 else
2557 memset( signature, '!', signature_size );
2558 /* If signature_size is 0 then we have nothing to do. We must not call
2559 * memset because signature may be NULL in this case. */
2560
2561 unlock_status = psa_unlock_key_slot( slot );
2562
2563 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2564}
2565
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002566static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002567 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002568 psa_algorithm_t alg,
2569 const uint8_t * input,
2570 size_t input_length,
2571 const uint8_t * signature,
2572 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002573{
2574 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2575 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2576 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002577
gabor-mezei-armf0486182021-05-12 11:03:09 +02002578 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002579 if( status != PSA_SUCCESS )
2580 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002581
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002582 status = psa_get_and_lock_key_slot_with_policy(
2583 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002584 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2585 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002586 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002587
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002588 if( status != PSA_SUCCESS )
2589 return( status );
2590
2591 psa_key_attributes_t attributes = {
2592 .core = slot->attr
2593 };
2594
gabor-mezei-armf0486182021-05-12 11:03:09 +02002595 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002596 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002597 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002598 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002599 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002600 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002601 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002602 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002603 {
2604 status = psa_driver_wrapper_verify_hash(
2605 &attributes, slot->key.data, slot->key.bytes,
2606 alg, input, input_length,
2607 signature, signature_length );
2608 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002609
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002610 unlock_status = psa_unlock_key_slot( slot );
2611
2612 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002613
2614}
2615
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002616psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002617 const psa_key_attributes_t *attributes,
2618 const uint8_t *key_buffer,
2619 size_t key_buffer_size,
2620 psa_algorithm_t alg,
2621 const uint8_t *input,
2622 size_t input_length,
2623 uint8_t *signature,
2624 size_t signature_size,
2625 size_t *signature_length )
2626{
2627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002628
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002629 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2630 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002631 size_t hash_length;
2632 uint8_t hash[PSA_HASH_MAX_SIZE];
2633
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002634 status = psa_driver_wrapper_hash_compute(
2635 PSA_ALG_SIGN_GET_HASH( alg ),
2636 input, input_length,
2637 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002638
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002639 if( status != PSA_SUCCESS )
2640 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002641
2642 return psa_driver_wrapper_sign_hash(
2643 attributes, key_buffer, key_buffer_size,
2644 alg, hash, hash_length,
2645 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002646 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002647
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002648 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002649}
2650
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002651psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2652 psa_algorithm_t alg,
2653 const uint8_t * input,
2654 size_t input_length,
2655 uint8_t * signature,
2656 size_t signature_size,
2657 size_t * signature_length )
2658{
2659 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002660 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002661 signature, signature_size, signature_length );
2662}
2663
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002664psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002665 const psa_key_attributes_t *attributes,
2666 const uint8_t *key_buffer,
2667 size_t key_buffer_size,
2668 psa_algorithm_t alg,
2669 const uint8_t *input,
2670 size_t input_length,
2671 const uint8_t *signature,
2672 size_t signature_length )
2673{
2674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002675
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002676 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2677 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002678 size_t hash_length;
2679 uint8_t hash[PSA_HASH_MAX_SIZE];
2680
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002681 status = psa_driver_wrapper_hash_compute(
2682 PSA_ALG_SIGN_GET_HASH( alg ),
2683 input, input_length,
2684 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002685
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002686 if( status != PSA_SUCCESS )
2687 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002688
2689 return psa_driver_wrapper_verify_hash(
2690 attributes, key_buffer, key_buffer_size,
2691 alg, hash, hash_length,
2692 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002693 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002694
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002695 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002696}
2697
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002698psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2699 psa_algorithm_t alg,
2700 const uint8_t * input,
2701 size_t input_length,
2702 const uint8_t * signature,
2703 size_t signature_length )
2704{
2705 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002706 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002708}
2709
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002710psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002711 const psa_key_attributes_t *attributes,
2712 const uint8_t *key_buffer, size_t key_buffer_size,
2713 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2714 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002715{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002716 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002717 {
Ronald Cron4501c982021-03-19 20:09:32 +01002718 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2719 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002720 {
Ronald Cron4501c982021-03-19 20:09:32 +01002721#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2722 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2723 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002724 attributes,
2725 key_buffer, key_buffer_size,
2726 alg, hash, hash_length,
2727 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002728#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2729 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002730 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002731 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002732 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002733 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002734 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002735 }
2736 else
Ronald Cron4501c982021-03-19 20:09:32 +01002737 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2738 {
2739 if( PSA_ALG_IS_ECDSA( alg ) )
2740 {
2741#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2742 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2743 return( mbedtls_psa_ecdsa_sign_hash(
2744 attributes,
2745 key_buffer, key_buffer_size,
2746 alg, hash, hash_length,
2747 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002748#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2749 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002750 }
2751 else
2752 {
2753 return( PSA_ERROR_INVALID_ARGUMENT );
2754 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002755 }
Ronald Cron4501c982021-03-19 20:09:32 +01002756
2757 (void)key_buffer;
2758 (void)key_buffer_size;
2759 (void)hash;
2760 (void)hash_length;
2761 (void)signature;
2762 (void)signature_size;
2763 (void)signature_length;
2764
2765 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002766}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002767
2768psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2769 psa_algorithm_t alg,
2770 const uint8_t *hash,
2771 size_t hash_length,
2772 uint8_t *signature,
2773 size_t signature_size,
2774 size_t *signature_length )
2775{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002776 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002777 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002778 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002779}
2780
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002781psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002782 const psa_key_attributes_t *attributes,
2783 const uint8_t *key_buffer, size_t key_buffer_size,
2784 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2785 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002786{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002787 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002788 {
Ronald Cron4501c982021-03-19 20:09:32 +01002789 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2790 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002791 {
Ronald Cron4501c982021-03-19 20:09:32 +01002792#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2793 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2794 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002795 attributes,
2796 key_buffer, key_buffer_size,
2797 alg, hash, hash_length,
2798 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002799#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2800 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002801 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002802 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002803 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002804 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002805 }
itayzafrir5c753392018-05-08 11:18:38 +03002806 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002807 else
Ronald Cron4501c982021-03-19 20:09:32 +01002808 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002809 {
Ronald Cron4501c982021-03-19 20:09:32 +01002810 if( PSA_ALG_IS_ECDSA( alg ) )
2811 {
2812#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2813 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2814 return( mbedtls_psa_ecdsa_verify_hash(
2815 attributes,
2816 key_buffer, key_buffer_size,
2817 alg, hash, hash_length,
2818 signature, signature_length ) );
2819#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2820 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2821 }
2822 else
2823 {
2824 return( PSA_ERROR_INVALID_ARGUMENT );
2825 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002826 }
Ronald Cron4501c982021-03-19 20:09:32 +01002827
2828 (void)key_buffer;
2829 (void)key_buffer_size;
2830 (void)hash;
2831 (void)hash_length;
2832 (void)signature;
2833 (void)signature_length;
2834
2835 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002836}
2837
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002838psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2839 psa_algorithm_t alg,
2840 const uint8_t *hash,
2841 size_t hash_length,
2842 const uint8_t *signature,
2843 size_t signature_length )
2844{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002845 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002846 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002847 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002848}
2849
John Durkop0e005192020-10-31 22:06:54 -07002850#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02002851static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2852 mbedtls_rsa_context *rsa )
2853{
2854 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2855 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2856 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2857 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2858}
John Durkop0e005192020-10-31 22:06:54 -07002859#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002860
Ronald Croncf56a0a2020-08-04 09:51:30 +02002861psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002862 psa_algorithm_t alg,
2863 const uint8_t *input,
2864 size_t input_length,
2865 const uint8_t *salt,
2866 size_t salt_length,
2867 uint8_t *output,
2868 size_t output_size,
2869 size_t *output_length )
2870{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002872 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002873 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002874
Darryl Green5cc689a2018-07-24 15:34:10 +01002875 (void) input;
2876 (void) input_length;
2877 (void) salt;
2878 (void) output;
2879 (void) output_size;
2880
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002881 *output_length = 0;
2882
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002883 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2884 return( PSA_ERROR_INVALID_ARGUMENT );
2885
Ronald Cron5c522922020-11-14 16:35:34 +01002886 status = psa_get_and_lock_transparent_key_slot_with_policy(
2887 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002888 if( status != PSA_SUCCESS )
2889 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002890 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2891 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002892 {
2893 status = PSA_ERROR_INVALID_ARGUMENT;
2894 goto exit;
2895 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002896
John Durkop6ba40d12020-11-10 08:50:04 -08002897#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2898 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002899 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002900 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002901 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002902 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2903 slot->key.data,
2904 slot->key.bytes,
2905 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002906 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02002907 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02002908
2909 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002910 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002911 status = PSA_ERROR_BUFFER_TOO_SMALL;
2912 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002913 }
John Durkop0e005192020-10-31 22:06:54 -07002914#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002915 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
2916 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002917 status = mbedtls_to_psa_error(
2918 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002919 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002920 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002921 input_length,
2922 input,
2923 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002924 }
2925 else
John Durkop0e005192020-10-31 22:06:54 -07002926#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2927#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002928 if( PSA_ALG_IS_RSA_OAEP( alg ) )
2929 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002930 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02002931 status = mbedtls_to_psa_error(
2932 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002933 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002934 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002935 salt, salt_length,
2936 input_length,
2937 input,
2938 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002939 }
2940 else
John Durkop0e005192020-10-31 22:06:54 -07002941#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002942 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002943 status = PSA_ERROR_INVALID_ARGUMENT;
2944 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002945 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02002946rsa_exit:
2947 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02002948 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002949
Steven Cooremana2371e52020-07-28 14:30:39 +02002950 mbedtls_rsa_free( rsa );
2951 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002952 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002953 else
John Durkop9814fa22020-11-04 12:28:15 -08002954#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08002955 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002956 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002957 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002958 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002959
2960exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002961 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002962
Ronald Cron5c522922020-11-14 16:35:34 +01002963 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002964}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002965
Ronald Croncf56a0a2020-08-04 09:51:30 +02002966psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002967 psa_algorithm_t alg,
2968 const uint8_t *input,
2969 size_t input_length,
2970 const uint8_t *salt,
2971 size_t salt_length,
2972 uint8_t *output,
2973 size_t output_size,
2974 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002975{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002977 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002978 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002979
Darryl Green5cc689a2018-07-24 15:34:10 +01002980 (void) input;
2981 (void) input_length;
2982 (void) salt;
2983 (void) output;
2984 (void) output_size;
2985
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002986 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002987
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002988 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2989 return( PSA_ERROR_INVALID_ARGUMENT );
2990
Ronald Cron5c522922020-11-14 16:35:34 +01002991 status = psa_get_and_lock_transparent_key_slot_with_policy(
2992 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002993 if( status != PSA_SUCCESS )
2994 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002995 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002996 {
2997 status = PSA_ERROR_INVALID_ARGUMENT;
2998 goto exit;
2999 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003000
John Durkop6ba40d12020-11-10 08:50:04 -08003001#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3002 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003003 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003004 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003005 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003006 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3007 slot->key.data,
3008 slot->key.bytes,
3009 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003010 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003011 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003012
Steven Cooremana2371e52020-07-28 14:30:39 +02003013 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003014 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003015 status = PSA_ERROR_INVALID_ARGUMENT;
3016 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003017 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003018
John Durkop0e005192020-10-31 22:06:54 -07003019#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003020 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003021 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003022 status = mbedtls_to_psa_error(
3023 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003024 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003025 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003026 output_length,
3027 input,
3028 output,
3029 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003030 }
3031 else
John Durkop0e005192020-10-31 22:06:54 -07003032#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3033#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003034 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003035 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003036 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003037 status = mbedtls_to_psa_error(
3038 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003039 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003040 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003041 salt, salt_length,
3042 output_length,
3043 input,
3044 output,
3045 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003046 }
3047 else
John Durkop0e005192020-10-31 22:06:54 -07003048#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003049 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003050 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003051 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003052
Steven Cooreman4fed4552020-08-03 14:46:03 +02003053rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003054 mbedtls_rsa_free( rsa );
3055 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003056 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003057 else
John Durkop6ba40d12020-11-10 08:50:04 -08003058#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3059 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003060 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003061 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003062 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003063
3064exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003065 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003066
Ronald Cron5c522922020-11-14 16:35:34 +01003067 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003068}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003069
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003070
3071
mohammad1603503973b2018-03-12 15:59:30 +02003072/****************************************************************/
3073/* Symmetric cryptography */
3074/****************************************************************/
3075
Ronald Cronab99ac22020-10-01 16:38:28 +02003076static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3077 mbedtls_svc_key_id_t key,
3078 psa_algorithm_t alg,
3079 mbedtls_operation_t cipher_operation )
3080{
3081 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3082 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3083 psa_key_slot_t *slot;
3084 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3085 PSA_KEY_USAGE_ENCRYPT :
3086 PSA_KEY_USAGE_DECRYPT );
3087
3088 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003089 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003090 return( PSA_ERROR_BAD_STATE );
3091
3092 /* The requested algorithm must be one that can be processed by cipher. */
3093 if( ! PSA_ALG_IS_CIPHER( alg ) )
3094 return( PSA_ERROR_INVALID_ARGUMENT );
3095
3096 /* Fetch key material from key storage. */
3097 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3098 if( status != PSA_SUCCESS )
3099 goto exit;
3100
Ronald Cron49fafa92021-03-10 08:34:23 +01003101 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003102 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003103 * so we only set it (in the driver wrapper) after resources have been
3104 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003105 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003106 if( alg == PSA_ALG_ECB_NO_PADDING )
3107 operation->iv_required = 0;
3108 else
3109 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003110 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003111
Ronald Crona4af55f2020-12-14 14:36:06 +01003112 psa_key_attributes_t attributes = {
3113 .core = slot->attr
3114 };
3115
Ronald Cronab99ac22020-10-01 16:38:28 +02003116 /* Try doing the operation through a driver before using software fallback. */
3117 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003118 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3119 &attributes,
3120 slot->key.data,
3121 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003122 alg );
3123 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003124 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3125 &attributes,
3126 slot->key.data,
3127 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003128 alg );
3129
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003130exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003131 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003132 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003133
Ronald Cron5c522922020-11-14 16:35:34 +01003134 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003135
Ronald Cron5c522922020-11-14 16:35:34 +01003136 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003137}
3138
Gilles Peskinefe119512018-07-08 21:39:34 +02003139psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003140 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003141 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003142{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003143 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003144}
3145
Gilles Peskinefe119512018-07-08 21:39:34 +02003146psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003147 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003148 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003149{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003150 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003151}
3152
Gilles Peskinefe119512018-07-08 21:39:34 +02003153psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003154 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003155 size_t iv_size,
3156 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003157{
Ronald Cron6d051732020-10-01 14:10:20 +02003158 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003159
Ronald Cron5618a392021-03-26 09:52:26 +01003160 *iv_length = 0;
3161
Ronald Cron49fafa92021-03-10 08:34:23 +01003162 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003163 {
3164 return( PSA_ERROR_BAD_STATE );
3165 }
3166
Steven Cooreman7df02922020-09-09 15:28:49 +02003167 if( operation->iv_set || ! operation->iv_required )
3168 {
3169 return( PSA_ERROR_BAD_STATE );
3170 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003171
Ronald Cron5618a392021-03-26 09:52:26 +01003172 if( iv_size < operation->default_iv_length )
3173 {
3174 status = PSA_ERROR_BUFFER_TOO_SMALL;
3175 goto exit;
3176 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003177
Ronald Cron5618a392021-03-26 09:52:26 +01003178 status = psa_generate_random( iv, operation->default_iv_length );
3179 if( status != PSA_SUCCESS )
3180 goto exit;
3181
3182 status = psa_driver_wrapper_cipher_set_iv( operation,
3183 iv,
3184 operation->default_iv_length );
3185
3186exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003187 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003188 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003189 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003190 *iv_length = operation->default_iv_length;
3191 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003192 else
Moran Peker395db872018-05-31 14:07:14 +03003193 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003194
itayzafrir534bd7c2018-08-02 13:56:32 +03003195 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003196}
3197
Gilles Peskinefe119512018-07-08 21:39:34 +02003198psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003199 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003200 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003201{
Ronald Cron6d051732020-10-01 14:10:20 +02003202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003203
Ronald Cron49fafa92021-03-10 08:34:23 +01003204 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003205 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003206
Steven Cooreman7df02922020-09-09 15:28:49 +02003207 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003208 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003209
3210 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3211 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003212
Ronald Crondd24c9b2020-12-15 14:10:01 +01003213 status = psa_driver_wrapper_cipher_set_iv( operation,
3214 iv,
3215 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003216
itayzafrir534bd7c2018-08-02 13:56:32 +03003217 if( status == PSA_SUCCESS )
3218 operation->iv_set = 1;
3219 else
mohammad1603503973b2018-03-12 15:59:30 +02003220 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003221 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003222}
3223
Gilles Peskinee553c652018-06-04 16:22:46 +02003224psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3225 const uint8_t *input,
3226 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003227 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003228 size_t output_size,
3229 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003230{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003232
Ronald Cron49fafa92021-03-10 08:34:23 +01003233 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003234 {
3235 return( PSA_ERROR_BAD_STATE );
3236 }
3237 if( operation->iv_required && ! operation->iv_set )
3238 {
3239 return( PSA_ERROR_BAD_STATE );
3240 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003241
Ronald Crondd24c9b2020-12-15 14:10:01 +01003242 status = psa_driver_wrapper_cipher_update( operation,
3243 input,
3244 input_length,
3245 output,
3246 output_size,
3247 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003248 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003249 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003250
itayzafrir534bd7c2018-08-02 13:56:32 +03003251 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003252}
3253
Gilles Peskinee553c652018-06-04 16:22:46 +02003254psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3255 uint8_t *output,
3256 size_t output_size,
3257 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003258{
David Saadab4ecc272019-02-14 13:48:10 +02003259 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003260
Ronald Cron49fafa92021-03-10 08:34:23 +01003261 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003262 {
3263 return( PSA_ERROR_BAD_STATE );
3264 }
3265 if( operation->iv_required && ! operation->iv_set )
3266 {
3267 return( PSA_ERROR_BAD_STATE );
3268 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003269
Ronald Crondd24c9b2020-12-15 14:10:01 +01003270 status = psa_driver_wrapper_cipher_finish( operation,
3271 output,
3272 output_size,
3273 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003274 if( status == PSA_SUCCESS )
3275 return( psa_cipher_abort( operation ) );
3276 else
3277 {
3278 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003279 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003280
Steven Cooremanef8575e2020-09-11 11:44:50 +02003281 return( status );
3282 }
mohammad1603503973b2018-03-12 15:59:30 +02003283}
3284
Gilles Peskinee553c652018-06-04 16:22:46 +02003285psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3286{
Ronald Cron49fafa92021-03-10 08:34:23 +01003287 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003288 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003289 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003290 * in use. It's ok to call abort on such an object, and there's
3291 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003292 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003293 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003294
Ronald Crondd24c9b2020-12-15 14:10:01 +01003295 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003296
Ronald Cron49fafa92021-03-10 08:34:23 +01003297 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003298 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003299 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003300
Moran Peker395db872018-05-31 14:07:14 +03003301 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003302}
3303
mohammad16035955c982018-04-26 00:53:03 +03003304/****************************************************************/
3305/* AEAD */
3306/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003307
Ronald Croncf56a0a2020-08-04 09:51:30 +02003308psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003309 psa_algorithm_t alg,
3310 const uint8_t *nonce,
3311 size_t nonce_length,
3312 const uint8_t *additional_data,
3313 size_t additional_data_length,
3314 const uint8_t *plaintext,
3315 size_t plaintext_length,
3316 uint8_t *ciphertext,
3317 size_t ciphertext_size,
3318 size_t *ciphertext_length )
3319{
Ronald Cron215633c2021-03-16 17:15:37 +01003320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3321 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003322
mohammad1603f08a5502018-06-03 15:05:47 +03003323 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003324
Steven Cooremanea7ab132021-03-17 16:28:00 +01003325 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3326 return( PSA_ERROR_NOT_SUPPORTED );
3327
Ronald Cron9a986162021-03-26 12:40:07 +01003328 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003329 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003330 if( status != PSA_SUCCESS )
3331 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003332
Ronald Cron215633c2021-03-16 17:15:37 +01003333 psa_key_attributes_t attributes = {
3334 .core = slot->attr
3335 };
mohammad16035955c982018-04-26 00:53:03 +03003336
Ronald Cronde822812021-03-17 16:08:20 +01003337 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003338 &attributes, slot->key.data, slot->key.bytes,
3339 alg,
3340 nonce, nonce_length,
3341 additional_data, additional_data_length,
3342 plaintext, plaintext_length,
3343 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003344
Gilles Peskineedf9a652018-08-17 18:11:56 +02003345 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3346 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003347
Ronald Cron9f310172021-03-16 16:36:37 +01003348 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003349
mohammad16035955c982018-04-26 00:53:03 +03003350 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003351}
3352
Ronald Croncf56a0a2020-08-04 09:51:30 +02003353psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003354 psa_algorithm_t alg,
3355 const uint8_t *nonce,
3356 size_t nonce_length,
3357 const uint8_t *additional_data,
3358 size_t additional_data_length,
3359 const uint8_t *ciphertext,
3360 size_t ciphertext_length,
3361 uint8_t *plaintext,
3362 size_t plaintext_size,
3363 size_t *plaintext_length )
3364{
Ronald Cron215633c2021-03-16 17:15:37 +01003365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3366 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003367
Gilles Peskineee652a32018-06-01 19:23:52 +02003368 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003369
Steven Cooremanea7ab132021-03-17 16:28:00 +01003370 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3371 return( PSA_ERROR_NOT_SUPPORTED );
3372
Ronald Cron9a986162021-03-26 12:40:07 +01003373 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003374 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003375 if( status != PSA_SUCCESS )
3376 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003377
Ronald Cron215633c2021-03-16 17:15:37 +01003378 psa_key_attributes_t attributes = {
3379 .core = slot->attr
3380 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003381
Ronald Cronde822812021-03-17 16:08:20 +01003382 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003383 &attributes, slot->key.data, slot->key.bytes,
3384 alg,
3385 nonce, nonce_length,
3386 additional_data, additional_data_length,
3387 ciphertext, ciphertext_length,
3388 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003389
Gilles Peskineedf9a652018-08-17 18:11:56 +02003390 if( status != PSA_SUCCESS && plaintext_size != 0 )
3391 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003392
Ronald Cron215633c2021-03-16 17:15:37 +01003393 psa_unlock_key_slot( slot );
3394
Gilles Peskineedf9a652018-08-17 18:11:56 +02003395 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003396}
3397
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003398/* Helper function to get the base algorithm from its variants. */
Paul Elliottd89304e2021-06-22 17:47:09 +01003399static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003400{
Paul Elliotte4030f22021-06-22 17:36:55 +01003401 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003402}
3403
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003404/* Set the key for a multipart authenticated operation. */
3405static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003406 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003407 mbedtls_svc_key_id_t key,
3408 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003409{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3411 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3412 psa_key_slot_t *slot = NULL;
3413 psa_key_usage_t key_usage = 0;
3414
Paul Elliottc2b71442021-06-24 18:17:52 +01003415 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3416 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003417 status = PSA_ERROR_INVALID_ARGUMENT;
3418 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003419 }
3420
3421 if( operation->id != 0 )
3422 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003423 status = PSA_ERROR_BAD_STATE;
3424 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003425 }
3426
3427 if( operation->nonce_set || operation->lengths_set ||
3428 operation->ad_started || operation->body_started )
3429 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003430 status = PSA_ERROR_BAD_STATE;
3431 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003432 }
3433
Paul Elliottd9343f22021-08-23 18:59:49 +01003434 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003435 key_usage = PSA_KEY_USAGE_ENCRYPT;
3436 else
3437 key_usage = PSA_KEY_USAGE_DECRYPT;
3438
3439 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3440 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003441 if( status != PSA_SUCCESS )
3442 goto exit;
3443
3444 psa_key_attributes_t attributes = {
3445 .core = slot->attr
3446 };
3447
Paul Elliottd9343f22021-08-23 18:59:49 +01003448 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003449 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3450 &attributes,
3451 slot->key.data,
3452 slot->key.bytes,
3453 alg );
3454 else
3455 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3456 &attributes,
3457 slot->key.data,
3458 slot->key.bytes,
3459 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003460 if( status != PSA_SUCCESS )
3461 goto exit;
3462
3463 operation->key_type = psa_get_key_type( &attributes );
3464
3465exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003466 unlock_status = psa_unlock_key_slot( slot );
3467
3468 if( status == PSA_SUCCESS )
3469 {
3470 status = unlock_status;
3471 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003472 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003473 }
3474 else
3475 psa_aead_abort( operation );
3476
3477 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003478}
3479
Paul Elliott302ff6b2021-04-20 18:10:30 +01003480/* Set the key for a multipart authenticated encryption operation. */
3481psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3482 mbedtls_svc_key_id_t key,
3483 psa_algorithm_t alg )
3484{
Paul Elliottd9343f22021-08-23 18:59:49 +01003485 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003486}
3487
3488/* Set the key for a multipart authenticated decryption operation. */
3489psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3490 mbedtls_svc_key_id_t key,
3491 psa_algorithm_t alg )
3492{
Paul Elliottd9343f22021-08-23 18:59:49 +01003493 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003494}
3495
3496/* Generate a random nonce / IV for multipart AEAD operation */
3497psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3498 uint8_t *nonce,
3499 size_t nonce_size,
3500 size_t *nonce_length )
3501{
3502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliottb91da712021-05-20 14:43:47 +01003503 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003504
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003505 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003506
Paul Elliottcee785c2021-05-20 14:29:20 +01003507 if( operation->id == 0 )
3508 {
3509 status = PSA_ERROR_BAD_STATE;
3510 goto exit;
3511 }
3512
Paul Elliottdaf5c892021-08-25 16:24:58 +01003513 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003514 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003515 status = PSA_ERROR_BAD_STATE;
3516 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003517 }
3518
Paul Elliottbbe90b52021-05-11 22:22:42 +01003519 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003520 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003521 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003522 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003523 status = PSA_ERROR_BUFFER_TOO_SMALL;
3524 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003525 }
3526
3527 status = psa_generate_random( nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003528 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003529 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003530
Paul Elliott95271f12021-06-23 16:50:45 +01003531 status = psa_aead_set_nonce( operation, nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003532
Paul Elliott39dc6b82021-05-11 19:16:09 +01003533exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003534 if( status == PSA_SUCCESS )
3535 *nonce_length = required_nonce_size;
3536 else
3537 psa_aead_abort( operation );
3538
3539 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003540}
3541
3542/* Set the nonce for a multipart authenticated encryption or decryption
3543 operation.*/
3544psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3545 const uint8_t *nonce,
3546 size_t nonce_length )
3547{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3549
Paul Elliottcee785c2021-05-20 14:29:20 +01003550 if( operation->id == 0 )
3551 {
3552 status = PSA_ERROR_BAD_STATE;
3553 goto exit;
3554 }
3555
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003556 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003557 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003558 status = PSA_ERROR_BAD_STATE;
3559 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003560 }
3561
Paul Elliott6eb95982021-05-21 17:41:41 +01003562 /* Not checking nonce size here as GCM spec allows almost arbitrarily
3563 * large nonces. Please note that we do not generally recommend the usage
3564 * of nonces of greater length than PSA_AEAD_NONCE_MAX_SIZE, as large
3565 * nonces are hashed to a shorter size, which can then lead to collisions
3566 * if you encrypt a very large number of messages.*/
Paul Elliott1a98aca2021-05-20 18:24:07 +01003567
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003568 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3569 nonce_length );
3570
Paul Elliott39dc6b82021-05-11 19:16:09 +01003571exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003572 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003573 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003574 else
3575 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003576
3577 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003578}
3579
3580/* Declare the lengths of the message and additional data for multipart AEAD. */
3581psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3582 size_t ad_length,
3583 size_t plaintext_length )
3584{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003585 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3586
Paul Elliottcee785c2021-05-20 14:29:20 +01003587 if( operation->id == 0 )
3588 {
3589 status = PSA_ERROR_BAD_STATE;
3590 goto exit;
3591 }
3592
Paul Elliott6eb95982021-05-21 17:41:41 +01003593 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003594 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003595 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003596 status = PSA_ERROR_BAD_STATE;
3597 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003598 }
3599
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003600 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3601 plaintext_length );
3602
Paul Elliott39dc6b82021-05-11 19:16:09 +01003603exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003604 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003605 {
3606 operation->ad_remaining = ad_length;
3607 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003608 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01003609 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003610 else
3611 psa_aead_abort( operation );
3612
3613 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003614}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003615
3616/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01003617psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
3618 const uint8_t *input,
3619 size_t input_length )
3620{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003621 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3622
Paul Elliottcee785c2021-05-20 14:29:20 +01003623 if( operation->id == 0 )
3624 {
3625 status = PSA_ERROR_BAD_STATE;
3626 goto exit;
3627 }
3628
Paul Elliott6eb95982021-05-21 17:41:41 +01003629 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003630 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003631 status = PSA_ERROR_BAD_STATE;
3632 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003633 }
3634
Paul Elliottee4ffe02021-05-20 17:25:06 +01003635 if( operation->lengths_set )
3636 {
Paul Elliott6eb95982021-05-21 17:41:41 +01003637 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003638 {
3639 status = PSA_ERROR_INVALID_ARGUMENT;
3640 goto exit;
3641 }
3642
3643 operation->ad_remaining -= input_length;
3644 }
3645
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003646 status = psa_driver_wrapper_aead_update_ad( operation, input,
3647 input_length );
3648
Paul Elliott39dc6b82021-05-11 19:16:09 +01003649exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003650 if( status == PSA_SUCCESS )
3651 operation->ad_started = 1;
3652 else
3653 psa_aead_abort( operation );
3654
3655 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003656}
3657
3658/* Encrypt or decrypt a message fragment in an active multipart AEAD
3659 operation.*/
3660psa_status_t psa_aead_update( psa_aead_operation_t *operation,
3661 const uint8_t *input,
3662 size_t input_length,
3663 uint8_t *output,
3664 size_t output_size,
3665 size_t *output_length )
3666{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003667 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003668
3669 *output_length = 0;
3670
Paul Elliottcee785c2021-05-20 14:29:20 +01003671 if( operation->id == 0 )
3672 {
3673 status = PSA_ERROR_BAD_STATE;
3674 goto exit;
3675 }
3676
Paul Elliott6eb95982021-05-21 17:41:41 +01003677 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003678 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003679 status = PSA_ERROR_BAD_STATE;
3680 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003681 }
3682
Paul Elliottee4ffe02021-05-20 17:25:06 +01003683 if( operation->lengths_set )
3684 {
3685 /* Additional data length was supplied, but not all the additional
3686 data was supplied.*/
3687 if( operation->ad_remaining != 0 )
3688 {
3689 status = PSA_ERROR_INVALID_ARGUMENT;
3690 goto exit;
3691 }
3692
3693 /* Too much data provided. */
3694 if( operation->body_remaining < input_length )
3695 {
3696 status = PSA_ERROR_INVALID_ARGUMENT;
3697 goto exit;
3698 }
3699
3700 operation->body_remaining -= input_length;
3701 }
3702
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003703 status = psa_driver_wrapper_aead_update( operation, input, input_length,
3704 output, output_size,
3705 output_length );
3706
Paul Elliott39dc6b82021-05-11 19:16:09 +01003707exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003708 if( status == PSA_SUCCESS )
3709 operation->body_started = 1;
3710 else
3711 psa_aead_abort( operation );
3712
3713 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003714}
3715
Paul Elliott69bf5fc2021-09-19 18:26:37 +01003716static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01003717{
Paul Elliott7f429b72021-06-24 18:08:54 +01003718 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01003719 return( PSA_ERROR_BAD_STATE );
3720
Paul Elliotta5614442021-07-14 14:54:11 +01003721 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01003722 operation->body_remaining != 0 ) )
3723 return( PSA_ERROR_INVALID_ARGUMENT );
3724
3725 return( PSA_SUCCESS );
3726}
3727
Paul Elliott302ff6b2021-04-20 18:10:30 +01003728/* Finish encrypting a message in a multipart AEAD operation. */
3729psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
3730 uint8_t *ciphertext,
3731 size_t ciphertext_size,
3732 size_t *ciphertext_length,
3733 uint8_t *tag,
3734 size_t tag_size,
3735 size_t *tag_length )
3736{
Paul Elliott39dc6b82021-05-11 19:16:09 +01003737 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3738
Paul Elliott302ff6b2021-04-20 18:10:30 +01003739 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01003740 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003741
Paul Elliott814fffb2021-08-16 18:20:36 +01003742 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01003743 if( status != PSA_SUCCESS )
3744 goto exit;
3745
Paul Elliott7f429b72021-06-24 18:08:54 +01003746 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01003747 {
3748 status = PSA_ERROR_BAD_STATE;
3749 goto exit;
3750 }
3751
Paul Elliott39dc6b82021-05-11 19:16:09 +01003752 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
3753 ciphertext_size,
3754 ciphertext_length,
3755 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003756
Paul Elliott39dc6b82021-05-11 19:16:09 +01003757exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01003758 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01003759 * the zero tag size, make sure the tag is set to something implausible.
3760 * Even if the operation succeeds, make sure we clear the rest of the
3761 * buffer to prevent potential leakage of anything previously placed in
3762 * the same buffer.*/
Paul Elliottec95cc92021-09-19 22:33:09 +01003763 if( tag )
3764 {
3765 if( status != PSA_SUCCESS )
3766 memset( tag, '!', tag_size );
3767 else if( *tag_length < tag_size )
3768 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
3769 }
Paul Elliottf47b0952021-05-21 18:02:33 +01003770
Paul Elliott39dc6b82021-05-11 19:16:09 +01003771 psa_aead_abort( operation );
3772
3773 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003774}
3775
3776/* Finish authenticating and decrypting a message in a multipart AEAD
3777 operation.*/
3778psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
3779 uint8_t *plaintext,
3780 size_t plaintext_size,
3781 size_t *plaintext_length,
3782 const uint8_t *tag,
3783 size_t tag_length )
3784{
Paul Elliott39dc6b82021-05-11 19:16:09 +01003785 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3786
Paul Elliott302ff6b2021-04-20 18:10:30 +01003787 *plaintext_length = 0;
3788
Paul Elliott814fffb2021-08-16 18:20:36 +01003789 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01003790 if( status != PSA_SUCCESS )
3791 goto exit;
3792
Paul Elliott7f429b72021-06-24 18:08:54 +01003793 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01003794 {
3795 status = PSA_ERROR_BAD_STATE;
3796 goto exit;
3797 }
3798
Paul Elliott39dc6b82021-05-11 19:16:09 +01003799 status = psa_driver_wrapper_aead_verify( operation, plaintext,
3800 plaintext_size,
3801 plaintext_length,
3802 tag, tag_length );
3803
3804exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003805 psa_aead_abort( operation );
3806
3807 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003808}
3809
3810/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003811psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003812{
3813 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3814
3815 if( operation->id == 0 )
3816 {
3817 /* The object has (apparently) been initialized but it is not (yet)
3818 * in use. It's ok to call abort on such an object, and there's
3819 * nothing to do. */
3820 return( PSA_SUCCESS );
3821 }
3822
3823 status = psa_driver_wrapper_aead_abort( operation );
3824
Paul Elliott70f447d2021-09-19 18:21:58 +01003825 memset( operation, 0, sizeof( psa_aead_operation_t ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003826
3827 return( status );
3828}
3829
Gilles Peskinee59236f2018-01-27 23:32:46 +01003830/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003831/* Generators */
3832/****************************************************************/
3833
John Durkop07cc04a2020-11-16 22:08:34 -08003834#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3835 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3836 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3837#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003838#endif /* At least one builtin KDF */
3839
3840#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3841 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3842 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3843static psa_status_t psa_key_derivation_start_hmac(
3844 psa_mac_operation_t *operation,
3845 psa_algorithm_t hash_alg,
3846 const uint8_t *hmac_key,
3847 size_t hmac_key_length )
3848{
3849 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3850 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3851 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3852 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3853 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3854
Steven Cooreman72f736a2021-05-07 14:14:37 +02003855 operation->is_sign = 1;
3856 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3857
Steven Cooreman094a77e2021-05-06 17:58:36 +02003858 status = psa_driver_wrapper_mac_sign_setup( operation,
3859 &attributes,
3860 hmac_key, hmac_key_length,
3861 PSA_ALG_HMAC( hash_alg ) );
3862
3863 psa_reset_key_attributes( &attributes );
3864 return( status );
3865}
3866#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003867
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003868#define HKDF_STATE_INIT 0 /* no input yet */
3869#define HKDF_STATE_STARTED 1 /* got salt */
3870#define HKDF_STATE_KEYED 2 /* got key */
3871#define HKDF_STATE_OUTPUT 3 /* output started */
3872
Gilles Peskinecbe66502019-05-16 16:59:18 +02003873static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003874 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003875{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003876 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3877 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003878 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003879 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003880}
3881
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003882psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003883{
3884 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003885 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003886 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003887 {
3888 /* The object has (apparently) been initialized but it is not
3889 * in use. It's ok to call abort on such an object, and there's
3890 * nothing to do. */
3891 }
3892 else
John Durkopd0321952020-10-29 21:37:36 -07003893#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003894 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003895 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003896 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003897 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003898 }
John Durkop07cc04a2020-11-16 22:08:34 -08003899 else
3900#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3901#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3902 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3903 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003904 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003905 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003906 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003907 if( operation->ctx.tls12_prf.secret != NULL )
3908 {
3909 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3910 operation->ctx.tls12_prf.secret_length );
3911 mbedtls_free( operation->ctx.tls12_prf.secret );
3912 }
3913
Janos Follath6a1d2622019-06-11 10:37:28 +01003914 if( operation->ctx.tls12_prf.seed != NULL )
3915 {
3916 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3917 operation->ctx.tls12_prf.seed_length );
3918 mbedtls_free( operation->ctx.tls12_prf.seed );
3919 }
3920
3921 if( operation->ctx.tls12_prf.label != NULL )
3922 {
3923 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3924 operation->ctx.tls12_prf.label_length );
3925 mbedtls_free( operation->ctx.tls12_prf.label );
3926 }
3927
Steven Cooremana6df6042021-04-29 19:32:25 +02003928 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003929
3930 /* We leave the fields Ai and output_block to be erased safely by the
3931 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003932 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003933 else
John Durkop07cc04a2020-11-16 22:08:34 -08003934#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3935 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003936 {
3937 status = PSA_ERROR_BAD_STATE;
3938 }
Janos Follath083036a2019-06-11 10:22:26 +01003939 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003940 return( status );
3941}
3942
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003943psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003944 size_t *capacity)
3945{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003946 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003947 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003948 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003949 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003950 }
3951
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003952 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003953 return( PSA_SUCCESS );
3954}
3955
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003956psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003957 size_t capacity )
3958{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003959 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003960 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003961 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003962 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003963 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003964 return( PSA_SUCCESS );
3965}
3966
John Durkopd0321952020-10-29 21:37:36 -07003967#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003968/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003969 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003970static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003971 psa_algorithm_t hash_alg,
3972 uint8_t *output,
3973 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003974{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003975 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003976 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003977 psa_status_t status;
3978
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003979 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3980 return( PSA_ERROR_BAD_STATE );
3981 hkdf->state = HKDF_STATE_OUTPUT;
3982
Gilles Peskinebef7f142018-07-12 17:22:21 +02003983 while( output_length != 0 )
3984 {
3985 /* Copy what remains of the current block */
3986 uint8_t n = hash_length - hkdf->offset_in_block;
3987 if( n > output_length )
3988 n = (uint8_t) output_length;
3989 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3990 output += n;
3991 output_length -= n;
3992 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003993 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003994 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003995 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003996 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003997 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003998 * object was corrupted or if this function is called directly
3999 * inside the library. */
4000 if( hkdf->block_number == 0xff )
4001 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004002
4003 /* We need a new block */
4004 ++hkdf->block_number;
4005 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004006
Steven Cooreman094a77e2021-05-06 17:58:36 +02004007 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4008 hash_alg,
4009 hkdf->prk,
4010 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004011 if( status != PSA_SUCCESS )
4012 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004013
Gilles Peskinebef7f142018-07-12 17:22:21 +02004014 if( hkdf->block_number != 1 )
4015 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004016 status = psa_mac_update( &hkdf->hmac,
4017 hkdf->output_block,
4018 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004019 if( status != PSA_SUCCESS )
4020 return( status );
4021 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004022 status = psa_mac_update( &hkdf->hmac,
4023 hkdf->info,
4024 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004025 if( status != PSA_SUCCESS )
4026 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004027 status = psa_mac_update( &hkdf->hmac,
4028 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004029 if( status != PSA_SUCCESS )
4030 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004031 status = psa_mac_sign_finish( &hkdf->hmac,
4032 hkdf->output_block,
4033 sizeof( hkdf->output_block ),
4034 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004035 if( status != PSA_SUCCESS )
4036 return( status );
4037 }
4038
4039 return( PSA_SUCCESS );
4040}
John Durkop07cc04a2020-11-16 22:08:34 -08004041#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004042
John Durkop07cc04a2020-11-16 22:08:34 -08004043#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4044 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004045static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4046 psa_tls12_prf_key_derivation_t *tls12_prf,
4047 psa_algorithm_t alg )
4048{
4049 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004050 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004051 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4052 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004053 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004054
Janos Follath7742fee2019-06-17 12:58:10 +01004055 /* We can't be wanting more output after block 0xff, otherwise
4056 * the capacity check in psa_key_derivation_output_bytes() would have
4057 * prevented this call. It could happen only if the operation
4058 * object was corrupted or if this function is called directly
4059 * inside the library. */
4060 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004061 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004062
4063 /* We need a new block */
4064 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004065 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004066
4067 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4068 *
4069 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4070 *
4071 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4072 * HMAC_hash(secret, A(2) + seed) +
4073 * HMAC_hash(secret, A(3) + seed) + ...
4074 *
4075 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004076 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004077 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004078 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004079 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004080 * is currently extracted as `output_block` and where i is
4081 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004082 */
4083
Steven Cooreman094a77e2021-05-06 17:58:36 +02004084 status = psa_key_derivation_start_hmac( &hmac,
4085 hash_alg,
4086 tls12_prf->secret,
4087 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004088 if( status != PSA_SUCCESS )
4089 goto cleanup;
4090
4091 /* Calculate A(i) where i = tls12_prf->block_number. */
4092 if( tls12_prf->block_number == 1 )
4093 {
4094 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4095 * the variable seed and in this instance means it in the context of the
4096 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004097 status = psa_mac_update( &hmac,
4098 tls12_prf->label,
4099 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004100 if( status != PSA_SUCCESS )
4101 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004102 status = psa_mac_update( &hmac,
4103 tls12_prf->seed,
4104 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004105 if( status != PSA_SUCCESS )
4106 goto cleanup;
4107 }
4108 else
4109 {
4110 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004111 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004112 if( status != PSA_SUCCESS )
4113 goto cleanup;
4114 }
4115
Steven Cooremana6df6042021-04-29 19:32:25 +02004116 status = psa_mac_sign_finish( &hmac,
4117 tls12_prf->Ai, hash_length,
4118 &hmac_output_length );
4119 if( hmac_output_length != hash_length )
4120 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004121 if( status != PSA_SUCCESS )
4122 goto cleanup;
4123
4124 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004125 status = psa_key_derivation_start_hmac( &hmac,
4126 hash_alg,
4127 tls12_prf->secret,
4128 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004129 if( status != PSA_SUCCESS )
4130 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004131 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004132 if( status != PSA_SUCCESS )
4133 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004134 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004135 if( status != PSA_SUCCESS )
4136 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004137 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004138 if( status != PSA_SUCCESS )
4139 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004140 status = psa_mac_sign_finish( &hmac,
4141 tls12_prf->output_block, hash_length,
4142 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004143 if( status != PSA_SUCCESS )
4144 goto cleanup;
4145
Janos Follath7742fee2019-06-17 12:58:10 +01004146
4147cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004148 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004149 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4150 status = cleanup_status;
4151
4152 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004153}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004154
Janos Follath844eb0e2019-06-19 12:10:49 +01004155static psa_status_t psa_key_derivation_tls12_prf_read(
4156 psa_tls12_prf_key_derivation_t *tls12_prf,
4157 psa_algorithm_t alg,
4158 uint8_t *output,
4159 size_t output_length )
4160{
4161 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004162 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004163 psa_status_t status;
4164 uint8_t offset, length;
4165
4166 while( output_length != 0 )
4167 {
4168 /* Check if we have fully processed the current block. */
4169 if( tls12_prf->left_in_block == 0 )
4170 {
4171 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4172 alg );
4173 if( status != PSA_SUCCESS )
4174 return( status );
4175
4176 continue;
4177 }
4178
4179 if( tls12_prf->left_in_block > output_length )
4180 length = (uint8_t) output_length;
4181 else
4182 length = tls12_prf->left_in_block;
4183
4184 offset = hash_length - tls12_prf->left_in_block;
4185 memcpy( output, tls12_prf->output_block + offset, length );
4186 output += length;
4187 output_length -= length;
4188 tls12_prf->left_in_block -= length;
4189 }
4190
4191 return( PSA_SUCCESS );
4192}
John Durkop07cc04a2020-11-16 22:08:34 -08004193#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4194 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004195
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004196psa_status_t psa_key_derivation_output_bytes(
4197 psa_key_derivation_operation_t *operation,
4198 uint8_t *output,
4199 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004200{
4201 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004202 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004203
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004204 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004205 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004206 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004207 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004208 }
4209
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004210 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004211 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004212 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004213 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004214 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004215 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004216 goto exit;
4217 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004218 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004219 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004220 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004221 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004222 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4223 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004224 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004225 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004226 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004227 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004228 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004229
John Durkopd0321952020-10-29 21:37:36 -07004230#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004231 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004232 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004233 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004234 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004235 output, output_length );
4236 }
Janos Follathadbec812019-06-14 11:05:39 +01004237 else
John Durkop07cc04a2020-11-16 22:08:34 -08004238#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4239#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4240 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004241 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004242 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004243 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004244 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004245 kdf_alg, output,
4246 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004247 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004248 else
John Durkop07cc04a2020-11-16 22:08:34 -08004249#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4250 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004251 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004252 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004253 return( PSA_ERROR_BAD_STATE );
4254 }
4255
4256exit:
4257 if( status != PSA_SUCCESS )
4258 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004259 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004260 * This allows us to differentiate between exhausted operations and
4261 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4262 * operations. */
4263 psa_algorithm_t alg = operation->alg;
4264 psa_key_derivation_abort( operation );
4265 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004266 memset( output, '!', output_length );
4267 }
4268 return( status );
4269}
4270
David Brown7807bf72021-02-09 16:28:23 -07004271#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004272static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4273{
4274 if( data_size >= 8 )
4275 mbedtls_des_key_set_parity( data );
4276 if( data_size >= 16 )
4277 mbedtls_des_key_set_parity( data + 8 );
4278 if( data_size >= 24 )
4279 mbedtls_des_key_set_parity( data + 16 );
4280}
David Brown7807bf72021-02-09 16:28:23 -07004281#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004282
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004283static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004284 psa_key_slot_t *slot,
4285 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004286 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004287{
4288 uint8_t *data = NULL;
4289 size_t bytes = PSA_BITS_TO_BYTES( bits );
4290 psa_status_t status;
4291
Gilles Peskine8e338702019-07-30 20:06:31 +02004292 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004293 return( PSA_ERROR_INVALID_ARGUMENT );
4294 if( bits % 8 != 0 )
4295 return( PSA_ERROR_INVALID_ARGUMENT );
4296 data = mbedtls_calloc( 1, bytes );
4297 if( data == NULL )
4298 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4299
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004300 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004301 if( status != PSA_SUCCESS )
4302 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004303#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004304 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004305 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004306#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004307
4308 status = psa_allocate_buffer_to_slot( slot, bytes );
4309 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004310 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004311
Ronald Cronbf33c932020-11-28 18:06:53 +01004312 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004313 psa_key_attributes_t attributes = {
4314 .core = slot->attr
4315 };
4316
Ronald Cronbf33c932020-11-28 18:06:53 +01004317 status = psa_driver_wrapper_import_key( &attributes,
4318 data, bytes,
4319 slot->key.data,
4320 slot->key.bytes,
4321 &slot->key.bytes, &bits );
4322 if( bits != slot->attr.bits )
4323 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004324
4325exit:
4326 mbedtls_free( data );
4327 return( status );
4328}
4329
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004330psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004331 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004332 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004333{
4334 psa_status_t status;
4335 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004336 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004337
Ronald Cron81709fc2020-11-14 12:10:32 +01004338 *key = MBEDTLS_SVC_KEY_ID_INIT;
4339
Gilles Peskine0f84d622019-09-12 19:03:13 +02004340 /* Reject any attempt to create a zero-length key so that we don't
4341 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4342 if( psa_get_key_bits( attributes ) == 0 )
4343 return( PSA_ERROR_INVALID_ARGUMENT );
4344
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004345 if( ! operation->can_output_key )
4346 return( PSA_ERROR_NOT_PERMITTED );
4347
Ronald Cron81709fc2020-11-14 12:10:32 +01004348 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4349 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004350#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4351 if( driver != NULL )
4352 {
4353 /* Deriving a key in a secure element is not implemented yet. */
4354 status = PSA_ERROR_NOT_SUPPORTED;
4355 }
4356#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004357 if( status == PSA_SUCCESS )
4358 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004359 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004360 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004361 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004362 }
4363 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004364 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004365 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004366 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004367
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004368 return( status );
4369}
4370
Gilles Peskineeab56e42018-07-12 17:12:33 +02004371
4372
4373/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004374/* Key derivation */
4375/****************************************************************/
4376
Steven Cooreman932ffb72021-02-15 12:14:32 +01004377#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004378static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004379 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004380 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004381{
John Durkop07cc04a2020-11-16 22:08:34 -08004382 int is_kdf_alg_supported;
4383
Janos Follath5fe19732019-06-20 15:09:30 +01004384 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4385 * initialisers for this union leave some bytes unspecified.) */
4386 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4387
Gilles Peskine969c5d62019-01-16 15:53:06 +01004388 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004389#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004390 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4391 is_kdf_alg_supported = 1;
4392 else
4393#endif
4394#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4395 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4396 is_kdf_alg_supported = 1;
4397 else
4398#endif
4399#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4400 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4401 is_kdf_alg_supported = 1;
4402 else
4403#endif
4404 is_kdf_alg_supported = 0;
4405
4406 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004407 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004408 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004409 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004410 if( hash_size == 0 )
4411 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004412 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4413 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004414 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004415 {
4416 return( PSA_ERROR_NOT_SUPPORTED );
4417 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004418 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004419 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004420 }
John Durkop07cc04a2020-11-16 22:08:34 -08004421
4422 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004423}
John Durkop07cc04a2020-11-16 22:08:34 -08004424#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004425
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004426psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004427 psa_algorithm_t alg )
4428{
4429 psa_status_t status;
4430
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004431 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004432 return( PSA_ERROR_BAD_STATE );
4433
Gilles Peskine6843c292019-01-18 16:44:49 +01004434 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4435 return( PSA_ERROR_INVALID_ARGUMENT );
4436 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004437 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004438#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004439 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004440 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004441#else
4442 return( PSA_ERROR_NOT_SUPPORTED );
4443#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004444 }
4445 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4446 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004447#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004448 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004449#else
4450 return( PSA_ERROR_NOT_SUPPORTED );
4451#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004452 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004453 else
4454 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004455
4456 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004457 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004458 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004459}
4460
John Durkopd0321952020-10-29 21:37:36 -07004461#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004462static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004463 psa_algorithm_t hash_alg,
4464 psa_key_derivation_step_t step,
4465 const uint8_t *data,
4466 size_t data_length )
4467{
4468 psa_status_t status;
4469 switch( step )
4470 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004471 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004472 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004473 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004474 else
4475 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004476 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4477 hash_alg,
4478 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004479 if( status != PSA_SUCCESS )
4480 return( status );
4481 hkdf->state = HKDF_STATE_STARTED;
4482 return( PSA_SUCCESS );
4483 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004484 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004485 /* If no salt was provided, use an empty salt. */
4486 if( hkdf->state == HKDF_STATE_INIT )
4487 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004488 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4489 hash_alg,
4490 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004491 if( status != PSA_SUCCESS )
4492 return( status );
4493 hkdf->state = HKDF_STATE_STARTED;
4494 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004495 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004496 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004497 status = psa_mac_update( &hkdf->hmac,
4498 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004499 if( status != PSA_SUCCESS )
4500 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004501 status = psa_mac_sign_finish( &hkdf->hmac,
4502 hkdf->prk,
4503 sizeof( hkdf->prk ),
4504 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004505 if( status != PSA_SUCCESS )
4506 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004507 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004508 hkdf->block_number = 0;
4509 hkdf->state = HKDF_STATE_KEYED;
4510 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004511 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004512 if( hkdf->state == HKDF_STATE_OUTPUT )
4513 return( PSA_ERROR_BAD_STATE );
4514 if( hkdf->info_set )
4515 return( PSA_ERROR_BAD_STATE );
4516 hkdf->info_length = data_length;
4517 if( data_length != 0 )
4518 {
4519 hkdf->info = mbedtls_calloc( 1, data_length );
4520 if( hkdf->info == NULL )
4521 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4522 memcpy( hkdf->info, data, data_length );
4523 }
4524 hkdf->info_set = 1;
4525 return( PSA_SUCCESS );
4526 default:
4527 return( PSA_ERROR_INVALID_ARGUMENT );
4528 }
4529}
John Durkop07cc04a2020-11-16 22:08:34 -08004530#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004531
John Durkop07cc04a2020-11-16 22:08:34 -08004532#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4533 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004534static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4535 const uint8_t *data,
4536 size_t data_length )
4537{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004538 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004539 return( PSA_ERROR_BAD_STATE );
4540
Janos Follathd6dce9f2019-07-04 09:11:38 +01004541 if( data_length != 0 )
4542 {
4543 prf->seed = mbedtls_calloc( 1, data_length );
4544 if( prf->seed == NULL )
4545 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004546
Janos Follathd6dce9f2019-07-04 09:11:38 +01004547 memcpy( prf->seed, data, data_length );
4548 prf->seed_length = data_length;
4549 }
Janos Follathf08e2652019-06-13 09:05:41 +01004550
Gilles Peskine43f958b2020-12-13 14:55:14 +01004551 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004552
4553 return( PSA_SUCCESS );
4554}
4555
Janos Follath81550542019-06-13 14:26:34 +01004556static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004557 const uint8_t *data,
4558 size_t data_length )
4559{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004560 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004561 return( PSA_ERROR_BAD_STATE );
4562
Steven Cooremana6df6042021-04-29 19:32:25 +02004563 if( data_length != 0 )
4564 {
4565 prf->secret = mbedtls_calloc( 1, data_length );
4566 if( prf->secret == NULL )
4567 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4568
4569 memcpy( prf->secret, data, data_length );
4570 prf->secret_length = data_length;
4571 }
Janos Follath81550542019-06-13 14:26:34 +01004572
Gilles Peskine43f958b2020-12-13 14:55:14 +01004573 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004574
4575 return( PSA_SUCCESS );
4576}
4577
Janos Follath63028dd2019-06-13 09:15:47 +01004578static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4579 const uint8_t *data,
4580 size_t data_length )
4581{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004582 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004583 return( PSA_ERROR_BAD_STATE );
4584
Janos Follathd6dce9f2019-07-04 09:11:38 +01004585 if( data_length != 0 )
4586 {
4587 prf->label = mbedtls_calloc( 1, data_length );
4588 if( prf->label == NULL )
4589 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004590
Janos Follathd6dce9f2019-07-04 09:11:38 +01004591 memcpy( prf->label, data, data_length );
4592 prf->label_length = data_length;
4593 }
Janos Follath63028dd2019-06-13 09:15:47 +01004594
Gilles Peskine43f958b2020-12-13 14:55:14 +01004595 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004596
4597 return( PSA_SUCCESS );
4598}
4599
Janos Follathb03233e2019-06-11 15:30:30 +01004600static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004601 psa_key_derivation_step_t step,
4602 const uint8_t *data,
4603 size_t data_length )
4604{
Janos Follathb03233e2019-06-11 15:30:30 +01004605 switch( step )
4606 {
Janos Follathf08e2652019-06-13 09:05:41 +01004607 case PSA_KEY_DERIVATION_INPUT_SEED:
4608 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004609 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004610 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004611 case PSA_KEY_DERIVATION_INPUT_LABEL:
4612 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004613 default:
4614 return( PSA_ERROR_INVALID_ARGUMENT );
4615 }
4616}
John Durkop07cc04a2020-11-16 22:08:34 -08004617#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4618 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4619
4620#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4621static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4622 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004623 const uint8_t *data,
4624 size_t data_length )
4625{
4626 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004627 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004628 uint8_t *cur = pms;
4629
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004630 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004631 return( PSA_ERROR_INVALID_ARGUMENT );
4632
4633 /* Quoting RFC 4279, Section 2:
4634 *
4635 * The premaster secret is formed as follows: if the PSK is N octets
4636 * long, concatenate a uint16 with the value N, N zero octets, a second
4637 * uint16 with the value N, and the PSK itself.
4638 */
4639
4640 *cur++ = ( data_length >> 8 ) & 0xff;
4641 *cur++ = ( data_length >> 0 ) & 0xff;
4642 memset( cur, 0, data_length );
4643 cur += data_length;
4644 *cur++ = pms[0];
4645 *cur++ = pms[1];
4646 memcpy( cur, data, data_length );
4647 cur += data_length;
4648
Steven Cooremana6df6042021-04-29 19:32:25 +02004649 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004650
4651 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4652 return( status );
4653}
Janos Follath6660f0e2019-06-17 08:44:03 +01004654
4655static psa_status_t psa_tls12_prf_psk_to_ms_input(
4656 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004657 psa_key_derivation_step_t step,
4658 const uint8_t *data,
4659 size_t data_length )
4660{
4661 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004662 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004663 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004664 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004665 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004666
Steven Cooremana6df6042021-04-29 19:32:25 +02004667 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004668}
John Durkop07cc04a2020-11-16 22:08:34 -08004669#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004670
Gilles Peskineb8965192019-09-24 16:21:10 +02004671/** Check whether the given key type is acceptable for the given
4672 * input step of a key derivation.
4673 *
4674 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4675 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4676 * Both secret and non-secret inputs can alternatively have the type
4677 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4678 * that the input was passed as a buffer rather than via a key object.
4679 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004680static int psa_key_derivation_check_input_type(
4681 psa_key_derivation_step_t step,
4682 psa_key_type_t key_type )
4683{
4684 switch( step )
4685 {
4686 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004687 if( key_type == PSA_KEY_TYPE_DERIVE )
4688 return( PSA_SUCCESS );
4689 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004690 return( PSA_SUCCESS );
4691 break;
4692 case PSA_KEY_DERIVATION_INPUT_LABEL:
4693 case PSA_KEY_DERIVATION_INPUT_SALT:
4694 case PSA_KEY_DERIVATION_INPUT_INFO:
4695 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004696 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4697 return( PSA_SUCCESS );
4698 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004699 return( PSA_SUCCESS );
4700 break;
4701 }
4702 return( PSA_ERROR_INVALID_ARGUMENT );
4703}
4704
Janos Follathb80a94e2019-06-12 15:54:46 +01004705static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004706 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004707 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004708 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004709 const uint8_t *data,
4710 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004711{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004712 psa_status_t status;
4713 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4714
4715 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004716 if( status != PSA_SUCCESS )
4717 goto exit;
4718
John Durkopd0321952020-10-29 21:37:36 -07004719#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004720 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004721 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004722 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004723 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004724 step, data, data_length );
4725 }
John Durkop07cc04a2020-11-16 22:08:34 -08004726 else
4727#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4728#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4729 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004730 {
Janos Follathb03233e2019-06-11 15:30:30 +01004731 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004732 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004733 }
John Durkop07cc04a2020-11-16 22:08:34 -08004734 else
4735#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4736#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4737 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004738 {
4739 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004740 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004741 }
4742 else
John Durkop07cc04a2020-11-16 22:08:34 -08004743#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004744 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004745 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004746 (void) data;
4747 (void) data_length;
4748 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004749 return( PSA_ERROR_BAD_STATE );
4750 }
4751
Gilles Peskine224b0d62019-09-23 18:13:17 +02004752exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004753 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004754 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004755 return( status );
4756}
4757
Janos Follath51f4a0f2019-06-14 11:35:55 +01004758psa_status_t psa_key_derivation_input_bytes(
4759 psa_key_derivation_operation_t *operation,
4760 psa_key_derivation_step_t step,
4761 const uint8_t *data,
4762 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004763{
Gilles Peskineb8965192019-09-24 16:21:10 +02004764 return( psa_key_derivation_input_internal( operation, step,
4765 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004766 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004767}
4768
Janos Follath51f4a0f2019-06-14 11:35:55 +01004769psa_status_t psa_key_derivation_input_key(
4770 psa_key_derivation_operation_t *operation,
4771 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004772 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004773{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004775 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004776 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004777
Ronald Cron5c522922020-11-14 16:35:34 +01004778 status = psa_get_and_lock_transparent_key_slot_with_policy(
4779 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004780 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004781 {
4782 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004783 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004784 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004785
4786 /* Passing a key object as a SECRET input unlocks the permission
4787 * to output to a key object. */
4788 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4789 operation->can_output_key = 1;
4790
Ronald Cronf95a2b12020-10-22 15:24:49 +02004791 status = psa_key_derivation_input_internal( operation,
4792 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004793 slot->key.data,
4794 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004795
Ronald Cron5c522922020-11-14 16:35:34 +01004796 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004797
Ronald Cron5c522922020-11-14 16:35:34 +01004798 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004799}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004800
4801
4802
4803/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004804/* Key agreement */
4805/****************************************************************/
4806
John Durkop6ba40d12020-11-10 08:50:04 -08004807#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004808static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4809 size_t peer_key_length,
4810 const mbedtls_ecp_keypair *our_key,
4811 uint8_t *shared_secret,
4812 size_t shared_secret_size,
4813 size_t *shared_secret_length )
4814{
Steven Cooremand4867872020-08-05 16:31:39 +02004815 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004816 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004817 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004818 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004819 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004820 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004821
Ronald Cron90857082020-11-25 14:58:33 +01004822 status = mbedtls_psa_ecp_load_representation(
4823 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004824 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004825 peer_key,
4826 peer_key_length,
4827 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004828 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004829 goto exit;
4830
Jaeden Amero97271b32019-01-10 19:38:51 +00004831 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004832 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004833 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004834 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004835 status = mbedtls_to_psa_error(
4836 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4837 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004838 goto exit;
4839
Jaeden Amero97271b32019-01-10 19:38:51 +00004840 status = mbedtls_to_psa_error(
4841 mbedtls_ecdh_calc_secret( &ecdh,
4842 shared_secret_length,
4843 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004844 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004845 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004846 if( status != PSA_SUCCESS )
4847 goto exit;
4848 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4849 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004850
4851exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004852 if( status != PSA_SUCCESS )
4853 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004854 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004855 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004856 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004857
Jaeden Amero97271b32019-01-10 19:38:51 +00004858 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004859}
John Durkop6ba40d12020-11-10 08:50:04 -08004860#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004861
Gilles Peskine01d718c2018-09-18 12:01:02 +02004862#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4863
Gilles Peskine0216fe12019-04-11 21:23:21 +02004864static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4865 psa_key_slot_t *private_key,
4866 const uint8_t *peer_key,
4867 size_t peer_key_length,
4868 uint8_t *shared_secret,
4869 size_t shared_secret_size,
4870 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004871{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004872 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004873 {
John Durkop6ba40d12020-11-10 08:50:04 -08004874#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004875 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004876 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004877 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004878 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004879 psa_status_t status = mbedtls_psa_ecp_load_representation(
4880 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004881 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004882 private_key->key.data,
4883 private_key->key.bytes,
4884 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004885 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004886 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004887 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004888 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004889 shared_secret, shared_secret_size,
4890 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004891 mbedtls_ecp_keypair_free( ecp );
4892 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004893 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004894#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004895 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004896 (void) private_key;
4897 (void) peer_key;
4898 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004899 (void) shared_secret;
4900 (void) shared_secret_size;
4901 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004902 return( PSA_ERROR_NOT_SUPPORTED );
4903 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004904}
4905
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004906/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004907 * to potentially free embedded data structures and wipe confidential data.
4908 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004909static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004910 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004911 psa_key_slot_t *private_key,
4912 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004913 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004914{
4915 psa_status_t status;
4916 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4917 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004918 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004919
4920 /* Step 1: run the secret agreement algorithm to generate the shared
4921 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004922 status = psa_key_agreement_raw_internal( ka_alg,
4923 private_key,
4924 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004925 shared_secret,
4926 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004927 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004928 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004929 goto exit;
4930
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004931 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004932 * the shared secret. A shared secret is permitted wherever a key
4933 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004934 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004935 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004936 shared_secret,
4937 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004938exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004939 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004940 return( status );
4941}
4942
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004943psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004944 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004945 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004946 const uint8_t *peer_key,
4947 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004948{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004949 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004950 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004951 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004952
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004953 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004954 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004955 status = psa_get_and_lock_transparent_key_slot_with_policy(
4956 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004957 if( status != PSA_SUCCESS )
4958 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004959 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004960 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004961 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004962 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004963 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004964 else
4965 {
4966 /* If a private key has been added as SECRET, we allow the derived
4967 * key material to be used as a key in PSA Crypto. */
4968 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4969 operation->can_output_key = 1;
4970 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004971
Ronald Cron5c522922020-11-14 16:35:34 +01004972 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004973
Ronald Cron5c522922020-11-14 16:35:34 +01004974 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004975}
4976
Gilles Peskinebe697d82019-05-16 18:00:41 +02004977psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004978 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004979 const uint8_t *peer_key,
4980 size_t peer_key_length,
4981 uint8_t *output,
4982 size_t output_size,
4983 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004984{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004985 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004986 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004987 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004988
4989 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4990 {
4991 status = PSA_ERROR_INVALID_ARGUMENT;
4992 goto exit;
4993 }
Ronald Cron5c522922020-11-14 16:35:34 +01004994 status = psa_get_and_lock_transparent_key_slot_with_policy(
4995 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004996 if( status != PSA_SUCCESS )
4997 goto exit;
4998
4999 status = psa_key_agreement_raw_internal( alg, slot,
5000 peer_key, peer_key_length,
5001 output, output_size,
5002 output_length );
5003
5004exit:
5005 if( status != PSA_SUCCESS )
5006 {
5007 /* If an error happens and is not handled properly, the output
5008 * may be used as a key to protect sensitive data. Arrange for such
5009 * a key to be random, which is likely to result in decryption or
5010 * verification errors. This is better than filling the buffer with
5011 * some constant data such as zeros, which would result in the data
5012 * being protected with a reproducible, easily knowable key.
5013 */
5014 psa_generate_random( output, output_size );
5015 *output_length = output_size;
5016 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005017
Ronald Cron5c522922020-11-14 16:35:34 +01005018 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005019
Ronald Cron5c522922020-11-14 16:35:34 +01005020 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005021}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005022
5023
Gilles Peskine30524eb2020-11-13 17:02:26 +01005024
Gilles Peskine86a440b2018-11-12 18:39:40 +01005025/****************************************************************/
5026/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005027/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005028
Gilles Peskine30524eb2020-11-13 17:02:26 +01005029/** Initialize the PSA random generator.
5030 */
5031static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5032{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005033#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5034 memset( rng, 0, sizeof( *rng ) );
5035#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5036
Gilles Peskine30524eb2020-11-13 17:02:26 +01005037 /* Set default configuration if
5038 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5039 if( rng->entropy_init == NULL )
5040 rng->entropy_init = mbedtls_entropy_init;
5041 if( rng->entropy_free == NULL )
5042 rng->entropy_free = mbedtls_entropy_free;
5043
5044 rng->entropy_init( &rng->entropy );
5045#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5046 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5047 /* The PSA entropy injection feature depends on using NV seed as an entropy
5048 * source. Add NV seed as an entropy source for PSA entropy injection. */
5049 mbedtls_entropy_add_source( &rng->entropy,
5050 mbedtls_nv_seed_poll, NULL,
5051 MBEDTLS_ENTROPY_BLOCK_SIZE,
5052 MBEDTLS_ENTROPY_SOURCE_STRONG );
5053#endif
5054
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005055 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005056#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005057}
5058
5059/** Deinitialize the PSA random generator.
5060 */
5061static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5062{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005063#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5064 memset( rng, 0, sizeof( *rng ) );
5065#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005066 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005067 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005068#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005069}
5070
5071/** Seed the PSA random generator.
5072 */
5073static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5074{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005075#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5076 /* Do nothing: the external RNG seeds itself. */
5077 (void) rng;
5078 return( PSA_SUCCESS );
5079#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005080 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005081 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5082 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005083 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005084#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005085}
5086
Gilles Peskinee59236f2018-01-27 23:32:46 +01005087psa_status_t psa_generate_random( uint8_t *output,
5088 size_t output_size )
5089{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005090 GUARD_MODULE_INITIALIZED;
5091
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005092#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5093
5094 size_t output_length = 0;
5095 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5096 output, output_size,
5097 &output_length );
5098 if( status != PSA_SUCCESS )
5099 return( status );
5100 /* Breaking up a request into smaller chunks is currently not supported
5101 * for the extrernal RNG interface. */
5102 if( output_length != output_size )
5103 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5104 return( PSA_SUCCESS );
5105
5106#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5107
Gilles Peskine71ddab92021-01-04 21:01:07 +01005108 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005109 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005110 size_t request_size =
5111 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5112 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5113 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005114 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5115 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005116 if( ret != 0 )
5117 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005118 output_size -= request_size;
5119 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005120 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005121 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005122#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005123}
5124
Gilles Peskine8814fc42020-12-14 15:33:44 +01005125/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005126 *
5127 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5128 * `psa_generate_random(...)`. The state parameter is ignored since the
5129 * PSA API doesn't support passing an explicit state.
5130 *
5131 * In the non-external case, psa_generate_random() calls an
5132 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5133 * and semantics as mbedtls_psa_get_random(). As an optimization,
5134 * instead of doing this back-and-forth between the PSA API and the
5135 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5136 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005137 */
5138#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5139int mbedtls_psa_get_random( void *p_rng,
5140 unsigned char *output,
5141 size_t output_size )
5142{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005143 /* This function takes a pointer to the RNG state because that's what
5144 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5145 * its own state internally and doesn't let the caller access that state.
5146 * So we just ignore the state parameter, and in practice we'll pass
5147 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005148 (void) p_rng;
5149 psa_status_t status = psa_generate_random( output, output_size );
5150 if( status == PSA_SUCCESS )
5151 return( 0 );
5152 else
5153 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5154}
5155#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5156
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005157#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005158#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005159
Gilles Peskine7228da22019-07-15 11:06:15 +02005160psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005161 size_t seed_size )
5162{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005163 if( global_data.initialized )
5164 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005165
5166 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5167 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5168 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5169 return( PSA_ERROR_INVALID_ARGUMENT );
5170
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005171 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005172}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005173#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005174
Ronald Cron3772afe2021-02-08 16:10:05 +01005175/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005176 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005177 * \param type The key type
5178 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005179 *
5180 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005181 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005182 * \retval #PSA_ERROR_INVALID_ARGUMENT
5183 * The size in bits of the key is not valid.
5184 * \retval #PSA_ERROR_NOT_SUPPORTED
5185 * The type and/or the size in bits of the key or the combination of
5186 * the two is not supported.
5187 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005188static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5189 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005190{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005191 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005192
Gilles Peskinee59236f2018-01-27 23:32:46 +01005193 if( key_type_is_raw_bytes( type ) )
5194 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02005195 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005196 if( status != PSA_SUCCESS )
5197 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005198 }
5199 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005200#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005201 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5202 {
5203 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5204 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005205
Ronald Cron01b2aba2020-10-05 09:42:02 +02005206 /* Accept only byte-aligned keys, for the same reasons as
5207 * in psa_import_rsa_key(). */
5208 if( bits % 8 != 0 )
5209 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005210 }
5211 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005212#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005213
Ronald Cron5c4d3862020-12-07 11:07:24 +01005214#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005215 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5216 {
Ronald Crond81ab562021-02-16 09:01:16 +01005217 /* To avoid empty block, return successfully here. */
5218 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005219 }
5220 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005221#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005222 {
5223 return( PSA_ERROR_NOT_SUPPORTED );
5224 }
5225
5226 return( PSA_SUCCESS );
5227}
5228
Ronald Cron55ed0592020-10-05 10:30:40 +02005229psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005230 const psa_key_attributes_t *attributes,
5231 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005232{
5233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005234 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005235
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005236 if( ( attributes->domain_parameters == NULL ) &&
5237 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005238 return( PSA_ERROR_INVALID_ARGUMENT );
5239
Ronald Cron01b2aba2020-10-05 09:42:02 +02005240 if( key_type_is_raw_bytes( type ) )
5241 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005242 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005243 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005244 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005245
David Brown12ca5032021-02-11 11:02:00 -07005246#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005247 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005248 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005249#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005250 }
5251 else
5252
Jaeden Amero424fa932021-05-14 08:34:32 +01005253#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5254 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005255 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005256 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005257 return( mbedtls_psa_rsa_generate_key( attributes,
5258 key_buffer,
5259 key_buffer_size,
5260 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005261 }
5262 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005263#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5264 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005265
John Durkop9814fa22020-11-04 12:28:15 -08005266#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005267 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005268 {
Ronald Cron7023db52020-11-20 18:17:42 +01005269 return( mbedtls_psa_ecp_generate_key( attributes,
5270 key_buffer,
5271 key_buffer_size,
5272 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005273 }
5274 else
John Durkop9814fa22020-11-04 12:28:15 -08005275#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005276 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005277 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005278 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005279 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005280
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005281 return( PSA_SUCCESS );
5282}
Darryl Green0c6575a2018-11-07 16:05:30 +00005283
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005284psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005285 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005286{
5287 psa_status_t status;
5288 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005289 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005290 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005291
Ronald Cron81709fc2020-11-14 12:10:32 +01005292 *key = MBEDTLS_SVC_KEY_ID_INIT;
5293
Gilles Peskine0f84d622019-09-12 19:03:13 +02005294 /* Reject any attempt to create a zero-length key so that we don't
5295 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5296 if( psa_get_key_bits( attributes ) == 0 )
5297 return( PSA_ERROR_INVALID_ARGUMENT );
5298
Ronald Cron81709fc2020-11-14 12:10:32 +01005299 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5300 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005301 if( status != PSA_SUCCESS )
5302 goto exit;
5303
Ronald Cron977c2472020-10-13 08:32:21 +02005304 /* In the case of a transparent key or an opaque key stored in local
5305 * storage (thus not in the case of generating a key in a secure element
5306 * or cryptoprocessor with storage), we have to allocate a buffer to
5307 * hold the generated key material. */
5308 if( slot->key.data == NULL )
5309 {
5310 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5311 PSA_KEY_LOCATION_LOCAL_STORAGE )
5312 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005313 status = psa_validate_key_type_and_size_for_key_generation(
5314 attributes->core.type, attributes->core.bits );
5315 if( status != PSA_SUCCESS )
5316 goto exit;
5317
5318 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5319 attributes->core.type,
5320 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005321 }
5322 else
5323 {
5324 status = psa_driver_wrapper_get_key_buffer_size(
5325 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005326 if( status != PSA_SUCCESS )
5327 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005328 }
Ronald Cron977c2472020-10-13 08:32:21 +02005329
5330 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5331 if( status != PSA_SUCCESS )
5332 goto exit;
5333 }
5334
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005335 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005336 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005337
Ronald Cron2b56bc82020-10-05 10:02:26 +02005338 if( status != PSA_SUCCESS )
5339 psa_remove_key_data_from_memory( slot );
5340
Gilles Peskine11792082019-08-06 18:36:36 +02005341exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005342 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005343 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005344 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005345 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005346
Darryl Green0c6575a2018-11-07 16:05:30 +00005347 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005348}
5349
Gilles Peskinee59236f2018-01-27 23:32:46 +01005350/****************************************************************/
5351/* Module setup */
5352/****************************************************************/
5353
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005354#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005355psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5356 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5357 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5358{
5359 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5360 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005361 global_data.rng.entropy_init = entropy_init;
5362 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005363 return( PSA_SUCCESS );
5364}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005365#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005366
Gilles Peskinee59236f2018-01-27 23:32:46 +01005367void mbedtls_psa_crypto_free( void )
5368{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005369 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005370 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5371 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005372 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005373 }
5374 /* Wipe all remaining data, including configuration.
5375 * In particular, this sets all state indicator to the value
5376 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005377 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005378#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005379 /* Unregister all secure element drivers, so that we restart from
5380 * a pristine state. */
5381 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005382#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005383}
5384
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005385#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5386/** Recover a transaction that was interrupted by a power failure.
5387 *
5388 * This function is called during initialization, before psa_crypto_init()
5389 * returns. If this function returns a failure status, the initialization
5390 * fails.
5391 */
5392static psa_status_t psa_crypto_recover_transaction(
5393 const psa_crypto_transaction_t *transaction )
5394{
5395 switch( transaction->unknown.type )
5396 {
5397 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5398 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005399 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005400 * is implemented.
5401 * https://github.com/ARMmbed/mbed-crypto/issues/218
5402 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005403 default:
5404 /* We found an unsupported transaction in the storage.
5405 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005406 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005407 }
5408}
5409#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5410
Gilles Peskinee59236f2018-01-27 23:32:46 +01005411psa_status_t psa_crypto_init( void )
5412{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005413 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005414
Gilles Peskinec6b69072018-11-20 21:42:52 +01005415 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005416 if( global_data.initialized != 0 )
5417 return( PSA_SUCCESS );
5418
Gilles Peskine30524eb2020-11-13 17:02:26 +01005419 /* Initialize and seed the random generator. */
5420 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005421 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005422 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005423 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005424 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005425 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005426
Gilles Peskine66fb1262018-12-10 16:29:04 +01005427 status = psa_initialize_key_slots( );
5428 if( status != PSA_SUCCESS )
5429 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005430
Gilles Peskined9348f22019-10-01 15:22:29 +02005431#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5432 status = psa_init_all_se_drivers( );
5433 if( status != PSA_SUCCESS )
5434 goto exit;
5435#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5436
Gilles Peskine4b734222019-07-24 15:56:31 +02005437#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005438 status = psa_crypto_load_transaction( );
5439 if( status == PSA_SUCCESS )
5440 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005441 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5442 if( status != PSA_SUCCESS )
5443 goto exit;
5444 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005445 }
5446 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5447 {
5448 /* There's no transaction to complete. It's all good. */
5449 status = PSA_SUCCESS;
5450 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005451#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005452
Gilles Peskinec6b69072018-11-20 21:42:52 +01005453 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005454 global_data.initialized = 1;
5455
5456exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005457 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005458 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005459 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005460}
5461
5462#endif /* MBEDTLS_PSA_CRYPTO_C */