blob: 3ca8c9d8f6c026c26d10bf62c4626a23eb5e4d5b [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 Peskine9ef733f2018-02-07 21:05:37 +010096/* constant-time buffer comparison */
97static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
98{
99 size_t i;
100 unsigned char diff = 0;
101
102 for( i = 0; i < n; i++ )
103 diff |= a[i] ^ b[i];
104
105 return( diff );
106}
107
108
109
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100110/****************************************************************/
111/* Global data, support functions and library management */
112/****************************************************************/
113
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200114static int key_type_is_raw_bytes( psa_key_type_t type )
115{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200116 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200117}
118
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100119/* Values for psa_global_data_t::rng_state */
120#define RNG_NOT_INITIALIZED 0
121#define RNG_INITIALIZED 1
122#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100123
Gilles Peskine2d277862018-06-18 15:41:12 +0200124typedef struct
125{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100126 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100127 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100128 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129} psa_global_data_t;
130
131static psa_global_data_t global_data;
132
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100133#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
134mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
135 &global_data.rng.drbg;
136#endif
137
itayzafrir0adf0fc2018-09-06 16:24:41 +0300138#define GUARD_MODULE_INITIALIZED \
139 if( global_data.initialized == 0 ) \
140 return( PSA_ERROR_BAD_STATE );
141
Steven Cooreman01164162020-07-20 15:31:37 +0200142psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100143{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100144 /* Mbed TLS error codes can combine a high-level error code and a
145 * low-level error code. The low-level error usually reflects the
146 * root cause better, so dispatch on that preferably. */
147 int low_level_ret = - ( -ret & 0x007f );
148 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100149 {
150 case 0:
151 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100152
153 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
154 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100155 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200156 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
157 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
158 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
159 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
160 case MBEDTLS_ERR_ASN1_INVALID_DATA:
161 return( PSA_ERROR_INVALID_ARGUMENT );
162 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
163 return( PSA_ERROR_INSUFFICIENT_MEMORY );
164 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
165 return( PSA_ERROR_BUFFER_TOO_SMALL );
166
Jaeden Amero93e21112019-02-20 13:57:28 +0000167#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000168 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000169#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100170 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
171 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100172
Jaeden Amero93e21112019-02-20 13:57:28 +0000173#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000174 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000175#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100176 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
177 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100178
179 case MBEDTLS_ERR_CCM_BAD_INPUT:
180 return( PSA_ERROR_INVALID_ARGUMENT );
181 case MBEDTLS_ERR_CCM_AUTH_FAILED:
182 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100183
Gilles Peskine26869f22019-05-06 15:25:00 +0200184 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
185 return( PSA_ERROR_INVALID_ARGUMENT );
186
187 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
188 return( PSA_ERROR_BAD_STATE );
189 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
190 return( PSA_ERROR_INVALID_SIGNATURE );
191
Gilles Peskinea5905292018-02-07 20:59:33 +0100192 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
193 return( PSA_ERROR_NOT_SUPPORTED );
194 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
195 return( PSA_ERROR_INVALID_ARGUMENT );
196 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
197 return( PSA_ERROR_INSUFFICIENT_MEMORY );
198 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
199 return( PSA_ERROR_INVALID_PADDING );
200 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200201 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100202 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200205 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100206
Gilles Peskine82e57d12020-11-13 21:31:17 +0100207#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
208 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100209 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
210 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100211 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
213 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
214 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
215 return( PSA_ERROR_NOT_SUPPORTED );
216 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
217 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100218#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100219
220 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
221 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100222
Gilles Peskinee59236f2018-01-27 23:32:46 +0100223 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
224 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
225 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
226 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100227
228 case MBEDTLS_ERR_GCM_AUTH_FAILED:
229 return( PSA_ERROR_INVALID_SIGNATURE );
230 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200231 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100232
Gilles Peskine82e57d12020-11-13 21:31:17 +0100233#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
234 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100235 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
236 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100237 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
238 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
239 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
240 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
241 return( PSA_ERROR_NOT_SUPPORTED );
242 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
243 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
244#endif
245
Gilles Peskinea5905292018-02-07 20:59:33 +0100246 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
247 return( PSA_ERROR_NOT_SUPPORTED );
248 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
249 return( PSA_ERROR_INVALID_ARGUMENT );
250 case MBEDTLS_ERR_MD_ALLOC_FAILED:
251 return( PSA_ERROR_INSUFFICIENT_MEMORY );
252 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
253 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100254
Gilles Peskinef76aa772018-10-29 19:24:33 +0100255 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
256 return( PSA_ERROR_STORAGE_FAILURE );
257 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
258 return( PSA_ERROR_INVALID_ARGUMENT );
259 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
260 return( PSA_ERROR_INVALID_ARGUMENT );
261 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
262 return( PSA_ERROR_BUFFER_TOO_SMALL );
263 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
268 return( PSA_ERROR_INVALID_ARGUMENT );
269 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
270 return( PSA_ERROR_INSUFFICIENT_MEMORY );
271
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100272 case MBEDTLS_ERR_PK_ALLOC_FAILED:
273 return( PSA_ERROR_INSUFFICIENT_MEMORY );
274 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
275 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100278 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100279 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
280 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
281 return( PSA_ERROR_INVALID_ARGUMENT );
282 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
283 return( PSA_ERROR_NOT_SUPPORTED );
284 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
285 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
286 return( PSA_ERROR_NOT_PERMITTED );
287 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_PK_INVALID_ALG:
290 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
291 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
292 return( PSA_ERROR_NOT_SUPPORTED );
293 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
294 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100295
Gilles Peskineff2d2002019-05-06 15:26:23 +0200296 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
297 return( PSA_ERROR_HARDWARE_FAILURE );
298 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
299 return( PSA_ERROR_NOT_SUPPORTED );
300
Gilles Peskinea5905292018-02-07 20:59:33 +0100301 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
302 return( PSA_ERROR_INVALID_ARGUMENT );
303 case MBEDTLS_ERR_RSA_INVALID_PADDING:
304 return( PSA_ERROR_INVALID_PADDING );
305 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
306 return( PSA_ERROR_HARDWARE_FAILURE );
307 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
308 return( PSA_ERROR_INVALID_ARGUMENT );
309 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
310 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200311 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
313 return( PSA_ERROR_INVALID_SIGNATURE );
314 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
315 return( PSA_ERROR_BUFFER_TOO_SMALL );
316 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100317 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200318
Gilles Peskinea5905292018-02-07 20:59:33 +0100319 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
320 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100321
itayzafrir5c753392018-05-08 11:18:38 +0300322 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300323 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300324 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300325 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
326 return( PSA_ERROR_BUFFER_TOO_SMALL );
327 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
328 return( PSA_ERROR_NOT_SUPPORTED );
329 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
330 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
331 return( PSA_ERROR_INVALID_SIGNATURE );
332 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
333 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100334 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
335 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100336
Janos Follatha13b9052019-11-22 12:48:59 +0000337 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
338 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300339
Gilles Peskinee59236f2018-01-27 23:32:46 +0100340 default:
David Saadab4ecc272019-02-14 13:48:10 +0200341 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100342 }
343}
344
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200345
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200346
347
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100348/****************************************************************/
349/* Key management */
350/****************************************************************/
351
Gilles Peskine73167e12019-07-12 23:44:37 +0200352#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
353static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
354{
Gilles Peskine8e338702019-07-30 20:06:31 +0200355 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200356}
357#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
358
John Durkop07cc04a2020-11-16 22:08:34 -0800359/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
360 * current test driver in key_management.c is using this function
361 * when accelerators are used for ECC key pair and public key.
362 * Once that dependency is resolved these guards can be removed.
363 */
John Durkop9814fa22020-11-04 12:28:15 -0800364#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800365 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
366 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
367 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100368mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100369 size_t bits,
370 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200371{
372 switch( curve )
373 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100374 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100375 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100376 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100377#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100378 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100379 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100380#endif
381#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100383 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100384#endif
385#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100386 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100388#endif
389#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100390 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100391 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100392#endif
393#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100396 case 528:
397 if( bits_is_sloppy )
398 return( MBEDTLS_ECP_DP_SECP521R1 );
399 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100401 }
402 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100403
Paul Elliott8ff510a2020-06-02 17:19:28 +0100404 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100407#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100408 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100409 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100410#endif
411#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#endif
415#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100416 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100417 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100419 }
420 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100421
Paul Elliott8ff510a2020-06-02 17:19:28 +0100422 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100425#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100426 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100427 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100428 case 256:
429 if( bits_is_sloppy )
430 return( MBEDTLS_ECP_DP_CURVE25519 );
431 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100432#endif
433#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100437 }
438 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100439
Paul Elliott8ff510a2020-06-02 17:19:28 +0100440 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100441 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100442 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100443#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100445 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100446#endif
447#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100448 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100449 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100450#endif
451#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100452 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100454#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100455 }
456 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200457 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100458
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100459 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100460 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200461}
John Durkop9814fa22020-11-04 12:28:15 -0800462#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800463 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
464 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
465 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200466
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200467static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
468 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200469{
470 /* Check that the bit size is acceptable for the key type */
471 switch( type )
472 {
473 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200474 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200475 case PSA_KEY_TYPE_DERIVE:
476 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100477#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478 case PSA_KEY_TYPE_AES:
479 if( bits != 128 && bits != 192 && bits != 256 )
480 return( PSA_ERROR_INVALID_ARGUMENT );
481 break;
482#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100483#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200484 case PSA_KEY_TYPE_CAMELLIA:
485 if( bits != 128 && bits != 192 && bits != 256 )
486 return( PSA_ERROR_INVALID_ARGUMENT );
487 break;
488#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100489#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490 case PSA_KEY_TYPE_DES:
491 if( bits != 64 && bits != 128 && bits != 192 )
492 return( PSA_ERROR_INVALID_ARGUMENT );
493 break;
494#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100495#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200496 case PSA_KEY_TYPE_ARC4:
497 if( bits < 8 || bits > 2048 )
498 return( PSA_ERROR_INVALID_ARGUMENT );
499 break;
500#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100501#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200502 case PSA_KEY_TYPE_CHACHA20:
503 if( bits != 256 )
504 return( PSA_ERROR_INVALID_ARGUMENT );
505 break;
506#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200507 default:
508 return( PSA_ERROR_NOT_SUPPORTED );
509 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200510 if( bits % 8 != 0 )
511 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200512
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200513 return( PSA_SUCCESS );
514}
515
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100516/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100517 *
Steven Cooremancd640932021-03-08 12:00:27 +0100518 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
519 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100520 *
521 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100522 * \param[in] key_type The key type of the key to be used with the
523 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100524 *
525 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100526 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100527 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100528 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100529 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100530MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100531 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100532 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100533{
Steven Cooremancd640932021-03-08 12:00:27 +0100534 if( PSA_ALG_IS_HMAC( algorithm ) )
535 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100536 if( key_type == PSA_KEY_TYPE_HMAC )
537 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100538 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100539
540 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100541 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100542 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
543 * key. */
544 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
545 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
546 {
547 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
548 * the block length (larger than 1) for block ciphers. */
549 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
550 return( PSA_SUCCESS );
551 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100552 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100553
554 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100555}
556
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200557psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
558 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200559{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100560 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200561 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200562
Ronald Cronea0f8a62020-11-25 17:52:23 +0100563 slot->key.data = mbedtls_calloc( 1, buffer_length );
564 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200565 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200566
Ronald Cronea0f8a62020-11-25 17:52:23 +0100567 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200568 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200569}
570
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200571psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
572 const uint8_t* data,
573 size_t data_length )
574{
575 psa_status_t status = psa_allocate_buffer_to_slot( slot,
576 data_length );
577 if( status != PSA_SUCCESS )
578 return( status );
579
Ronald Cronea0f8a62020-11-25 17:52:23 +0100580 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200581 return( PSA_SUCCESS );
582}
583
Ronald Crona0fe59f2020-11-29 11:14:53 +0100584psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 const psa_key_attributes_t *attributes,
586 const uint8_t *data, size_t data_length,
587 uint8_t *key_buffer, size_t key_buffer_size,
588 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100589{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
591 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100592
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200593 /* zero-length keys are never supported. */
594 if( data_length == 0 )
595 return( PSA_ERROR_NOT_SUPPORTED );
596
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100598 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200600
Steven Cooreman75b74362020-07-28 14:30:13 +0200601 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
602 if( data_length > SIZE_MAX / 8 )
603 return( PSA_ERROR_NOT_SUPPORTED );
604
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200605 /* Enforce a size limit, and in particular ensure that the bit
606 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200608 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200609
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100610 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200611 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200612 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200613
Ronald Crondd04d422020-11-28 15:14:42 +0100614 /* Copy the key material. */
615 memcpy( key_buffer, data, data_length );
616 *key_buffer_length = data_length;
617 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200618
Steven Cooreman40120f62020-10-29 11:42:22 +0100619 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100620 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100621 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200622 {
John Durkop9814fa22020-11-04 12:28:15 -0800623#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
624 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100625 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200626 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100627 return( mbedtls_psa_ecp_import_key( attributes,
628 data, data_length,
629 key_buffer, key_buffer_size,
630 key_buffer_length,
631 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100632 }
John Durkop9814fa22020-11-04 12:28:15 -0800633#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
634 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700635#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
636 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100637 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200638 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100639 return( mbedtls_psa_rsa_import_key( attributes,
640 data, data_length,
641 key_buffer, key_buffer_size,
642 key_buffer_length,
643 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200644 }
John Durkop9814fa22020-11-04 12:28:15 -0800645#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
646 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100647 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100648
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100649 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100650}
651
Gilles Peskinef603c712019-01-19 13:40:11 +0100652/** Calculate the intersection of two algorithm usage policies.
653 *
654 * Return 0 (which allows no operation) on incompatibility.
655 */
656static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100657 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100658 psa_algorithm_t alg1,
659 psa_algorithm_t alg2 )
660{
Gilles Peskine549ea862019-05-22 11:45:59 +0200661 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100662 if( alg1 == alg2 )
663 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100664 /* If the policies are from the same hash-and-sign family, check
665 * if one is a wildcard. If so the other has the specific algorithm. */
666 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
667 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
668 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100669 {
Steven Cooreman03488022021-02-18 12:07:20 +0100670 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
671 return( alg2 );
672 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
673 return( alg1 );
674 }
675 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100676 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100677 * restrictive tag length. */
678 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
679 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
680 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
681 {
682 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
683 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100684 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100685
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100686 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100687 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
688 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100689 {
Steven Cooremancd640932021-03-08 12:00:27 +0100690 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
691 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100692 }
693 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100694 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100695 ( alg1_len <= alg2_len ) )
696 {
697 return( alg2 );
698 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100699 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100700 ( alg2_len <= alg1_len ) )
701 {
702 return( alg1 );
703 }
704 }
705 /* If the policies are from the same MAC family, check whether one
706 * of them is a minimum-MAC-length policy. Calculate the most
707 * restrictive tag length. */
708 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
709 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
710 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
711 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100712 /* Validate the combination of key type and algorithm. Since the base
713 * algorithm of alg1 and alg2 are the same, we only need this once. */
714 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100715 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100716
Steven Cooreman31a876d2021-03-03 20:47:40 +0100717 /* Get the (exact or at-least) output lengths for both sides of the
718 * requested intersection. None of the currently supported algorithms
719 * have an output length dependent on the actual key size, so setting it
720 * to a bogus value of 0 is currently OK.
721 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100722 * Note that for at-least-this-length wildcard algorithms, the output
723 * length is set to the shortest allowed length, which allows us to
724 * calculate the most restrictive tag length for the intersection. */
725 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
726 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100727 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100728
Steven Cooremana1d83222021-02-25 10:20:29 +0100729 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100730 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
731 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100732 {
Steven Cooremancd640932021-03-08 12:00:27 +0100733 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100734 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100735
736 /* If only one is an at-least-this-length policy, the intersection would
737 * be the other (fixed-length) policy as long as said fixed length is
738 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100739 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100740 {
Steven Cooremancd640932021-03-08 12:00:27 +0100741 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100742 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100743 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100744 {
Steven Cooremancd640932021-03-08 12:00:27 +0100745 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100746 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100747
Steven Cooremancd640932021-03-08 12:00:27 +0100748 /* If none of them are wildcards, check whether they define the same tag
749 * length. This is still possible here when one is default-length and
750 * the other specific-length. Ensure to always return the
751 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100752 if( alg1_len == alg2_len )
753 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100754 }
755 /* If the policies are incompatible, allow nothing. */
756 return( 0 );
757}
758
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100759static int psa_key_algorithm_permits( psa_key_type_t key_type,
760 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200761 psa_algorithm_t requested_alg )
762{
Gilles Peskine549ea862019-05-22 11:45:59 +0200763 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200764 if( requested_alg == policy_alg )
765 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100766 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
767 * and requested_alg is the same hash-and-sign family with any hash,
768 * then requested_alg is compliant with policy_alg. */
769 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
770 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200771 {
Steven Cooreman03488022021-02-18 12:07:20 +0100772 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
773 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
774 }
775 /* If policy_alg is a wildcard AEAD algorithm of the same base as
776 * the requested algorithm, check the requested tag length to be
777 * equal-length or longer than the wildcard-specified length. */
778 if( PSA_ALG_IS_AEAD( policy_alg ) &&
779 PSA_ALG_IS_AEAD( requested_alg ) &&
780 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
781 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100782 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100783 {
784 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
785 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
786 }
Steven Cooremancd640932021-03-08 12:00:27 +0100787 /* If policy_alg is a MAC algorithm of the same base as the requested
788 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100789 if( PSA_ALG_IS_MAC( policy_alg ) &&
790 PSA_ALG_IS_MAC( requested_alg ) &&
791 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100792 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100793 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100794 /* Validate the combination of key type and algorithm. Since the policy
795 * and requested algorithms are the same, we only need this once. */
796 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100797 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100798
Steven Cooreman31a876d2021-03-03 20:47:40 +0100799 /* Get both the requested output length for the algorithm which is to be
800 * verified, and the default output length for the base algorithm.
801 * Note that none of the currently supported algorithms have an output
802 * length dependent on actual key size, so setting it to a bogus value
803 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100804 size_t requested_output_length = PSA_MAC_LENGTH(
805 key_type, 0, requested_alg );
806 size_t default_output_length = PSA_MAC_LENGTH(
807 key_type, 0,
808 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100809
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100810 /* If the policy is default-length, only allow an algorithm with
811 * a declared exact-length matching the default. */
812 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100813 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100814
815 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100816 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100817 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
818 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
819 {
820 return( 1 );
821 }
822
Steven Cooremancd640932021-03-08 12:00:27 +0100823 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
824 * check for the requested MAC length to be equal to or longer than the
825 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100826 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
827 {
828 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100829 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100830 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200831 }
Steven Cooremance48e852020-10-05 16:02:45 +0200832 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200833 * a key derivation with that key agreement should also be allowed. This
834 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200835 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
836 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
837 {
838 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
839 policy_alg );
840 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100841 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200842 return( 0 );
843}
844
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100845/** Test whether a policy permits an algorithm.
846 *
847 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100848 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100849 * \note This function requires providing the key type for which the policy is
850 * being validated, since some algorithm policy definitions (e.g. MAC)
851 * have different properties depending on what kind of cipher it is
852 * combined with.
853 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100854 * \retval PSA_SUCCESS When \p alg is a specific algorithm
855 * allowed by the \p policy.
856 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
857 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
858 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100859 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100860static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100861 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100862 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100863{
Steven Cooremand788fab2021-02-25 11:29:17 +0100864 /* '0' is not a valid algorithm */
865 if( alg == 0 )
866 return( PSA_ERROR_INVALID_ARGUMENT );
867
Steven Cooreman7e39f052021-02-23 14:18:32 +0100868 /* A requested algorithm cannot be a wildcard. */
869 if( PSA_ALG_IS_WILDCARD( alg ) )
870 return( PSA_ERROR_INVALID_ARGUMENT );
871
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100872 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
873 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100874 return( PSA_SUCCESS );
875 else
876 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100877}
878
Gilles Peskinef603c712019-01-19 13:40:11 +0100879/** Restrict a key policy based on a constraint.
880 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100881 * \note This function requires providing the key type for which the policy is
882 * being restricted, since some algorithm policy definitions (e.g. MAC)
883 * have different properties depending on what kind of cipher it is
884 * combined with.
885 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100886 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100887 * \param[in,out] policy The policy to restrict.
888 * \param[in] constraint The policy constraint to apply.
889 *
890 * \retval #PSA_SUCCESS
891 * \c *policy contains the intersection of the original value of
892 * \c *policy and \c *constraint.
893 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100894 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 * \c *policy is unchanged.
896 */
897static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100898 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100899 psa_key_policy_t *policy,
900 const psa_key_policy_t *constraint )
901{
902 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100903 psa_key_policy_algorithm_intersection( key_type, policy->alg,
904 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200905 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100906 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
907 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100908 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
909 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200910 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
911 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100912 policy->usage &= constraint->usage;
913 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200914 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100915 return( PSA_SUCCESS );
916}
917
Ronald Cron5c522922020-11-14 16:35:34 +0100918/** Get the description of a key given its identifier and policy constraints
919 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200920 *
Ronald Cron5c522922020-11-14 16:35:34 +0100921 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100922 * nonzero, the key must allow operations with this algorithm. If \p alg is
923 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100924 *
Ronald Cron5c522922020-11-14 16:35:34 +0100925 * In case of a persistent key, the function loads the description of the key
926 * into a key slot if not already done.
927 *
928 * On success, the returned key slot is locked. It is the responsibility of
929 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200930 */
Ronald Cron5c522922020-11-14 16:35:34 +0100931static psa_status_t psa_get_and_lock_key_slot_with_policy(
932 mbedtls_svc_key_id_t key,
933 psa_key_slot_t **p_slot,
934 psa_key_usage_t usage,
935 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100936{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
938 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100939
Ronald Cron5c522922020-11-14 16:35:34 +0100940 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100941 if( status != PSA_SUCCESS )
942 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200943 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100944
945 /* Enforce that usage policy for the key slot contains all the flags
946 * required by the usage parameter. There is one exception: public
947 * keys can always be exported, so we treat public key objects as
948 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200949 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100950 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200951
Gilles Peskine8e338702019-07-30 20:06:31 +0200952 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100953 {
954 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200955 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100956 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100957
958 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100959 if( alg != 0 )
960 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100961 status = psa_key_policy_permits( &slot->attr.policy,
962 slot->attr.type,
963 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100964 if( status != PSA_SUCCESS )
965 goto error;
966 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100967
Darryl Green06fd18d2018-07-16 11:21:11 +0100968 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200969
970error:
971 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100972 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200973
974 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100975}
Darryl Green940d72c2018-07-13 13:18:51 +0100976
Ronald Cron5c522922020-11-14 16:35:34 +0100977/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200978 *
979 * A transparent key is a key for which the key material is directly
980 * available, as opposed to a key in a secure element.
981 *
Ronald Cron5c522922020-11-14 16:35:34 +0100982 * This is a temporary function to use instead of
983 * psa_get_and_lock_key_slot_with_policy() until secure element support is
984 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200985 *
Ronald Cron5c522922020-11-14 16:35:34 +0100986 * On success, the returned key slot is locked. It is the responsibility of the
987 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200988 */
989#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100990static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
991 mbedtls_svc_key_id_t key,
992 psa_key_slot_t **p_slot,
993 psa_key_usage_t usage,
994 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200995{
Ronald Cron5c522922020-11-14 16:35:34 +0100996 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
997 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200998 if( status != PSA_SUCCESS )
999 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001000
Gilles Peskineadad8132019-07-25 11:31:23 +02001001 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001002 {
Ronald Cron5c522922020-11-14 16:35:34 +01001003 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001004 *p_slot = NULL;
1005 return( PSA_ERROR_NOT_SUPPORTED );
1006 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001007
Gilles Peskine28f8f302019-07-24 13:30:31 +02001008 return( PSA_SUCCESS );
1009}
1010#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1011/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001012#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1013 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001014#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1015
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001016psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001017{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001018 /* Data pointer will always be either a valid pointer or NULL in an
1019 * initialized slot, so we can just free it. */
1020 if( slot->key.data != NULL )
1021 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1022
1023 mbedtls_free( slot->key.data );
1024 slot->key.data = NULL;
1025 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001026
1027 return( PSA_SUCCESS );
1028}
1029
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001030/** Completely wipe a slot in memory, including its policy.
1031 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001032psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001033{
1034 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001035
1036 /*
1037 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001038 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001039 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1040 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001041 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001042 */
Ronald Cron5c522922020-11-14 16:35:34 +01001043 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001044 {
1045#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001046 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001047#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001048 status = PSA_ERROR_CORRUPTION_DETECTED;
1049 }
1050
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001051 /* Multipart operations may still be using the key. This is safe
1052 * because all multipart operation objects are independent from
1053 * the key slot: if they need to access the key after the setup
1054 * phase, they have a copy of the key. Note that this means that
1055 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001056 /* At this point, key material and other type-specific content has
1057 * been wiped. Clear remaining metadata. We can call memset and not
1058 * zeroize because the metadata is not particularly sensitive. */
1059 memset( slot, 0, sizeof( *slot ) );
1060 return( status );
1061}
1062
Ronald Croncf56a0a2020-08-04 09:51:30 +02001063psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001064{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001065 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001066 psa_status_t status; /* status of the last operation */
1067 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001068#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1069 psa_se_drv_table_entry_t *driver;
1070#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001071
Ronald Croncf56a0a2020-08-04 09:51:30 +02001072 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001073 return( PSA_SUCCESS );
1074
Ronald Cronf2911112020-10-29 17:51:10 +01001075 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001076 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001077 * key, this will load the key description from persistent memory if not
1078 * done yet. We cannot avoid this loading as without it we don't know if
1079 * the key is operated by an SE or not and this information is needed by
1080 * the current implementation.
1081 */
Ronald Cron5c522922020-11-14 16:35:34 +01001082 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001083 if( status != PSA_SUCCESS )
1084 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001085
Ronald Cronf2911112020-10-29 17:51:10 +01001086 /*
1087 * If the key slot containing the key description is under access by the
1088 * library (apart from the present access), the key cannot be destroyed
1089 * yet. For the time being, just return in error. Eventually (to be
1090 * implemented), the key should be destroyed when all accesses have
1091 * stopped.
1092 */
Ronald Cron5c522922020-11-14 16:35:34 +01001093 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001094 {
Ronald Cron5c522922020-11-14 16:35:34 +01001095 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001096 return( PSA_ERROR_GENERIC_ERROR );
1097 }
1098
Gilles Peskine354f7672019-07-12 23:46:38 +02001099#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001100 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001101 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001102 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001103 /* For a key in a secure element, we need to do three things:
1104 * remove the key file in internal storage, destroy the
1105 * key inside the secure element, and update the driver's
1106 * persistent data. Start a transaction that will encompass these
1107 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001108 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001109 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001110 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001111 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001112 status = psa_crypto_save_transaction( );
1113 if( status != PSA_SUCCESS )
1114 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001115 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001116 /* We should still try to destroy the key in the secure
1117 * element and the key metadata in storage. This is especially
1118 * important if the error is that the storage is full.
1119 * But how to do it exactly without risking an inconsistent
1120 * state after a reset?
1121 * https://github.com/ARMmbed/mbed-crypto/issues/215
1122 */
1123 overall_status = status;
1124 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001125 }
1126
Ronald Cronea0f8a62020-11-25 17:52:23 +01001127 status = psa_destroy_se_key( driver,
1128 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001129 if( overall_status == PSA_SUCCESS )
1130 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001131 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001132#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1133
Darryl Greend49a4992018-06-18 17:27:26 +01001134#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001135 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001136 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001137 status = psa_destroy_persistent_key( slot->attr.id );
1138 if( overall_status == PSA_SUCCESS )
1139 overall_status = status;
1140
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001141 /* TODO: other slots may have a copy of the same key. We should
1142 * invalidate them.
1143 * https://github.com/ARMmbed/mbed-crypto/issues/214
1144 */
Darryl Greend49a4992018-06-18 17:27:26 +01001145 }
1146#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001147
Gilles Peskinefc762652019-07-22 19:30:34 +02001148#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1149 if( driver != NULL )
1150 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001151 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001152 if( overall_status == PSA_SUCCESS )
1153 overall_status = status;
1154 status = psa_crypto_stop_transaction( );
1155 if( overall_status == PSA_SUCCESS )
1156 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001157 }
1158#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1159
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001160#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1161exit:
1162#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001163 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001164 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1165 if( overall_status == PSA_SUCCESS )
1166 overall_status = status;
1167 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001168}
1169
John Durkop07cc04a2020-11-16 22:08:34 -08001170#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001171 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001172static psa_status_t psa_get_rsa_public_exponent(
1173 const mbedtls_rsa_context *rsa,
1174 psa_key_attributes_t *attributes )
1175{
1176 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001177 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001178 uint8_t *buffer = NULL;
1179 size_t buflen;
1180 mbedtls_mpi_init( &mpi );
1181
1182 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1183 if( ret != 0 )
1184 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001185 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1186 {
1187 /* It's the default value, which is reported as an empty string,
1188 * so there's nothing to do. */
1189 goto exit;
1190 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001191
1192 buflen = mbedtls_mpi_size( &mpi );
1193 buffer = mbedtls_calloc( 1, buflen );
1194 if( buffer == NULL )
1195 {
1196 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1197 goto exit;
1198 }
1199 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1200 if( ret != 0 )
1201 goto exit;
1202 attributes->domain_parameters = buffer;
1203 attributes->domain_parameters_size = buflen;
1204
1205exit:
1206 mbedtls_mpi_free( &mpi );
1207 if( ret != 0 )
1208 mbedtls_free( buffer );
1209 return( mbedtls_to_psa_error( ret ) );
1210}
John Durkop07cc04a2020-11-16 22:08:34 -08001211#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001212 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001213
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001214/** Retrieve all the publicly-accessible attributes of a key.
1215 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001216psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001217 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001218{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001220 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001221 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001222
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001223 psa_reset_key_attributes( attributes );
1224
Ronald Cron5c522922020-11-14 16:35:34 +01001225 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001226 if( status != PSA_SUCCESS )
1227 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001228
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001229 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001230 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1231 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1232
1233#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1234 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001235 psa_set_key_slot_number( attributes,
1236 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001237#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001238
Gilles Peskine8e338702019-07-30 20:06:31 +02001239 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001240 {
John Durkop07cc04a2020-11-16 22:08:34 -08001241#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001242 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001243 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001244 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001245#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001246 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001247 * is not yet implemented.
1248 * https://github.com/ARMmbed/mbed-crypto/issues/216
1249 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001250 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001251 break;
1252#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001253 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001254 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001255
Ronald Cron90857082020-11-25 14:58:33 +01001256 status = mbedtls_psa_rsa_load_representation(
1257 slot->attr.type,
1258 slot->key.data,
1259 slot->key.bytes,
1260 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001261 if( status != PSA_SUCCESS )
1262 break;
1263
Steven Cooremana2371e52020-07-28 14:30:39 +02001264 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001265 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001266 mbedtls_rsa_free( rsa );
1267 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001268 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001269 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001270#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001271 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001272 default:
1273 /* Nothing else to do. */
1274 break;
1275 }
1276
1277 if( status != PSA_SUCCESS )
1278 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001279
Ronald Cron5c522922020-11-14 16:35:34 +01001280 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001281
Ronald Cron5c522922020-11-14 16:35:34 +01001282 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001283}
1284
Gilles Peskinec8000c02019-08-02 20:15:51 +02001285#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1286psa_status_t psa_get_key_slot_number(
1287 const psa_key_attributes_t *attributes,
1288 psa_key_slot_number_t *slot_number )
1289{
1290 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1291 {
1292 *slot_number = attributes->slot_number;
1293 return( PSA_SUCCESS );
1294 }
1295 else
1296 return( PSA_ERROR_INVALID_ARGUMENT );
1297}
1298#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1299
Ronald Crond18b5f82020-11-25 16:46:05 +01001300static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1301 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001302 uint8_t *data,
1303 size_t data_size,
1304 size_t *data_length )
1305{
Ronald Crond18b5f82020-11-25 16:46:05 +01001306 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001307 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001308 memcpy( data, key_buffer, key_buffer_size );
1309 memset( data + key_buffer_size, 0,
1310 data_size - key_buffer_size );
1311 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001312 return( PSA_SUCCESS );
1313}
1314
Ronald Cron7285cda2020-11-26 14:46:37 +01001315psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001316 const psa_key_attributes_t *attributes,
1317 const uint8_t *key_buffer, size_t key_buffer_size,
1318 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001319{
Ronald Crond18b5f82020-11-25 16:46:05 +01001320 psa_key_type_t type = attributes->core.type;
1321
Ronald Crond18b5f82020-11-25 16:46:05 +01001322 if( key_type_is_raw_bytes( type ) ||
1323 PSA_KEY_TYPE_IS_RSA( type ) ||
1324 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001325 {
1326 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001327 key_buffer, key_buffer_size,
1328 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001329 }
1330 else
1331 {
1332 /* This shouldn't happen in the reference implementation, but
1333 it is valid for a special-purpose implementation to omit
1334 support for exporting certain key types. */
1335 return( PSA_ERROR_NOT_SUPPORTED );
1336 }
1337}
1338
1339psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1340 uint8_t *data,
1341 size_t data_size,
1342 size_t *data_length )
1343{
1344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1345 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1346 psa_key_slot_t *slot;
1347
Ronald Crone907e552021-01-18 13:22:38 +01001348 /* Reject a zero-length output buffer now, since this can never be a
1349 * valid key representation. This way we know that data must be a valid
1350 * pointer and we can do things like memset(data, ..., data_size). */
1351 if( data_size == 0 )
1352 return( PSA_ERROR_BUFFER_TOO_SMALL );
1353
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354 /* Set the key to empty now, so that even when there are errors, we always
1355 * set data_length to a value between 0 and data_size. On error, setting
1356 * the key to empty is a good choice because an empty key representation is
1357 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001358 *data_length = 0;
1359
Ronald Cron9486f9d2020-11-26 13:36:23 +01001360 /* Export requires the EXPORT flag. There is an exception for public keys,
1361 * which don't require any flag, but
1362 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1363 */
1364 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1365 PSA_KEY_USAGE_EXPORT, 0 );
1366 if( status != PSA_SUCCESS )
1367 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001368
Ronald Crond18b5f82020-11-25 16:46:05 +01001369 psa_key_attributes_t attributes = {
1370 .core = slot->attr
1371 };
Ronald Cron67227982020-11-26 15:16:05 +01001372 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001373 slot->key.data, slot->key.bytes,
1374 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001375
Ronald Cron9486f9d2020-11-26 13:36:23 +01001376 unlock_status = psa_unlock_key_slot( slot );
1377
1378 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1379}
1380
Ronald Cron7285cda2020-11-26 14:46:37 +01001381psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001382 const psa_key_attributes_t *attributes,
1383 const uint8_t *key_buffer,
1384 size_t key_buffer_size,
1385 uint8_t *data,
1386 size_t data_size,
1387 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001388{
Ronald Crond18b5f82020-11-25 16:46:05 +01001389 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001390
Ronald Crond18b5f82020-11-25 16:46:05 +01001391 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001392 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001393 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001394 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001395 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001396 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001397 key_buffer, key_buffer_size,
1398 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001399 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001400
Ronald Crond18b5f82020-11-25 16:46:05 +01001401 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001402 {
John Durkop0e005192020-10-31 22:06:54 -07001403#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1404 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001405 return( mbedtls_psa_rsa_export_public_key( attributes,
1406 key_buffer,
1407 key_buffer_size,
1408 data,
1409 data_size,
1410 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001411#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001412 /* We don't know how to convert a private RSA key to public. */
1413 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001414#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1415 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001416 }
1417 else
Moran Pekera998bc62018-04-16 18:16:20 +03001418 {
John Durkop6ba40d12020-11-10 08:50:04 -08001419#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1420 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001421 return( mbedtls_psa_ecp_export_public_key( attributes,
1422 key_buffer,
1423 key_buffer_size,
1424 data,
1425 data_size,
1426 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001427#else
1428 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001429 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001430#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1431 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001432 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001433 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001434 else
1435 {
1436 /* This shouldn't happen in the reference implementation, but
1437 it is valid for a special-purpose implementation to omit
1438 support for exporting certain key types. */
1439 return( PSA_ERROR_NOT_SUPPORTED );
1440 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001441}
Ronald Crond18b5f82020-11-25 16:46:05 +01001442
Ronald Croncf56a0a2020-08-04 09:51:30 +02001443psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001444 uint8_t *data,
1445 size_t data_size,
1446 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001447{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001448 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001449 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001450 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001451
Ronald Crone907e552021-01-18 13:22:38 +01001452 /* Reject a zero-length output buffer now, since this can never be a
1453 * valid key representation. This way we know that data must be a valid
1454 * pointer and we can do things like memset(data, ..., data_size). */
1455 if( data_size == 0 )
1456 return( PSA_ERROR_BUFFER_TOO_SMALL );
1457
Darryl Greendd8fb772018-11-07 16:00:44 +00001458 /* Set the key to empty now, so that even when there are errors, we always
1459 * set data_length to a value between 0 and data_size. On error, setting
1460 * the key to empty is a good choice because an empty key representation is
1461 * unlikely to be accepted anywhere. */
1462 *data_length = 0;
1463
1464 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001465 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001466 if( status != PSA_SUCCESS )
1467 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001468
Ronald Cron9486f9d2020-11-26 13:36:23 +01001469 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1470 {
1471 status = PSA_ERROR_INVALID_ARGUMENT;
1472 goto exit;
1473 }
1474
Ronald Crond18b5f82020-11-25 16:46:05 +01001475 psa_key_attributes_t attributes = {
1476 .core = slot->attr
1477 };
Ronald Cron67227982020-11-26 15:16:05 +01001478 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001479 &attributes, slot->key.data, slot->key.bytes,
1480 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001481
1482exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001483 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001484
Ronald Cron5c522922020-11-14 16:35:34 +01001485 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001486}
1487
Gilles Peskine91e8c332019-08-02 19:19:39 +02001488#if defined(static_assert)
1489static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1490 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001491static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001492 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001493static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001494 "One or more key attribute flag is listed as both internal-only and external-only" );
1495#endif
1496
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001497/** Validate that a key policy is internally well-formed.
1498 *
1499 * This function only rejects invalid policies. It does not validate the
1500 * consistency of the policy with respect to other attributes of the key
1501 * such as the key type.
1502 */
1503static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001504{
1505 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001506 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001507 PSA_KEY_USAGE_ENCRYPT |
1508 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001509 PSA_KEY_USAGE_SIGN_HASH |
1510 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001511 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1512 return( PSA_ERROR_INVALID_ARGUMENT );
1513
Gilles Peskine4747d192019-04-17 15:05:45 +02001514 return( PSA_SUCCESS );
1515}
1516
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001517/** Validate the internal consistency of key attributes.
1518 *
1519 * This function only rejects invalid attribute values. If does not
1520 * validate the consistency of the attributes with any key data that may
1521 * be involved in the creation of the key.
1522 *
1523 * Call this function early in the key creation process.
1524 *
1525 * \param[in] attributes Key attributes for the new key.
1526 * \param[out] p_drv On any return, the driver for the key, if any.
1527 * NULL for a transparent key.
1528 *
1529 */
1530static psa_status_t psa_validate_key_attributes(
1531 const psa_key_attributes_t *attributes,
1532 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001533{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001534 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001535 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001536 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001537
Ronald Cron54b90082020-10-29 15:26:43 +01001538 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001539 if( status != PSA_SUCCESS )
1540 return( status );
1541
Ronald Crond2ed4812020-07-17 16:11:30 +02001542 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001543 if( status != PSA_SUCCESS )
1544 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001545
Ronald Cron65f38a32020-10-23 17:11:13 +02001546 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1547 {
1548 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1549 return( PSA_ERROR_INVALID_ARGUMENT );
1550 }
1551 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001552 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001553 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1554 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001555 }
1556
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001557 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001558 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001559 return( status );
1560
1561 /* Refuse to create overly large keys.
1562 * Note that this doesn't trigger on import if the attributes don't
1563 * explicitly specify a size (so psa_get_key_bits returns 0), so
1564 * psa_import_key() needs its own checks. */
1565 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1566 return( PSA_ERROR_NOT_SUPPORTED );
1567
Gilles Peskine91e8c332019-08-02 19:19:39 +02001568 /* Reject invalid flags. These should not be reachable through the API. */
1569 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1570 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1571 return( PSA_ERROR_INVALID_ARGUMENT );
1572
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001573 return( PSA_SUCCESS );
1574}
1575
Gilles Peskine4747d192019-04-17 15:05:45 +02001576/** Prepare a key slot to receive key material.
1577 *
1578 * This function allocates a key slot and sets its metadata.
1579 *
1580 * If this function fails, call psa_fail_key_creation().
1581 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001582 * This function is intended to be used as follows:
1583 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001584 * it with the specified attributes, and in case of a volatile key assign it
1585 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001586 * -# Populate the slot with the key material.
1587 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1588 * In case of failure at any step, stop the sequence and call
1589 * psa_fail_key_creation().
1590 *
Ronald Cron5c522922020-11-14 16:35:34 +01001591 * On success, the key slot is locked. It is the responsibility of the caller
1592 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001593 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001594 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001595 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001596 * \param[out] p_slot On success, a pointer to the prepared slot.
1597 * \param[out] p_drv On any return, the driver for the key, if any.
1598 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001599 *
1600 * \retval #PSA_SUCCESS
1601 * The key slot is ready to receive key material.
1602 * \return If this function fails, the key slot is an invalid state.
1603 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001604 */
1605static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001606 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001607 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001608 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001609 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001610{
1611 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001612 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001613 psa_key_slot_t *slot;
1614
Gilles Peskinedf179142019-07-15 22:02:14 +02001615 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001616 *p_drv = NULL;
1617
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001618 status = psa_validate_key_attributes( attributes, p_drv );
1619 if( status != PSA_SUCCESS )
1620 return( status );
1621
Ronald Cronc4d1b512020-07-31 11:26:37 +02001622 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001623 if( status != PSA_SUCCESS )
1624 return( status );
1625 slot = *p_slot;
1626
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001627 /* We're storing the declared bit-size of the key. It's up to each
1628 * creation mechanism to verify that this information is correct.
1629 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001630 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001631 * is optional (import, copy). In case of a volatile key, assign it the
1632 * volatile key identifier associated to the slot returned to contain its
1633 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001634
1635 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001636 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1637 {
1638#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1639 slot->attr.id = volatile_key_id;
1640#else
1641 slot->attr.id.key_id = volatile_key_id;
1642#endif
1643 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001644
Gilles Peskine91e8c332019-08-02 19:19:39 +02001645 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001646 * external-only flags, query `attributes`. Thanks to the check
1647 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001648 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001649 * may have set. */
1650 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001651
Gilles Peskinecbaff462019-07-12 23:46:04 +02001652#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001653 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001654 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001655 * create the key file in internal storage, create the
1656 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001657 * persistent data. This is done by starting a transaction that will
1658 * encompass these three actions.
1659 * For registering a volatile key, we just need to find an appropriate
1660 * slot number inside the SE. Since the key is designated volatile, creating
1661 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001662 /* The first thing to do is to find a slot number for the new key.
1663 * We save the slot number in persistent storage as part of the
1664 * transaction data. It will be needed to recover if the power
1665 * fails during the key creation process, to clean up on the secure
1666 * element side after restarting. Obtaining a slot number from the
1667 * secure element driver updates its persistent state, but we do not yet
1668 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001669 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001670 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001671 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001672 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001673 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001674 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001675 if( status != PSA_SUCCESS )
1676 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001677
1678 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001679 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001680 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1681 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001682 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001683 psa_crypto_transaction.key.id = slot->attr.id;
1684 status = psa_crypto_save_transaction( );
1685 if( status != PSA_SUCCESS )
1686 {
1687 (void) psa_crypto_stop_transaction( );
1688 return( status );
1689 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001690 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001691
1692 status = psa_copy_key_material_into_slot(
1693 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001694 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001695
1696 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1697 {
1698 /* Key registration only makes sense with a secure element. */
1699 return( PSA_ERROR_INVALID_ARGUMENT );
1700 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001701#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1702
Ronald Cronc4d1b512020-07-31 11:26:37 +02001703 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001704}
Gilles Peskine4747d192019-04-17 15:05:45 +02001705
1706/** Finalize the creation of a key once its key material has been set.
1707 *
1708 * This entails writing the key to persistent storage.
1709 *
1710 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001711 * See the documentation of psa_start_key_creation() for the intended use
1712 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001713 *
Ronald Cron5c522922020-11-14 16:35:34 +01001714 * If the finalization succeeds, the function unlocks the key slot (it was
1715 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1716 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001717 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001718 * \param[in,out] slot Pointer to the slot with key material.
1719 * \param[in] driver The secure element driver for the key,
1720 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001721 * \param[out] key On success, identifier of the key. Note that the
1722 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001723 *
1724 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001725 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001726 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1727 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1728 * \retval #PSA_ERROR_ALREADY_EXISTS
1729 * \retval #PSA_ERROR_DATA_INVALID
1730 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001731 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001732 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001733 * \return If this function fails, the key slot is an invalid state.
1734 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001735 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001736static psa_status_t psa_finish_key_creation(
1737 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001738 psa_se_drv_table_entry_t *driver,
1739 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001740{
1741 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001742 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001743 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001744
1745#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001746 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001747 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001748#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1749 if( driver != NULL )
1750 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001751 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001752 psa_key_slot_number_t slot_number =
1753 psa_key_slot_get_slot_number( slot ) ;
1754
Gilles Peskineb46bef22019-07-30 21:32:04 +02001755#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001756 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001757 sizeof( data.slot_number ),
1758 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001759#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001760 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001761 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001762 (uint8_t*) &data,
1763 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001764 }
1765 else
1766#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1767 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001768 /* Key material is saved in export representation in the slot, so
1769 * just pass the slot buffer for storage. */
1770 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001771 slot->key.data,
1772 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001773 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001775#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1776
Gilles Peskinecbaff462019-07-12 23:46:04 +02001777#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001778 /* Finish the transaction for a key creation. This does not
1779 * happen when registering an existing key. Detect this case
1780 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001781 * creation of a persistent key in a secure element requires a transaction,
1782 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001783 if( driver != NULL &&
1784 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001785 {
1786 status = psa_save_se_persistent_data( driver );
1787 if( status != PSA_SUCCESS )
1788 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001789 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001790 return( status );
1791 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001792 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001793 }
1794#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1795
Ronald Cron50972942020-11-14 11:28:25 +01001796 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001797 {
1798 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001799 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001800 if( status != PSA_SUCCESS )
1801 *key = MBEDTLS_SVC_KEY_ID_INIT;
1802 }
Ronald Cron50972942020-11-14 11:28:25 +01001803
Gilles Peskine4747d192019-04-17 15:05:45 +02001804 return( status );
1805}
1806
1807/** Abort the creation of a key.
1808 *
1809 * You may call this function after calling psa_start_key_creation(),
1810 * or after psa_finish_key_creation() fails. In other circumstances, this
1811 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001812 * See the documentation of psa_start_key_creation() for the intended use
1813 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001814 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001815 * \param[in,out] slot Pointer to the slot with key material.
1816 * \param[in] driver The secure element driver for the key,
1817 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001818 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001819static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001820 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001821{
Gilles Peskine011e4282019-06-26 18:34:38 +02001822 (void) driver;
1823
Gilles Peskine4747d192019-04-17 15:05:45 +02001824 if( slot == NULL )
1825 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001826
1827#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001828 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001829 * element, and the failure happened later (when saving metadata
1830 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001831 * element.
1832 * https://github.com/ARMmbed/mbed-crypto/issues/217
1833 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001834
Gilles Peskined7729582019-08-05 15:55:54 +02001835 /* Abort the ongoing transaction if any (there may not be one if
1836 * the creation process failed before starting one, or if the
1837 * key creation is a registration of a key in a secure element).
1838 * Earlier functions must already have done what it takes to undo any
1839 * partial creation. All that's left is to update the transaction data
1840 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001841 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001842#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1843
Gilles Peskine4747d192019-04-17 15:05:45 +02001844 psa_wipe_key_slot( slot );
1845}
1846
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001847/** Validate optional attributes during key creation.
1848 *
1849 * Some key attributes are optional during key creation. If they are
1850 * specified in the attributes structure, check that they are consistent
1851 * with the data in the slot.
1852 *
1853 * This function should be called near the end of key creation, after
1854 * the slot in memory is fully populated but before saving persistent data.
1855 */
1856static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001857 const psa_key_slot_t *slot,
1858 const psa_key_attributes_t *attributes )
1859{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001860 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001861 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001862 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 return( PSA_ERROR_INVALID_ARGUMENT );
1864 }
1865
1866 if( attributes->domain_parameters_size != 0 )
1867 {
John Durkop0e005192020-10-31 22:06:54 -07001868#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1869 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001870 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001872 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001873 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001874 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001875
Ronald Cron90857082020-11-25 14:58:33 +01001876 psa_status_t status = mbedtls_psa_rsa_load_representation(
1877 slot->attr.type,
1878 slot->key.data,
1879 slot->key.bytes,
1880 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001881 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001882 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001883
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001884 mbedtls_mpi_init( &actual );
1885 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001886 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001888 mbedtls_rsa_free( rsa );
1889 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001890 if( ret != 0 )
1891 goto rsa_exit;
1892 ret = mbedtls_mpi_read_binary( &required,
1893 attributes->domain_parameters,
1894 attributes->domain_parameters_size );
1895 if( ret != 0 )
1896 goto rsa_exit;
1897 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1898 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1899 rsa_exit:
1900 mbedtls_mpi_free( &actual );
1901 mbedtls_mpi_free( &required );
1902 if( ret != 0)
1903 return( mbedtls_to_psa_error( ret ) );
1904 }
1905 else
John Durkop9814fa22020-11-04 12:28:15 -08001906#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1907 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908 {
1909 return( PSA_ERROR_INVALID_ARGUMENT );
1910 }
1911 }
1912
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001913 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001914 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001915 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001916 return( PSA_ERROR_INVALID_ARGUMENT );
1917 }
1918
1919 return( PSA_SUCCESS );
1920}
1921
Gilles Peskine4747d192019-04-17 15:05:45 +02001922psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001923 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001924 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001925 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001926{
1927 psa_status_t status;
1928 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001929 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931
Ronald Cron81709fc2020-11-14 12:10:32 +01001932 *key = MBEDTLS_SVC_KEY_ID_INIT;
1933
Gilles Peskine0f84d622019-09-12 19:03:13 +02001934 /* Reject zero-length symmetric keys (including raw data key objects).
1935 * This also rejects any key which might be encoded as an empty string,
1936 * which is never valid. */
1937 if( data_length == 0 )
1938 return( PSA_ERROR_INVALID_ARGUMENT );
1939
Gilles Peskinedf179142019-07-15 22:02:14 +02001940 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001941 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001942 if( status != PSA_SUCCESS )
1943 goto exit;
1944
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001945 /* In the case of a transparent key or an opaque key stored in local
1946 * storage (thus not in the case of generating a key in a secure element
1947 * or cryptoprocessor with storage), we have to allocate a buffer to
1948 * hold the generated key material. */
1949 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001950 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001951 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001952 if( status != PSA_SUCCESS )
1953 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001954 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001955
1956 bits = slot->attr.bits;
1957 status = psa_driver_wrapper_import_key( attributes,
1958 data, data_length,
1959 slot->key.data,
1960 slot->key.bytes,
1961 &slot->key.bytes, &bits );
1962 if( status != PSA_SUCCESS )
1963 goto exit;
1964
1965 if( slot->attr.bits == 0 )
1966 slot->attr.bits = (psa_key_bits_t) bits;
1967 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001968 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001969 status = PSA_ERROR_INVALID_ARGUMENT;
1970 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001971 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001972
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001973 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001974 if( status != PSA_SUCCESS )
1975 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001976
Ronald Cron81709fc2020-11-14 12:10:32 +01001977 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001978exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001979 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001980 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001981
Gilles Peskine4747d192019-04-17 15:05:45 +02001982 return( status );
1983}
1984
Gilles Peskined7729582019-08-05 15:55:54 +02001985#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1986psa_status_t mbedtls_psa_register_se_key(
1987 const psa_key_attributes_t *attributes )
1988{
1989 psa_status_t status;
1990 psa_key_slot_t *slot = NULL;
1991 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001992 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001993
1994 /* Leaving attributes unspecified is not currently supported.
1995 * It could make sense to query the key type and size from the
1996 * secure element, but not all secure elements support this
1997 * and the driver HAL doesn't currently support it. */
1998 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1999 return( PSA_ERROR_NOT_SUPPORTED );
2000 if( psa_get_key_bits( attributes ) == 0 )
2001 return( PSA_ERROR_NOT_SUPPORTED );
2002
2003 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002004 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002005 if( status != PSA_SUCCESS )
2006 goto exit;
2007
Ronald Cron81709fc2020-11-14 12:10:32 +01002008 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002009
2010exit:
2011 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002012 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002013
Gilles Peskined7729582019-08-05 15:55:54 +02002014 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002015 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002016 return( status );
2017}
2018#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2019
Gilles Peskinef603c712019-01-19 13:40:11 +01002020static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002021 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002022{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002023 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002024 source->key.data,
2025 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002026 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002027 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002028
Steven Cooreman398aee52020-10-13 14:35:45 +02002029 target->attr.type = source->attr.type;
2030 target->attr.bits = source->attr.bits;
2031
2032 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002033}
2034
Ronald Croncf56a0a2020-08-04 09:51:30 +02002035psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002037 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002038{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002039 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002040 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002041 psa_key_slot_t *source_slot = NULL;
2042 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002043 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002044 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002045
Ronald Cron81709fc2020-11-14 12:10:32 +01002046 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2047
Ronald Cron5c522922020-11-14 16:35:34 +01002048 status = psa_get_and_lock_transparent_key_slot_with_policy(
2049 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002050 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002051 goto exit;
2052
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002053 status = psa_validate_optional_attributes( source_slot,
2054 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002055 if( status != PSA_SUCCESS )
2056 goto exit;
2057
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002058 status = psa_restrict_key_policy( source_slot->attr.type,
2059 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002060 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002061 if( status != PSA_SUCCESS )
2062 goto exit;
2063
Ronald Cron81709fc2020-11-14 12:10:32 +01002064 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2065 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002066 if( status != PSA_SUCCESS )
2067 goto exit;
2068
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002069#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2070 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002071 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002072 /* Copying to a secure element is not implemented yet. */
2073 status = PSA_ERROR_NOT_SUPPORTED;
2074 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002075 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002077
Ronald Cron6cc66312021-04-02 12:27:47 +02002078 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2079 {
2080 /*
2081 * Copying through an opaque driver is not implemented yet, consider
2082 * a lifetime with an external location as an invalid parameter for
2083 * now.
2084 */
2085 status = PSA_ERROR_INVALID_ARGUMENT;
2086 goto exit;
2087 }
2088
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002089 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002090 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002091 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002092
Ronald Cron81709fc2020-11-14 12:10:32 +01002093 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002095 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002096 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002097
Ronald Cron5c522922020-11-14 16:35:34 +01002098 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002099
Ronald Cron5c522922020-11-14 16:35:34 +01002100 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002101}
2102
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002103
2104
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002105/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002106/* Message digests */
2107/****************************************************************/
2108
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002109psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2110{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002111 /* Aborting a non-active operation is allowed */
2112 if( operation->id == 0 )
2113 return( PSA_SUCCESS );
2114
2115 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2116 operation->id = 0;
2117
2118 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002119}
2120
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002121psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002122 psa_algorithm_t alg )
2123{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002124 /* A context must be freshly initialized before it can be set up. */
2125 if( operation->id != 0 )
2126 return( PSA_ERROR_BAD_STATE );
2127
2128 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002129 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002130
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002131 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2132 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002133 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2134
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002135 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002136}
2137
2138psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2139 const uint8_t *input,
2140 size_t input_length )
2141{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002142 if( operation->id == 0 )
2143 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002144
Steven Cooremanc8288352021-03-04 14:02:19 +01002145 /* Don't require hash implementations to behave correctly on a
2146 * zero-length input, which may have an invalid pointer. */
2147 if( input_length == 0 )
2148 return( PSA_SUCCESS );
2149
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002150 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2151 input, input_length );
2152 if( status != PSA_SUCCESS )
2153 psa_hash_abort( operation );
2154
2155 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156}
2157
2158psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2159 uint8_t *hash,
2160 size_t hash_size,
2161 size_t *hash_length )
2162{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002163 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002164 if( operation->id == 0 )
2165 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166
Steven Cooreman1e582352021-02-18 17:24:37 +01002167 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002168 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002169 psa_hash_abort( operation );
2170 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002171}
2172
Gilles Peskine2d277862018-06-18 15:41:12 +02002173psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2174 const uint8_t *hash,
2175 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002176{
2177 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2178 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002179 psa_status_t status = psa_hash_finish(
2180 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002181 actual_hash, sizeof( actual_hash ),
2182 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183 if( status != PSA_SUCCESS )
2184 return( status );
2185 if( actual_hash_length != hash_length )
2186 return( PSA_ERROR_INVALID_SIGNATURE );
2187 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2188 return( PSA_ERROR_INVALID_SIGNATURE );
2189 return( PSA_SUCCESS );
2190}
2191
Gilles Peskine0a749c82019-11-28 19:33:58 +01002192psa_status_t psa_hash_compute( psa_algorithm_t alg,
2193 const uint8_t *input, size_t input_length,
2194 uint8_t *hash, size_t hash_size,
2195 size_t *hash_length )
2196{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002197 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002198 if( !PSA_ALG_IS_HASH( alg ) )
2199 return( PSA_ERROR_INVALID_ARGUMENT );
2200
Steven Cooreman1e582352021-02-18 17:24:37 +01002201 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2202 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002203}
2204
2205psa_status_t psa_hash_compare( psa_algorithm_t alg,
2206 const uint8_t *input, size_t input_length,
2207 const uint8_t *hash, size_t hash_length )
2208{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002209 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2210 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002211
2212 if( !PSA_ALG_IS_HASH( alg ) )
2213 return( PSA_ERROR_INVALID_ARGUMENT );
2214
Steven Cooreman1e582352021-02-18 17:24:37 +01002215 psa_status_t status = psa_driver_wrapper_hash_compute(
2216 alg, input, input_length,
2217 actual_hash, sizeof(actual_hash),
2218 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002219 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002220 return( status );
2221 if( actual_hash_length != hash_length )
2222 return( PSA_ERROR_INVALID_SIGNATURE );
2223 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2224 return( PSA_ERROR_INVALID_SIGNATURE );
2225 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002226}
2227
Gilles Peskineeb35d782019-01-22 17:56:16 +01002228psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2229 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002230{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002231 if( source_operation->id == 0 ||
2232 target_operation->id != 0 )
2233 {
2234 return( PSA_ERROR_BAD_STATE );
2235 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002236
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002237 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2238 target_operation );
2239 if( status != PSA_SUCCESS )
2240 psa_hash_abort( target_operation );
2241
2242 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002243}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244
2245
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002247/* MAC */
2248/****************************************************************/
2249
Steven Cooremane6804192021-03-19 18:28:56 +01002250psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002251{
Steven Cooremane6804192021-03-19 18:28:56 +01002252 /* Aborting a non-active operation is allowed */
2253 if( operation->id == 0 )
2254 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002255
Steven Cooremane6804192021-03-19 18:28:56 +01002256 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
2257 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002258
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002259 return( status );
2260}
2261
Steven Cooremane6804192021-03-19 18:28:56 +01002262static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002263 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002264 psa_algorithm_t alg,
2265 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002266{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002267 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002268 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002269 psa_key_slot_t *slot;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002270 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002271 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Steven Cooremane6804192021-03-19 18:28:56 +01002272 size_t mac_size = 0;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002273
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002274 /* A context must be freshly initialized before it can be set up. */
Steven Cooremane6804192021-03-19 18:28:56 +01002275 if( operation->id != 0 )
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002276 return( PSA_ERROR_BAD_STATE );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002277
Steven Cooremane6804192021-03-19 18:28:56 +01002278 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002279 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002280 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002281 goto exit;
Steven Cooreman15472f82021-03-02 16:16:22 +01002282
Steven Cooremane6804192021-03-19 18:28:56 +01002283 psa_key_attributes_t attributes = {
2284 .core = slot->attr
2285 };
2286
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002287 /* Validate the combination of key type and algorithm */
Steven Cooremane6804192021-03-19 18:28:56 +01002288 status = psa_mac_key_can_do( alg, psa_get_key_type( &attributes ) );
Steven Cooreman15472f82021-03-02 16:16:22 +01002289 if( status != PSA_SUCCESS )
2290 goto exit;
2291
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002292 /* Get the output length for the algorithm and key combination. None of the
2293 * currently supported algorithms have an output length dependent on actual
2294 * key size, so setting it to a bogus value is currently OK. */
Steven Cooremane6804192021-03-19 18:28:56 +01002295 mac_size = PSA_MAC_LENGTH( psa_get_key_type( &attributes ), 0, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002296
Steven Cooremane6804192021-03-19 18:28:56 +01002297 if( mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002298 {
2299 /* A very short MAC is too short for security since it can be
2300 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2301 * so we make this our minimum, even though 32 bits is still
2302 * too small for security. */
2303 status = PSA_ERROR_NOT_SUPPORTED;
2304 goto exit;
2305 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002306
Steven Cooremane6804192021-03-19 18:28:56 +01002307 if( mac_size > PSA_MAC_LENGTH( psa_get_key_type( &attributes ), 0,
2308 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002309 {
2310 /* It's impossible to "truncate" to a larger length than the full length
2311 * of the algorithm. */
2312 status = PSA_ERROR_INVALID_ARGUMENT;
2313 goto exit;
2314 }
2315
Steven Cooremane6804192021-03-19 18:28:56 +01002316 /* Dispatch the MAC setup call with validated input */
2317 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002318 {
Steven Cooremane6804192021-03-19 18:28:56 +01002319 status = psa_driver_wrapper_mac_sign_setup( operation,
2320 &attributes,
2321 slot->key.data,
2322 slot->key.bytes,
2323 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002324 }
2325 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002326 {
Steven Cooremane6804192021-03-19 18:28:56 +01002327 status = psa_driver_wrapper_mac_verify_setup( operation,
2328 &attributes,
2329 slot->key.data,
2330 slot->key.bytes,
2331 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002332 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002333
Gilles Peskinefbfac682018-07-08 20:51:54 +02002334exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002335 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002336 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002337
Ronald Cron5c522922020-11-14 16:35:34 +01002338 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002339
Ronald Cron5c522922020-11-14 16:35:34 +01002340 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002341}
2342
Gilles Peskine89167cb2018-07-08 20:12:23 +02002343psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002344 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002345 psa_algorithm_t alg )
2346{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002347 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002348}
2349
2350psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002351 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002352 psa_algorithm_t alg )
2353{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002354 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002355}
2356
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002357psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002358 const uint8_t *input,
2359 size_t input_length )
2360{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002361 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002362 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002363
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002364 /* Don't require hash implementations to behave correctly on a
2365 * zero-length input, which may have an invalid pointer. */
2366 if( input_length == 0 )
2367 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002368
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002369 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2370 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002371 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002372 psa_mac_abort( operation );
2373
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002374 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002375}
2376
Steven Cooremana5b860a2021-03-19 19:04:39 +01002377psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002378 uint8_t *mac,
2379 size_t mac_size,
2380 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002381{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2383 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002384
Steven Cooremana5b860a2021-03-19 19:04:39 +01002385 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002386 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002387
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002388 /* Fill the output buffer with something that isn't a valid mac
2389 * (barring an attack on the mac and deliberately-crafted input),
2390 * in case the caller doesn't check the return status properly. */
2391 *mac_length = mac_size;
2392 /* If mac_size is 0 then mac may be NULL and then the
2393 * call to memset would have undefined behavior. */
2394 if( mac_size != 0 )
2395 memset( mac, '!', mac_size );
2396
Steven Cooremana5b860a2021-03-19 19:04:39 +01002397 status = psa_driver_wrapper_mac_sign_finish( operation,
2398 mac, mac_size, mac_length );
mohammad16036df908f2018-04-02 08:34:15 -07002399
Steven Cooremana5b860a2021-03-19 19:04:39 +01002400 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002401
Steven Cooremana5b860a2021-03-19 19:04:39 +01002402 if( status != PSA_SUCCESS && mac_size > 0 )
2403 memset( mac, '!', mac_size );
2404
2405 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002406}
2407
Steven Cooremana5b860a2021-03-19 19:04:39 +01002408psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002409 const uint8_t *mac,
2410 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002411{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2413 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002414
Steven Cooremana5b860a2021-03-19 19:04:39 +01002415 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002416 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002417
Steven Cooremana5b860a2021-03-19 19:04:39 +01002418 status = psa_driver_wrapper_mac_verify_finish( operation,
2419 mac, mac_length );
2420 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002421
Steven Cooremana5b860a2021-03-19 19:04:39 +01002422 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002423}
2424
2425
Gilles Peskine20035e32018-02-03 22:44:14 +01002426
Gilles Peskine20035e32018-02-03 22:44:14 +01002427/****************************************************************/
2428/* Asymmetric cryptography */
2429/****************************************************************/
2430
Ronald Cron67b1eb32020-12-08 17:37:27 +01002431psa_status_t psa_sign_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002432 const psa_key_attributes_t *attributes,
2433 const uint8_t *key_buffer, size_t key_buffer_size,
2434 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2435 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002436{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002437 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002438 {
Ronald Cron4501c982021-03-19 20:09:32 +01002439 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2440 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002441 {
Ronald Cron4501c982021-03-19 20:09:32 +01002442#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2443 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2444 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002445 attributes,
2446 key_buffer, key_buffer_size,
2447 alg, hash, hash_length,
2448 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002449#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2450 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002451 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002452 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002453 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002454 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002455 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002456 }
2457 else
Ronald Cron4501c982021-03-19 20:09:32 +01002458 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2459 {
2460 if( PSA_ALG_IS_ECDSA( alg ) )
2461 {
2462#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2463 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2464 return( mbedtls_psa_ecdsa_sign_hash(
2465 attributes,
2466 key_buffer, key_buffer_size,
2467 alg, hash, hash_length,
2468 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002469#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2470 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002471 }
2472 else
2473 {
2474 return( PSA_ERROR_INVALID_ARGUMENT );
2475 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002476 }
Ronald Cron4501c982021-03-19 20:09:32 +01002477
2478 (void)key_buffer;
2479 (void)key_buffer_size;
2480 (void)hash;
2481 (void)hash_length;
2482 (void)signature;
2483 (void)signature_size;
2484 (void)signature_length;
2485
2486 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002487}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002488
2489psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2490 psa_algorithm_t alg,
2491 const uint8_t *hash,
2492 size_t hash_length,
2493 uint8_t *signature,
2494 size_t signature_size,
2495 size_t *signature_length )
2496{
2497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2498 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2499 psa_key_slot_t *slot;
2500
2501 *signature_length = signature_size;
2502 /* Immediately reject a zero-length signature buffer. This guarantees
2503 * that signature must be a valid pointer. (On the other hand, the hash
2504 * buffer can in principle be empty since it doesn't actually have
2505 * to be a hash.) */
2506 if( signature_size == 0 )
2507 return( PSA_ERROR_BUFFER_TOO_SMALL );
2508
2509 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
2510 PSA_KEY_USAGE_SIGN_HASH,
2511 alg );
2512 if( status != PSA_SUCCESS )
2513 goto exit;
2514 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2515 {
2516 status = PSA_ERROR_INVALID_ARGUMENT;
2517 goto exit;
2518 }
2519
Ronald Cron9f17aa42020-12-08 17:07:25 +01002520 psa_key_attributes_t attributes = {
2521 .core = slot->attr
2522 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002523
Ronald Cron9f17aa42020-12-08 17:07:25 +01002524 status = psa_driver_wrapper_sign_hash(
2525 &attributes, slot->key.data, slot->key.bytes,
2526 alg, hash, hash_length,
2527 signature, signature_size, signature_length );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002528
2529exit:
2530 /* Fill the unused part of the output buffer (the whole buffer on error,
2531 * the trailing part on success) with something that isn't a valid mac
2532 * (barring an attack on the mac and deliberately-crafted input),
2533 * in case the caller doesn't check the return status properly. */
2534 if( status == PSA_SUCCESS )
2535 memset( signature + *signature_length, '!',
2536 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02002537 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02002538 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002539 /* If signature_size is 0 then we have nothing to do. We must not call
2540 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02002541
Ronald Cron5c522922020-11-14 16:35:34 +01002542 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002543
Ronald Cron5c522922020-11-14 16:35:34 +01002544 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03002545}
2546
Ronald Cron67b1eb32020-12-08 17:37:27 +01002547psa_status_t psa_verify_hash_internal(
Ronald Cron18659932020-12-08 16:32:23 +01002548 const psa_key_attributes_t *attributes,
2549 const uint8_t *key_buffer, size_t key_buffer_size,
2550 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2551 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002552{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002553 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002554 {
Ronald Cron4501c982021-03-19 20:09:32 +01002555 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2556 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002557 {
Ronald Cron4501c982021-03-19 20:09:32 +01002558#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2559 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2560 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002561 attributes,
2562 key_buffer, key_buffer_size,
2563 alg, hash, hash_length,
2564 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002565#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2566 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002567 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002568 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002569 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002570 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002571 }
itayzafrir5c753392018-05-08 11:18:38 +03002572 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002573 else
Ronald Cron4501c982021-03-19 20:09:32 +01002574 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002575 {
Ronald Cron4501c982021-03-19 20:09:32 +01002576 if( PSA_ALG_IS_ECDSA( alg ) )
2577 {
2578#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2579 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2580 return( mbedtls_psa_ecdsa_verify_hash(
2581 attributes,
2582 key_buffer, key_buffer_size,
2583 alg, hash, hash_length,
2584 signature, signature_length ) );
2585#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2586 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2587 }
2588 else
2589 {
2590 return( PSA_ERROR_INVALID_ARGUMENT );
2591 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002592 }
Ronald Cron4501c982021-03-19 20:09:32 +01002593
2594 (void)key_buffer;
2595 (void)key_buffer_size;
2596 (void)hash;
2597 (void)hash_length;
2598 (void)signature;
2599 (void)signature_length;
2600
2601 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002602}
2603
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002604psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2605 psa_algorithm_t alg,
2606 const uint8_t *hash,
2607 size_t hash_length,
2608 const uint8_t *signature,
2609 size_t signature_length )
2610{
2611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2612 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002613 psa_key_slot_t *slot;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002614
2615 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002616 PSA_KEY_USAGE_VERIFY_HASH,
Gilles Peskineb75e4f12018-06-08 17:44:47 +02002617 alg );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002618 if( status != PSA_SUCCESS )
2619 return( status );
2620
Ronald Cron9f17aa42020-12-08 17:07:25 +01002621 psa_key_attributes_t attributes = {
2622 .core = slot->attr
2623 };
Gilles Peskinee59236f2018-01-27 23:32:46 +01002624
Ronald Cron9f17aa42020-12-08 17:07:25 +01002625 status = psa_driver_wrapper_verify_hash(
2626 &attributes, slot->key.data, slot->key.bytes,
2627 alg, hash, hash_length,
2628 signature, signature_length );
Gilles Peskine61b91d42018-06-08 16:09:36 +02002629
Ronald Cron5c522922020-11-14 16:35:34 +01002630 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002631
Ronald Cron5c522922020-11-14 16:35:34 +01002632 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002633}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002634
John Durkop0e005192020-10-31 22:06:54 -07002635#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02002636static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2637 mbedtls_rsa_context *rsa )
2638{
2639 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2640 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2641 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
2642 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
2643}
John Durkop0e005192020-10-31 22:06:54 -07002644#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002645
Ronald Croncf56a0a2020-08-04 09:51:30 +02002646psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002647 psa_algorithm_t alg,
2648 const uint8_t *input,
2649 size_t input_length,
2650 const uint8_t *salt,
2651 size_t salt_length,
2652 uint8_t *output,
2653 size_t output_size,
2654 size_t *output_length )
2655{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002656 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002657 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002658 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002659
Darryl Green5cc689a2018-07-24 15:34:10 +01002660 (void) input;
2661 (void) input_length;
2662 (void) salt;
2663 (void) output;
2664 (void) output_size;
2665
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002666 *output_length = 0;
2667
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002668 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2669 return( PSA_ERROR_INVALID_ARGUMENT );
2670
Ronald Cron5c522922020-11-14 16:35:34 +01002671 status = psa_get_and_lock_transparent_key_slot_with_policy(
2672 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002673 if( status != PSA_SUCCESS )
2674 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002675 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2676 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002677 {
2678 status = PSA_ERROR_INVALID_ARGUMENT;
2679 goto exit;
2680 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002681
John Durkop6ba40d12020-11-10 08:50:04 -08002682#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2683 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002684 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002685 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002686 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002687 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2688 slot->key.data,
2689 slot->key.bytes,
2690 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002691 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02002692 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02002693
2694 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002695 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002696 status = PSA_ERROR_BUFFER_TOO_SMALL;
2697 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002698 }
John Durkop0e005192020-10-31 22:06:54 -07002699#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002700 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
2701 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002702 status = mbedtls_to_psa_error(
2703 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002704 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002705 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002706 MBEDTLS_RSA_PUBLIC,
2707 input_length,
2708 input,
2709 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002710 }
2711 else
John Durkop0e005192020-10-31 22:06:54 -07002712#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2713#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002714 if( PSA_ALG_IS_RSA_OAEP( alg ) )
2715 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002716 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02002717 status = mbedtls_to_psa_error(
2718 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002719 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002720 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002721 MBEDTLS_RSA_PUBLIC,
2722 salt, salt_length,
2723 input_length,
2724 input,
2725 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002726 }
2727 else
John Durkop0e005192020-10-31 22:06:54 -07002728#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002729 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002730 status = PSA_ERROR_INVALID_ARGUMENT;
2731 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002732 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02002733rsa_exit:
2734 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02002735 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002736
Steven Cooremana2371e52020-07-28 14:30:39 +02002737 mbedtls_rsa_free( rsa );
2738 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002739 }
2740 else
John Durkop9814fa22020-11-04 12:28:15 -08002741#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08002742 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002743 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002744 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002745 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002746
2747exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002748 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002749
Ronald Cron5c522922020-11-14 16:35:34 +01002750 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002751}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002752
Ronald Croncf56a0a2020-08-04 09:51:30 +02002753psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02002754 psa_algorithm_t alg,
2755 const uint8_t *input,
2756 size_t input_length,
2757 const uint8_t *salt,
2758 size_t salt_length,
2759 uint8_t *output,
2760 size_t output_size,
2761 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002762{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002763 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002764 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002765 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002766
Darryl Green5cc689a2018-07-24 15:34:10 +01002767 (void) input;
2768 (void) input_length;
2769 (void) salt;
2770 (void) output;
2771 (void) output_size;
2772
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03002773 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002774
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002775 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2776 return( PSA_ERROR_INVALID_ARGUMENT );
2777
Ronald Cron5c522922020-11-14 16:35:34 +01002778 status = psa_get_and_lock_transparent_key_slot_with_policy(
2779 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002780 if( status != PSA_SUCCESS )
2781 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002782 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002783 {
2784 status = PSA_ERROR_INVALID_ARGUMENT;
2785 goto exit;
2786 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002787
John Durkop6ba40d12020-11-10 08:50:04 -08002788#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2789 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002790 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002791 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002792 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002793 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2794 slot->key.data,
2795 slot->key.bytes,
2796 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002797 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002798 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002799
Steven Cooremana2371e52020-07-28 14:30:39 +02002800 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002801 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002802 status = PSA_ERROR_INVALID_ARGUMENT;
2803 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002804 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002805
John Durkop0e005192020-10-31 22:06:54 -07002806#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02002807 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002808 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002809 status = mbedtls_to_psa_error(
2810 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002811 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002812 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002813 MBEDTLS_RSA_PRIVATE,
2814 output_length,
2815 input,
2816 output,
2817 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002818 }
2819 else
John Durkop0e005192020-10-31 22:06:54 -07002820#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2821#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02002822 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002823 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002824 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02002825 status = mbedtls_to_psa_error(
2826 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002827 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002828 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002829 MBEDTLS_RSA_PRIVATE,
2830 salt, salt_length,
2831 output_length,
2832 input,
2833 output,
2834 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002835 }
2836 else
John Durkop0e005192020-10-31 22:06:54 -07002837#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002838 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002839 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002840 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03002841
Steven Cooreman4fed4552020-08-03 14:46:03 +02002842rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02002843 mbedtls_rsa_free( rsa );
2844 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002845 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002846 else
John Durkop6ba40d12020-11-10 08:50:04 -08002847#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
2848 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002849 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02002850 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002851 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002852
2853exit:
Ronald Cron5c522922020-11-14 16:35:34 +01002854 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002855
Ronald Cron5c522922020-11-14 16:35:34 +01002856 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02002857}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002858
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002859
2860
mohammad1603503973b2018-03-12 15:59:30 +02002861/****************************************************************/
2862/* Symmetric cryptography */
2863/****************************************************************/
2864
Ronald Cronab99ac22020-10-01 16:38:28 +02002865static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
2866 mbedtls_svc_key_id_t key,
2867 psa_algorithm_t alg,
2868 mbedtls_operation_t cipher_operation )
2869{
2870 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2871 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2872 psa_key_slot_t *slot;
2873 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
2874 PSA_KEY_USAGE_ENCRYPT :
2875 PSA_KEY_USAGE_DECRYPT );
2876
2877 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01002878 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02002879 return( PSA_ERROR_BAD_STATE );
2880
2881 /* The requested algorithm must be one that can be processed by cipher. */
2882 if( ! PSA_ALG_IS_CIPHER( alg ) )
2883 return( PSA_ERROR_INVALID_ARGUMENT );
2884
2885 /* Fetch key material from key storage. */
2886 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
2887 if( status != PSA_SUCCESS )
2888 goto exit;
2889
Ronald Cron49fafa92021-03-10 08:34:23 +01002890 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02002891 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01002892 * so we only set it (in the driver wrapper) after resources have been
2893 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02002894 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02002895 if( alg == PSA_ALG_ECB_NO_PADDING )
2896 operation->iv_required = 0;
2897 else
2898 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01002899 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02002900
Ronald Crona4af55f2020-12-14 14:36:06 +01002901 psa_key_attributes_t attributes = {
2902 .core = slot->attr
2903 };
2904
Ronald Cronab99ac22020-10-01 16:38:28 +02002905 /* Try doing the operation through a driver before using software fallback. */
2906 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01002907 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
2908 &attributes,
2909 slot->key.data,
2910 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02002911 alg );
2912 else
Ronald Crona4af55f2020-12-14 14:36:06 +01002913 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
2914 &attributes,
2915 slot->key.data,
2916 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02002917 alg );
2918
Gilles Peskine9ab61b62019-02-25 17:43:14 +01002919exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01002920 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01002921 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002922
Ronald Cron5c522922020-11-14 16:35:34 +01002923 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002924
Ronald Cron5c522922020-11-14 16:35:34 +01002925 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02002926}
2927
Gilles Peskinefe119512018-07-08 21:39:34 +02002928psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002929 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02002930 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02002931{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002932 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02002933}
2934
Gilles Peskinefe119512018-07-08 21:39:34 +02002935psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002936 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02002937 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02002938{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002939 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02002940}
2941
Gilles Peskinefe119512018-07-08 21:39:34 +02002942psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01002943 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02002944 size_t iv_size,
2945 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02002946{
Ronald Cron6d051732020-10-01 14:10:20 +02002947 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02002948
Ronald Cron5618a392021-03-26 09:52:26 +01002949 *iv_length = 0;
2950
Ronald Cron49fafa92021-03-10 08:34:23 +01002951 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02002952 {
2953 return( PSA_ERROR_BAD_STATE );
2954 }
2955
Steven Cooreman7df02922020-09-09 15:28:49 +02002956 if( operation->iv_set || ! operation->iv_required )
2957 {
2958 return( PSA_ERROR_BAD_STATE );
2959 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02002960
Ronald Cron5618a392021-03-26 09:52:26 +01002961 if( iv_size < operation->default_iv_length )
2962 {
2963 status = PSA_ERROR_BUFFER_TOO_SMALL;
2964 goto exit;
2965 }
Gilles Peskinee553c652018-06-04 16:22:46 +02002966
Ronald Cron5618a392021-03-26 09:52:26 +01002967 status = psa_generate_random( iv, operation->default_iv_length );
2968 if( status != PSA_SUCCESS )
2969 goto exit;
2970
2971 status = psa_driver_wrapper_cipher_set_iv( operation,
2972 iv,
2973 operation->default_iv_length );
2974
2975exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02002976 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01002977 {
Steven Cooreman7df02922020-09-09 15:28:49 +02002978 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01002979 *iv_length = operation->default_iv_length;
2980 }
Steven Cooreman7df02922020-09-09 15:28:49 +02002981 else
Moran Peker395db872018-05-31 14:07:14 +03002982 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02002983
itayzafrir534bd7c2018-08-02 13:56:32 +03002984 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02002985}
2986
Gilles Peskinefe119512018-07-08 21:39:34 +02002987psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01002988 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02002989 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02002990{
Ronald Cron6d051732020-10-01 14:10:20 +02002991 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02002992
Ronald Cron49fafa92021-03-10 08:34:23 +01002993 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02002994 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02002995
Steven Cooreman7df02922020-09-09 15:28:49 +02002996 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02002997 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01002998
2999 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3000 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003001
Ronald Crondd24c9b2020-12-15 14:10:01 +01003002 status = psa_driver_wrapper_cipher_set_iv( operation,
3003 iv,
3004 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003005
itayzafrir534bd7c2018-08-02 13:56:32 +03003006 if( status == PSA_SUCCESS )
3007 operation->iv_set = 1;
3008 else
mohammad1603503973b2018-03-12 15:59:30 +02003009 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003010 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003011}
3012
Gilles Peskinee553c652018-06-04 16:22:46 +02003013psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3014 const uint8_t *input,
3015 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003016 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003017 size_t output_size,
3018 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003019{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003021
Ronald Cron49fafa92021-03-10 08:34:23 +01003022 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003023 {
3024 return( PSA_ERROR_BAD_STATE );
3025 }
3026 if( operation->iv_required && ! operation->iv_set )
3027 {
3028 return( PSA_ERROR_BAD_STATE );
3029 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003030
Ronald Crondd24c9b2020-12-15 14:10:01 +01003031 status = psa_driver_wrapper_cipher_update( operation,
3032 input,
3033 input_length,
3034 output,
3035 output_size,
3036 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003037 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003038 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003039
itayzafrir534bd7c2018-08-02 13:56:32 +03003040 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003041}
3042
Gilles Peskinee553c652018-06-04 16:22:46 +02003043psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3044 uint8_t *output,
3045 size_t output_size,
3046 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003047{
David Saadab4ecc272019-02-14 13:48:10 +02003048 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003049
Ronald Cron49fafa92021-03-10 08:34:23 +01003050 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003051 {
3052 return( PSA_ERROR_BAD_STATE );
3053 }
3054 if( operation->iv_required && ! operation->iv_set )
3055 {
3056 return( PSA_ERROR_BAD_STATE );
3057 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003058
Ronald Crondd24c9b2020-12-15 14:10:01 +01003059 status = psa_driver_wrapper_cipher_finish( operation,
3060 output,
3061 output_size,
3062 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003063 if( status == PSA_SUCCESS )
3064 return( psa_cipher_abort( operation ) );
3065 else
3066 {
3067 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003068 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003069
Steven Cooremanef8575e2020-09-11 11:44:50 +02003070 return( status );
3071 }
mohammad1603503973b2018-03-12 15:59:30 +02003072}
3073
Gilles Peskinee553c652018-06-04 16:22:46 +02003074psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3075{
Ronald Cron49fafa92021-03-10 08:34:23 +01003076 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003077 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003078 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003079 * in use. It's ok to call abort on such an object, and there's
3080 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003081 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003082 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003083
Ronald Crondd24c9b2020-12-15 14:10:01 +01003084 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003085
Ronald Cron49fafa92021-03-10 08:34:23 +01003086 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003087 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003088 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003089
Moran Peker395db872018-05-31 14:07:14 +03003090 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003091}
3092
mohammad16035955c982018-04-26 00:53:03 +03003093/****************************************************************/
3094/* AEAD */
3095/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003096
Ronald Croncf56a0a2020-08-04 09:51:30 +02003097psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003098 psa_algorithm_t alg,
3099 const uint8_t *nonce,
3100 size_t nonce_length,
3101 const uint8_t *additional_data,
3102 size_t additional_data_length,
3103 const uint8_t *plaintext,
3104 size_t plaintext_length,
3105 uint8_t *ciphertext,
3106 size_t ciphertext_size,
3107 size_t *ciphertext_length )
3108{
Ronald Cron215633c2021-03-16 17:15:37 +01003109 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3110 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003111
mohammad1603f08a5502018-06-03 15:05:47 +03003112 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003113
Steven Cooremanea7ab132021-03-17 16:28:00 +01003114 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3115 return( PSA_ERROR_NOT_SUPPORTED );
3116
Ronald Cron9a986162021-03-26 12:40:07 +01003117 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003118 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003119 if( status != PSA_SUCCESS )
3120 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003121
Ronald Cron215633c2021-03-16 17:15:37 +01003122 psa_key_attributes_t attributes = {
3123 .core = slot->attr
3124 };
mohammad16035955c982018-04-26 00:53:03 +03003125
Ronald Cronde822812021-03-17 16:08:20 +01003126 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003127 &attributes, slot->key.data, slot->key.bytes,
3128 alg,
3129 nonce, nonce_length,
3130 additional_data, additional_data_length,
3131 plaintext, plaintext_length,
3132 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003133
Gilles Peskineedf9a652018-08-17 18:11:56 +02003134 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3135 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003136
Ronald Cron9f310172021-03-16 16:36:37 +01003137 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003138
mohammad16035955c982018-04-26 00:53:03 +03003139 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003140}
3141
Ronald Croncf56a0a2020-08-04 09:51:30 +02003142psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003143 psa_algorithm_t alg,
3144 const uint8_t *nonce,
3145 size_t nonce_length,
3146 const uint8_t *additional_data,
3147 size_t additional_data_length,
3148 const uint8_t *ciphertext,
3149 size_t ciphertext_length,
3150 uint8_t *plaintext,
3151 size_t plaintext_size,
3152 size_t *plaintext_length )
3153{
Ronald Cron215633c2021-03-16 17:15:37 +01003154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3155 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003156
Gilles Peskineee652a32018-06-01 19:23:52 +02003157 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003158
Steven Cooremanea7ab132021-03-17 16:28:00 +01003159 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3160 return( PSA_ERROR_NOT_SUPPORTED );
3161
Ronald Cron9a986162021-03-26 12:40:07 +01003162 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003163 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003164 if( status != PSA_SUCCESS )
3165 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003166
Ronald Cron215633c2021-03-16 17:15:37 +01003167 psa_key_attributes_t attributes = {
3168 .core = slot->attr
3169 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003170
Ronald Cronde822812021-03-17 16:08:20 +01003171 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003172 &attributes, slot->key.data, slot->key.bytes,
3173 alg,
3174 nonce, nonce_length,
3175 additional_data, additional_data_length,
3176 ciphertext, ciphertext_length,
3177 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003178
Gilles Peskineedf9a652018-08-17 18:11:56 +02003179 if( status != PSA_SUCCESS && plaintext_size != 0 )
3180 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003181
Ronald Cron215633c2021-03-16 17:15:37 +01003182 psa_unlock_key_slot( slot );
3183
Gilles Peskineedf9a652018-08-17 18:11:56 +02003184 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003185}
3186
Gilles Peskinee59236f2018-01-27 23:32:46 +01003187/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003188/* Generators */
3189/****************************************************************/
3190
John Durkop07cc04a2020-11-16 22:08:34 -08003191#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3192 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3193 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3194#define AT_LEAST_ONE_BUILTIN_KDF
3195#endif
3196
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003197#define HKDF_STATE_INIT 0 /* no input yet */
3198#define HKDF_STATE_STARTED 1 /* got salt */
3199#define HKDF_STATE_KEYED 2 /* got key */
3200#define HKDF_STATE_OUTPUT 3 /* output started */
3201
Gilles Peskinecbe66502019-05-16 16:59:18 +02003202static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003203 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003204{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003205 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3206 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003207 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003208 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003209}
3210
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003211psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003212{
3213 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003214 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003215 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003216 {
3217 /* The object has (apparently) been initialized but it is not
3218 * in use. It's ok to call abort on such an object, and there's
3219 * nothing to do. */
3220 }
3221 else
John Durkopd0321952020-10-29 21:37:36 -07003222#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003223 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003224 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003225 mbedtls_free( operation->ctx.hkdf.info );
3226 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003227 }
John Durkop07cc04a2020-11-16 22:08:34 -08003228 else
3229#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3230#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3231 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3232 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003233 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003234 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003235 {
Janos Follath6a1d2622019-06-11 10:37:28 +01003236 if( operation->ctx.tls12_prf.seed != NULL )
3237 {
3238 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3239 operation->ctx.tls12_prf.seed_length );
3240 mbedtls_free( operation->ctx.tls12_prf.seed );
3241 }
3242
3243 if( operation->ctx.tls12_prf.label != NULL )
3244 {
3245 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3246 operation->ctx.tls12_prf.label_length );
3247 mbedtls_free( operation->ctx.tls12_prf.label );
3248 }
3249
3250 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
3251
3252 /* We leave the fields Ai and output_block to be erased safely by the
3253 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003254 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003255 else
John Durkop07cc04a2020-11-16 22:08:34 -08003256#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3257 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003258 {
3259 status = PSA_ERROR_BAD_STATE;
3260 }
Janos Follath083036a2019-06-11 10:22:26 +01003261 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003262 return( status );
3263}
3264
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003265psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003266 size_t *capacity)
3267{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003268 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003269 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003270 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003271 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003272 }
3273
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003274 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003275 return( PSA_SUCCESS );
3276}
3277
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003278psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003279 size_t capacity )
3280{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003281 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003282 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003283 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003284 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003285 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003286 return( PSA_SUCCESS );
3287}
3288
John Durkopd0321952020-10-29 21:37:36 -07003289#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003290/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003291 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003292static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003293 psa_algorithm_t hash_alg,
3294 uint8_t *output,
3295 size_t output_length )
3296{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003297 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003298 psa_status_t status;
3299
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003300 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3301 return( PSA_ERROR_BAD_STATE );
3302 hkdf->state = HKDF_STATE_OUTPUT;
3303
Gilles Peskinebef7f142018-07-12 17:22:21 +02003304 while( output_length != 0 )
3305 {
3306 /* Copy what remains of the current block */
3307 uint8_t n = hash_length - hkdf->offset_in_block;
3308 if( n > output_length )
3309 n = (uint8_t) output_length;
3310 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3311 output += n;
3312 output_length -= n;
3313 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003314 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003315 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003316 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003317 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003318 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003319 * object was corrupted or if this function is called directly
3320 * inside the library. */
3321 if( hkdf->block_number == 0xff )
3322 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003323
3324 /* We need a new block */
3325 ++hkdf->block_number;
3326 hkdf->offset_in_block = 0;
3327 status = psa_hmac_setup_internal( &hkdf->hmac,
3328 hkdf->prk, hash_length,
3329 hash_alg );
3330 if( status != PSA_SUCCESS )
3331 return( status );
3332 if( hkdf->block_number != 1 )
3333 {
3334 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3335 hkdf->output_block,
3336 hash_length );
3337 if( status != PSA_SUCCESS )
3338 return( status );
3339 }
3340 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3341 hkdf->info,
3342 hkdf->info_length );
3343 if( status != PSA_SUCCESS )
3344 return( status );
3345 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3346 &hkdf->block_number, 1 );
3347 if( status != PSA_SUCCESS )
3348 return( status );
3349 status = psa_hmac_finish_internal( &hkdf->hmac,
3350 hkdf->output_block,
3351 sizeof( hkdf->output_block ) );
3352 if( status != PSA_SUCCESS )
3353 return( status );
3354 }
3355
3356 return( PSA_SUCCESS );
3357}
John Durkop07cc04a2020-11-16 22:08:34 -08003358#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003359
John Durkop07cc04a2020-11-16 22:08:34 -08003360#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3361 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003362static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3363 psa_tls12_prf_key_derivation_t *tls12_prf,
3364 psa_algorithm_t alg )
3365{
3366 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003367 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01003368 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
3369 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003370
Janos Follath7742fee2019-06-17 12:58:10 +01003371 /* We can't be wanting more output after block 0xff, otherwise
3372 * the capacity check in psa_key_derivation_output_bytes() would have
3373 * prevented this call. It could happen only if the operation
3374 * object was corrupted or if this function is called directly
3375 * inside the library. */
3376 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003377 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003378
3379 /* We need a new block */
3380 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003381 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003382
3383 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3384 *
3385 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3386 *
3387 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3388 * HMAC_hash(secret, A(2) + seed) +
3389 * HMAC_hash(secret, A(3) + seed) + ...
3390 *
3391 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003392 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003393 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003394 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003395 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003396 * is currently extracted as `output_block` and where i is
3397 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003398 */
3399
Janos Follathea29bfb2019-06-19 12:21:20 +01003400 /* Save the hash context before using it, to preserve the hash state with
3401 * only the inner padding in it. We need this, because inner padding depends
3402 * on the key (secret in the RFC's terminology). */
3403 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
3404 if( status != PSA_SUCCESS )
3405 goto cleanup;
3406
3407 /* Calculate A(i) where i = tls12_prf->block_number. */
3408 if( tls12_prf->block_number == 1 )
3409 {
3410 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3411 * the variable seed and in this instance means it in the context of the
3412 * P_hash function, where seed = label + seed.) */
3413 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3414 tls12_prf->label, tls12_prf->label_length );
3415 if( status != PSA_SUCCESS )
3416 goto cleanup;
3417 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3418 tls12_prf->seed, tls12_prf->seed_length );
3419 if( status != PSA_SUCCESS )
3420 goto cleanup;
3421 }
3422 else
3423 {
3424 /* A(i) = HMAC_hash(secret, A(i-1)) */
3425 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3426 tls12_prf->Ai, hash_length );
3427 if( status != PSA_SUCCESS )
3428 goto cleanup;
3429 }
3430
3431 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3432 tls12_prf->Ai, hash_length );
3433 if( status != PSA_SUCCESS )
3434 goto cleanup;
3435 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3436 if( status != PSA_SUCCESS )
3437 goto cleanup;
3438
3439 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
3440 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3441 tls12_prf->Ai, hash_length );
3442 if( status != PSA_SUCCESS )
3443 goto cleanup;
3444 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3445 tls12_prf->label, tls12_prf->label_length );
3446 if( status != PSA_SUCCESS )
3447 goto cleanup;
3448 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
3449 tls12_prf->seed, tls12_prf->seed_length );
3450 if( status != PSA_SUCCESS )
3451 goto cleanup;
3452 status = psa_hmac_finish_internal( &tls12_prf->hmac,
3453 tls12_prf->output_block, hash_length );
3454 if( status != PSA_SUCCESS )
3455 goto cleanup;
3456 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
3457 if( status != PSA_SUCCESS )
3458 goto cleanup;
3459
Janos Follath7742fee2019-06-17 12:58:10 +01003460
3461cleanup:
3462
Janos Follathea29bfb2019-06-19 12:21:20 +01003463 cleanup_status = psa_hash_abort( &backup );
3464 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3465 status = cleanup_status;
3466
3467 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003468}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003469
Janos Follath844eb0e2019-06-19 12:10:49 +01003470static psa_status_t psa_key_derivation_tls12_prf_read(
3471 psa_tls12_prf_key_derivation_t *tls12_prf,
3472 psa_algorithm_t alg,
3473 uint8_t *output,
3474 size_t output_length )
3475{
3476 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003477 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003478 psa_status_t status;
3479 uint8_t offset, length;
3480
3481 while( output_length != 0 )
3482 {
3483 /* Check if we have fully processed the current block. */
3484 if( tls12_prf->left_in_block == 0 )
3485 {
3486 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3487 alg );
3488 if( status != PSA_SUCCESS )
3489 return( status );
3490
3491 continue;
3492 }
3493
3494 if( tls12_prf->left_in_block > output_length )
3495 length = (uint8_t) output_length;
3496 else
3497 length = tls12_prf->left_in_block;
3498
3499 offset = hash_length - tls12_prf->left_in_block;
3500 memcpy( output, tls12_prf->output_block + offset, length );
3501 output += length;
3502 output_length -= length;
3503 tls12_prf->left_in_block -= length;
3504 }
3505
3506 return( PSA_SUCCESS );
3507}
John Durkop07cc04a2020-11-16 22:08:34 -08003508#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3509 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003510
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003511psa_status_t psa_key_derivation_output_bytes(
3512 psa_key_derivation_operation_t *operation,
3513 uint8_t *output,
3514 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003515{
3516 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003517 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003518
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003519 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003520 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003521 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003522 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003523 }
3524
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003525 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003526 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003527 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003528 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003529 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003530 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003531 goto exit;
3532 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003533 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003534 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003535 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003536 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003537 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3538 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003539 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003540 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003541 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003542 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003543 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003544
John Durkopd0321952020-10-29 21:37:36 -07003545#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003546 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003547 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003548 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003549 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003550 output, output_length );
3551 }
Janos Follathadbec812019-06-14 11:05:39 +01003552 else
John Durkop07cc04a2020-11-16 22:08:34 -08003553#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3554#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3555 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003556 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003557 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003558 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003559 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003560 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003561 output_length );
3562 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003563 else
John Durkop07cc04a2020-11-16 22:08:34 -08003564#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3565 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003566 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003567 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003568 return( PSA_ERROR_BAD_STATE );
3569 }
3570
3571exit:
3572 if( status != PSA_SUCCESS )
3573 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003574 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003575 * This allows us to differentiate between exhausted operations and
3576 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3577 * operations. */
3578 psa_algorithm_t alg = operation->alg;
3579 psa_key_derivation_abort( operation );
3580 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003581 memset( output, '!', output_length );
3582 }
3583 return( status );
3584}
3585
David Brown7807bf72021-02-09 16:28:23 -07003586#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003587static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3588{
3589 if( data_size >= 8 )
3590 mbedtls_des_key_set_parity( data );
3591 if( data_size >= 16 )
3592 mbedtls_des_key_set_parity( data + 8 );
3593 if( data_size >= 24 )
3594 mbedtls_des_key_set_parity( data + 16 );
3595}
David Brown7807bf72021-02-09 16:28:23 -07003596#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003597
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003598static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003599 psa_key_slot_t *slot,
3600 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003601 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003602{
3603 uint8_t *data = NULL;
3604 size_t bytes = PSA_BITS_TO_BYTES( bits );
3605 psa_status_t status;
3606
Gilles Peskine8e338702019-07-30 20:06:31 +02003607 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003608 return( PSA_ERROR_INVALID_ARGUMENT );
3609 if( bits % 8 != 0 )
3610 return( PSA_ERROR_INVALID_ARGUMENT );
3611 data = mbedtls_calloc( 1, bytes );
3612 if( data == NULL )
3613 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3614
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003615 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003616 if( status != PSA_SUCCESS )
3617 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003618#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003619 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003620 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003621#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003622
3623 status = psa_allocate_buffer_to_slot( slot, bytes );
3624 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003625 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003626
Ronald Cronbf33c932020-11-28 18:06:53 +01003627 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003628 psa_key_attributes_t attributes = {
3629 .core = slot->attr
3630 };
3631
Ronald Cronbf33c932020-11-28 18:06:53 +01003632 status = psa_driver_wrapper_import_key( &attributes,
3633 data, bytes,
3634 slot->key.data,
3635 slot->key.bytes,
3636 &slot->key.bytes, &bits );
3637 if( bits != slot->attr.bits )
3638 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003639
3640exit:
3641 mbedtls_free( data );
3642 return( status );
3643}
3644
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003645psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003646 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003647 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003648{
3649 psa_status_t status;
3650 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02003651 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02003652
Ronald Cron81709fc2020-11-14 12:10:32 +01003653 *key = MBEDTLS_SVC_KEY_ID_INIT;
3654
Gilles Peskine0f84d622019-09-12 19:03:13 +02003655 /* Reject any attempt to create a zero-length key so that we don't
3656 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
3657 if( psa_get_key_bits( attributes ) == 0 )
3658 return( PSA_ERROR_INVALID_ARGUMENT );
3659
Gilles Peskine178c9aa2019-09-24 18:21:06 +02003660 if( ! operation->can_output_key )
3661 return( PSA_ERROR_NOT_PERMITTED );
3662
Ronald Cron81709fc2020-11-14 12:10:32 +01003663 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
3664 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02003665#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3666 if( driver != NULL )
3667 {
3668 /* Deriving a key in a secure element is not implemented yet. */
3669 status = PSA_ERROR_NOT_SUPPORTED;
3670 }
3671#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003672 if( status == PSA_SUCCESS )
3673 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003674 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02003675 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003676 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003677 }
3678 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01003679 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003680 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02003681 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003682
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003683 return( status );
3684}
3685
Gilles Peskineeab56e42018-07-12 17:12:33 +02003686
3687
3688/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02003689/* Key derivation */
3690/****************************************************************/
3691
Steven Cooreman932ffb72021-02-15 12:14:32 +01003692#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003693static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003694 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003695 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003696{
John Durkop07cc04a2020-11-16 22:08:34 -08003697 int is_kdf_alg_supported;
3698
Janos Follath5fe19732019-06-20 15:09:30 +01003699 /* Make sure that operation->ctx is properly zero-initialised. (Macro
3700 * initialisers for this union leave some bytes unspecified.) */
3701 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
3702
Gilles Peskine969c5d62019-01-16 15:53:06 +01003703 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07003704#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08003705 if( PSA_ALG_IS_HKDF( kdf_alg ) )
3706 is_kdf_alg_supported = 1;
3707 else
3708#endif
3709#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
3710 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
3711 is_kdf_alg_supported = 1;
3712 else
3713#endif
3714#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3715 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
3716 is_kdf_alg_supported = 1;
3717 else
3718#endif
3719 is_kdf_alg_supported = 0;
3720
3721 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003722 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003723 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003724 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003725 if( hash_size == 0 )
3726 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003727 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
3728 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02003729 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003730 {
3731 return( PSA_ERROR_NOT_SUPPORTED );
3732 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003733 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01003734 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003735 }
John Durkop07cc04a2020-11-16 22:08:34 -08003736
3737 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003738}
John Durkop07cc04a2020-11-16 22:08:34 -08003739#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003740
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003741psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01003742 psa_algorithm_t alg )
3743{
3744 psa_status_t status;
3745
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003746 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003747 return( PSA_ERROR_BAD_STATE );
3748
Gilles Peskine6843c292019-01-18 16:44:49 +01003749 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
3750 return( PSA_ERROR_INVALID_ARGUMENT );
3751 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003752 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01003753#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003754 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003755 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01003756#else
3757 return( PSA_ERROR_NOT_SUPPORTED );
3758#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003759 }
3760 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
3761 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01003762#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003763 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01003764#else
3765 return( PSA_ERROR_NOT_SUPPORTED );
3766#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003767 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003768 else
3769 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003770
3771 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003772 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01003773 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003774}
3775
John Durkopd0321952020-10-29 21:37:36 -07003776#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02003777static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003778 psa_algorithm_t hash_alg,
3779 psa_key_derivation_step_t step,
3780 const uint8_t *data,
3781 size_t data_length )
3782{
3783 psa_status_t status;
3784 switch( step )
3785 {
Gilles Peskine03410b52019-05-16 16:05:19 +02003786 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02003787 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003788 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02003789 status = psa_hmac_setup_internal( &hkdf->hmac,
3790 data, data_length,
3791 hash_alg );
3792 if( status != PSA_SUCCESS )
3793 return( status );
3794 hkdf->state = HKDF_STATE_STARTED;
3795 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02003796 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003797 /* If no salt was provided, use an empty salt. */
3798 if( hkdf->state == HKDF_STATE_INIT )
3799 {
3800 status = psa_hmac_setup_internal( &hkdf->hmac,
3801 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02003802 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003803 if( status != PSA_SUCCESS )
3804 return( status );
3805 hkdf->state = HKDF_STATE_STARTED;
3806 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02003807 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003808 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02003809 status = psa_hash_update( &hkdf->hmac.hash_ctx,
3810 data, data_length );
3811 if( status != PSA_SUCCESS )
3812 return( status );
3813 status = psa_hmac_finish_internal( &hkdf->hmac,
3814 hkdf->prk,
3815 sizeof( hkdf->prk ) );
3816 if( status != PSA_SUCCESS )
3817 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003818 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02003819 hkdf->block_number = 0;
3820 hkdf->state = HKDF_STATE_KEYED;
3821 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02003822 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003823 if( hkdf->state == HKDF_STATE_OUTPUT )
3824 return( PSA_ERROR_BAD_STATE );
3825 if( hkdf->info_set )
3826 return( PSA_ERROR_BAD_STATE );
3827 hkdf->info_length = data_length;
3828 if( data_length != 0 )
3829 {
3830 hkdf->info = mbedtls_calloc( 1, data_length );
3831 if( hkdf->info == NULL )
3832 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3833 memcpy( hkdf->info, data, data_length );
3834 }
3835 hkdf->info_set = 1;
3836 return( PSA_SUCCESS );
3837 default:
3838 return( PSA_ERROR_INVALID_ARGUMENT );
3839 }
3840}
John Durkop07cc04a2020-11-16 22:08:34 -08003841#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01003842
John Durkop07cc04a2020-11-16 22:08:34 -08003843#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3844 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01003845static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
3846 const uint8_t *data,
3847 size_t data_length )
3848{
Gilles Peskine43f958b2020-12-13 14:55:14 +01003849 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01003850 return( PSA_ERROR_BAD_STATE );
3851
Janos Follathd6dce9f2019-07-04 09:11:38 +01003852 if( data_length != 0 )
3853 {
3854 prf->seed = mbedtls_calloc( 1, data_length );
3855 if( prf->seed == NULL )
3856 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01003857
Janos Follathd6dce9f2019-07-04 09:11:38 +01003858 memcpy( prf->seed, data, data_length );
3859 prf->seed_length = data_length;
3860 }
Janos Follathf08e2652019-06-13 09:05:41 +01003861
Gilles Peskine43f958b2020-12-13 14:55:14 +01003862 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01003863
3864 return( PSA_SUCCESS );
3865}
3866
Janos Follath81550542019-06-13 14:26:34 +01003867static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
3868 psa_algorithm_t hash_alg,
3869 const uint8_t *data,
3870 size_t data_length )
3871{
3872 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01003873 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01003874 return( PSA_ERROR_BAD_STATE );
3875
3876 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
3877 if( status != PSA_SUCCESS )
3878 return( status );
3879
Gilles Peskine43f958b2020-12-13 14:55:14 +01003880 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01003881
3882 return( PSA_SUCCESS );
3883}
3884
Janos Follath63028dd2019-06-13 09:15:47 +01003885static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
3886 const uint8_t *data,
3887 size_t data_length )
3888{
Gilles Peskine43f958b2020-12-13 14:55:14 +01003889 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01003890 return( PSA_ERROR_BAD_STATE );
3891
Janos Follathd6dce9f2019-07-04 09:11:38 +01003892 if( data_length != 0 )
3893 {
3894 prf->label = mbedtls_calloc( 1, data_length );
3895 if( prf->label == NULL )
3896 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01003897
Janos Follathd6dce9f2019-07-04 09:11:38 +01003898 memcpy( prf->label, data, data_length );
3899 prf->label_length = data_length;
3900 }
Janos Follath63028dd2019-06-13 09:15:47 +01003901
Gilles Peskine43f958b2020-12-13 14:55:14 +01003902 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01003903
3904 return( PSA_SUCCESS );
3905}
3906
Janos Follathb03233e2019-06-11 15:30:30 +01003907static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
3908 psa_algorithm_t hash_alg,
3909 psa_key_derivation_step_t step,
3910 const uint8_t *data,
3911 size_t data_length )
3912{
Janos Follathb03233e2019-06-11 15:30:30 +01003913 switch( step )
3914 {
Janos Follathf08e2652019-06-13 09:05:41 +01003915 case PSA_KEY_DERIVATION_INPUT_SEED:
3916 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01003917 case PSA_KEY_DERIVATION_INPUT_SECRET:
3918 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01003919 case PSA_KEY_DERIVATION_INPUT_LABEL:
3920 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01003921 default:
3922 return( PSA_ERROR_INVALID_ARGUMENT );
3923 }
3924}
John Durkop07cc04a2020-11-16 22:08:34 -08003925#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3926 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
3927
3928#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3929static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
3930 psa_tls12_prf_key_derivation_t *prf,
3931 psa_algorithm_t hash_alg,
3932 const uint8_t *data,
3933 size_t data_length )
3934{
3935 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003936 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08003937 uint8_t *cur = pms;
3938
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003939 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08003940 return( PSA_ERROR_INVALID_ARGUMENT );
3941
3942 /* Quoting RFC 4279, Section 2:
3943 *
3944 * The premaster secret is formed as follows: if the PSK is N octets
3945 * long, concatenate a uint16 with the value N, N zero octets, a second
3946 * uint16 with the value N, and the PSK itself.
3947 */
3948
3949 *cur++ = ( data_length >> 8 ) & 0xff;
3950 *cur++ = ( data_length >> 0 ) & 0xff;
3951 memset( cur, 0, data_length );
3952 cur += data_length;
3953 *cur++ = pms[0];
3954 *cur++ = pms[1];
3955 memcpy( cur, data, data_length );
3956 cur += data_length;
3957
3958 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
3959
3960 mbedtls_platform_zeroize( pms, sizeof( pms ) );
3961 return( status );
3962}
Janos Follath6660f0e2019-06-17 08:44:03 +01003963
3964static psa_status_t psa_tls12_prf_psk_to_ms_input(
3965 psa_tls12_prf_key_derivation_t *prf,
3966 psa_algorithm_t hash_alg,
3967 psa_key_derivation_step_t step,
3968 const uint8_t *data,
3969 size_t data_length )
3970{
3971 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01003972 {
Janos Follath6660f0e2019-06-17 08:44:03 +01003973 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
3974 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01003975 }
Janos Follath6660f0e2019-06-17 08:44:03 +01003976
3977 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
3978}
John Durkop07cc04a2020-11-16 22:08:34 -08003979#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003980
Gilles Peskineb8965192019-09-24 16:21:10 +02003981/** Check whether the given key type is acceptable for the given
3982 * input step of a key derivation.
3983 *
3984 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
3985 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
3986 * Both secret and non-secret inputs can alternatively have the type
3987 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
3988 * that the input was passed as a buffer rather than via a key object.
3989 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02003990static int psa_key_derivation_check_input_type(
3991 psa_key_derivation_step_t step,
3992 psa_key_type_t key_type )
3993{
3994 switch( step )
3995 {
3996 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02003997 if( key_type == PSA_KEY_TYPE_DERIVE )
3998 return( PSA_SUCCESS );
3999 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004000 return( PSA_SUCCESS );
4001 break;
4002 case PSA_KEY_DERIVATION_INPUT_LABEL:
4003 case PSA_KEY_DERIVATION_INPUT_SALT:
4004 case PSA_KEY_DERIVATION_INPUT_INFO:
4005 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004006 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4007 return( PSA_SUCCESS );
4008 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004009 return( PSA_SUCCESS );
4010 break;
4011 }
4012 return( PSA_ERROR_INVALID_ARGUMENT );
4013}
4014
Janos Follathb80a94e2019-06-12 15:54:46 +01004015static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004016 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004017 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004018 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004019 const uint8_t *data,
4020 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004021{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004022 psa_status_t status;
4023 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4024
4025 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004026 if( status != PSA_SUCCESS )
4027 goto exit;
4028
John Durkopd0321952020-10-29 21:37:36 -07004029#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004030 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004031 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004032 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004033 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004034 step, data, data_length );
4035 }
John Durkop07cc04a2020-11-16 22:08:34 -08004036 else
4037#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4038#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4039 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004040 {
Janos Follathb03233e2019-06-11 15:30:30 +01004041 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
4042 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4043 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004044 }
John Durkop07cc04a2020-11-16 22:08:34 -08004045 else
4046#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4047#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4048 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004049 {
4050 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
4051 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
4052 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004053 }
4054 else
John Durkop07cc04a2020-11-16 22:08:34 -08004055#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004056 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004057 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004058 (void) data;
4059 (void) data_length;
4060 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004061 return( PSA_ERROR_BAD_STATE );
4062 }
4063
Gilles Peskine224b0d62019-09-23 18:13:17 +02004064exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004065 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004066 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004067 return( status );
4068}
4069
Janos Follath51f4a0f2019-06-14 11:35:55 +01004070psa_status_t psa_key_derivation_input_bytes(
4071 psa_key_derivation_operation_t *operation,
4072 psa_key_derivation_step_t step,
4073 const uint8_t *data,
4074 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004075{
Gilles Peskineb8965192019-09-24 16:21:10 +02004076 return( psa_key_derivation_input_internal( operation, step,
4077 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004078 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004079}
4080
Janos Follath51f4a0f2019-06-14 11:35:55 +01004081psa_status_t psa_key_derivation_input_key(
4082 psa_key_derivation_operation_t *operation,
4083 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004084 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004085{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004087 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004088 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004089
Ronald Cron5c522922020-11-14 16:35:34 +01004090 status = psa_get_and_lock_transparent_key_slot_with_policy(
4091 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004092 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004093 {
4094 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004095 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004096 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004097
4098 /* Passing a key object as a SECRET input unlocks the permission
4099 * to output to a key object. */
4100 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4101 operation->can_output_key = 1;
4102
Ronald Cronf95a2b12020-10-22 15:24:49 +02004103 status = psa_key_derivation_input_internal( operation,
4104 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004105 slot->key.data,
4106 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004107
Ronald Cron5c522922020-11-14 16:35:34 +01004108 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004109
Ronald Cron5c522922020-11-14 16:35:34 +01004110 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004111}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004112
4113
4114
4115/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004116/* Key agreement */
4117/****************************************************************/
4118
John Durkop6ba40d12020-11-10 08:50:04 -08004119#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004120static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4121 size_t peer_key_length,
4122 const mbedtls_ecp_keypair *our_key,
4123 uint8_t *shared_secret,
4124 size_t shared_secret_size,
4125 size_t *shared_secret_length )
4126{
Steven Cooremand4867872020-08-05 16:31:39 +02004127 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004128 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004129 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004130 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004131 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004132 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004133
Ronald Cron90857082020-11-25 14:58:33 +01004134 status = mbedtls_psa_ecp_load_representation(
4135 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004136 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004137 peer_key,
4138 peer_key_length,
4139 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004140 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004141 goto exit;
4142
Jaeden Amero97271b32019-01-10 19:38:51 +00004143 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004144 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004145 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004146 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004147 status = mbedtls_to_psa_error(
4148 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4149 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004150 goto exit;
4151
Jaeden Amero97271b32019-01-10 19:38:51 +00004152 status = mbedtls_to_psa_error(
4153 mbedtls_ecdh_calc_secret( &ecdh,
4154 shared_secret_length,
4155 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004156 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004157 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004158 if( status != PSA_SUCCESS )
4159 goto exit;
4160 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4161 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004162
4163exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004164 if( status != PSA_SUCCESS )
4165 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004166 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004167 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004168 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004169
Jaeden Amero97271b32019-01-10 19:38:51 +00004170 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004171}
John Durkop6ba40d12020-11-10 08:50:04 -08004172#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004173
Gilles Peskine01d718c2018-09-18 12:01:02 +02004174#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4175
Gilles Peskine0216fe12019-04-11 21:23:21 +02004176static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4177 psa_key_slot_t *private_key,
4178 const uint8_t *peer_key,
4179 size_t peer_key_length,
4180 uint8_t *shared_secret,
4181 size_t shared_secret_size,
4182 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004183{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004184 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004185 {
John Durkop6ba40d12020-11-10 08:50:04 -08004186#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004187 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004188 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004189 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004190 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004191 psa_status_t status = mbedtls_psa_ecp_load_representation(
4192 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004193 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004194 private_key->key.data,
4195 private_key->key.bytes,
4196 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004197 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004198 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004199 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004200 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004201 shared_secret, shared_secret_size,
4202 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004203 mbedtls_ecp_keypair_free( ecp );
4204 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004205 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004206#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004207 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004208 (void) private_key;
4209 (void) peer_key;
4210 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004211 (void) shared_secret;
4212 (void) shared_secret_size;
4213 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004214 return( PSA_ERROR_NOT_SUPPORTED );
4215 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004216}
4217
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004218/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004219 * to potentially free embedded data structures and wipe confidential data.
4220 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004221static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004222 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004223 psa_key_slot_t *private_key,
4224 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004225 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004226{
4227 psa_status_t status;
4228 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4229 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004230 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004231
4232 /* Step 1: run the secret agreement algorithm to generate the shared
4233 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004234 status = psa_key_agreement_raw_internal( ka_alg,
4235 private_key,
4236 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004237 shared_secret,
4238 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004239 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004240 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004241 goto exit;
4242
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004243 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004244 * the shared secret. A shared secret is permitted wherever a key
4245 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004246 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004247 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004248 shared_secret,
4249 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004250exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004251 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004252 return( status );
4253}
4254
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004255psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004256 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004257 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004258 const uint8_t *peer_key,
4259 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004260{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004261 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004262 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004263 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004264
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004265 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004266 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004267 status = psa_get_and_lock_transparent_key_slot_with_policy(
4268 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004269 if( status != PSA_SUCCESS )
4270 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004271 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004272 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004273 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004274 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004275 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004276 else
4277 {
4278 /* If a private key has been added as SECRET, we allow the derived
4279 * key material to be used as a key in PSA Crypto. */
4280 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4281 operation->can_output_key = 1;
4282 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004283
Ronald Cron5c522922020-11-14 16:35:34 +01004284 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004285
Ronald Cron5c522922020-11-14 16:35:34 +01004286 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004287}
4288
Gilles Peskinebe697d82019-05-16 18:00:41 +02004289psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004290 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004291 const uint8_t *peer_key,
4292 size_t peer_key_length,
4293 uint8_t *output,
4294 size_t output_size,
4295 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004296{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004298 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004299 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004300
4301 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4302 {
4303 status = PSA_ERROR_INVALID_ARGUMENT;
4304 goto exit;
4305 }
Ronald Cron5c522922020-11-14 16:35:34 +01004306 status = psa_get_and_lock_transparent_key_slot_with_policy(
4307 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004308 if( status != PSA_SUCCESS )
4309 goto exit;
4310
4311 status = psa_key_agreement_raw_internal( alg, slot,
4312 peer_key, peer_key_length,
4313 output, output_size,
4314 output_length );
4315
4316exit:
4317 if( status != PSA_SUCCESS )
4318 {
4319 /* If an error happens and is not handled properly, the output
4320 * may be used as a key to protect sensitive data. Arrange for such
4321 * a key to be random, which is likely to result in decryption or
4322 * verification errors. This is better than filling the buffer with
4323 * some constant data such as zeros, which would result in the data
4324 * being protected with a reproducible, easily knowable key.
4325 */
4326 psa_generate_random( output, output_size );
4327 *output_length = output_size;
4328 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004329
Ronald Cron5c522922020-11-14 16:35:34 +01004330 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004331
Ronald Cron5c522922020-11-14 16:35:34 +01004332 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004333}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004334
4335
Gilles Peskine30524eb2020-11-13 17:02:26 +01004336
Gilles Peskine86a440b2018-11-12 18:39:40 +01004337/****************************************************************/
4338/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004339/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004340
Gilles Peskine30524eb2020-11-13 17:02:26 +01004341/** Initialize the PSA random generator.
4342 */
4343static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4344{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004345#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4346 memset( rng, 0, sizeof( *rng ) );
4347#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4348
Gilles Peskine30524eb2020-11-13 17:02:26 +01004349 /* Set default configuration if
4350 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4351 if( rng->entropy_init == NULL )
4352 rng->entropy_init = mbedtls_entropy_init;
4353 if( rng->entropy_free == NULL )
4354 rng->entropy_free = mbedtls_entropy_free;
4355
4356 rng->entropy_init( &rng->entropy );
4357#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4358 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4359 /* The PSA entropy injection feature depends on using NV seed as an entropy
4360 * source. Add NV seed as an entropy source for PSA entropy injection. */
4361 mbedtls_entropy_add_source( &rng->entropy,
4362 mbedtls_nv_seed_poll, NULL,
4363 MBEDTLS_ENTROPY_BLOCK_SIZE,
4364 MBEDTLS_ENTROPY_SOURCE_STRONG );
4365#endif
4366
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004367 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004368#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004369}
4370
4371/** Deinitialize the PSA random generator.
4372 */
4373static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4374{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004375#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4376 memset( rng, 0, sizeof( *rng ) );
4377#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004378 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004379 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004380#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004381}
4382
4383/** Seed the PSA random generator.
4384 */
4385static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4386{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004387#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4388 /* Do nothing: the external RNG seeds itself. */
4389 (void) rng;
4390 return( PSA_SUCCESS );
4391#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004392 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004393 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4394 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004395 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004396#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004397}
4398
Gilles Peskinee59236f2018-01-27 23:32:46 +01004399psa_status_t psa_generate_random( uint8_t *output,
4400 size_t output_size )
4401{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004402 GUARD_MODULE_INITIALIZED;
4403
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004404#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4405
4406 size_t output_length = 0;
4407 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4408 output, output_size,
4409 &output_length );
4410 if( status != PSA_SUCCESS )
4411 return( status );
4412 /* Breaking up a request into smaller chunks is currently not supported
4413 * for the extrernal RNG interface. */
4414 if( output_length != output_size )
4415 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4416 return( PSA_SUCCESS );
4417
4418#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4419
Gilles Peskine71ddab92021-01-04 21:01:07 +01004420 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004421 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004422 size_t request_size =
4423 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4424 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4425 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004426 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4427 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004428 if( ret != 0 )
4429 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004430 output_size -= request_size;
4431 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004432 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004433 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004434#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004435}
4436
Gilles Peskine8814fc42020-12-14 15:33:44 +01004437/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004438 *
4439 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4440 * `psa_generate_random(...)`. The state parameter is ignored since the
4441 * PSA API doesn't support passing an explicit state.
4442 *
4443 * In the non-external case, psa_generate_random() calls an
4444 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4445 * and semantics as mbedtls_psa_get_random(). As an optimization,
4446 * instead of doing this back-and-forth between the PSA API and the
4447 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4448 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004449 */
4450#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4451int mbedtls_psa_get_random( void *p_rng,
4452 unsigned char *output,
4453 size_t output_size )
4454{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004455 /* This function takes a pointer to the RNG state because that's what
4456 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4457 * its own state internally and doesn't let the caller access that state.
4458 * So we just ignore the state parameter, and in practice we'll pass
4459 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004460 (void) p_rng;
4461 psa_status_t status = psa_generate_random( output, output_size );
4462 if( status == PSA_SUCCESS )
4463 return( 0 );
4464 else
4465 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4466}
4467#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4468
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004469#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004470#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004471
Gilles Peskine7228da22019-07-15 11:06:15 +02004472psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004473 size_t seed_size )
4474{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004475 if( global_data.initialized )
4476 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004477
4478 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4479 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4480 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4481 return( PSA_ERROR_INVALID_ARGUMENT );
4482
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004483 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004484}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004485#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004486
Ronald Cron3772afe2021-02-08 16:10:05 +01004487/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004488 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004489 * \param type The key type
4490 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004491 *
4492 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004493 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004494 * \retval #PSA_ERROR_INVALID_ARGUMENT
4495 * The size in bits of the key is not valid.
4496 * \retval #PSA_ERROR_NOT_SUPPORTED
4497 * The type and/or the size in bits of the key or the combination of
4498 * the two is not supported.
4499 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004500static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4501 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004502{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004503 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004504
Gilles Peskinee59236f2018-01-27 23:32:46 +01004505 if( key_type_is_raw_bytes( type ) )
4506 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004507 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004508 if( status != PSA_SUCCESS )
4509 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004510 }
4511 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004512#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004513 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4514 {
4515 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4516 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004517
Ronald Cron01b2aba2020-10-05 09:42:02 +02004518 /* Accept only byte-aligned keys, for the same reasons as
4519 * in psa_import_rsa_key(). */
4520 if( bits % 8 != 0 )
4521 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004522 }
4523 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004524#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004525
Ronald Cron5c4d3862020-12-07 11:07:24 +01004526#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004527 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4528 {
Ronald Crond81ab562021-02-16 09:01:16 +01004529 /* To avoid empty block, return successfully here. */
4530 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004531 }
4532 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004533#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004534 {
4535 return( PSA_ERROR_NOT_SUPPORTED );
4536 }
4537
4538 return( PSA_SUCCESS );
4539}
4540
Ronald Cron55ed0592020-10-05 10:30:40 +02004541psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004542 const psa_key_attributes_t *attributes,
4543 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004544{
4545 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004546 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004547
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004548 if( ( attributes->domain_parameters == NULL ) &&
4549 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004550 return( PSA_ERROR_INVALID_ARGUMENT );
4551
Ronald Cron01b2aba2020-10-05 09:42:02 +02004552 if( key_type_is_raw_bytes( type ) )
4553 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004554 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004555 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004556 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004557
David Brown12ca5032021-02-11 11:02:00 -07004558#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004559 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004560 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004561#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004562 }
4563 else
4564
John Durkop07cc04a2020-11-16 22:08:34 -08004565#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004566 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004567 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004568 return( mbedtls_psa_rsa_generate_key( attributes,
4569 key_buffer,
4570 key_buffer_size,
4571 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004572 }
4573 else
John Durkop07cc04a2020-11-16 22:08:34 -08004574#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004575
John Durkop9814fa22020-11-04 12:28:15 -08004576#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004577 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004578 {
Ronald Cron7023db52020-11-20 18:17:42 +01004579 return( mbedtls_psa_ecp_generate_key( attributes,
4580 key_buffer,
4581 key_buffer_size,
4582 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004583 }
4584 else
John Durkop9814fa22020-11-04 12:28:15 -08004585#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004586 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004587 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004588 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004589 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004590
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004591 return( PSA_SUCCESS );
4592}
Darryl Green0c6575a2018-11-07 16:05:30 +00004593
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004594psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004595 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004596{
4597 psa_status_t status;
4598 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004599 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004600 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004601
Ronald Cron81709fc2020-11-14 12:10:32 +01004602 *key = MBEDTLS_SVC_KEY_ID_INIT;
4603
Gilles Peskine0f84d622019-09-12 19:03:13 +02004604 /* Reject any attempt to create a zero-length key so that we don't
4605 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4606 if( psa_get_key_bits( attributes ) == 0 )
4607 return( PSA_ERROR_INVALID_ARGUMENT );
4608
Ronald Cron81709fc2020-11-14 12:10:32 +01004609 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4610 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004611 if( status != PSA_SUCCESS )
4612 goto exit;
4613
Ronald Cron977c2472020-10-13 08:32:21 +02004614 /* In the case of a transparent key or an opaque key stored in local
4615 * storage (thus not in the case of generating a key in a secure element
4616 * or cryptoprocessor with storage), we have to allocate a buffer to
4617 * hold the generated key material. */
4618 if( slot->key.data == NULL )
4619 {
4620 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4621 PSA_KEY_LOCATION_LOCAL_STORAGE )
4622 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004623 status = psa_validate_key_type_and_size_for_key_generation(
4624 attributes->core.type, attributes->core.bits );
4625 if( status != PSA_SUCCESS )
4626 goto exit;
4627
4628 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
4629 attributes->core.type,
4630 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02004631 }
4632 else
4633 {
4634 status = psa_driver_wrapper_get_key_buffer_size(
4635 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01004636 if( status != PSA_SUCCESS )
4637 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02004638 }
Ronald Cron977c2472020-10-13 08:32:21 +02004639
4640 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
4641 if( status != PSA_SUCCESS )
4642 goto exit;
4643 }
4644
Steven Cooreman2a1664c2020-07-20 15:33:08 +02004645 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02004646 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02004647
Ronald Cron2b56bc82020-10-05 10:02:26 +02004648 if( status != PSA_SUCCESS )
4649 psa_remove_key_data_from_memory( slot );
4650
Gilles Peskine11792082019-08-06 18:36:36 +02004651exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004652 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004653 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004654 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004655 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004656
Darryl Green0c6575a2018-11-07 16:05:30 +00004657 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004658}
4659
Gilles Peskinee59236f2018-01-27 23:32:46 +01004660/****************************************************************/
4661/* Module setup */
4662/****************************************************************/
4663
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004664#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01004665psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
4666 void (* entropy_init )( mbedtls_entropy_context *ctx ),
4667 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
4668{
4669 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4670 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004671 global_data.rng.entropy_init = entropy_init;
4672 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01004673 return( PSA_SUCCESS );
4674}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004675#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01004676
Gilles Peskinee59236f2018-01-27 23:32:46 +01004677void mbedtls_psa_crypto_free( void )
4678{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004679 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004680 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4681 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01004682 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004683 }
4684 /* Wipe all remaining data, including configuration.
4685 * In particular, this sets all state indicator to the value
4686 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01004687 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02004688#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02004689 /* Unregister all secure element drivers, so that we restart from
4690 * a pristine state. */
4691 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02004692#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004693}
4694
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004695#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
4696/** Recover a transaction that was interrupted by a power failure.
4697 *
4698 * This function is called during initialization, before psa_crypto_init()
4699 * returns. If this function returns a failure status, the initialization
4700 * fails.
4701 */
4702static psa_status_t psa_crypto_recover_transaction(
4703 const psa_crypto_transaction_t *transaction )
4704{
4705 switch( transaction->unknown.type )
4706 {
4707 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
4708 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01004709 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02004710 * is implemented.
4711 * https://github.com/ARMmbed/mbed-crypto/issues/218
4712 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004713 default:
4714 /* We found an unsupported transaction in the storage.
4715 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01004716 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004717 }
4718}
4719#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
4720
Gilles Peskinee59236f2018-01-27 23:32:46 +01004721psa_status_t psa_crypto_init( void )
4722{
Gilles Peskine66fb1262018-12-10 16:29:04 +01004723 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004724
Gilles Peskinec6b69072018-11-20 21:42:52 +01004725 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004726 if( global_data.initialized != 0 )
4727 return( PSA_SUCCESS );
4728
Gilles Peskine30524eb2020-11-13 17:02:26 +01004729 /* Initialize and seed the random generator. */
4730 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01004731 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01004732 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01004733 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004734 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004735 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004736
Gilles Peskine66fb1262018-12-10 16:29:04 +01004737 status = psa_initialize_key_slots( );
4738 if( status != PSA_SUCCESS )
4739 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01004740
Gilles Peskined9348f22019-10-01 15:22:29 +02004741#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4742 status = psa_init_all_se_drivers( );
4743 if( status != PSA_SUCCESS )
4744 goto exit;
4745#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
4746
Gilles Peskine4b734222019-07-24 15:56:31 +02004747#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02004748 status = psa_crypto_load_transaction( );
4749 if( status == PSA_SUCCESS )
4750 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02004751 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
4752 if( status != PSA_SUCCESS )
4753 goto exit;
4754 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02004755 }
4756 else if( status == PSA_ERROR_DOES_NOT_EXIST )
4757 {
4758 /* There's no transaction to complete. It's all good. */
4759 status = PSA_SUCCESS;
4760 }
Gilles Peskine4b734222019-07-24 15:56:31 +02004761#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02004762
Gilles Peskinec6b69072018-11-20 21:42:52 +01004763 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004764 global_data.initialized = 1;
4765
4766exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01004767 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004768 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01004769 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004770}
4771
4772#endif /* MBEDTLS_PSA_CRYPTO_C */