blob: 9e5e009324773706d74e1a9378ff65154be829bc [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020055#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056#define mbedtls_calloc calloc
57#define mbedtls_free free
58#endif
59
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010060#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020062#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000063#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020064#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/blowfish.h"
66#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020067#include "mbedtls/chacha20.h"
68#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/cipher.h"
70#include "mbedtls/ccm.h"
71#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020073#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010074#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010075#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/error.h"
77#include "mbedtls/gcm.h"
78#include "mbedtls/md2.h"
79#include "mbedtls/md4.h"
80#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010081#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000082#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010083#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000084#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010085#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000086#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010088#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010089#include "mbedtls/sha1.h"
90#include "mbedtls/sha256.h"
91#include "mbedtls/sha512.h"
92#include "mbedtls/xtea.h"
93
Gilles Peskine996deb12018-08-01 15:45:45 +020094#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
95
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010096/****************************************************************/
97/* Global data, support functions and library management */
98/****************************************************************/
99
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200100static int key_type_is_raw_bytes( psa_key_type_t type )
101{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200102 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200103}
104
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100105/* Values for psa_global_data_t::rng_state */
106#define RNG_NOT_INITIALIZED 0
107#define RNG_INITIALIZED 1
108#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100109
Gilles Peskine2d277862018-06-18 15:41:12 +0200110typedef struct
111{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100112 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100113 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100114 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100115} psa_global_data_t;
116
117static psa_global_data_t global_data;
118
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100119#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
120mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
121 &global_data.rng.drbg;
122#endif
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100130 /* Mbed TLS error codes can combine a high-level error code and a
131 * low-level error code. The low-level error usually reflects the
132 * root cause better, so dispatch on that preferably. */
133 int low_level_ret = - ( -ret & 0x007f );
134 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135 {
136 case 0:
137 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100138
139 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
140 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100141 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200142 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
143 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
144 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
145 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
146 case MBEDTLS_ERR_ASN1_INVALID_DATA:
147 return( PSA_ERROR_INVALID_ARGUMENT );
148 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
149 return( PSA_ERROR_INSUFFICIENT_MEMORY );
150 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
151 return( PSA_ERROR_BUFFER_TOO_SMALL );
152
Jaeden Amero93e21112019-02-20 13:57:28 +0000153#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000154 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000155#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100156 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
157 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100158
Jaeden Amero93e21112019-02-20 13:57:28 +0000159#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000160 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000161#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100162 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
163 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100164
165 case MBEDTLS_ERR_CCM_BAD_INPUT:
166 return( PSA_ERROR_INVALID_ARGUMENT );
167 case MBEDTLS_ERR_CCM_AUTH_FAILED:
168 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100169
Gilles Peskine26869f22019-05-06 15:25:00 +0200170 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
171 return( PSA_ERROR_INVALID_ARGUMENT );
172
173 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
174 return( PSA_ERROR_BAD_STATE );
175 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
176 return( PSA_ERROR_INVALID_SIGNATURE );
177
Gilles Peskinea5905292018-02-07 20:59:33 +0100178 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
179 return( PSA_ERROR_NOT_SUPPORTED );
180 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
181 return( PSA_ERROR_INVALID_ARGUMENT );
182 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
183 return( PSA_ERROR_INSUFFICIENT_MEMORY );
184 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
185 return( PSA_ERROR_INVALID_PADDING );
186 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200187 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100188 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
189 return( PSA_ERROR_INVALID_SIGNATURE );
190 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200191 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100192
Gilles Peskine82e57d12020-11-13 21:31:17 +0100193#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
194 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100195 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
196 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100197 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
198 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
199 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
200 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
201 return( PSA_ERROR_NOT_SUPPORTED );
202 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
203 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100204#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100205
206 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
207 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208
Gilles Peskinee59236f2018-01-27 23:32:46 +0100209 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
210 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
211 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
212 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100213
214 case MBEDTLS_ERR_GCM_AUTH_FAILED:
215 return( PSA_ERROR_INVALID_SIGNATURE );
216 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200217 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100218
Gilles Peskine82e57d12020-11-13 21:31:17 +0100219#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
220 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100221 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
222 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100223 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
224 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
225 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
226 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
227 return( PSA_ERROR_NOT_SUPPORTED );
228 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
229 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
230#endif
231
Gilles Peskinea5905292018-02-07 20:59:33 +0100232 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
233 return( PSA_ERROR_NOT_SUPPORTED );
234 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
235 return( PSA_ERROR_INVALID_ARGUMENT );
236 case MBEDTLS_ERR_MD_ALLOC_FAILED:
237 return( PSA_ERROR_INSUFFICIENT_MEMORY );
238 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
239 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100240
Gilles Peskinef76aa772018-10-29 19:24:33 +0100241 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
242 return( PSA_ERROR_STORAGE_FAILURE );
243 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
244 return( PSA_ERROR_INVALID_ARGUMENT );
245 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
246 return( PSA_ERROR_INVALID_ARGUMENT );
247 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
248 return( PSA_ERROR_BUFFER_TOO_SMALL );
249 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
250 return( PSA_ERROR_INVALID_ARGUMENT );
251 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
252 return( PSA_ERROR_INVALID_ARGUMENT );
253 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
254 return( PSA_ERROR_INVALID_ARGUMENT );
255 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
256 return( PSA_ERROR_INSUFFICIENT_MEMORY );
257
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100258 case MBEDTLS_ERR_PK_ALLOC_FAILED:
259 return( PSA_ERROR_INSUFFICIENT_MEMORY );
260 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
261 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
262 return( PSA_ERROR_INVALID_ARGUMENT );
263 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100264 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100265 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
266 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
267 return( PSA_ERROR_INVALID_ARGUMENT );
268 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
269 return( PSA_ERROR_NOT_SUPPORTED );
270 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
271 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
272 return( PSA_ERROR_NOT_PERMITTED );
273 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
274 return( PSA_ERROR_INVALID_ARGUMENT );
275 case MBEDTLS_ERR_PK_INVALID_ALG:
276 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
277 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
278 return( PSA_ERROR_NOT_SUPPORTED );
279 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
280 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100281
Gilles Peskineff2d2002019-05-06 15:26:23 +0200282 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
283 return( PSA_ERROR_HARDWARE_FAILURE );
284 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
285 return( PSA_ERROR_NOT_SUPPORTED );
286
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
288 return( PSA_ERROR_INVALID_ARGUMENT );
289 case MBEDTLS_ERR_RSA_INVALID_PADDING:
290 return( PSA_ERROR_INVALID_PADDING );
291 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
292 return( PSA_ERROR_HARDWARE_FAILURE );
293 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
294 return( PSA_ERROR_INVALID_ARGUMENT );
295 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
296 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200297 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
299 return( PSA_ERROR_INVALID_SIGNATURE );
300 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
301 return( PSA_ERROR_BUFFER_TOO_SMALL );
302 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100303 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200304
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
306 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100307
itayzafrir5c753392018-05-08 11:18:38 +0300308 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300309 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300310 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300311 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
312 return( PSA_ERROR_BUFFER_TOO_SMALL );
313 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
314 return( PSA_ERROR_NOT_SUPPORTED );
315 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
316 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
317 return( PSA_ERROR_INVALID_SIGNATURE );
318 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
319 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100320 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
321 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100322
Janos Follatha13b9052019-11-22 12:48:59 +0000323 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
324 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300325
Gilles Peskinee59236f2018-01-27 23:32:46 +0100326 default:
David Saadab4ecc272019-02-14 13:48:10 +0200327 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100328 }
329}
330
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200331
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200332
333
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334/****************************************************************/
335/* Key management */
336/****************************************************************/
337
Gilles Peskine73167e12019-07-12 23:44:37 +0200338#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
339static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
340{
Gilles Peskine8e338702019-07-30 20:06:31 +0200341 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200342}
343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
344
John Durkop07cc04a2020-11-16 22:08:34 -0800345/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
346 * current test driver in key_management.c is using this function
347 * when accelerators are used for ECC key pair and public key.
348 * Once that dependency is resolved these guards can be removed.
349 */
John Durkop9814fa22020-11-04 12:28:15 -0800350#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800351 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
352 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
353 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100354mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 size_t bits,
356 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200357{
358 switch( curve )
359 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100360 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100362 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100363#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100364 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100365 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100366#endif
367#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100368 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100369 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100370#endif
371#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100372 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100373 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100374#endif
375#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#endif
379#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100380 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100381 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100382 case 528:
383 if( bits_is_sloppy )
384 return( MBEDTLS_ECP_DP_SECP521R1 );
385 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100386#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100387 }
388 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100389
Paul Elliott8ff510a2020-06-02 17:19:28 +0100390 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100393#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#endif
397#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100398 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100399 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100400#endif
401#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100402 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100403 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100404#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100405 }
406 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100407
Paul Elliott8ff510a2020-06-02 17:19:28 +0100408 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100414 case 256:
415 if( bits_is_sloppy )
416 return( MBEDTLS_ECP_DP_CURVE25519 );
417 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100418#endif
419#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100420 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100422#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100423 }
424 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100425
Paul Elliott8ff510a2020-06-02 17:19:28 +0100426 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100429#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100430 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100431 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100432#endif
433#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100434 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100435 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100436#endif
437#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100438 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100440#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100441 }
442 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200443 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100444
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100445 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100446 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200447}
John Durkop9814fa22020-11-04 12:28:15 -0800448#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800449 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
450 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
451 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200452
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200453static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
454 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200455{
456 /* Check that the bit size is acceptable for the key type */
457 switch( type )
458 {
459 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200460 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200461 case PSA_KEY_TYPE_DERIVE:
462 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_AES:
465 if( bits != 128 && bits != 192 && bits != 256 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200470 case PSA_KEY_TYPE_CAMELLIA:
471 if( bits != 128 && bits != 192 && bits != 256 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100475#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200476 case PSA_KEY_TYPE_DES:
477 if( bits != 64 && bits != 128 && bits != 192 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
479 break;
480#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100481#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200482 case PSA_KEY_TYPE_ARC4:
483 if( bits < 8 || bits > 2048 )
484 return( PSA_ERROR_INVALID_ARGUMENT );
485 break;
486#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100487#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200488 case PSA_KEY_TYPE_CHACHA20:
489 if( bits != 256 )
490 return( PSA_ERROR_INVALID_ARGUMENT );
491 break;
492#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200493 default:
494 return( PSA_ERROR_NOT_SUPPORTED );
495 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200496 if( bits % 8 != 0 )
497 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200498
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200499 return( PSA_SUCCESS );
500}
501
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 *
Steven Cooremancd640932021-03-08 12:00:27 +0100504 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
505 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 *
507 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100508 * \param[in] key_type The key type of the key to be used with the
509 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100510 *
511 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100512 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100513 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100514 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100516MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100517 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100518 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100519{
Steven Cooremancd640932021-03-08 12:00:27 +0100520 if( PSA_ALG_IS_HMAC( algorithm ) )
521 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100522 if( key_type == PSA_KEY_TYPE_HMAC )
523 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100524 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100525
526 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100527 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100528 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
529 * key. */
530 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
531 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
532 {
533 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
534 * the block length (larger than 1) for block ciphers. */
535 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
536 return( PSA_SUCCESS );
537 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100538 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100539
540 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100541}
542
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200543psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
544 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200545{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200547 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200548
Ronald Cronea0f8a62020-11-25 17:52:23 +0100549 slot->key.data = mbedtls_calloc( 1, buffer_length );
550 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200551 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200552
Ronald Cronea0f8a62020-11-25 17:52:23 +0100553 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200554 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200555}
556
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200557psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
558 const uint8_t* data,
559 size_t data_length )
560{
561 psa_status_t status = psa_allocate_buffer_to_slot( slot,
562 data_length );
563 if( status != PSA_SUCCESS )
564 return( status );
565
Ronald Cronea0f8a62020-11-25 17:52:23 +0100566 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200567 return( PSA_SUCCESS );
568}
569
Ronald Crona0fe59f2020-11-29 11:14:53 +0100570psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100571 const psa_key_attributes_t *attributes,
572 const uint8_t *data, size_t data_length,
573 uint8_t *key_buffer, size_t key_buffer_size,
574 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100575{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100576 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
577 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100578
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200579 /* zero-length keys are never supported. */
580 if( data_length == 0 )
581 return( PSA_ERROR_NOT_SUPPORTED );
582
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100583 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100584 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Steven Cooreman75b74362020-07-28 14:30:13 +0200587 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
588 if( data_length > SIZE_MAX / 8 )
589 return( PSA_ERROR_NOT_SUPPORTED );
590
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200591 /* Enforce a size limit, and in particular ensure that the bit
592 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200594 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200595
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100596 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200598 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200599
Ronald Crondd04d422020-11-28 15:14:42 +0100600 /* Copy the key material. */
601 memcpy( key_buffer, data, data_length );
602 *key_buffer_length = data_length;
603 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200604
Steven Cooreman40120f62020-10-29 11:42:22 +0100605 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100606 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200608 {
John Durkop9814fa22020-11-04 12:28:15 -0800609#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
610 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100611 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200612 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100613 return( mbedtls_psa_ecp_import_key( attributes,
614 data, data_length,
615 key_buffer, key_buffer_size,
616 key_buffer_length,
617 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100618 }
John Durkop9814fa22020-11-04 12:28:15 -0800619#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
620 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700621#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
622 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100623 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200624 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100625 return( mbedtls_psa_rsa_import_key( attributes,
626 data, data_length,
627 key_buffer, key_buffer_size,
628 key_buffer_length,
629 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200630 }
John Durkop9814fa22020-11-04 12:28:15 -0800631#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
632 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100633 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100634
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100636}
637
Gilles Peskinef603c712019-01-19 13:40:11 +0100638/** Calculate the intersection of two algorithm usage policies.
639 *
640 * Return 0 (which allows no operation) on incompatibility.
641 */
642static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100643 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100644 psa_algorithm_t alg1,
645 psa_algorithm_t alg2 )
646{
Gilles Peskine549ea862019-05-22 11:45:59 +0200647 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100648 if( alg1 == alg2 )
649 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
652 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
653 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
654 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100655 {
Steven Cooreman03488022021-02-18 12:07:20 +0100656 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
657 return( alg2 );
658 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
659 return( alg1 );
660 }
661 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100662 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100663 * restrictive tag length. */
664 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
665 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
666 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
667 {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100673 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
674 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100675 {
Steven Cooremancd640932021-03-08 12:00:27 +0100676 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
677 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100678 }
679 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100680 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100681 ( alg1_len <= alg2_len ) )
682 {
683 return( alg2 );
684 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100685 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100686 ( alg2_len <= alg1_len ) )
687 {
688 return( alg1 );
689 }
690 }
691 /* If the policies are from the same MAC family, check whether one
692 * of them is a minimum-MAC-length policy. Calculate the most
693 * restrictive tag length. */
694 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
695 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
696 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
697 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100698 /* Validate the combination of key type and algorithm. Since the base
699 * algorithm of alg1 and alg2 are the same, we only need this once. */
700 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100702
Steven Cooreman31a876d2021-03-03 20:47:40 +0100703 /* Get the (exact or at-least) output lengths for both sides of the
704 * requested intersection. None of the currently supported algorithms
705 * have an output length dependent on the actual key size, so setting it
706 * to a bogus value of 0 is currently OK.
707 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100708 * Note that for at-least-this-length wildcard algorithms, the output
709 * length is set to the shortest allowed length, which allows us to
710 * calculate the most restrictive tag length for the intersection. */
711 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
712 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100713 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100714
Steven Cooremana1d83222021-02-25 10:20:29 +0100715 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100716 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
717 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100718 {
Steven Cooremancd640932021-03-08 12:00:27 +0100719 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100720 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100721
722 /* If only one is an at-least-this-length policy, the intersection would
723 * be the other (fixed-length) policy as long as said fixed length is
724 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100725 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100726 {
Steven Cooremancd640932021-03-08 12:00:27 +0100727 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100728 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100729 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100730 {
Steven Cooremancd640932021-03-08 12:00:27 +0100731 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100732 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100733
Steven Cooremancd640932021-03-08 12:00:27 +0100734 /* If none of them are wildcards, check whether they define the same tag
735 * length. This is still possible here when one is default-length and
736 * the other specific-length. Ensure to always return the
737 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100738 if( alg1_len == alg2_len )
739 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100740 }
741 /* If the policies are incompatible, allow nothing. */
742 return( 0 );
743}
744
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100745static int psa_key_algorithm_permits( psa_key_type_t key_type,
746 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200747 psa_algorithm_t requested_alg )
748{
Gilles Peskine549ea862019-05-22 11:45:59 +0200749 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200750 if( requested_alg == policy_alg )
751 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100752 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
753 * and requested_alg is the same hash-and-sign family with any hash,
754 * then requested_alg is compliant with policy_alg. */
755 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
756 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200757 {
Steven Cooreman03488022021-02-18 12:07:20 +0100758 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
759 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
760 }
761 /* If policy_alg is a wildcard AEAD algorithm of the same base as
762 * the requested algorithm, check the requested tag length to be
763 * equal-length or longer than the wildcard-specified length. */
764 if( PSA_ALG_IS_AEAD( policy_alg ) &&
765 PSA_ALG_IS_AEAD( requested_alg ) &&
766 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
767 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100768 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100769 {
770 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
771 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
772 }
Steven Cooremancd640932021-03-08 12:00:27 +0100773 /* If policy_alg is a MAC algorithm of the same base as the requested
774 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100775 if( PSA_ALG_IS_MAC( policy_alg ) &&
776 PSA_ALG_IS_MAC( requested_alg ) &&
777 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100778 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100779 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100780 /* Validate the combination of key type and algorithm. Since the policy
781 * and requested algorithms are the same, we only need this once. */
782 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784
Steven Cooreman31a876d2021-03-03 20:47:40 +0100785 /* Get both the requested output length for the algorithm which is to be
786 * verified, and the default output length for the base algorithm.
787 * Note that none of the currently supported algorithms have an output
788 * length dependent on actual key size, so setting it to a bogus value
789 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100790 size_t requested_output_length = PSA_MAC_LENGTH(
791 key_type, 0, requested_alg );
792 size_t default_output_length = PSA_MAC_LENGTH(
793 key_type, 0,
794 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100795
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796 /* If the policy is default-length, only allow an algorithm with
797 * a declared exact-length matching the default. */
798 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100799 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100800
801 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100802 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100803 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
804 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
805 {
806 return( 1 );
807 }
808
Steven Cooremancd640932021-03-08 12:00:27 +0100809 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
810 * check for the requested MAC length to be equal to or longer than the
811 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100812 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
813 {
814 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100815 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100816 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200817 }
Steven Cooremance48e852020-10-05 16:02:45 +0200818 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200819 * a key derivation with that key agreement should also be allowed. This
820 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200821 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
822 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
823 {
824 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
825 policy_alg );
826 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100827 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200828 return( 0 );
829}
830
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100831/** Test whether a policy permits an algorithm.
832 *
833 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100835 * \note This function requires providing the key type for which the policy is
836 * being validated, since some algorithm policy definitions (e.g. MAC)
837 * have different properties depending on what kind of cipher it is
838 * combined with.
839 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100840 * \retval PSA_SUCCESS When \p alg is a specific algorithm
841 * allowed by the \p policy.
842 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
843 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
844 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100845 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100846static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100847 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100848 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100849{
Steven Cooremand788fab2021-02-25 11:29:17 +0100850 /* '0' is not a valid algorithm */
851 if( alg == 0 )
852 return( PSA_ERROR_INVALID_ARGUMENT );
853
Steven Cooreman7e39f052021-02-23 14:18:32 +0100854 /* A requested algorithm cannot be a wildcard. */
855 if( PSA_ALG_IS_WILDCARD( alg ) )
856 return( PSA_ERROR_INVALID_ARGUMENT );
857
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100858 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
859 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100860 return( PSA_SUCCESS );
861 else
862 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100863}
864
Gilles Peskinef603c712019-01-19 13:40:11 +0100865/** Restrict a key policy based on a constraint.
866 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100867 * \note This function requires providing the key type for which the policy is
868 * being restricted, since some algorithm policy definitions (e.g. MAC)
869 * have different properties depending on what kind of cipher it is
870 * combined with.
871 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100872 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 * \param[in,out] policy The policy to restrict.
874 * \param[in] constraint The policy constraint to apply.
875 *
876 * \retval #PSA_SUCCESS
877 * \c *policy contains the intersection of the original value of
878 * \c *policy and \c *constraint.
879 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100880 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100881 * \c *policy is unchanged.
882 */
883static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100884 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100885 psa_key_policy_t *policy,
886 const psa_key_policy_t *constraint )
887{
888 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100889 psa_key_policy_algorithm_intersection( key_type, policy->alg,
890 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200891 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100892 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
893 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100894 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
895 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200896 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
897 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100898 policy->usage &= constraint->usage;
899 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200900 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100901 return( PSA_SUCCESS );
902}
903
Ronald Cron5c522922020-11-14 16:35:34 +0100904/** Get the description of a key given its identifier and policy constraints
905 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200906 *
Ronald Cron5c522922020-11-14 16:35:34 +0100907 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100908 * nonzero, the key must allow operations with this algorithm. If \p alg is
909 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100910 *
Ronald Cron5c522922020-11-14 16:35:34 +0100911 * In case of a persistent key, the function loads the description of the key
912 * into a key slot if not already done.
913 *
914 * On success, the returned key slot is locked. It is the responsibility of
915 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200916 */
Ronald Cron5c522922020-11-14 16:35:34 +0100917static psa_status_t psa_get_and_lock_key_slot_with_policy(
918 mbedtls_svc_key_id_t key,
919 psa_key_slot_t **p_slot,
920 psa_key_usage_t usage,
921 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100922{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200923 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
924 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Ronald Cron5c522922020-11-14 16:35:34 +0100926 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100927 if( status != PSA_SUCCESS )
928 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200929 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100930
931 /* Enforce that usage policy for the key slot contains all the flags
932 * required by the usage parameter. There is one exception: public
933 * keys can always be exported, so we treat public key objects as
934 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200935 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100936 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
Gilles Peskine8e338702019-07-30 20:06:31 +0200938 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100939 {
940 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200941 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100942 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100943
944 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945 if( alg != 0 )
946 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100947 status = psa_key_policy_permits( &slot->attr.policy,
948 slot->attr.type,
949 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100950 if( status != PSA_SUCCESS )
951 goto error;
952 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100953
Darryl Green06fd18d2018-07-16 11:21:11 +0100954 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200955
956error:
957 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100958 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
960 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100961}
Darryl Green940d72c2018-07-13 13:18:51 +0100962
Ronald Cron5c522922020-11-14 16:35:34 +0100963/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 *
965 * A transparent key is a key for which the key material is directly
966 * available, as opposed to a key in a secure element.
967 *
Ronald Cron5c522922020-11-14 16:35:34 +0100968 * This is a temporary function to use instead of
969 * psa_get_and_lock_key_slot_with_policy() until secure element support is
970 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 *
Ronald Cron5c522922020-11-14 16:35:34 +0100972 * On success, the returned key slot is locked. It is the responsibility of the
973 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200974 */
975#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
980 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981{
Ronald Cron5c522922020-11-14 16:35:34 +0100982 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
983 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200984 if( status != PSA_SUCCESS )
985 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200986
Gilles Peskineadad8132019-07-25 11:31:23 +0200987 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200988 {
Ronald Cron5c522922020-11-14 16:35:34 +0100989 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200990 *p_slot = NULL;
991 return( PSA_ERROR_NOT_SUPPORTED );
992 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200993
Gilles Peskine28f8f302019-07-24 13:30:31 +0200994 return( PSA_SUCCESS );
995}
996#else /* MBEDTLS_PSA_CRYPTO_SE_C */
997/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100998#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
999 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001000#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1001
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001002psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001003{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001004 /* Data pointer will always be either a valid pointer or NULL in an
1005 * initialized slot, so we can just free it. */
1006 if( slot->key.data != NULL )
1007 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1008
1009 mbedtls_free( slot->key.data );
1010 slot->key.data = NULL;
1011 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001012
1013 return( PSA_SUCCESS );
1014}
1015
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001016/** Completely wipe a slot in memory, including its policy.
1017 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001018psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001019{
1020 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001021
Ronald Cron5c522922020-11-14 16:35:34 +01001022 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001023 {
Ronald Cronddd3d052020-10-30 14:07:07 +01001024 status = PSA_ERROR_CORRUPTION_DETECTED;
1025 }
1026
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001027 /* Multipart operations may still be using the key. This is safe
1028 * because all multipart operation objects are independent from
1029 * the key slot: if they need to access the key after the setup
1030 * phase, they have a copy of the key. Note that this means that
1031 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001032 /* At this point, key material and other type-specific content has
1033 * been wiped. Clear remaining metadata. We can call memset and not
1034 * zeroize because the metadata is not particularly sensitive. */
1035 memset( slot, 0, sizeof( *slot ) );
1036 return( status );
1037}
1038
Ronald Croncf56a0a2020-08-04 09:51:30 +02001039psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001040{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001041 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001042 psa_status_t status; /* status of the last operation */
1043 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001044#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1045 psa_se_drv_table_entry_t *driver;
1046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001047
Ronald Croncf56a0a2020-08-04 09:51:30 +02001048 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001049 return( PSA_SUCCESS );
1050
Ronald Cronf2911112020-10-29 17:51:10 +01001051 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001052 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001053 * key, this will load the key description from persistent memory if not
1054 * done yet. We cannot avoid this loading as without it we don't know if
1055 * the key is operated by an SE or not and this information is needed by
1056 * the current implementation.
1057 */
Ronald Cron5c522922020-11-14 16:35:34 +01001058 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001059 if( status != PSA_SUCCESS )
1060 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001061
Ronald Cronf2911112020-10-29 17:51:10 +01001062 /*
1063 * If the key slot containing the key description is under access by the
1064 * library (apart from the present access), the key cannot be destroyed
1065 * yet. For the time being, just return in error. Eventually (to be
1066 * implemented), the key should be destroyed when all accesses have
1067 * stopped.
1068 */
Ronald Cron5c522922020-11-14 16:35:34 +01001069 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001070 {
Ronald Cron5c522922020-11-14 16:35:34 +01001071 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001072 return( PSA_ERROR_GENERIC_ERROR );
1073 }
1074
Gilles Peskine354f7672019-07-12 23:46:38 +02001075#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001076 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001077 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001078 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001079 /* For a key in a secure element, we need to do three things:
1080 * remove the key file in internal storage, destroy the
1081 * key inside the secure element, and update the driver's
1082 * persistent data. Start a transaction that will encompass these
1083 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001084 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001085 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001086 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001087 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 status = psa_crypto_save_transaction( );
1089 if( status != PSA_SUCCESS )
1090 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001091 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 /* We should still try to destroy the key in the secure
1093 * element and the key metadata in storage. This is especially
1094 * important if the error is that the storage is full.
1095 * But how to do it exactly without risking an inconsistent
1096 * state after a reset?
1097 * https://github.com/ARMmbed/mbed-crypto/issues/215
1098 */
1099 overall_status = status;
1100 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001101 }
1102
Ronald Cronea0f8a62020-11-25 17:52:23 +01001103 status = psa_destroy_se_key( driver,
1104 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001105 if( overall_status == PSA_SUCCESS )
1106 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001107 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001108#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1109
Darryl Greend49a4992018-06-18 17:27:26 +01001110#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001111 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001112 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001113 status = psa_destroy_persistent_key( slot->attr.id );
1114 if( overall_status == PSA_SUCCESS )
1115 overall_status = status;
1116
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001117 /* TODO: other slots may have a copy of the same key. We should
1118 * invalidate them.
1119 * https://github.com/ARMmbed/mbed-crypto/issues/214
1120 */
Darryl Greend49a4992018-06-18 17:27:26 +01001121 }
1122#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001123
Gilles Peskinefc762652019-07-22 19:30:34 +02001124#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1125 if( driver != NULL )
1126 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001127 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001128 if( overall_status == PSA_SUCCESS )
1129 overall_status = status;
1130 status = psa_crypto_stop_transaction( );
1131 if( overall_status == PSA_SUCCESS )
1132 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001133 }
1134#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1135
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001136#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1137exit:
1138#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001139 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1141 if( overall_status == PSA_SUCCESS )
1142 overall_status = status;
1143 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001144}
1145
John Durkop07cc04a2020-11-16 22:08:34 -08001146#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001147 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001148static psa_status_t psa_get_rsa_public_exponent(
1149 const mbedtls_rsa_context *rsa,
1150 psa_key_attributes_t *attributes )
1151{
1152 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001154 uint8_t *buffer = NULL;
1155 size_t buflen;
1156 mbedtls_mpi_init( &mpi );
1157
1158 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1159 if( ret != 0 )
1160 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001161 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1162 {
1163 /* It's the default value, which is reported as an empty string,
1164 * so there's nothing to do. */
1165 goto exit;
1166 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001167
1168 buflen = mbedtls_mpi_size( &mpi );
1169 buffer = mbedtls_calloc( 1, buflen );
1170 if( buffer == NULL )
1171 {
1172 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1173 goto exit;
1174 }
1175 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1176 if( ret != 0 )
1177 goto exit;
1178 attributes->domain_parameters = buffer;
1179 attributes->domain_parameters_size = buflen;
1180
1181exit:
1182 mbedtls_mpi_free( &mpi );
1183 if( ret != 0 )
1184 mbedtls_free( buffer );
1185 return( mbedtls_to_psa_error( ret ) );
1186}
John Durkop07cc04a2020-11-16 22:08:34 -08001187#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001188 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001189
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001190/** Retrieve all the publicly-accessible attributes of a key.
1191 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001192psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001193 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001194{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001196 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001197 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001198
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001199 psa_reset_key_attributes( attributes );
1200
Ronald Cron5c522922020-11-14 16:35:34 +01001201 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001202 if( status != PSA_SUCCESS )
1203 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001204
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001205 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1207 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1208
1209#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1210 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001211 psa_set_key_slot_number( attributes,
1212 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001213#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001214
Gilles Peskine8e338702019-07-30 20:06:31 +02001215 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001216 {
John Durkop07cc04a2020-11-16 22:08:34 -08001217#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001218 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001219 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001220 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001221#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001222 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001223 * is not yet implemented.
1224 * https://github.com/ARMmbed/mbed-crypto/issues/216
1225 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001226 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001227 break;
1228#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001229 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001230 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001231
Ronald Cron90857082020-11-25 14:58:33 +01001232 status = mbedtls_psa_rsa_load_representation(
1233 slot->attr.type,
1234 slot->key.data,
1235 slot->key.bytes,
1236 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001237 if( status != PSA_SUCCESS )
1238 break;
1239
Steven Cooremana2371e52020-07-28 14:30:39 +02001240 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001241 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001242 mbedtls_rsa_free( rsa );
1243 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001244 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001245 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001246#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001247 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248 default:
1249 /* Nothing else to do. */
1250 break;
1251 }
1252
1253 if( status != PSA_SUCCESS )
1254 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001255
Ronald Cron5c522922020-11-14 16:35:34 +01001256 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001257
Ronald Cron5c522922020-11-14 16:35:34 +01001258 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001259}
1260
Gilles Peskinec8000c02019-08-02 20:15:51 +02001261#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1262psa_status_t psa_get_key_slot_number(
1263 const psa_key_attributes_t *attributes,
1264 psa_key_slot_number_t *slot_number )
1265{
1266 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1267 {
1268 *slot_number = attributes->slot_number;
1269 return( PSA_SUCCESS );
1270 }
1271 else
1272 return( PSA_ERROR_INVALID_ARGUMENT );
1273}
1274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1275
Ronald Crond18b5f82020-11-25 16:46:05 +01001276static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1277 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001278 uint8_t *data,
1279 size_t data_size,
1280 size_t *data_length )
1281{
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001283 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001284 memcpy( data, key_buffer, key_buffer_size );
1285 memset( data + key_buffer_size, 0,
1286 data_size - key_buffer_size );
1287 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001288 return( PSA_SUCCESS );
1289}
1290
Ronald Cron7285cda2020-11-26 14:46:37 +01001291psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001292 const psa_key_attributes_t *attributes,
1293 const uint8_t *key_buffer, size_t key_buffer_size,
1294 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001295{
Ronald Crond18b5f82020-11-25 16:46:05 +01001296 psa_key_type_t type = attributes->core.type;
1297
Ronald Crond18b5f82020-11-25 16:46:05 +01001298 if( key_type_is_raw_bytes( type ) ||
1299 PSA_KEY_TYPE_IS_RSA( type ) ||
1300 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001301 {
1302 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001303 key_buffer, key_buffer_size,
1304 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001305 }
1306 else
1307 {
1308 /* This shouldn't happen in the reference implementation, but
1309 it is valid for a special-purpose implementation to omit
1310 support for exporting certain key types. */
1311 return( PSA_ERROR_NOT_SUPPORTED );
1312 }
1313}
1314
1315psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1316 uint8_t *data,
1317 size_t data_size,
1318 size_t *data_length )
1319{
1320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1321 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1322 psa_key_slot_t *slot;
1323
Ronald Crone907e552021-01-18 13:22:38 +01001324 /* Reject a zero-length output buffer now, since this can never be a
1325 * valid key representation. This way we know that data must be a valid
1326 * pointer and we can do things like memset(data, ..., data_size). */
1327 if( data_size == 0 )
1328 return( PSA_ERROR_BUFFER_TOO_SMALL );
1329
Ronald Cron9486f9d2020-11-26 13:36:23 +01001330 /* Set the key to empty now, so that even when there are errors, we always
1331 * set data_length to a value between 0 and data_size. On error, setting
1332 * the key to empty is a good choice because an empty key representation is
1333 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001334 *data_length = 0;
1335
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 /* Export requires the EXPORT flag. There is an exception for public keys,
1337 * which don't require any flag, but
1338 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1339 */
1340 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1341 PSA_KEY_USAGE_EXPORT, 0 );
1342 if( status != PSA_SUCCESS )
1343 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001344
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 psa_key_attributes_t attributes = {
1346 .core = slot->attr
1347 };
Ronald Cron67227982020-11-26 15:16:05 +01001348 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 slot->key.data, slot->key.bytes,
1350 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001351
Ronald Cron9486f9d2020-11-26 13:36:23 +01001352 unlock_status = psa_unlock_key_slot( slot );
1353
1354 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer,
1360 size_t key_buffer_size,
1361 uint8_t *data,
1362 size_t data_size,
1363 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001364{
Ronald Crond18b5f82020-11-25 16:46:05 +01001365 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001368 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001369 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001370 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001371 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001373 key_buffer, key_buffer_size,
1374 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001375 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001376
Ronald Crond18b5f82020-11-25 16:46:05 +01001377 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001378 {
John Durkop0e005192020-10-31 22:06:54 -07001379#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1380 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001381 return( mbedtls_psa_rsa_export_public_key( attributes,
1382 key_buffer,
1383 key_buffer_size,
1384 data,
1385 data_size,
1386 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001387#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001388 /* We don't know how to convert a private RSA key to public. */
1389 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001392 }
1393 else
Moran Pekera998bc62018-04-16 18:16:20 +03001394 {
John Durkop6ba40d12020-11-10 08:50:04 -08001395#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1396 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001397 return( mbedtls_psa_ecp_export_public_key( attributes,
1398 key_buffer,
1399 key_buffer_size,
1400 data,
1401 data_size,
1402 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001403#else
1404 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001405 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001406#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1407 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001408 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001409 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001410 else
1411 {
1412 /* This shouldn't happen in the reference implementation, but
1413 it is valid for a special-purpose implementation to omit
1414 support for exporting certain key types. */
1415 return( PSA_ERROR_NOT_SUPPORTED );
1416 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001417}
Ronald Crond18b5f82020-11-25 16:46:05 +01001418
Ronald Croncf56a0a2020-08-04 09:51:30 +02001419psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001420 uint8_t *data,
1421 size_t data_size,
1422 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001423{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001426 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001427
Ronald Crone907e552021-01-18 13:22:38 +01001428 /* Reject a zero-length output buffer now, since this can never be a
1429 * valid key representation. This way we know that data must be a valid
1430 * pointer and we can do things like memset(data, ..., data_size). */
1431 if( data_size == 0 )
1432 return( PSA_ERROR_BUFFER_TOO_SMALL );
1433
Darryl Greendd8fb772018-11-07 16:00:44 +00001434 /* Set the key to empty now, so that even when there are errors, we always
1435 * set data_length to a value between 0 and data_size. On error, setting
1436 * the key to empty is a good choice because an empty key representation is
1437 * unlikely to be accepted anywhere. */
1438 *data_length = 0;
1439
1440 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001441 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001442 if( status != PSA_SUCCESS )
1443 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001444
Ronald Cron9486f9d2020-11-26 13:36:23 +01001445 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1446 {
1447 status = PSA_ERROR_INVALID_ARGUMENT;
1448 goto exit;
1449 }
1450
Ronald Crond18b5f82020-11-25 16:46:05 +01001451 psa_key_attributes_t attributes = {
1452 .core = slot->attr
1453 };
Ronald Cron67227982020-11-26 15:16:05 +01001454 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001455 &attributes, slot->key.data, slot->key.bytes,
1456 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001457
1458exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001459 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001460
Ronald Cron5c522922020-11-14 16:35:34 +01001461 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001462}
1463
Gilles Peskine91e8c332019-08-02 19:19:39 +02001464#if defined(static_assert)
1465static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1466 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001467static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001468 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001469static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001470 "One or more key attribute flag is listed as both internal-only and external-only" );
1471#endif
1472
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001473/** Validate that a key policy is internally well-formed.
1474 *
1475 * This function only rejects invalid policies. It does not validate the
1476 * consistency of the policy with respect to other attributes of the key
1477 * such as the key type.
1478 */
1479static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001480{
1481 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001482 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001483 PSA_KEY_USAGE_ENCRYPT |
1484 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001485 PSA_KEY_USAGE_SIGN_MESSAGE |
1486 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001487 PSA_KEY_USAGE_SIGN_HASH |
1488 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001489 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001490 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1491 return( PSA_ERROR_INVALID_ARGUMENT );
1492
Gilles Peskine4747d192019-04-17 15:05:45 +02001493 return( PSA_SUCCESS );
1494}
1495
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001496/** Validate the internal consistency of key attributes.
1497 *
1498 * This function only rejects invalid attribute values. If does not
1499 * validate the consistency of the attributes with any key data that may
1500 * be involved in the creation of the key.
1501 *
1502 * Call this function early in the key creation process.
1503 *
1504 * \param[in] attributes Key attributes for the new key.
1505 * \param[out] p_drv On any return, the driver for the key, if any.
1506 * NULL for a transparent key.
1507 *
1508 */
1509static psa_status_t psa_validate_key_attributes(
1510 const psa_key_attributes_t *attributes,
1511 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001512{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001513 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001514 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001515 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001516
Ronald Cron54b90082020-10-29 15:26:43 +01001517 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001518 if( status != PSA_SUCCESS )
1519 return( status );
1520
Ronald Crond2ed4812020-07-17 16:11:30 +02001521 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001522 if( status != PSA_SUCCESS )
1523 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001524
Ronald Cron65f38a32020-10-23 17:11:13 +02001525 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1526 {
1527 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1528 return( PSA_ERROR_INVALID_ARGUMENT );
1529 }
1530 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001531 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001532 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1533 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001534 }
1535
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001536 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001537 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001538 return( status );
1539
1540 /* Refuse to create overly large keys.
1541 * Note that this doesn't trigger on import if the attributes don't
1542 * explicitly specify a size (so psa_get_key_bits returns 0), so
1543 * psa_import_key() needs its own checks. */
1544 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1545 return( PSA_ERROR_NOT_SUPPORTED );
1546
Gilles Peskine91e8c332019-08-02 19:19:39 +02001547 /* Reject invalid flags. These should not be reachable through the API. */
1548 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1549 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1550 return( PSA_ERROR_INVALID_ARGUMENT );
1551
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001552 return( PSA_SUCCESS );
1553}
1554
Gilles Peskine4747d192019-04-17 15:05:45 +02001555/** Prepare a key slot to receive key material.
1556 *
1557 * This function allocates a key slot and sets its metadata.
1558 *
1559 * If this function fails, call psa_fail_key_creation().
1560 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001561 * This function is intended to be used as follows:
1562 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001563 * it with the specified attributes, and in case of a volatile key assign it
1564 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001565 * -# Populate the slot with the key material.
1566 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1567 * In case of failure at any step, stop the sequence and call
1568 * psa_fail_key_creation().
1569 *
Ronald Cron5c522922020-11-14 16:35:34 +01001570 * On success, the key slot is locked. It is the responsibility of the caller
1571 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001572 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001573 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001574 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001575 * \param[out] p_slot On success, a pointer to the prepared slot.
1576 * \param[out] p_drv On any return, the driver for the key, if any.
1577 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001578 *
1579 * \retval #PSA_SUCCESS
1580 * The key slot is ready to receive key material.
1581 * \return If this function fails, the key slot is an invalid state.
1582 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001583 */
1584static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001585 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001587 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001588 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001589{
1590 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001591 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001592 psa_key_slot_t *slot;
1593
Gilles Peskinedf179142019-07-15 22:02:14 +02001594 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001595 *p_drv = NULL;
1596
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001597 status = psa_validate_key_attributes( attributes, p_drv );
1598 if( status != PSA_SUCCESS )
1599 return( status );
1600
Ronald Cronc4d1b512020-07-31 11:26:37 +02001601 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001602 if( status != PSA_SUCCESS )
1603 return( status );
1604 slot = *p_slot;
1605
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001606 /* We're storing the declared bit-size of the key. It's up to each
1607 * creation mechanism to verify that this information is correct.
1608 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001609 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001610 * is optional (import, copy). In case of a volatile key, assign it the
1611 * volatile key identifier associated to the slot returned to contain its
1612 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001613
1614 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001615 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1616 {
1617#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1618 slot->attr.id = volatile_key_id;
1619#else
1620 slot->attr.id.key_id = volatile_key_id;
1621#endif
1622 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001623
Gilles Peskine91e8c332019-08-02 19:19:39 +02001624 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001625 * external-only flags, query `attributes`. Thanks to the check
1626 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001627 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001628 * may have set. */
1629 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001630
Gilles Peskinecbaff462019-07-12 23:46:04 +02001631#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001632 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001633 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001634 * create the key file in internal storage, create the
1635 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001636 * persistent data. This is done by starting a transaction that will
1637 * encompass these three actions.
1638 * For registering a volatile key, we just need to find an appropriate
1639 * slot number inside the SE. Since the key is designated volatile, creating
1640 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001641 /* The first thing to do is to find a slot number for the new key.
1642 * We save the slot number in persistent storage as part of the
1643 * transaction data. It will be needed to recover if the power
1644 * fails during the key creation process, to clean up on the secure
1645 * element side after restarting. Obtaining a slot number from the
1646 * secure element driver updates its persistent state, but we do not yet
1647 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001648 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001649 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001650 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001652 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001653 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001654 if( status != PSA_SUCCESS )
1655 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001656
1657 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001658 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001659 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1660 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001661 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001662 psa_crypto_transaction.key.id = slot->attr.id;
1663 status = psa_crypto_save_transaction( );
1664 if( status != PSA_SUCCESS )
1665 {
1666 (void) psa_crypto_stop_transaction( );
1667 return( status );
1668 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001669 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001670
1671 status = psa_copy_key_material_into_slot(
1672 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001673 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001674
1675 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1676 {
1677 /* Key registration only makes sense with a secure element. */
1678 return( PSA_ERROR_INVALID_ARGUMENT );
1679 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001680#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1681
Ronald Cronc4d1b512020-07-31 11:26:37 +02001682 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001683}
Gilles Peskine4747d192019-04-17 15:05:45 +02001684
1685/** Finalize the creation of a key once its key material has been set.
1686 *
1687 * This entails writing the key to persistent storage.
1688 *
1689 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001690 * See the documentation of psa_start_key_creation() for the intended use
1691 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001692 *
Ronald Cron5c522922020-11-14 16:35:34 +01001693 * If the finalization succeeds, the function unlocks the key slot (it was
1694 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1695 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001696 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001697 * \param[in,out] slot Pointer to the slot with key material.
1698 * \param[in] driver The secure element driver for the key,
1699 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001700 * \param[out] key On success, identifier of the key. Note that the
1701 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 *
1703 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001704 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001705 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1706 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1707 * \retval #PSA_ERROR_ALREADY_EXISTS
1708 * \retval #PSA_ERROR_DATA_INVALID
1709 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001710 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001711 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001712 * \return If this function fails, the key slot is an invalid state.
1713 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001714 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001715static psa_status_t psa_finish_key_creation(
1716 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001717 psa_se_drv_table_entry_t *driver,
1718 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001719{
1720 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001721 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001722 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001723
1724#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001725 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001727#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1728 if( driver != NULL )
1729 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001730 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 psa_key_slot_number_t slot_number =
1732 psa_key_slot_get_slot_number( slot ) ;
1733
Gilles Peskineb46bef22019-07-30 21:32:04 +02001734#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001735 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001736 sizeof( data.slot_number ),
1737 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001738#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001739 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001740 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001741 (uint8_t*) &data,
1742 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001743 }
1744 else
1745#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1746 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001747 /* Key material is saved in export representation in the slot, so
1748 * just pass the slot buffer for storage. */
1749 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001750 slot->key.data,
1751 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001752 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001753 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001754#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1755
Gilles Peskinecbaff462019-07-12 23:46:04 +02001756#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001757 /* Finish the transaction for a key creation. This does not
1758 * happen when registering an existing key. Detect this case
1759 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001760 * creation of a persistent key in a secure element requires a transaction,
1761 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001762 if( driver != NULL &&
1763 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001764 {
1765 status = psa_save_se_persistent_data( driver );
1766 if( status != PSA_SUCCESS )
1767 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001768 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001769 return( status );
1770 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001771 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001772 }
1773#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1774
Ronald Cron50972942020-11-14 11:28:25 +01001775 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001776 {
1777 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001778 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001779 if( status != PSA_SUCCESS )
1780 *key = MBEDTLS_SVC_KEY_ID_INIT;
1781 }
Ronald Cron50972942020-11-14 11:28:25 +01001782
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 return( status );
1784}
1785
1786/** Abort the creation of a key.
1787 *
1788 * You may call this function after calling psa_start_key_creation(),
1789 * or after psa_finish_key_creation() fails. In other circumstances, this
1790 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001791 * See the documentation of psa_start_key_creation() for the intended use
1792 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001794 * \param[in,out] slot Pointer to the slot with key material.
1795 * \param[in] driver The secure element driver for the key,
1796 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001797 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001798static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001799 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001800{
Gilles Peskine011e4282019-06-26 18:34:38 +02001801 (void) driver;
1802
Gilles Peskine4747d192019-04-17 15:05:45 +02001803 if( slot == NULL )
1804 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001805
1806#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001807 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001808 * element, and the failure happened later (when saving metadata
1809 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001810 * element.
1811 * https://github.com/ARMmbed/mbed-crypto/issues/217
1812 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001813
Gilles Peskined7729582019-08-05 15:55:54 +02001814 /* Abort the ongoing transaction if any (there may not be one if
1815 * the creation process failed before starting one, or if the
1816 * key creation is a registration of a key in a secure element).
1817 * Earlier functions must already have done what it takes to undo any
1818 * partial creation. All that's left is to update the transaction data
1819 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001820 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001821#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1822
Gilles Peskine4747d192019-04-17 15:05:45 +02001823 psa_wipe_key_slot( slot );
1824}
1825
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001826/** Validate optional attributes during key creation.
1827 *
1828 * Some key attributes are optional during key creation. If they are
1829 * specified in the attributes structure, check that they are consistent
1830 * with the data in the slot.
1831 *
1832 * This function should be called near the end of key creation, after
1833 * the slot in memory is fully populated but before saving persistent data.
1834 */
1835static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001836 const psa_key_slot_t *slot,
1837 const psa_key_attributes_t *attributes )
1838{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001839 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001841 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842 return( PSA_ERROR_INVALID_ARGUMENT );
1843 }
1844
1845 if( attributes->domain_parameters_size != 0 )
1846 {
John Durkop0e005192020-10-31 22:06:54 -07001847#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1848 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001849 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001850 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001851 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001852 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001854
Ronald Cron90857082020-11-25 14:58:33 +01001855 psa_status_t status = mbedtls_psa_rsa_load_representation(
1856 slot->attr.type,
1857 slot->key.data,
1858 slot->key.bytes,
1859 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001860 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001861 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001862
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001863 mbedtls_mpi_init( &actual );
1864 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001865 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001866 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001867 mbedtls_rsa_free( rsa );
1868 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 if( ret != 0 )
1870 goto rsa_exit;
1871 ret = mbedtls_mpi_read_binary( &required,
1872 attributes->domain_parameters,
1873 attributes->domain_parameters_size );
1874 if( ret != 0 )
1875 goto rsa_exit;
1876 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1877 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1878 rsa_exit:
1879 mbedtls_mpi_free( &actual );
1880 mbedtls_mpi_free( &required );
1881 if( ret != 0)
1882 return( mbedtls_to_psa_error( ret ) );
1883 }
1884 else
John Durkop9814fa22020-11-04 12:28:15 -08001885#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1886 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887 {
1888 return( PSA_ERROR_INVALID_ARGUMENT );
1889 }
1890 }
1891
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001892 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001894 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 return( PSA_ERROR_INVALID_ARGUMENT );
1896 }
1897
1898 return( PSA_SUCCESS );
1899}
1900
Gilles Peskine4747d192019-04-17 15:05:45 +02001901psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001902 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001903 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001904 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001905{
1906 psa_status_t status;
1907 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001908 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001909 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910
Ronald Cron81709fc2020-11-14 12:10:32 +01001911 *key = MBEDTLS_SVC_KEY_ID_INIT;
1912
Gilles Peskine0f84d622019-09-12 19:03:13 +02001913 /* Reject zero-length symmetric keys (including raw data key objects).
1914 * This also rejects any key which might be encoded as an empty string,
1915 * which is never valid. */
1916 if( data_length == 0 )
1917 return( PSA_ERROR_INVALID_ARGUMENT );
1918
Gilles Peskinedf179142019-07-15 22:02:14 +02001919 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001920 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 if( status != PSA_SUCCESS )
1922 goto exit;
1923
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001924 /* In the case of a transparent key or an opaque key stored in local
1925 * storage (thus not in the case of generating a key in a secure element
1926 * or cryptoprocessor with storage), we have to allocate a buffer to
1927 * hold the generated key material. */
1928 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001929 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001930 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001931 if( status != PSA_SUCCESS )
1932 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001933 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001934
1935 bits = slot->attr.bits;
1936 status = psa_driver_wrapper_import_key( attributes,
1937 data, data_length,
1938 slot->key.data,
1939 slot->key.bytes,
1940 &slot->key.bytes, &bits );
1941 if( status != PSA_SUCCESS )
1942 goto exit;
1943
1944 if( slot->attr.bits == 0 )
1945 slot->attr.bits = (psa_key_bits_t) bits;
1946 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001947 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001948 status = PSA_ERROR_INVALID_ARGUMENT;
1949 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001950 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001951
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001952 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001953 if( status != PSA_SUCCESS )
1954 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955
Ronald Cron81709fc2020-11-14 12:10:32 +01001956 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001957exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001959 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001960
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 return( status );
1962}
1963
Gilles Peskined7729582019-08-05 15:55:54 +02001964#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1965psa_status_t mbedtls_psa_register_se_key(
1966 const psa_key_attributes_t *attributes )
1967{
1968 psa_status_t status;
1969 psa_key_slot_t *slot = NULL;
1970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001971 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001972
1973 /* Leaving attributes unspecified is not currently supported.
1974 * It could make sense to query the key type and size from the
1975 * secure element, but not all secure elements support this
1976 * and the driver HAL doesn't currently support it. */
1977 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1978 return( PSA_ERROR_NOT_SUPPORTED );
1979 if( psa_get_key_bits( attributes ) == 0 )
1980 return( PSA_ERROR_NOT_SUPPORTED );
1981
1982 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001983 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001984 if( status != PSA_SUCCESS )
1985 goto exit;
1986
Ronald Cron81709fc2020-11-14 12:10:32 +01001987 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001988
1989exit:
1990 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001991 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001992
Gilles Peskined7729582019-08-05 15:55:54 +02001993 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001994 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001995 return( status );
1996}
1997#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1998
Gilles Peskinef603c712019-01-19 13:40:11 +01001999static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002000 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002001{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002002 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002003 source->key.data,
2004 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002005 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002006 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002007
Steven Cooreman398aee52020-10-13 14:35:45 +02002008 target->attr.type = source->attr.type;
2009 target->attr.bits = source->attr.bits;
2010
2011 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002012}
2013
Ronald Croncf56a0a2020-08-04 09:51:30 +02002014psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002015 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002016 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002017{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002019 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002020 psa_key_slot_t *source_slot = NULL;
2021 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002022 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002023 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002024
Ronald Cron81709fc2020-11-14 12:10:32 +01002025 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2026
Ronald Cron5c522922020-11-14 16:35:34 +01002027 status = psa_get_and_lock_transparent_key_slot_with_policy(
2028 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002029 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002030 goto exit;
2031
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002032 status = psa_validate_optional_attributes( source_slot,
2033 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002034 if( status != PSA_SUCCESS )
2035 goto exit;
2036
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002037 status = psa_restrict_key_policy( source_slot->attr.type,
2038 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002039 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002040 if( status != PSA_SUCCESS )
2041 goto exit;
2042
Ronald Cron81709fc2020-11-14 12:10:32 +01002043 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2044 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002045 if( status != PSA_SUCCESS )
2046 goto exit;
2047
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002048#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2049 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002050 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002051 /* Copying to a secure element is not implemented yet. */
2052 status = PSA_ERROR_NOT_SUPPORTED;
2053 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002054 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002055#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002056
Ronald Cron6cc66312021-04-02 12:27:47 +02002057 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2058 {
2059 /*
2060 * Copying through an opaque driver is not implemented yet, consider
2061 * a lifetime with an external location as an invalid parameter for
2062 * now.
2063 */
2064 status = PSA_ERROR_INVALID_ARGUMENT;
2065 goto exit;
2066 }
2067
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002069 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002070 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002071
Ronald Cron81709fc2020-11-14 12:10:32 +01002072 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002073exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002074 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002075 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002076
Ronald Cron5c522922020-11-14 16:35:34 +01002077 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002078
Ronald Cron5c522922020-11-14 16:35:34 +01002079 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002080}
2081
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002082
2083
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002084/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002085/* Message digests */
2086/****************************************************************/
2087
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002088psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2089{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002090 /* Aborting a non-active operation is allowed */
2091 if( operation->id == 0 )
2092 return( PSA_SUCCESS );
2093
2094 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2095 operation->id = 0;
2096
2097 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098}
2099
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002100psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002101 psa_algorithm_t alg )
2102{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002103 /* A context must be freshly initialized before it can be set up. */
2104 if( operation->id != 0 )
2105 return( PSA_ERROR_BAD_STATE );
2106
2107 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002108 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002109
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002110 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2111 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002112 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2113
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002114 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115}
2116
2117psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2118 const uint8_t *input,
2119 size_t input_length )
2120{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002121 if( operation->id == 0 )
2122 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002123
Steven Cooremanc8288352021-03-04 14:02:19 +01002124 /* Don't require hash implementations to behave correctly on a
2125 * zero-length input, which may have an invalid pointer. */
2126 if( input_length == 0 )
2127 return( PSA_SUCCESS );
2128
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2130 input, input_length );
2131 if( status != PSA_SUCCESS )
2132 psa_hash_abort( operation );
2133
2134 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002135}
2136
2137psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2138 uint8_t *hash,
2139 size_t hash_size,
2140 size_t *hash_length )
2141{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002142 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002143 if( operation->id == 0 )
2144 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002145
Steven Cooreman1e582352021-02-18 17:24:37 +01002146 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002147 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002148 psa_hash_abort( operation );
2149 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002150}
2151
Gilles Peskine2d277862018-06-18 15:41:12 +02002152psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2153 const uint8_t *hash,
2154 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155{
2156 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2157 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002158 psa_status_t status = psa_hash_finish(
2159 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002160 actual_hash, sizeof( actual_hash ),
2161 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002162 if( status != PSA_SUCCESS )
2163 return( status );
2164 if( actual_hash_length != hash_length )
2165 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002166 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167 return( PSA_ERROR_INVALID_SIGNATURE );
2168 return( PSA_SUCCESS );
2169}
2170
Gilles Peskine0a749c82019-11-28 19:33:58 +01002171psa_status_t psa_hash_compute( psa_algorithm_t alg,
2172 const uint8_t *input, size_t input_length,
2173 uint8_t *hash, size_t hash_size,
2174 size_t *hash_length )
2175{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002176 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002177 if( !PSA_ALG_IS_HASH( alg ) )
2178 return( PSA_ERROR_INVALID_ARGUMENT );
2179
Steven Cooreman1e582352021-02-18 17:24:37 +01002180 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2181 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002182}
2183
2184psa_status_t psa_hash_compare( psa_algorithm_t alg,
2185 const uint8_t *input, size_t input_length,
2186 const uint8_t *hash, size_t hash_length )
2187{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002188 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2189 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002190
2191 if( !PSA_ALG_IS_HASH( alg ) )
2192 return( PSA_ERROR_INVALID_ARGUMENT );
2193
Steven Cooreman1e582352021-02-18 17:24:37 +01002194 psa_status_t status = psa_driver_wrapper_hash_compute(
2195 alg, input, input_length,
2196 actual_hash, sizeof(actual_hash),
2197 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002198 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002199 return( status );
2200 if( actual_hash_length != hash_length )
2201 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooreman36876a02021-04-29 16:37:59 +02002202 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002203 return( PSA_ERROR_INVALID_SIGNATURE );
2204 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002205}
2206
Gilles Peskineeb35d782019-01-22 17:56:16 +01002207psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2208 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002209{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002210 if( source_operation->id == 0 ||
2211 target_operation->id != 0 )
2212 {
2213 return( PSA_ERROR_BAD_STATE );
2214 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002215
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002216 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2217 target_operation );
2218 if( status != PSA_SUCCESS )
2219 psa_hash_abort( target_operation );
2220
2221 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002222}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223
2224
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002226/* MAC */
2227/****************************************************************/
2228
Steven Cooremane6804192021-03-19 18:28:56 +01002229psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002230{
Steven Cooremane6804192021-03-19 18:28:56 +01002231 /* Aborting a non-active operation is allowed */
2232 if( operation->id == 0 )
2233 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002234
Steven Cooremane6804192021-03-19 18:28:56 +01002235 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002236 operation->mac_size = 0;
2237 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002238 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002239
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002240 return( status );
2241}
2242
Ronald Cron2dff3b22021-06-17 16:33:22 +02002243static psa_status_t psa_mac_finalize_alg_and_key_validation(
2244 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002245 const psa_key_attributes_t *attributes,
2246 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002247{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002249 psa_key_type_t key_type = psa_get_key_type( attributes );
2250 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002251
Ronald Cron28ea0502021-06-17 16:10:24 +02002252 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002253 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002254
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002255 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002256 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002257 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002258 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002259
Steven Cooremand1a68f12021-05-10 11:13:41 +02002260 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002261 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002262
Ronald Cron79bdd822021-06-17 16:46:44 +02002263 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002264 {
2265 /* A very short MAC is too short for security since it can be
2266 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2267 * so we make this our minimum, even though 32 bits is still
2268 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002269 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002270 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002271
Ronald Cron79bdd822021-06-17 16:46:44 +02002272 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2273 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002274 {
2275 /* It's impossible to "truncate" to a larger length than the full length
2276 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002277 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002278 }
2279
Ronald Cron79bdd822021-06-17 16:46:44 +02002280 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002281}
2282
2283static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2284 mbedtls_svc_key_id_t key,
2285 psa_algorithm_t alg,
2286 int is_sign )
2287{
2288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2289 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2290 psa_key_slot_t *slot;
2291
2292 /* A context must be freshly initialized before it can be set up. */
2293 if( operation->id != 0 )
2294 return( PSA_ERROR_BAD_STATE );
2295
2296 status = psa_get_and_lock_key_slot_with_policy(
2297 key,
2298 &slot,
2299 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2300 alg );
2301 if( status != PSA_SUCCESS )
2302 return( status );
2303
2304 psa_key_attributes_t attributes = {
2305 .core = slot->attr
2306 };
2307
Ronald Cron79bdd822021-06-17 16:46:44 +02002308 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2309 &operation->mac_size );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002310 if( status != PSA_SUCCESS )
2311 goto exit;
2312
2313 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002314 /* Dispatch the MAC setup call with validated input */
2315 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002316 {
Steven Cooremane6804192021-03-19 18:28:56 +01002317 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron2dff3b22021-06-17 16:33:22 +02002318 &attributes,
Steven Cooremane6804192021-03-19 18:28:56 +01002319 slot->key.data,
2320 slot->key.bytes,
2321 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002322 }
2323 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002324 {
Steven Cooremane6804192021-03-19 18:28:56 +01002325 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron2dff3b22021-06-17 16:33:22 +02002326 &attributes,
Steven Cooremane6804192021-03-19 18:28:56 +01002327 slot->key.data,
2328 slot->key.bytes,
2329 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002330 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002331
Gilles Peskinefbfac682018-07-08 20:51:54 +02002332exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002333 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002334 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002335
Ronald Cron5c522922020-11-14 16:35:34 +01002336 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002337
Ronald Cron5c522922020-11-14 16:35:34 +01002338 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002339}
2340
Gilles Peskine89167cb2018-07-08 20:12:23 +02002341psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002342 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002343 psa_algorithm_t alg )
2344{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002345 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002346}
2347
2348psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002349 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002350 psa_algorithm_t alg )
2351{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002352 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002353}
2354
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002355psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002356 const uint8_t *input,
2357 size_t input_length )
2358{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002359 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002360 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002362 /* Don't require hash implementations to behave correctly on a
2363 * zero-length input, which may have an invalid pointer. */
2364 if( input_length == 0 )
2365 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002366
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002367 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2368 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002369 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002370 psa_mac_abort( operation );
2371
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002372 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373}
2374
Steven Cooremana5b860a2021-03-19 19:04:39 +01002375psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002376 uint8_t *mac,
2377 size_t mac_size,
2378 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002379{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002380 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2381 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002382
Steven Cooreman72f736a2021-05-07 14:14:37 +02002383 /* Set the output length and content to a safe default, such that in
2384 * case the caller misses an error check, the output would be an
2385 * unachievable MAC. */
2386 *mac_length = mac_size;
2387
Steven Cooremana5b860a2021-03-19 19:04:39 +01002388 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002389 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002390
Steven Cooreman72f736a2021-05-07 14:14:37 +02002391 if( ! operation->is_sign )
2392 return( PSA_ERROR_BAD_STATE );
2393
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002394 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2395 * once all the error checks are done. */
2396 if( operation->mac_size == 0 )
2397 return( PSA_ERROR_BAD_STATE );
2398
2399 if( mac_size < operation->mac_size )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002400 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002401
Steven Cooremana5b860a2021-03-19 19:04:39 +01002402 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002403 mac, operation->mac_size,
2404 mac_length );
2405
2406 if( status == PSA_SUCCESS )
2407 {
2408 /* Set the excess room in the output buffer to an invalid value, to
2409 * avoid potentially leaking a longer MAC. */
2410 if( mac_size > operation->mac_size )
2411 memset( &mac[operation->mac_size],
2412 '!',
2413 mac_size - operation->mac_size );
2414 }
2415 else
2416 {
2417 /* Set the output length and content to a safe default, such that in
2418 * case the caller misses an error check, the output would be an
2419 * unachievable MAC. */
2420 *mac_length = mac_size;
2421 memset( mac, '!', mac_size );
2422 }
mohammad16036df908f2018-04-02 08:34:15 -07002423
Steven Cooremana5b860a2021-03-19 19:04:39 +01002424 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002425
Steven Cooremana5b860a2021-03-19 19:04:39 +01002426 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002427}
2428
Steven Cooremana5b860a2021-03-19 19:04:39 +01002429psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002430 const uint8_t *mac,
2431 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2434 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002435
Steven Cooremana5b860a2021-03-19 19:04:39 +01002436 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002437 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002438
Steven Cooreman72f736a2021-05-07 14:14:37 +02002439 if( operation->is_sign )
2440 return( PSA_ERROR_BAD_STATE );
2441
2442 if( operation->mac_size != mac_length )
2443 {
2444 status = PSA_ERROR_INVALID_SIGNATURE;
2445 goto cleanup;
2446 }
2447
Steven Cooremana5b860a2021-03-19 19:04:39 +01002448 status = psa_driver_wrapper_mac_verify_finish( operation,
2449 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002450
2451cleanup:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002452 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002453
Steven Cooremana5b860a2021-03-19 19:04:39 +01002454 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002455}
2456
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002457psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2458 psa_algorithm_t alg,
2459 const uint8_t *input,
2460 size_t input_length,
2461 uint8_t *mac,
2462 size_t mac_size,
2463 size_t *mac_length)
2464{
2465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2466 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002467
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002468 status = psa_mac_sign_setup( &operation, key, alg );
2469 if( status != PSA_SUCCESS )
2470 goto exit;
2471
2472 status = psa_mac_update( &operation, input, input_length );
2473 if( status != PSA_SUCCESS )
2474 goto exit;
2475
2476 status = psa_mac_sign_finish( &operation, mac, mac_size, mac_length );
2477 if( status != PSA_SUCCESS )
2478 goto exit;
2479
2480exit:
2481 if ( status == PSA_SUCCESS )
2482 status = psa_mac_abort( &operation );
2483 else
2484 psa_mac_abort( &operation );
2485
2486 return ( status );
2487}
2488
2489psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2490 psa_algorithm_t alg,
2491 const uint8_t *input,
2492 size_t input_length,
2493 const uint8_t *mac,
2494 size_t mac_length)
2495{
2496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2497 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
2498
2499 status = psa_mac_verify_setup( &operation, key, alg );
2500 if( status != PSA_SUCCESS )
2501 goto exit;
2502
2503 status = psa_mac_update( &operation, input, input_length );
2504 if( status != PSA_SUCCESS )
2505 goto exit;
2506
2507 status = psa_mac_verify_finish( &operation, mac, mac_length );
2508 if( status != PSA_SUCCESS )
2509 goto exit;
2510
2511exit:
2512 if ( status == PSA_SUCCESS )
2513 status = psa_mac_abort( &operation );
2514 else
2515 psa_mac_abort( &operation );
2516
2517 return ( status );
2518}
Gilles Peskine20035e32018-02-03 22:44:14 +01002519
Gilles Peskine20035e32018-02-03 22:44:14 +01002520/****************************************************************/
2521/* Asymmetric cryptography */
2522/****************************************************************/
2523
gabor-mezei-armf0486182021-05-12 11:03:09 +02002524static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002525 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002526{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002527 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002528 {
2529 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2530 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002531
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002532 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2533 {
2534 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2535 return( PSA_ERROR_INVALID_ARGUMENT );
2536 }
2537 }
2538 else
2539 {
2540 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2541 return( PSA_ERROR_INVALID_ARGUMENT );
2542 }
2543
2544 return( PSA_SUCCESS );
2545}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002546
2547static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002548 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002549 psa_algorithm_t alg,
2550 const uint8_t * input,
2551 size_t input_length,
2552 uint8_t * signature,
2553 size_t signature_size,
2554 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002555{
2556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2557 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2558 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002559
2560 *signature_length = 0;
2561
gabor-mezei-armf0486182021-05-12 11:03:09 +02002562 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002563 if( status != PSA_SUCCESS )
2564 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002565
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002566 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002567 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002568 * buffer can in principle be empty since it doesn't actually have
2569 * to be a hash.) */
2570 if( signature_size == 0 )
2571 return( PSA_ERROR_BUFFER_TOO_SMALL );
2572
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002573 status = psa_get_and_lock_key_slot_with_policy(
2574 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002575 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2576 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002577 alg );
2578
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002579 if( status != PSA_SUCCESS )
2580 goto exit;
2581
2582 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2583 {
2584 status = PSA_ERROR_INVALID_ARGUMENT;
2585 goto exit;
2586 }
2587
2588 psa_key_attributes_t attributes = {
2589 .core = slot->attr
2590 };
2591
gabor-mezei-armf0486182021-05-12 11:03:09 +02002592 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002593 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002594 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002595 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002596 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002597 signature, signature_size, signature_length );
2598 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002599 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002600 {
2601
2602 status = psa_driver_wrapper_sign_hash(
2603 &attributes, slot->key.data, slot->key.bytes,
2604 alg, input, input_length,
2605 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002606 }
2607
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002608
2609exit:
2610 /* Fill the unused part of the output buffer (the whole buffer on error,
2611 * the trailing part on success) with something that isn't a valid signature
2612 * (barring an attack on the signature and deliberately-crafted input),
2613 * in case the caller doesn't check the return status properly. */
2614 if( status == PSA_SUCCESS )
2615 memset( signature + *signature_length, '!',
2616 signature_size - *signature_length );
2617 else
2618 memset( signature, '!', signature_size );
2619 /* If signature_size is 0 then we have nothing to do. We must not call
2620 * memset because signature may be NULL in this case. */
2621
2622 unlock_status = psa_unlock_key_slot( slot );
2623
2624 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2625}
2626
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002627static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002628 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002629 psa_algorithm_t alg,
2630 const uint8_t * input,
2631 size_t input_length,
2632 const uint8_t * signature,
2633 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002634{
2635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2636 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2637 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002638
gabor-mezei-armf0486182021-05-12 11:03:09 +02002639 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002640 if( status != PSA_SUCCESS )
2641 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002642
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002643 status = psa_get_and_lock_key_slot_with_policy(
2644 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002645 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2646 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002647 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002648
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002649 if( status != PSA_SUCCESS )
2650 return( status );
2651
2652 psa_key_attributes_t attributes = {
2653 .core = slot->attr
2654 };
2655
gabor-mezei-armf0486182021-05-12 11:03:09 +02002656 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002657 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002658 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002659 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002660 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002661 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002662 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002663 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002664 {
2665 status = psa_driver_wrapper_verify_hash(
2666 &attributes, slot->key.data, slot->key.bytes,
2667 alg, input, input_length,
2668 signature, signature_length );
2669 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002670
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002671 unlock_status = psa_unlock_key_slot( slot );
2672
2673 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002674
2675}
2676
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002677psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002678 const psa_key_attributes_t *attributes,
2679 const uint8_t *key_buffer,
2680 size_t key_buffer_size,
2681 psa_algorithm_t alg,
2682 const uint8_t *input,
2683 size_t input_length,
2684 uint8_t *signature,
2685 size_t signature_size,
2686 size_t *signature_length )
2687{
2688 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002689
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002690 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2691 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002692 size_t hash_length;
2693 uint8_t hash[PSA_HASH_MAX_SIZE];
2694
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002695 status = psa_driver_wrapper_hash_compute(
2696 PSA_ALG_SIGN_GET_HASH( alg ),
2697 input, input_length,
2698 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002699
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002700 if( status != PSA_SUCCESS )
2701 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002702
2703 return psa_driver_wrapper_sign_hash(
2704 attributes, key_buffer, key_buffer_size,
2705 alg, hash, hash_length,
2706 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002707 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002708
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002709 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002710}
2711
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002712psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2713 psa_algorithm_t alg,
2714 const uint8_t * input,
2715 size_t input_length,
2716 uint8_t * signature,
2717 size_t signature_size,
2718 size_t * signature_length )
2719{
2720 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002721 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002722 signature, signature_size, signature_length );
2723}
2724
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002725psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002726 const psa_key_attributes_t *attributes,
2727 const uint8_t *key_buffer,
2728 size_t key_buffer_size,
2729 psa_algorithm_t alg,
2730 const uint8_t *input,
2731 size_t input_length,
2732 const uint8_t *signature,
2733 size_t signature_length )
2734{
2735 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002736
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002737 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2738 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002739 size_t hash_length;
2740 uint8_t hash[PSA_HASH_MAX_SIZE];
2741
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002742 status = psa_driver_wrapper_hash_compute(
2743 PSA_ALG_SIGN_GET_HASH( alg ),
2744 input, input_length,
2745 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002746
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002747 if( status != PSA_SUCCESS )
2748 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002749
2750 return psa_driver_wrapper_verify_hash(
2751 attributes, key_buffer, key_buffer_size,
2752 alg, hash, hash_length,
2753 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002754 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002755
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002756 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002757}
2758
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002759psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2760 psa_algorithm_t alg,
2761 const uint8_t * input,
2762 size_t input_length,
2763 const uint8_t * signature,
2764 size_t signature_length )
2765{
2766 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002767 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002768 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002769}
2770
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002771psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002772 const psa_key_attributes_t *attributes,
2773 const uint8_t *key_buffer, size_t key_buffer_size,
2774 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2775 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002776{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002777 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002778 {
Ronald Cron4501c982021-03-19 20:09:32 +01002779 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2780 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002781 {
Ronald Cron4501c982021-03-19 20:09:32 +01002782#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2783 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2784 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002785 attributes,
2786 key_buffer, key_buffer_size,
2787 alg, hash, hash_length,
2788 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002789#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2790 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002791 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002792 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002793 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002794 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002795 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002796 }
2797 else
Ronald Cron4501c982021-03-19 20:09:32 +01002798 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2799 {
2800 if( PSA_ALG_IS_ECDSA( alg ) )
2801 {
2802#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2803 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2804 return( mbedtls_psa_ecdsa_sign_hash(
2805 attributes,
2806 key_buffer, key_buffer_size,
2807 alg, hash, hash_length,
2808 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002809#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2810 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002811 }
2812 else
2813 {
2814 return( PSA_ERROR_INVALID_ARGUMENT );
2815 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002816 }
Ronald Cron4501c982021-03-19 20:09:32 +01002817
2818 (void)key_buffer;
2819 (void)key_buffer_size;
2820 (void)hash;
2821 (void)hash_length;
2822 (void)signature;
2823 (void)signature_size;
2824 (void)signature_length;
2825
2826 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002827}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002828
2829psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2830 psa_algorithm_t alg,
2831 const uint8_t *hash,
2832 size_t hash_length,
2833 uint8_t *signature,
2834 size_t signature_size,
2835 size_t *signature_length )
2836{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002838 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002839 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002840}
2841
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002842psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002843 const psa_key_attributes_t *attributes,
2844 const uint8_t *key_buffer, size_t key_buffer_size,
2845 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2846 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002847{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002848 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002849 {
Ronald Cron4501c982021-03-19 20:09:32 +01002850 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2851 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002852 {
Ronald Cron4501c982021-03-19 20:09:32 +01002853#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2854 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2855 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002856 attributes,
2857 key_buffer, key_buffer_size,
2858 alg, hash, hash_length,
2859 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002860#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2861 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002862 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002863 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002864 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002865 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002866 }
itayzafrir5c753392018-05-08 11:18:38 +03002867 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002868 else
Ronald Cron4501c982021-03-19 20:09:32 +01002869 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002870 {
Ronald Cron4501c982021-03-19 20:09:32 +01002871 if( PSA_ALG_IS_ECDSA( alg ) )
2872 {
2873#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2874 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2875 return( mbedtls_psa_ecdsa_verify_hash(
2876 attributes,
2877 key_buffer, key_buffer_size,
2878 alg, hash, hash_length,
2879 signature, signature_length ) );
2880#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2881 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2882 }
2883 else
2884 {
2885 return( PSA_ERROR_INVALID_ARGUMENT );
2886 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002887 }
Ronald Cron4501c982021-03-19 20:09:32 +01002888
2889 (void)key_buffer;
2890 (void)key_buffer_size;
2891 (void)hash;
2892 (void)hash_length;
2893 (void)signature;
2894 (void)signature_length;
2895
2896 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002897}
2898
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002899psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
2900 psa_algorithm_t alg,
2901 const uint8_t *hash,
2902 size_t hash_length,
2903 const uint8_t *signature,
2904 size_t signature_length )
2905{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002906 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002907 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002908 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002909}
2910
John Durkop0e005192020-10-31 22:06:54 -07002911#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Ronald Cronea7631b2021-06-03 18:51:59 +02002912static int psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
2913 mbedtls_rsa_context *rsa )
Gilles Peskine072ac562018-06-30 00:21:29 +02002914{
2915 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
2916 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
2917 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Ronald Cronea7631b2021-06-03 18:51:59 +02002918
2919 return( mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg ) );
Gilles Peskine072ac562018-06-30 00:21:29 +02002920}
John Durkop0e005192020-10-31 22:06:54 -07002921#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02002922
Ronald Croncf56a0a2020-08-04 09:51:30 +02002923psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002924 psa_algorithm_t alg,
2925 const uint8_t *input,
2926 size_t input_length,
2927 const uint8_t *salt,
2928 size_t salt_length,
2929 uint8_t *output,
2930 size_t output_size,
2931 size_t *output_length )
2932{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002933 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002934 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002935 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002936
Darryl Green5cc689a2018-07-24 15:34:10 +01002937 (void) input;
2938 (void) input_length;
2939 (void) salt;
2940 (void) output;
2941 (void) output_size;
2942
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002943 *output_length = 0;
2944
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02002945 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
2946 return( PSA_ERROR_INVALID_ARGUMENT );
2947
Ronald Cron5c522922020-11-14 16:35:34 +01002948 status = psa_get_and_lock_transparent_key_slot_with_policy(
2949 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002950 if( status != PSA_SUCCESS )
2951 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02002952 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
2953 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02002954 {
2955 status = PSA_ERROR_INVALID_ARGUMENT;
2956 goto exit;
2957 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002958
John Durkop6ba40d12020-11-10 08:50:04 -08002959#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
2960 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02002961 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002962 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002963 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01002964 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
2965 slot->key.data,
2966 slot->key.bytes,
2967 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002968 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02002969 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02002970
2971 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02002972 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002973 status = PSA_ERROR_BUFFER_TOO_SMALL;
2974 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02002975 }
John Durkop0e005192020-10-31 22:06:54 -07002976#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002977 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
2978 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02002979 status = mbedtls_to_psa_error(
2980 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002981 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01002982 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02002983 input_length,
2984 input,
2985 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002986 }
2987 else
John Durkop0e005192020-10-31 22:06:54 -07002988#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
2989#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002990 if( PSA_ALG_IS_RSA_OAEP( alg ) )
2991 {
Ronald Cronea7631b2021-06-03 18:51:59 +02002992 status = mbedtls_to_psa_error(
2993 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
2994 if( status != PSA_SUCCESS )
2995 goto rsa_exit;
2996
Steven Cooreman4fed4552020-08-03 14:46:03 +02002997 status = mbedtls_to_psa_error(
2998 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01002999 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003000 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003001 salt, salt_length,
3002 input_length,
3003 input,
3004 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003005 }
3006 else
John Durkop0e005192020-10-31 22:06:54 -07003007#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003008 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003009 status = PSA_ERROR_INVALID_ARGUMENT;
3010 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003011 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003012rsa_exit:
3013 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003014 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003015
Steven Cooremana2371e52020-07-28 14:30:39 +02003016 mbedtls_rsa_free( rsa );
3017 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003018 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003019 else
John Durkop9814fa22020-11-04 12:28:15 -08003020#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003021 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003022 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003023 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003024 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003025
3026exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003027 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003028
Ronald Cron5c522922020-11-14 16:35:34 +01003029 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003030}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003031
Ronald Croncf56a0a2020-08-04 09:51:30 +02003032psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003033 psa_algorithm_t alg,
3034 const uint8_t *input,
3035 size_t input_length,
3036 const uint8_t *salt,
3037 size_t salt_length,
3038 uint8_t *output,
3039 size_t output_size,
3040 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003041{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003043 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003044 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003045
Darryl Green5cc689a2018-07-24 15:34:10 +01003046 (void) input;
3047 (void) input_length;
3048 (void) salt;
3049 (void) output;
3050 (void) output_size;
3051
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003052 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003053
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003054 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3055 return( PSA_ERROR_INVALID_ARGUMENT );
3056
Ronald Cron5c522922020-11-14 16:35:34 +01003057 status = psa_get_and_lock_transparent_key_slot_with_policy(
3058 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003059 if( status != PSA_SUCCESS )
3060 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003061 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003062 {
3063 status = PSA_ERROR_INVALID_ARGUMENT;
3064 goto exit;
3065 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003066
John Durkop6ba40d12020-11-10 08:50:04 -08003067#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3068 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003069 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003070 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003071 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003072 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3073 slot->key.data,
3074 slot->key.bytes,
3075 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003076 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003077 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003078
Steven Cooremana2371e52020-07-28 14:30:39 +02003079 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003080 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003081 status = PSA_ERROR_INVALID_ARGUMENT;
3082 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003083 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003084
John Durkop0e005192020-10-31 22:06:54 -07003085#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003086 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003087 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003088 status = mbedtls_to_psa_error(
3089 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003090 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003091 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003092 output_length,
3093 input,
3094 output,
3095 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096 }
3097 else
John Durkop0e005192020-10-31 22:06:54 -07003098#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3099#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003100 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003101 {
Ronald Cronea7631b2021-06-03 18:51:59 +02003102 status = mbedtls_to_psa_error(
3103 psa_rsa_oaep_set_padding_mode( alg, rsa ) );
3104 if( status != PSA_SUCCESS )
3105 goto rsa_exit;
3106
Steven Cooreman4fed4552020-08-03 14:46:03 +02003107 status = mbedtls_to_psa_error(
3108 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003109 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003110 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003111 salt, salt_length,
3112 output_length,
3113 input,
3114 output,
3115 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116 }
3117 else
John Durkop0e005192020-10-31 22:06:54 -07003118#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003119 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003120 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003122
Steven Cooreman4fed4552020-08-03 14:46:03 +02003123rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003124 mbedtls_rsa_free( rsa );
3125 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003126 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127 else
John Durkop6ba40d12020-11-10 08:50:04 -08003128#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3129 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003130 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003131 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003132 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003133
3134exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003135 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003136
Ronald Cron5c522922020-11-14 16:35:34 +01003137 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003138}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003139
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003140
3141
mohammad1603503973b2018-03-12 15:59:30 +02003142/****************************************************************/
3143/* Symmetric cryptography */
3144/****************************************************************/
3145
Ronald Cronab99ac22020-10-01 16:38:28 +02003146static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3147 mbedtls_svc_key_id_t key,
3148 psa_algorithm_t alg,
3149 mbedtls_operation_t cipher_operation )
3150{
3151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3152 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3153 psa_key_slot_t *slot;
3154 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3155 PSA_KEY_USAGE_ENCRYPT :
3156 PSA_KEY_USAGE_DECRYPT );
3157
3158 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003159 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003160 return( PSA_ERROR_BAD_STATE );
3161
3162 /* The requested algorithm must be one that can be processed by cipher. */
3163 if( ! PSA_ALG_IS_CIPHER( alg ) )
3164 return( PSA_ERROR_INVALID_ARGUMENT );
3165
3166 /* Fetch key material from key storage. */
3167 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3168 if( status != PSA_SUCCESS )
3169 goto exit;
3170
Ronald Cron49fafa92021-03-10 08:34:23 +01003171 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003172 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003173 * so we only set it (in the driver wrapper) after resources have been
3174 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003175 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003176 if( alg == PSA_ALG_ECB_NO_PADDING )
3177 operation->iv_required = 0;
3178 else
3179 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003180 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003181
Ronald Crona4af55f2020-12-14 14:36:06 +01003182 psa_key_attributes_t attributes = {
3183 .core = slot->attr
3184 };
3185
Ronald Cronab99ac22020-10-01 16:38:28 +02003186 /* Try doing the operation through a driver before using software fallback. */
3187 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003188 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3189 &attributes,
3190 slot->key.data,
3191 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003192 alg );
3193 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003194 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3195 &attributes,
3196 slot->key.data,
3197 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003198 alg );
3199
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003200exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003201 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003202 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003203
Ronald Cron5c522922020-11-14 16:35:34 +01003204 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003205
Ronald Cron5c522922020-11-14 16:35:34 +01003206 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003207}
3208
Gilles Peskinefe119512018-07-08 21:39:34 +02003209psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003210 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003211 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003212{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003213 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003214}
3215
Gilles Peskinefe119512018-07-08 21:39:34 +02003216psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003217 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003218 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003219{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003220 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003221}
3222
Gilles Peskinefe119512018-07-08 21:39:34 +02003223psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003224 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003225 size_t iv_size,
3226 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003227{
Ronald Cron6d051732020-10-01 14:10:20 +02003228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003229
Ronald Cron5618a392021-03-26 09:52:26 +01003230 *iv_length = 0;
3231
Ronald Cron49fafa92021-03-10 08:34:23 +01003232 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003233 {
3234 return( PSA_ERROR_BAD_STATE );
3235 }
3236
Steven Cooreman7df02922020-09-09 15:28:49 +02003237 if( operation->iv_set || ! operation->iv_required )
3238 {
3239 return( PSA_ERROR_BAD_STATE );
3240 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003241
Ronald Cron5618a392021-03-26 09:52:26 +01003242 if( iv_size < operation->default_iv_length )
3243 {
3244 status = PSA_ERROR_BUFFER_TOO_SMALL;
3245 goto exit;
3246 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003247
Ronald Cron5618a392021-03-26 09:52:26 +01003248 status = psa_generate_random( iv, operation->default_iv_length );
3249 if( status != PSA_SUCCESS )
3250 goto exit;
3251
3252 status = psa_driver_wrapper_cipher_set_iv( operation,
3253 iv,
3254 operation->default_iv_length );
3255
3256exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003257 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003258 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003259 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003260 *iv_length = operation->default_iv_length;
3261 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003262 else
Moran Peker395db872018-05-31 14:07:14 +03003263 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003264
itayzafrir534bd7c2018-08-02 13:56:32 +03003265 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003266}
3267
Gilles Peskinefe119512018-07-08 21:39:34 +02003268psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003269 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003270 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003271{
Ronald Cron6d051732020-10-01 14:10:20 +02003272 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003273
Ronald Cron49fafa92021-03-10 08:34:23 +01003274 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003275 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003276
Steven Cooreman7df02922020-09-09 15:28:49 +02003277 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003278 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003279
3280 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3281 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003282
Ronald Crondd24c9b2020-12-15 14:10:01 +01003283 status = psa_driver_wrapper_cipher_set_iv( operation,
3284 iv,
3285 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003286
itayzafrir534bd7c2018-08-02 13:56:32 +03003287 if( status == PSA_SUCCESS )
3288 operation->iv_set = 1;
3289 else
mohammad1603503973b2018-03-12 15:59:30 +02003290 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003291 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003292}
3293
Gilles Peskinee553c652018-06-04 16:22:46 +02003294psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3295 const uint8_t *input,
3296 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003297 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003298 size_t output_size,
3299 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003300{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003301 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003302
Ronald Cron49fafa92021-03-10 08:34:23 +01003303 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003304 {
3305 return( PSA_ERROR_BAD_STATE );
3306 }
3307 if( operation->iv_required && ! operation->iv_set )
3308 {
3309 return( PSA_ERROR_BAD_STATE );
3310 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003311
Ronald Crondd24c9b2020-12-15 14:10:01 +01003312 status = psa_driver_wrapper_cipher_update( operation,
3313 input,
3314 input_length,
3315 output,
3316 output_size,
3317 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003318 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003319 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003320
itayzafrir534bd7c2018-08-02 13:56:32 +03003321 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003322}
3323
Gilles Peskinee553c652018-06-04 16:22:46 +02003324psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3325 uint8_t *output,
3326 size_t output_size,
3327 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003328{
David Saadab4ecc272019-02-14 13:48:10 +02003329 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003330
Ronald Cron49fafa92021-03-10 08:34:23 +01003331 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003332 {
3333 return( PSA_ERROR_BAD_STATE );
3334 }
3335 if( operation->iv_required && ! operation->iv_set )
3336 {
3337 return( PSA_ERROR_BAD_STATE );
3338 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003339
Ronald Crondd24c9b2020-12-15 14:10:01 +01003340 status = psa_driver_wrapper_cipher_finish( operation,
3341 output,
3342 output_size,
3343 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003344 if( status == PSA_SUCCESS )
3345 return( psa_cipher_abort( operation ) );
3346 else
3347 {
3348 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003349 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003350
Steven Cooremanef8575e2020-09-11 11:44:50 +02003351 return( status );
3352 }
mohammad1603503973b2018-03-12 15:59:30 +02003353}
3354
Gilles Peskinee553c652018-06-04 16:22:46 +02003355psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3356{
Ronald Cron49fafa92021-03-10 08:34:23 +01003357 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003358 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003359 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003360 * in use. It's ok to call abort on such an object, and there's
3361 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003362 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003363 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003364
Ronald Crondd24c9b2020-12-15 14:10:01 +01003365 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003366
Ronald Cron49fafa92021-03-10 08:34:23 +01003367 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003368 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003369 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003370
Moran Peker395db872018-05-31 14:07:14 +03003371 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003372}
3373
mohammad16035955c982018-04-26 00:53:03 +03003374/****************************************************************/
3375/* AEAD */
3376/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003377
Ronald Croncf56a0a2020-08-04 09:51:30 +02003378psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003379 psa_algorithm_t alg,
3380 const uint8_t *nonce,
3381 size_t nonce_length,
3382 const uint8_t *additional_data,
3383 size_t additional_data_length,
3384 const uint8_t *plaintext,
3385 size_t plaintext_length,
3386 uint8_t *ciphertext,
3387 size_t ciphertext_size,
3388 size_t *ciphertext_length )
3389{
Ronald Cron215633c2021-03-16 17:15:37 +01003390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3391 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003392
mohammad1603f08a5502018-06-03 15:05:47 +03003393 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003394
Steven Cooremanea7ab132021-03-17 16:28:00 +01003395 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3396 return( PSA_ERROR_NOT_SUPPORTED );
3397
Ronald Cron9a986162021-03-26 12:40:07 +01003398 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003399 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003400 if( status != PSA_SUCCESS )
3401 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003402
Ronald Cron215633c2021-03-16 17:15:37 +01003403 psa_key_attributes_t attributes = {
3404 .core = slot->attr
3405 };
mohammad16035955c982018-04-26 00:53:03 +03003406
Ronald Cronde822812021-03-17 16:08:20 +01003407 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003408 &attributes, slot->key.data, slot->key.bytes,
3409 alg,
3410 nonce, nonce_length,
3411 additional_data, additional_data_length,
3412 plaintext, plaintext_length,
3413 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003414
Gilles Peskineedf9a652018-08-17 18:11:56 +02003415 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3416 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003417
Ronald Cron9f310172021-03-16 16:36:37 +01003418 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003419
mohammad16035955c982018-04-26 00:53:03 +03003420 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003421}
3422
Ronald Croncf56a0a2020-08-04 09:51:30 +02003423psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003424 psa_algorithm_t alg,
3425 const uint8_t *nonce,
3426 size_t nonce_length,
3427 const uint8_t *additional_data,
3428 size_t additional_data_length,
3429 const uint8_t *ciphertext,
3430 size_t ciphertext_length,
3431 uint8_t *plaintext,
3432 size_t plaintext_size,
3433 size_t *plaintext_length )
3434{
Ronald Cron215633c2021-03-16 17:15:37 +01003435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3436 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003437
Gilles Peskineee652a32018-06-01 19:23:52 +02003438 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003439
Steven Cooremanea7ab132021-03-17 16:28:00 +01003440 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3441 return( PSA_ERROR_NOT_SUPPORTED );
3442
Ronald Cron9a986162021-03-26 12:40:07 +01003443 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003444 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003445 if( status != PSA_SUCCESS )
3446 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003447
Ronald Cron215633c2021-03-16 17:15:37 +01003448 psa_key_attributes_t attributes = {
3449 .core = slot->attr
3450 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003451
Ronald Cronde822812021-03-17 16:08:20 +01003452 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003453 &attributes, slot->key.data, slot->key.bytes,
3454 alg,
3455 nonce, nonce_length,
3456 additional_data, additional_data_length,
3457 ciphertext, ciphertext_length,
3458 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003459
Gilles Peskineedf9a652018-08-17 18:11:56 +02003460 if( status != PSA_SUCCESS && plaintext_size != 0 )
3461 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003462
Ronald Cron215633c2021-03-16 17:15:37 +01003463 psa_unlock_key_slot( slot );
3464
Gilles Peskineedf9a652018-08-17 18:11:56 +02003465 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003466}
3467
Gilles Peskinee59236f2018-01-27 23:32:46 +01003468/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003469/* Generators */
3470/****************************************************************/
3471
John Durkop07cc04a2020-11-16 22:08:34 -08003472#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3473 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3474 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3475#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02003476#endif /* At least one builtin KDF */
3477
3478#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3479 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3480 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3481static psa_status_t psa_key_derivation_start_hmac(
3482 psa_mac_operation_t *operation,
3483 psa_algorithm_t hash_alg,
3484 const uint8_t *hmac_key,
3485 size_t hmac_key_length )
3486{
3487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3488 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3489 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3490 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3491 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3492
Steven Cooreman72f736a2021-05-07 14:14:37 +02003493 operation->is_sign = 1;
3494 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3495
Steven Cooreman094a77e2021-05-06 17:58:36 +02003496 status = psa_driver_wrapper_mac_sign_setup( operation,
3497 &attributes,
3498 hmac_key, hmac_key_length,
3499 PSA_ALG_HMAC( hash_alg ) );
3500
3501 psa_reset_key_attributes( &attributes );
3502 return( status );
3503}
3504#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003505
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003506#define HKDF_STATE_INIT 0 /* no input yet */
3507#define HKDF_STATE_STARTED 1 /* got salt */
3508#define HKDF_STATE_KEYED 2 /* got key */
3509#define HKDF_STATE_OUTPUT 3 /* output started */
3510
Gilles Peskinecbe66502019-05-16 16:59:18 +02003511static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003512 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003513{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003514 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3515 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003516 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003517 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003518}
3519
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003520psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003521{
3522 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003523 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003524 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003525 {
3526 /* The object has (apparently) been initialized but it is not
3527 * in use. It's ok to call abort on such an object, and there's
3528 * nothing to do. */
3529 }
3530 else
John Durkopd0321952020-10-29 21:37:36 -07003531#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003532 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003533 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003534 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003535 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003536 }
John Durkop07cc04a2020-11-16 22:08:34 -08003537 else
3538#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3539#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3540 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3541 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003542 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003543 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003544 {
Steven Cooremana6df6042021-04-29 19:32:25 +02003545 if( operation->ctx.tls12_prf.secret != NULL )
3546 {
3547 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3548 operation->ctx.tls12_prf.secret_length );
3549 mbedtls_free( operation->ctx.tls12_prf.secret );
3550 }
3551
Janos Follath6a1d2622019-06-11 10:37:28 +01003552 if( operation->ctx.tls12_prf.seed != NULL )
3553 {
3554 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3555 operation->ctx.tls12_prf.seed_length );
3556 mbedtls_free( operation->ctx.tls12_prf.seed );
3557 }
3558
3559 if( operation->ctx.tls12_prf.label != NULL )
3560 {
3561 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3562 operation->ctx.tls12_prf.label_length );
3563 mbedtls_free( operation->ctx.tls12_prf.label );
3564 }
3565
Steven Cooremana6df6042021-04-29 19:32:25 +02003566 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003567
3568 /* We leave the fields Ai and output_block to be erased safely by the
3569 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003570 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003571 else
John Durkop07cc04a2020-11-16 22:08:34 -08003572#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3573 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003574 {
3575 status = PSA_ERROR_BAD_STATE;
3576 }
Janos Follath083036a2019-06-11 10:22:26 +01003577 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003578 return( status );
3579}
3580
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003581psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003582 size_t *capacity)
3583{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003584 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003585 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003586 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003587 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003588 }
3589
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003590 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003591 return( PSA_SUCCESS );
3592}
3593
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003594psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003595 size_t capacity )
3596{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003597 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003598 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003599 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003600 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003601 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003602 return( PSA_SUCCESS );
3603}
3604
John Durkopd0321952020-10-29 21:37:36 -07003605#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003606/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003607 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003608static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003609 psa_algorithm_t hash_alg,
3610 uint8_t *output,
3611 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003612{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003613 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003614 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003615 psa_status_t status;
3616
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003617 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3618 return( PSA_ERROR_BAD_STATE );
3619 hkdf->state = HKDF_STATE_OUTPUT;
3620
Gilles Peskinebef7f142018-07-12 17:22:21 +02003621 while( output_length != 0 )
3622 {
3623 /* Copy what remains of the current block */
3624 uint8_t n = hash_length - hkdf->offset_in_block;
3625 if( n > output_length )
3626 n = (uint8_t) output_length;
3627 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3628 output += n;
3629 output_length -= n;
3630 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003631 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003632 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003633 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003634 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003635 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003636 * object was corrupted or if this function is called directly
3637 * inside the library. */
3638 if( hkdf->block_number == 0xff )
3639 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003640
3641 /* We need a new block */
3642 ++hkdf->block_number;
3643 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003644
Steven Cooreman094a77e2021-05-06 17:58:36 +02003645 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3646 hash_alg,
3647 hkdf->prk,
3648 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003649 if( status != PSA_SUCCESS )
3650 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003651
Gilles Peskinebef7f142018-07-12 17:22:21 +02003652 if( hkdf->block_number != 1 )
3653 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003654 status = psa_mac_update( &hkdf->hmac,
3655 hkdf->output_block,
3656 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003657 if( status != PSA_SUCCESS )
3658 return( status );
3659 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003660 status = psa_mac_update( &hkdf->hmac,
3661 hkdf->info,
3662 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003663 if( status != PSA_SUCCESS )
3664 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003665 status = psa_mac_update( &hkdf->hmac,
3666 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003667 if( status != PSA_SUCCESS )
3668 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02003669 status = psa_mac_sign_finish( &hkdf->hmac,
3670 hkdf->output_block,
3671 sizeof( hkdf->output_block ),
3672 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003673 if( status != PSA_SUCCESS )
3674 return( status );
3675 }
3676
3677 return( PSA_SUCCESS );
3678}
John Durkop07cc04a2020-11-16 22:08:34 -08003679#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003680
John Durkop07cc04a2020-11-16 22:08:34 -08003681#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3682 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003683static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3684 psa_tls12_prf_key_derivation_t *tls12_prf,
3685 psa_algorithm_t alg )
3686{
3687 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003688 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02003689 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3690 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003691 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003692
Janos Follath7742fee2019-06-17 12:58:10 +01003693 /* We can't be wanting more output after block 0xff, otherwise
3694 * the capacity check in psa_key_derivation_output_bytes() would have
3695 * prevented this call. It could happen only if the operation
3696 * object was corrupted or if this function is called directly
3697 * inside the library. */
3698 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003699 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003700
3701 /* We need a new block */
3702 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003703 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003704
3705 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3706 *
3707 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3708 *
3709 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3710 * HMAC_hash(secret, A(2) + seed) +
3711 * HMAC_hash(secret, A(3) + seed) + ...
3712 *
3713 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003714 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003715 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003716 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003717 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003718 * is currently extracted as `output_block` and where i is
3719 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003720 */
3721
Steven Cooreman094a77e2021-05-06 17:58:36 +02003722 status = psa_key_derivation_start_hmac( &hmac,
3723 hash_alg,
3724 tls12_prf->secret,
3725 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003726 if( status != PSA_SUCCESS )
3727 goto cleanup;
3728
3729 /* Calculate A(i) where i = tls12_prf->block_number. */
3730 if( tls12_prf->block_number == 1 )
3731 {
3732 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3733 * the variable seed and in this instance means it in the context of the
3734 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003735 status = psa_mac_update( &hmac,
3736 tls12_prf->label,
3737 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003738 if( status != PSA_SUCCESS )
3739 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003740 status = psa_mac_update( &hmac,
3741 tls12_prf->seed,
3742 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003743 if( status != PSA_SUCCESS )
3744 goto cleanup;
3745 }
3746 else
3747 {
3748 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02003749 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003750 if( status != PSA_SUCCESS )
3751 goto cleanup;
3752 }
3753
Steven Cooremana6df6042021-04-29 19:32:25 +02003754 status = psa_mac_sign_finish( &hmac,
3755 tls12_prf->Ai, hash_length,
3756 &hmac_output_length );
3757 if( hmac_output_length != hash_length )
3758 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003759 if( status != PSA_SUCCESS )
3760 goto cleanup;
3761
3762 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02003763 status = psa_key_derivation_start_hmac( &hmac,
3764 hash_alg,
3765 tls12_prf->secret,
3766 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003767 if( status != PSA_SUCCESS )
3768 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003769 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003770 if( status != PSA_SUCCESS )
3771 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003772 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003773 if( status != PSA_SUCCESS )
3774 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003775 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003776 if( status != PSA_SUCCESS )
3777 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02003778 status = psa_mac_sign_finish( &hmac,
3779 tls12_prf->output_block, hash_length,
3780 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003781 if( status != PSA_SUCCESS )
3782 goto cleanup;
3783
Janos Follath7742fee2019-06-17 12:58:10 +01003784
3785cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02003786 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003787 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3788 status = cleanup_status;
3789
3790 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003791}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003792
Janos Follath844eb0e2019-06-19 12:10:49 +01003793static psa_status_t psa_key_derivation_tls12_prf_read(
3794 psa_tls12_prf_key_derivation_t *tls12_prf,
3795 psa_algorithm_t alg,
3796 uint8_t *output,
3797 size_t output_length )
3798{
3799 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003800 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003801 psa_status_t status;
3802 uint8_t offset, length;
3803
3804 while( output_length != 0 )
3805 {
3806 /* Check if we have fully processed the current block. */
3807 if( tls12_prf->left_in_block == 0 )
3808 {
3809 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3810 alg );
3811 if( status != PSA_SUCCESS )
3812 return( status );
3813
3814 continue;
3815 }
3816
3817 if( tls12_prf->left_in_block > output_length )
3818 length = (uint8_t) output_length;
3819 else
3820 length = tls12_prf->left_in_block;
3821
3822 offset = hash_length - tls12_prf->left_in_block;
3823 memcpy( output, tls12_prf->output_block + offset, length );
3824 output += length;
3825 output_length -= length;
3826 tls12_prf->left_in_block -= length;
3827 }
3828
3829 return( PSA_SUCCESS );
3830}
John Durkop07cc04a2020-11-16 22:08:34 -08003831#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3832 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003833
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003834psa_status_t psa_key_derivation_output_bytes(
3835 psa_key_derivation_operation_t *operation,
3836 uint8_t *output,
3837 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003838{
3839 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003840 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003841
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003842 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003843 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003844 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003845 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003846 }
3847
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003848 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003849 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003850 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003851 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003852 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003853 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003854 goto exit;
3855 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003856 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003857 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003858 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003859 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003860 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3861 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003862 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003863 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003864 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003865 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003866 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003867
John Durkopd0321952020-10-29 21:37:36 -07003868#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003869 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003870 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003871 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003872 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003873 output, output_length );
3874 }
Janos Follathadbec812019-06-14 11:05:39 +01003875 else
John Durkop07cc04a2020-11-16 22:08:34 -08003876#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3877#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3878 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003879 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003880 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003881 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003882 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02003883 kdf_alg, output,
3884 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003885 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003886 else
John Durkop07cc04a2020-11-16 22:08:34 -08003887#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3888 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003889 {
Steven Cooreman74afe472021-02-10 17:19:22 +01003890 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003891 return( PSA_ERROR_BAD_STATE );
3892 }
3893
3894exit:
3895 if( status != PSA_SUCCESS )
3896 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003897 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003898 * This allows us to differentiate between exhausted operations and
3899 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
3900 * operations. */
3901 psa_algorithm_t alg = operation->alg;
3902 psa_key_derivation_abort( operation );
3903 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003904 memset( output, '!', output_length );
3905 }
3906 return( status );
3907}
3908
David Brown7807bf72021-02-09 16:28:23 -07003909#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02003910static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
3911{
3912 if( data_size >= 8 )
3913 mbedtls_des_key_set_parity( data );
3914 if( data_size >= 16 )
3915 mbedtls_des_key_set_parity( data + 8 );
3916 if( data_size >= 24 )
3917 mbedtls_des_key_set_parity( data + 16 );
3918}
David Brown7807bf72021-02-09 16:28:23 -07003919#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02003920
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003921static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003922 psa_key_slot_t *slot,
3923 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003924 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003925{
3926 uint8_t *data = NULL;
3927 size_t bytes = PSA_BITS_TO_BYTES( bits );
3928 psa_status_t status;
3929
Gilles Peskine8e338702019-07-30 20:06:31 +02003930 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003931 return( PSA_ERROR_INVALID_ARGUMENT );
3932 if( bits % 8 != 0 )
3933 return( PSA_ERROR_INVALID_ARGUMENT );
3934 data = mbedtls_calloc( 1, bytes );
3935 if( data == NULL )
3936 return( PSA_ERROR_INSUFFICIENT_MEMORY );
3937
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003938 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003939 if( status != PSA_SUCCESS )
3940 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07003941#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02003942 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02003943 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07003944#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01003945
3946 status = psa_allocate_buffer_to_slot( slot, bytes );
3947 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00003948 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01003949
Ronald Cronbf33c932020-11-28 18:06:53 +01003950 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01003951 psa_key_attributes_t attributes = {
3952 .core = slot->attr
3953 };
3954
Ronald Cronbf33c932020-11-28 18:06:53 +01003955 status = psa_driver_wrapper_import_key( &attributes,
3956 data, bytes,
3957 slot->key.data,
3958 slot->key.bytes,
3959 &slot->key.bytes, &bits );
3960 if( bits != slot->attr.bits )
3961 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003962
3963exit:
3964 mbedtls_free( data );
3965 return( status );
3966}
3967
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003968psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003969 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003970 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003971{
3972 psa_status_t status;
3973 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02003974 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02003975
Ronald Cron81709fc2020-11-14 12:10:32 +01003976 *key = MBEDTLS_SVC_KEY_ID_INIT;
3977
Gilles Peskine0f84d622019-09-12 19:03:13 +02003978 /* Reject any attempt to create a zero-length key so that we don't
3979 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
3980 if( psa_get_key_bits( attributes ) == 0 )
3981 return( PSA_ERROR_INVALID_ARGUMENT );
3982
Gilles Peskine178c9aa2019-09-24 18:21:06 +02003983 if( ! operation->can_output_key )
3984 return( PSA_ERROR_NOT_PERMITTED );
3985
Ronald Cron81709fc2020-11-14 12:10:32 +01003986 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
3987 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02003988#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
3989 if( driver != NULL )
3990 {
3991 /* Deriving a key in a secure element is not implemented yet. */
3992 status = PSA_ERROR_NOT_SUPPORTED;
3993 }
3994#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02003995 if( status == PSA_SUCCESS )
3996 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01003997 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02003998 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003999 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004000 }
4001 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004002 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004003 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004004 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004005
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004006 return( status );
4007}
4008
Gilles Peskineeab56e42018-07-12 17:12:33 +02004009
4010
4011/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004012/* Key derivation */
4013/****************************************************************/
4014
Steven Cooreman932ffb72021-02-15 12:14:32 +01004015#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004016static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004017 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004018 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004019{
John Durkop07cc04a2020-11-16 22:08:34 -08004020 int is_kdf_alg_supported;
4021
Janos Follath5fe19732019-06-20 15:09:30 +01004022 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4023 * initialisers for this union leave some bytes unspecified.) */
4024 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4025
Gilles Peskine969c5d62019-01-16 15:53:06 +01004026 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004027#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004028 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4029 is_kdf_alg_supported = 1;
4030 else
4031#endif
4032#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4033 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4034 is_kdf_alg_supported = 1;
4035 else
4036#endif
4037#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4038 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4039 is_kdf_alg_supported = 1;
4040 else
4041#endif
4042 is_kdf_alg_supported = 0;
4043
4044 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004045 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004046 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004047 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004048 if( hash_size == 0 )
4049 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004050 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4051 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004052 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004053 {
4054 return( PSA_ERROR_NOT_SUPPORTED );
4055 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004056 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004057 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004058 }
John Durkop07cc04a2020-11-16 22:08:34 -08004059
4060 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004061}
John Durkop07cc04a2020-11-16 22:08:34 -08004062#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004063
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004064psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004065 psa_algorithm_t alg )
4066{
4067 psa_status_t status;
4068
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004069 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004070 return( PSA_ERROR_BAD_STATE );
4071
Gilles Peskine6843c292019-01-18 16:44:49 +01004072 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4073 return( PSA_ERROR_INVALID_ARGUMENT );
4074 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004075 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004076#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004077 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004078 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004079#else
4080 return( PSA_ERROR_NOT_SUPPORTED );
4081#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004082 }
4083 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4084 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004085#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004086 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004087#else
4088 return( PSA_ERROR_NOT_SUPPORTED );
4089#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004090 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004091 else
4092 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004093
4094 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004095 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004096 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004097}
4098
John Durkopd0321952020-10-29 21:37:36 -07004099#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004100static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004101 psa_algorithm_t hash_alg,
4102 psa_key_derivation_step_t step,
4103 const uint8_t *data,
4104 size_t data_length )
4105{
4106 psa_status_t status;
4107 switch( step )
4108 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004109 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004110 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004111 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004112 else
4113 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004114 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4115 hash_alg,
4116 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004117 if( status != PSA_SUCCESS )
4118 return( status );
4119 hkdf->state = HKDF_STATE_STARTED;
4120 return( PSA_SUCCESS );
4121 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004122 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004123 /* If no salt was provided, use an empty salt. */
4124 if( hkdf->state == HKDF_STATE_INIT )
4125 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02004126 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4127 hash_alg,
4128 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004129 if( status != PSA_SUCCESS )
4130 return( status );
4131 hkdf->state = HKDF_STATE_STARTED;
4132 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004133 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004134 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004135 status = psa_mac_update( &hkdf->hmac,
4136 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004137 if( status != PSA_SUCCESS )
4138 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004139 status = psa_mac_sign_finish( &hkdf->hmac,
4140 hkdf->prk,
4141 sizeof( hkdf->prk ),
4142 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004143 if( status != PSA_SUCCESS )
4144 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004145 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004146 hkdf->block_number = 0;
4147 hkdf->state = HKDF_STATE_KEYED;
4148 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004149 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004150 if( hkdf->state == HKDF_STATE_OUTPUT )
4151 return( PSA_ERROR_BAD_STATE );
4152 if( hkdf->info_set )
4153 return( PSA_ERROR_BAD_STATE );
4154 hkdf->info_length = data_length;
4155 if( data_length != 0 )
4156 {
4157 hkdf->info = mbedtls_calloc( 1, data_length );
4158 if( hkdf->info == NULL )
4159 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4160 memcpy( hkdf->info, data, data_length );
4161 }
4162 hkdf->info_set = 1;
4163 return( PSA_SUCCESS );
4164 default:
4165 return( PSA_ERROR_INVALID_ARGUMENT );
4166 }
4167}
John Durkop07cc04a2020-11-16 22:08:34 -08004168#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004169
John Durkop07cc04a2020-11-16 22:08:34 -08004170#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4171 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004172static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4173 const uint8_t *data,
4174 size_t data_length )
4175{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004176 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004177 return( PSA_ERROR_BAD_STATE );
4178
Janos Follathd6dce9f2019-07-04 09:11:38 +01004179 if( data_length != 0 )
4180 {
4181 prf->seed = mbedtls_calloc( 1, data_length );
4182 if( prf->seed == NULL )
4183 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004184
Janos Follathd6dce9f2019-07-04 09:11:38 +01004185 memcpy( prf->seed, data, data_length );
4186 prf->seed_length = data_length;
4187 }
Janos Follathf08e2652019-06-13 09:05:41 +01004188
Gilles Peskine43f958b2020-12-13 14:55:14 +01004189 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004190
4191 return( PSA_SUCCESS );
4192}
4193
Janos Follath81550542019-06-13 14:26:34 +01004194static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004195 const uint8_t *data,
4196 size_t data_length )
4197{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004198 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004199 return( PSA_ERROR_BAD_STATE );
4200
Steven Cooremana6df6042021-04-29 19:32:25 +02004201 if( data_length != 0 )
4202 {
4203 prf->secret = mbedtls_calloc( 1, data_length );
4204 if( prf->secret == NULL )
4205 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4206
4207 memcpy( prf->secret, data, data_length );
4208 prf->secret_length = data_length;
4209 }
Janos Follath81550542019-06-13 14:26:34 +01004210
Gilles Peskine43f958b2020-12-13 14:55:14 +01004211 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004212
4213 return( PSA_SUCCESS );
4214}
4215
Janos Follath63028dd2019-06-13 09:15:47 +01004216static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4217 const uint8_t *data,
4218 size_t data_length )
4219{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004220 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004221 return( PSA_ERROR_BAD_STATE );
4222
Janos Follathd6dce9f2019-07-04 09:11:38 +01004223 if( data_length != 0 )
4224 {
4225 prf->label = mbedtls_calloc( 1, data_length );
4226 if( prf->label == NULL )
4227 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004228
Janos Follathd6dce9f2019-07-04 09:11:38 +01004229 memcpy( prf->label, data, data_length );
4230 prf->label_length = data_length;
4231 }
Janos Follath63028dd2019-06-13 09:15:47 +01004232
Gilles Peskine43f958b2020-12-13 14:55:14 +01004233 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004234
4235 return( PSA_SUCCESS );
4236}
4237
Janos Follathb03233e2019-06-11 15:30:30 +01004238static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004239 psa_key_derivation_step_t step,
4240 const uint8_t *data,
4241 size_t data_length )
4242{
Janos Follathb03233e2019-06-11 15:30:30 +01004243 switch( step )
4244 {
Janos Follathf08e2652019-06-13 09:05:41 +01004245 case PSA_KEY_DERIVATION_INPUT_SEED:
4246 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004247 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02004248 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004249 case PSA_KEY_DERIVATION_INPUT_LABEL:
4250 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004251 default:
4252 return( PSA_ERROR_INVALID_ARGUMENT );
4253 }
4254}
John Durkop07cc04a2020-11-16 22:08:34 -08004255#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4256 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4257
4258#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4259static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4260 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004261 const uint8_t *data,
4262 size_t data_length )
4263{
4264 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004265 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004266 uint8_t *cur = pms;
4267
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004268 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004269 return( PSA_ERROR_INVALID_ARGUMENT );
4270
4271 /* Quoting RFC 4279, Section 2:
4272 *
4273 * The premaster secret is formed as follows: if the PSK is N octets
4274 * long, concatenate a uint16 with the value N, N zero octets, a second
4275 * uint16 with the value N, and the PSK itself.
4276 */
4277
4278 *cur++ = ( data_length >> 8 ) & 0xff;
4279 *cur++ = ( data_length >> 0 ) & 0xff;
4280 memset( cur, 0, data_length );
4281 cur += data_length;
4282 *cur++ = pms[0];
4283 *cur++ = pms[1];
4284 memcpy( cur, data, data_length );
4285 cur += data_length;
4286
Steven Cooremana6df6042021-04-29 19:32:25 +02004287 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004288
4289 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4290 return( status );
4291}
Janos Follath6660f0e2019-06-17 08:44:03 +01004292
4293static psa_status_t psa_tls12_prf_psk_to_ms_input(
4294 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004295 psa_key_derivation_step_t step,
4296 const uint8_t *data,
4297 size_t data_length )
4298{
4299 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004300 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004301 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004302 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004303 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004304
Steven Cooremana6df6042021-04-29 19:32:25 +02004305 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004306}
John Durkop07cc04a2020-11-16 22:08:34 -08004307#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004308
Gilles Peskineb8965192019-09-24 16:21:10 +02004309/** Check whether the given key type is acceptable for the given
4310 * input step of a key derivation.
4311 *
4312 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4313 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4314 * Both secret and non-secret inputs can alternatively have the type
4315 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4316 * that the input was passed as a buffer rather than via a key object.
4317 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004318static int psa_key_derivation_check_input_type(
4319 psa_key_derivation_step_t step,
4320 psa_key_type_t key_type )
4321{
4322 switch( step )
4323 {
4324 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004325 if( key_type == PSA_KEY_TYPE_DERIVE )
4326 return( PSA_SUCCESS );
4327 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004328 return( PSA_SUCCESS );
4329 break;
4330 case PSA_KEY_DERIVATION_INPUT_LABEL:
4331 case PSA_KEY_DERIVATION_INPUT_SALT:
4332 case PSA_KEY_DERIVATION_INPUT_INFO:
4333 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004334 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4335 return( PSA_SUCCESS );
4336 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004337 return( PSA_SUCCESS );
4338 break;
4339 }
4340 return( PSA_ERROR_INVALID_ARGUMENT );
4341}
4342
Janos Follathb80a94e2019-06-12 15:54:46 +01004343static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004344 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004345 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004346 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004347 const uint8_t *data,
4348 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004349{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004350 psa_status_t status;
4351 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4352
4353 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004354 if( status != PSA_SUCCESS )
4355 goto exit;
4356
John Durkopd0321952020-10-29 21:37:36 -07004357#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004358 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004359 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004360 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004361 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004362 step, data, data_length );
4363 }
John Durkop07cc04a2020-11-16 22:08:34 -08004364 else
4365#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4366#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4367 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004368 {
Janos Follathb03233e2019-06-11 15:30:30 +01004369 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004370 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004371 }
John Durkop07cc04a2020-11-16 22:08:34 -08004372 else
4373#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4374#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4375 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004376 {
4377 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004378 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004379 }
4380 else
John Durkop07cc04a2020-11-16 22:08:34 -08004381#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004382 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004383 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004384 (void) data;
4385 (void) data_length;
4386 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004387 return( PSA_ERROR_BAD_STATE );
4388 }
4389
Gilles Peskine224b0d62019-09-23 18:13:17 +02004390exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004391 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004392 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004393 return( status );
4394}
4395
Janos Follath51f4a0f2019-06-14 11:35:55 +01004396psa_status_t psa_key_derivation_input_bytes(
4397 psa_key_derivation_operation_t *operation,
4398 psa_key_derivation_step_t step,
4399 const uint8_t *data,
4400 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004401{
Gilles Peskineb8965192019-09-24 16:21:10 +02004402 return( psa_key_derivation_input_internal( operation, step,
4403 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004404 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004405}
4406
Janos Follath51f4a0f2019-06-14 11:35:55 +01004407psa_status_t psa_key_derivation_input_key(
4408 psa_key_derivation_operation_t *operation,
4409 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004410 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004411{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004413 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004414 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004415
Ronald Cron5c522922020-11-14 16:35:34 +01004416 status = psa_get_and_lock_transparent_key_slot_with_policy(
4417 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004418 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004419 {
4420 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004421 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004422 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004423
4424 /* Passing a key object as a SECRET input unlocks the permission
4425 * to output to a key object. */
4426 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4427 operation->can_output_key = 1;
4428
Ronald Cronf95a2b12020-10-22 15:24:49 +02004429 status = psa_key_derivation_input_internal( operation,
4430 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004431 slot->key.data,
4432 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004433
Ronald Cron5c522922020-11-14 16:35:34 +01004434 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004435
Ronald Cron5c522922020-11-14 16:35:34 +01004436 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004437}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004438
4439
4440
4441/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004442/* Key agreement */
4443/****************************************************************/
4444
John Durkop6ba40d12020-11-10 08:50:04 -08004445#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004446static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4447 size_t peer_key_length,
4448 const mbedtls_ecp_keypair *our_key,
4449 uint8_t *shared_secret,
4450 size_t shared_secret_size,
4451 size_t *shared_secret_length )
4452{
Steven Cooremand4867872020-08-05 16:31:39 +02004453 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004454 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004455 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004456 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004457 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004458 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004459
Ronald Cron90857082020-11-25 14:58:33 +01004460 status = mbedtls_psa_ecp_load_representation(
4461 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004462 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004463 peer_key,
4464 peer_key_length,
4465 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004466 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004467 goto exit;
4468
Jaeden Amero97271b32019-01-10 19:38:51 +00004469 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004470 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004471 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004472 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004473 status = mbedtls_to_psa_error(
4474 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4475 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004476 goto exit;
4477
Jaeden Amero97271b32019-01-10 19:38:51 +00004478 status = mbedtls_to_psa_error(
4479 mbedtls_ecdh_calc_secret( &ecdh,
4480 shared_secret_length,
4481 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004482 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004483 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004484 if( status != PSA_SUCCESS )
4485 goto exit;
4486 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4487 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004488
4489exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004490 if( status != PSA_SUCCESS )
4491 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004492 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004493 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004494 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004495
Jaeden Amero97271b32019-01-10 19:38:51 +00004496 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004497}
John Durkop6ba40d12020-11-10 08:50:04 -08004498#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004499
Gilles Peskine01d718c2018-09-18 12:01:02 +02004500#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4501
Gilles Peskine0216fe12019-04-11 21:23:21 +02004502static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4503 psa_key_slot_t *private_key,
4504 const uint8_t *peer_key,
4505 size_t peer_key_length,
4506 uint8_t *shared_secret,
4507 size_t shared_secret_size,
4508 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004509{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004510 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004511 {
John Durkop6ba40d12020-11-10 08:50:04 -08004512#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004513 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004514 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004515 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004516 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004517 psa_status_t status = mbedtls_psa_ecp_load_representation(
4518 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004519 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004520 private_key->key.data,
4521 private_key->key.bytes,
4522 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004523 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004524 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004525 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004526 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004527 shared_secret, shared_secret_size,
4528 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004529 mbedtls_ecp_keypair_free( ecp );
4530 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004531 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004532#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004533 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004534 (void) private_key;
4535 (void) peer_key;
4536 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004537 (void) shared_secret;
4538 (void) shared_secret_size;
4539 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004540 return( PSA_ERROR_NOT_SUPPORTED );
4541 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004542}
4543
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004544/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004545 * to potentially free embedded data structures and wipe confidential data.
4546 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004547static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004548 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004549 psa_key_slot_t *private_key,
4550 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004551 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004552{
4553 psa_status_t status;
4554 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4555 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004556 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004557
4558 /* Step 1: run the secret agreement algorithm to generate the shared
4559 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004560 status = psa_key_agreement_raw_internal( ka_alg,
4561 private_key,
4562 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004563 shared_secret,
4564 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004565 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004566 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004567 goto exit;
4568
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004569 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004570 * the shared secret. A shared secret is permitted wherever a key
4571 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004572 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004573 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004574 shared_secret,
4575 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004576exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004577 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004578 return( status );
4579}
4580
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004581psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004582 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004583 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004584 const uint8_t *peer_key,
4585 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004586{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004587 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004588 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004589 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004590
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004591 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004592 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004593 status = psa_get_and_lock_transparent_key_slot_with_policy(
4594 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004595 if( status != PSA_SUCCESS )
4596 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004597 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004598 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004599 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004600 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004601 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004602 else
4603 {
4604 /* If a private key has been added as SECRET, we allow the derived
4605 * key material to be used as a key in PSA Crypto. */
4606 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4607 operation->can_output_key = 1;
4608 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004609
Ronald Cron5c522922020-11-14 16:35:34 +01004610 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004611
Ronald Cron5c522922020-11-14 16:35:34 +01004612 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004613}
4614
Gilles Peskinebe697d82019-05-16 18:00:41 +02004615psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004616 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004617 const uint8_t *peer_key,
4618 size_t peer_key_length,
4619 uint8_t *output,
4620 size_t output_size,
4621 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004622{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004624 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004625 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004626
4627 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4628 {
4629 status = PSA_ERROR_INVALID_ARGUMENT;
4630 goto exit;
4631 }
Ronald Cron5c522922020-11-14 16:35:34 +01004632 status = psa_get_and_lock_transparent_key_slot_with_policy(
4633 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004634 if( status != PSA_SUCCESS )
4635 goto exit;
4636
4637 status = psa_key_agreement_raw_internal( alg, slot,
4638 peer_key, peer_key_length,
4639 output, output_size,
4640 output_length );
4641
4642exit:
4643 if( status != PSA_SUCCESS )
4644 {
4645 /* If an error happens and is not handled properly, the output
4646 * may be used as a key to protect sensitive data. Arrange for such
4647 * a key to be random, which is likely to result in decryption or
4648 * verification errors. This is better than filling the buffer with
4649 * some constant data such as zeros, which would result in the data
4650 * being protected with a reproducible, easily knowable key.
4651 */
4652 psa_generate_random( output, output_size );
4653 *output_length = output_size;
4654 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004655
Ronald Cron5c522922020-11-14 16:35:34 +01004656 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004657
Ronald Cron5c522922020-11-14 16:35:34 +01004658 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004659}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004660
4661
Gilles Peskine30524eb2020-11-13 17:02:26 +01004662
Gilles Peskine86a440b2018-11-12 18:39:40 +01004663/****************************************************************/
4664/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004665/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004666
Gilles Peskine30524eb2020-11-13 17:02:26 +01004667/** Initialize the PSA random generator.
4668 */
4669static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4670{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004671#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4672 memset( rng, 0, sizeof( *rng ) );
4673#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4674
Gilles Peskine30524eb2020-11-13 17:02:26 +01004675 /* Set default configuration if
4676 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4677 if( rng->entropy_init == NULL )
4678 rng->entropy_init = mbedtls_entropy_init;
4679 if( rng->entropy_free == NULL )
4680 rng->entropy_free = mbedtls_entropy_free;
4681
4682 rng->entropy_init( &rng->entropy );
4683#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4684 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4685 /* The PSA entropy injection feature depends on using NV seed as an entropy
4686 * source. Add NV seed as an entropy source for PSA entropy injection. */
4687 mbedtls_entropy_add_source( &rng->entropy,
4688 mbedtls_nv_seed_poll, NULL,
4689 MBEDTLS_ENTROPY_BLOCK_SIZE,
4690 MBEDTLS_ENTROPY_SOURCE_STRONG );
4691#endif
4692
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004693 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004694#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004695}
4696
4697/** Deinitialize the PSA random generator.
4698 */
4699static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4700{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004701#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4702 memset( rng, 0, sizeof( *rng ) );
4703#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004704 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004705 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004706#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004707}
4708
4709/** Seed the PSA random generator.
4710 */
4711static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4712{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004713#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4714 /* Do nothing: the external RNG seeds itself. */
4715 (void) rng;
4716 return( PSA_SUCCESS );
4717#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004718 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004719 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4720 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004721 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004722#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004723}
4724
Gilles Peskinee59236f2018-01-27 23:32:46 +01004725psa_status_t psa_generate_random( uint8_t *output,
4726 size_t output_size )
4727{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004728 GUARD_MODULE_INITIALIZED;
4729
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004730#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4731
4732 size_t output_length = 0;
4733 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4734 output, output_size,
4735 &output_length );
4736 if( status != PSA_SUCCESS )
4737 return( status );
4738 /* Breaking up a request into smaller chunks is currently not supported
4739 * for the extrernal RNG interface. */
4740 if( output_length != output_size )
4741 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4742 return( PSA_SUCCESS );
4743
4744#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4745
Gilles Peskine71ddab92021-01-04 21:01:07 +01004746 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004747 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004748 size_t request_size =
4749 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4750 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4751 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004752 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4753 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004754 if( ret != 0 )
4755 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004756 output_size -= request_size;
4757 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004758 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004759 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004760#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004761}
4762
Gilles Peskine8814fc42020-12-14 15:33:44 +01004763/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004764 *
4765 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4766 * `psa_generate_random(...)`. The state parameter is ignored since the
4767 * PSA API doesn't support passing an explicit state.
4768 *
4769 * In the non-external case, psa_generate_random() calls an
4770 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4771 * and semantics as mbedtls_psa_get_random(). As an optimization,
4772 * instead of doing this back-and-forth between the PSA API and the
4773 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4774 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004775 */
4776#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4777int mbedtls_psa_get_random( void *p_rng,
4778 unsigned char *output,
4779 size_t output_size )
4780{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004781 /* This function takes a pointer to the RNG state because that's what
4782 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4783 * its own state internally and doesn't let the caller access that state.
4784 * So we just ignore the state parameter, and in practice we'll pass
4785 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004786 (void) p_rng;
4787 psa_status_t status = psa_generate_random( output, output_size );
4788 if( status == PSA_SUCCESS )
4789 return( 0 );
4790 else
4791 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4792}
4793#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4794
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004795#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00004796#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004797
Gilles Peskine7228da22019-07-15 11:06:15 +02004798psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004799 size_t seed_size )
4800{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004801 if( global_data.initialized )
4802 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004803
4804 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4805 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4806 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4807 return( PSA_ERROR_INVALID_ARGUMENT );
4808
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004809 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004810}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004811#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004812
Ronald Cron3772afe2021-02-08 16:10:05 +01004813/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004814 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004815 * \param type The key type
4816 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004817 *
4818 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004819 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004820 * \retval #PSA_ERROR_INVALID_ARGUMENT
4821 * The size in bits of the key is not valid.
4822 * \retval #PSA_ERROR_NOT_SUPPORTED
4823 * The type and/or the size in bits of the key or the combination of
4824 * the two is not supported.
4825 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004826static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4827 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004828{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004829 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004830
Gilles Peskinee59236f2018-01-27 23:32:46 +01004831 if( key_type_is_raw_bytes( type ) )
4832 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004833 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004834 if( status != PSA_SUCCESS )
4835 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004836 }
4837 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004838#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004839 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4840 {
4841 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4842 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004843
Ronald Cron01b2aba2020-10-05 09:42:02 +02004844 /* Accept only byte-aligned keys, for the same reasons as
4845 * in psa_import_rsa_key(). */
4846 if( bits % 8 != 0 )
4847 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004848 }
4849 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004850#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004851
Ronald Cron5c4d3862020-12-07 11:07:24 +01004852#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004853 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4854 {
Ronald Crond81ab562021-02-16 09:01:16 +01004855 /* To avoid empty block, return successfully here. */
4856 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004857 }
4858 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004859#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004860 {
4861 return( PSA_ERROR_NOT_SUPPORTED );
4862 }
4863
4864 return( PSA_SUCCESS );
4865}
4866
Ronald Cron55ed0592020-10-05 10:30:40 +02004867psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004868 const psa_key_attributes_t *attributes,
4869 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004870{
4871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004872 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004873
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004874 if( ( attributes->domain_parameters == NULL ) &&
4875 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004876 return( PSA_ERROR_INVALID_ARGUMENT );
4877
Ronald Cron01b2aba2020-10-05 09:42:02 +02004878 if( key_type_is_raw_bytes( type ) )
4879 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004880 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004881 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004882 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004883
David Brown12ca5032021-02-11 11:02:00 -07004884#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004885 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004886 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004887#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004888 }
4889 else
4890
Jaeden Amero424fa932021-05-14 08:34:32 +01004891#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
4892 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004893 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004894 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01004895 return( mbedtls_psa_rsa_generate_key( attributes,
4896 key_buffer,
4897 key_buffer_size,
4898 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004899 }
4900 else
Jaeden Amero424fa932021-05-14 08:34:32 +01004901#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
4902 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004903
John Durkop9814fa22020-11-04 12:28:15 -08004904#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02004905 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004906 {
Ronald Cron7023db52020-11-20 18:17:42 +01004907 return( mbedtls_psa_ecp_generate_key( attributes,
4908 key_buffer,
4909 key_buffer_size,
4910 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004911 }
4912 else
John Durkop9814fa22020-11-04 12:28:15 -08004913#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02004914 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004915 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004916 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02004917 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01004918
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004919 return( PSA_SUCCESS );
4920}
Darryl Green0c6575a2018-11-07 16:05:30 +00004921
Gilles Peskine35ef36b2019-05-16 19:42:05 +02004922psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004923 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004924{
4925 psa_status_t status;
4926 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004927 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02004928 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02004929
Ronald Cron81709fc2020-11-14 12:10:32 +01004930 *key = MBEDTLS_SVC_KEY_ID_INIT;
4931
Gilles Peskine0f84d622019-09-12 19:03:13 +02004932 /* Reject any attempt to create a zero-length key so that we don't
4933 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4934 if( psa_get_key_bits( attributes ) == 0 )
4935 return( PSA_ERROR_INVALID_ARGUMENT );
4936
Ronald Cron81709fc2020-11-14 12:10:32 +01004937 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
4938 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02004939 if( status != PSA_SUCCESS )
4940 goto exit;
4941
Ronald Cron977c2472020-10-13 08:32:21 +02004942 /* In the case of a transparent key or an opaque key stored in local
4943 * storage (thus not in the case of generating a key in a secure element
4944 * or cryptoprocessor with storage), we have to allocate a buffer to
4945 * hold the generated key material. */
4946 if( slot->key.data == NULL )
4947 {
4948 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
4949 PSA_KEY_LOCATION_LOCAL_STORAGE )
4950 {
Ronald Cron3772afe2021-02-08 16:10:05 +01004951 status = psa_validate_key_type_and_size_for_key_generation(
4952 attributes->core.type, attributes->core.bits );
4953 if( status != PSA_SUCCESS )
4954 goto exit;
4955
4956 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
4957 attributes->core.type,
4958 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02004959 }
4960 else
4961 {
4962 status = psa_driver_wrapper_get_key_buffer_size(
4963 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01004964 if( status != PSA_SUCCESS )
4965 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02004966 }
Ronald Cron977c2472020-10-13 08:32:21 +02004967
4968 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
4969 if( status != PSA_SUCCESS )
4970 goto exit;
4971 }
4972
Steven Cooreman2a1664c2020-07-20 15:33:08 +02004973 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02004974 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02004975
Ronald Cron2b56bc82020-10-05 10:02:26 +02004976 if( status != PSA_SUCCESS )
4977 psa_remove_key_data_from_memory( slot );
4978
Gilles Peskine11792082019-08-06 18:36:36 +02004979exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004980 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004981 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004982 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004983 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004984
Darryl Green0c6575a2018-11-07 16:05:30 +00004985 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004986}
4987
Gilles Peskinee59236f2018-01-27 23:32:46 +01004988/****************************************************************/
4989/* Module setup */
4990/****************************************************************/
4991
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004992#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01004993psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
4994 void (* entropy_init )( mbedtls_entropy_context *ctx ),
4995 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
4996{
4997 if( global_data.rng_state != RNG_NOT_INITIALIZED )
4998 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004999 global_data.rng.entropy_init = entropy_init;
5000 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005001 return( PSA_SUCCESS );
5002}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005003#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005004
Gilles Peskinee59236f2018-01-27 23:32:46 +01005005void mbedtls_psa_crypto_free( void )
5006{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005007 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005008 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5009 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005010 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005011 }
5012 /* Wipe all remaining data, including configuration.
5013 * In particular, this sets all state indicator to the value
5014 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005015 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005016#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005017 /* Unregister all secure element drivers, so that we restart from
5018 * a pristine state. */
5019 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005020#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005021}
5022
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005023#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5024/** Recover a transaction that was interrupted by a power failure.
5025 *
5026 * This function is called during initialization, before psa_crypto_init()
5027 * returns. If this function returns a failure status, the initialization
5028 * fails.
5029 */
5030static psa_status_t psa_crypto_recover_transaction(
5031 const psa_crypto_transaction_t *transaction )
5032{
5033 switch( transaction->unknown.type )
5034 {
5035 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5036 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005037 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005038 * is implemented.
5039 * https://github.com/ARMmbed/mbed-crypto/issues/218
5040 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005041 default:
5042 /* We found an unsupported transaction in the storage.
5043 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005044 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005045 }
5046}
5047#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5048
Gilles Peskinee59236f2018-01-27 23:32:46 +01005049psa_status_t psa_crypto_init( void )
5050{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005051 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005052
Gilles Peskinec6b69072018-11-20 21:42:52 +01005053 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005054 if( global_data.initialized != 0 )
5055 return( PSA_SUCCESS );
5056
Gilles Peskine30524eb2020-11-13 17:02:26 +01005057 /* Initialize and seed the random generator. */
5058 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005059 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005060 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005061 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005062 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005063 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005064
Gilles Peskine66fb1262018-12-10 16:29:04 +01005065 status = psa_initialize_key_slots( );
5066 if( status != PSA_SUCCESS )
5067 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005068
Gilles Peskined9348f22019-10-01 15:22:29 +02005069#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5070 status = psa_init_all_se_drivers( );
5071 if( status != PSA_SUCCESS )
5072 goto exit;
5073#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5074
Gilles Peskine4b734222019-07-24 15:56:31 +02005075#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005076 status = psa_crypto_load_transaction( );
5077 if( status == PSA_SUCCESS )
5078 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005079 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5080 if( status != PSA_SUCCESS )
5081 goto exit;
5082 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005083 }
5084 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5085 {
5086 /* There's no transaction to complete. It's all good. */
5087 status = PSA_SUCCESS;
5088 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005089#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005090
Gilles Peskinec6b69072018-11-20 21:42:52 +01005091 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005092 global_data.initialized = 1;
5093
5094exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005095 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005096 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005097 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005098}
5099
5100#endif /* MBEDTLS_PSA_CRYPTO_C */