blob: 661b152623a5dd2cd0ac112b82b7c756744d102a [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
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010030#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031
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 Peskine9a944802018-06-21 09:35:35 +020061#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000062#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020063#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020065#include "mbedtls/chacha20.h"
66#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/cipher.h"
68#include "mbedtls/ccm.h"
69#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020071#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010073#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074#include "mbedtls/error.h"
75#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010077#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000078#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010079#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000080#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010081#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000082#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010083#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/sha1.h"
86#include "mbedtls/sha256.h"
87#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088
Gilles Peskine996deb12018-08-01 15:45:45 +020089#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
90
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010091/****************************************************************/
92/* Global data, support functions and library management */
93/****************************************************************/
94
Gilles Peskine48c0ea12018-06-21 14:15:31 +020095static int key_type_is_raw_bytes( psa_key_type_t type )
96{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020097 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020098}
99
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100100/* Values for psa_global_data_t::rng_state */
101#define RNG_NOT_INITIALIZED 0
102#define RNG_INITIALIZED 1
103#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100104
Gilles Peskine2d277862018-06-18 15:41:12 +0200105typedef struct
106{
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskine2d8a1822021-11-08 22:20:03 +0100109 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100110} psa_global_data_t;
111
112static psa_global_data_t global_data;
113
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100114#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
115mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
116 &global_data.rng.drbg;
117#endif
118
itayzafrir0adf0fc2018-09-06 16:24:41 +0300119#define GUARD_MODULE_INITIALIZED \
120 if( global_data.initialized == 0 ) \
121 return( PSA_ERROR_BAD_STATE );
122
Steven Cooreman01164162020-07-20 15:31:37 +0200123psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100125 /* Mbed TLS error codes can combine a high-level error code and a
126 * low-level error code. The low-level error usually reflects the
127 * root cause better, so dispatch on that preferably. */
128 int low_level_ret = - ( -ret & 0x007f );
129 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100130 {
131 case 0:
132 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100133
134 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
135 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100136 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200137 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
138 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
139 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
140 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
141 case MBEDTLS_ERR_ASN1_INVALID_DATA:
142 return( PSA_ERROR_INVALID_ARGUMENT );
143 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
144 return( PSA_ERROR_INSUFFICIENT_MEMORY );
145 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
146 return( PSA_ERROR_BUFFER_TOO_SMALL );
147
Jaeden Amero93e21112019-02-20 13:57:28 +0000148#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000149 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000150#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100151 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
152 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100153
154 case MBEDTLS_ERR_CCM_BAD_INPUT:
155 return( PSA_ERROR_INVALID_ARGUMENT );
156 case MBEDTLS_ERR_CCM_AUTH_FAILED:
157 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100158
Gilles Peskine26869f22019-05-06 15:25:00 +0200159 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
160 return( PSA_ERROR_INVALID_ARGUMENT );
161
162 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
163 return( PSA_ERROR_BAD_STATE );
164 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
165 return( PSA_ERROR_INVALID_SIGNATURE );
166
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
170 return( PSA_ERROR_INVALID_ARGUMENT );
171 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
172 return( PSA_ERROR_INSUFFICIENT_MEMORY );
173 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
174 return( PSA_ERROR_INVALID_PADDING );
175 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200176 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
178 return( PSA_ERROR_INVALID_SIGNATURE );
179 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200180 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100181
Gilles Peskine82e57d12020-11-13 21:31:17 +0100182#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
183 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100184 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
185 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100186 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
187 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
188 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
189 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
190 return( PSA_ERROR_NOT_SUPPORTED );
191 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
192 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100193#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100194
195 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
196 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Gilles Peskinee59236f2018-01-27 23:32:46 +0100198 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
199 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
200 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
201 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100202
203 case MBEDTLS_ERR_GCM_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200205 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
206 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200208 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100209
Gilles Peskine82e57d12020-11-13 21:31:17 +0100210#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
211 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100212 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
213 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100214 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
215 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
216 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
217 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
218 return( PSA_ERROR_NOT_SUPPORTED );
219 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
220 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
221#endif
222
Gilles Peskinea5905292018-02-07 20:59:33 +0100223 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
224 return( PSA_ERROR_NOT_SUPPORTED );
225 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
226 return( PSA_ERROR_INVALID_ARGUMENT );
227 case MBEDTLS_ERR_MD_ALLOC_FAILED:
228 return( PSA_ERROR_INSUFFICIENT_MEMORY );
229 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100231
Gilles Peskinef76aa772018-10-29 19:24:33 +0100232 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
233 return( PSA_ERROR_STORAGE_FAILURE );
234 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
235 return( PSA_ERROR_INVALID_ARGUMENT );
236 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
237 return( PSA_ERROR_INVALID_ARGUMENT );
238 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
239 return( PSA_ERROR_BUFFER_TOO_SMALL );
240 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
241 return( PSA_ERROR_INVALID_ARGUMENT );
242 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
243 return( PSA_ERROR_INVALID_ARGUMENT );
244 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
245 return( PSA_ERROR_INVALID_ARGUMENT );
246 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100249 case MBEDTLS_ERR_PK_ALLOC_FAILED:
250 return( PSA_ERROR_INSUFFICIENT_MEMORY );
251 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
252 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
253 return( PSA_ERROR_INVALID_ARGUMENT );
254 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100256 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
257 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
258 return( PSA_ERROR_INVALID_ARGUMENT );
259 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
260 return( PSA_ERROR_NOT_SUPPORTED );
261 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
262 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
263 return( PSA_ERROR_NOT_PERMITTED );
264 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_PK_INVALID_ALG:
267 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
268 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
269 return( PSA_ERROR_NOT_SUPPORTED );
270 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
271 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200272 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
273 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100274
Gilles Peskineff2d2002019-05-06 15:26:23 +0200275 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
276 return( PSA_ERROR_HARDWARE_FAILURE );
277 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
278 return( PSA_ERROR_NOT_SUPPORTED );
279
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
281 return( PSA_ERROR_INVALID_ARGUMENT );
282 case MBEDTLS_ERR_RSA_INVALID_PADDING:
283 return( PSA_ERROR_INVALID_PADDING );
284 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
285 return( PSA_ERROR_HARDWARE_FAILURE );
286 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
289 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200290 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100291 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
292 return( PSA_ERROR_INVALID_SIGNATURE );
293 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
294 return( PSA_ERROR_BUFFER_TOO_SMALL );
295 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100296 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200297
itayzafrir5c753392018-05-08 11:18:38 +0300298 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300299 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300300 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300301 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
302 return( PSA_ERROR_BUFFER_TOO_SMALL );
303 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
304 return( PSA_ERROR_NOT_SUPPORTED );
305 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
306 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
307 return( PSA_ERROR_INVALID_SIGNATURE );
308 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
309 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100310 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
311 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100312
Janos Follatha13b9052019-11-22 12:48:59 +0000313 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
314 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300315
Gilles Peskinee59236f2018-01-27 23:32:46 +0100316 default:
David Saadab4ecc272019-02-14 13:48:10 +0200317 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100318 }
319}
320
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200321
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200322
323
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100324/****************************************************************/
325/* Key management */
326/****************************************************************/
327
John Durkop9814fa22020-11-04 12:28:15 -0800328#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800329 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100330 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
331 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
332 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100333mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100334 size_t bits,
335 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200336{
337 switch( curve )
338 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100339 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100340 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100341 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100342#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100343 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100344 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100345#endif
346#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100347 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100348 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100349#endif
350#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100351 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100352 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100353#endif
354#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100356 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100357#endif
358#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100359 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100360 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 case 528:
362 if( bits_is_sloppy )
363 return( MBEDTLS_ECP_DP_SECP521R1 );
364 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100365#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100366 }
367 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100368
Paul Elliott8ff510a2020-06-02 17:19:28 +0100369 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100370 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100371 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100372#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100373 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100375#endif
376#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100377 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100378 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100379#endif
380#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100381 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100382 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100383#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100384 }
385 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100386
Paul Elliott8ff510a2020-06-02 17:19:28 +0100387 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100388 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100389 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100390#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100393 case 256:
394 if( bits_is_sloppy )
395 return( MBEDTLS_ECP_DP_CURVE25519 );
396 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100397#endif
398#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100400 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100401#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100402 }
403 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100404
Paul Elliott8ff510a2020-06-02 17:19:28 +0100405 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100406 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100407 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100408#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#endif
412#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100413 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100414 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100415#endif
416#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100418 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100419#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 }
421 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200422 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100424 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200426}
John Durkop9814fa22020-11-04 12:28:15 -0800427#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100428 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
429 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
430 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
431 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Archana4d7ae1d2021-07-07 02:50:22 +0530433psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200449#if defined(PSA_WANT_KEY_TYPE_ARIA)
450 case PSA_KEY_TYPE_ARIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_CAMELLIA:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200462 case PSA_KEY_TYPE_DES:
463 if( bits != 64 && bits != 128 && bits != 192 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100467#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200468 case PSA_KEY_TYPE_CHACHA20:
469 if( bits != 256 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 default:
474 return( PSA_ERROR_NOT_SUPPORTED );
475 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200476 if( bits % 8 != 0 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479 return( PSA_SUCCESS );
480}
481
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100482/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100483 *
Steven Cooremancd640932021-03-08 12:00:27 +0100484 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
485 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 *
487 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100488 * \param[in] key_type The key type of the key to be used with the
489 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 *
491 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100497 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100499{
Steven Cooremancd640932021-03-08 12:00:27 +0100500 if( PSA_ALG_IS_HMAC( algorithm ) )
501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 if( key_type == PSA_KEY_TYPE_HMAC )
503 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100504 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100505
506 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
509 * key. */
510 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
511 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
512 {
513 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
514 * the block length (larger than 1) for block ciphers. */
515 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
516 return( PSA_SUCCESS );
517 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100518 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100519
520 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100521}
522
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200523psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
524 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200525{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100526 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200527 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200528
Ronald Cronea0f8a62020-11-25 17:52:23 +0100529 slot->key.data = mbedtls_calloc( 1, buffer_length );
530 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200531 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200532
Ronald Cronea0f8a62020-11-25 17:52:23 +0100533 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200534 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200535}
536
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200537psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
538 const uint8_t* data,
539 size_t data_length )
540{
541 psa_status_t status = psa_allocate_buffer_to_slot( slot,
542 data_length );
543 if( status != PSA_SUCCESS )
544 return( status );
545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200547 return( PSA_SUCCESS );
548}
549
Ronald Crona0fe59f2020-11-29 11:14:53 +0100550psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100551 const psa_key_attributes_t *attributes,
552 const uint8_t *data, size_t data_length,
553 uint8_t *key_buffer, size_t key_buffer_size,
554 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100555{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
557 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559 /* zero-length keys are never supported. */
560 if( data_length == 0 )
561 return( PSA_ERROR_NOT_SUPPORTED );
562
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100563 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100564 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200566
Archana449608b2021-09-08 15:36:05 +0530567 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
568 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200569 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200570 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200571
Ronald Crondd04d422020-11-28 15:14:42 +0100572 /* Copy the key material. */
573 memcpy( key_buffer, data, data_length );
574 *key_buffer_length = data_length;
575 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Steven Cooreman40120f62020-10-29 11:42:22 +0100577 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100578 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100579 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200580 {
John Durkop9814fa22020-11-04 12:28:15 -0800581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100583 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200584 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 return( mbedtls_psa_ecp_import_key( attributes,
586 data, data_length,
587 key_buffer, key_buffer_size,
588 key_buffer_length,
589 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100590 }
John Durkop9814fa22020-11-04 12:28:15 -0800591#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
592 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700593#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100595 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200596 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 return( mbedtls_psa_rsa_import_key( attributes,
598 data, data_length,
599 key_buffer, key_buffer_size,
600 key_buffer_length,
601 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200602 }
John Durkop9814fa22020-11-04 12:28:15 -0800603#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
617 psa_algorithm_t alg2 )
618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100620 if( alg1 == alg2 )
621 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100622 /* If the policies are from the same hash-and-sign family, check
623 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200624 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
625 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100626 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100627 {
Steven Cooreman03488022021-02-18 12:07:20 +0100628 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
629 return( alg2 );
630 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
631 return( alg1 );
632 }
633 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100634 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100635 * restrictive tag length. */
636 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
637 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
638 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
639 {
640 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
641 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100642 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100643
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100644 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100645 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
646 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100647 {
Steven Cooremancd640932021-03-08 12:00:27 +0100648 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100652 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100653 ( alg1_len <= alg2_len ) )
654 {
655 return( alg2 );
656 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100657 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100658 ( alg2_len <= alg1_len ) )
659 {
660 return( alg1 );
661 }
662 }
663 /* If the policies are from the same MAC family, check whether one
664 * of them is a minimum-MAC-length policy. Calculate the most
665 * restrictive tag length. */
666 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
667 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
668 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
669 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100670 /* Validate the combination of key type and algorithm. Since the base
671 * algorithm of alg1 and alg2 are the same, we only need this once. */
672 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100673 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100674
Steven Cooreman31a876d2021-03-03 20:47:40 +0100675 /* Get the (exact or at-least) output lengths for both sides of the
676 * requested intersection. None of the currently supported algorithms
677 * have an output length dependent on the actual key size, so setting it
678 * to a bogus value of 0 is currently OK.
679 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100680 * Note that for at-least-this-length wildcard algorithms, the output
681 * length is set to the shortest allowed length, which allows us to
682 * calculate the most restrictive tag length for the intersection. */
683 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
684 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100685 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100686
Steven Cooremana1d83222021-02-25 10:20:29 +0100687 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100688 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
689 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100690 {
Steven Cooremancd640932021-03-08 12:00:27 +0100691 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100692 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100693
694 /* If only one is an at-least-this-length policy, the intersection would
695 * be the other (fixed-length) policy as long as said fixed length is
696 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100697 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100698 {
Steven Cooremancd640932021-03-08 12:00:27 +0100699 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100702 {
Steven Cooremancd640932021-03-08 12:00:27 +0100703 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100704 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100705
Steven Cooremancd640932021-03-08 12:00:27 +0100706 /* If none of them are wildcards, check whether they define the same tag
707 * length. This is still possible here when one is default-length and
708 * the other specific-length. Ensure to always return the
709 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100710 if( alg1_len == alg2_len )
711 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100712 }
713 /* If the policies are incompatible, allow nothing. */
714 return( 0 );
715}
716
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100717static int psa_key_algorithm_permits( psa_key_type_t key_type,
718 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200719 psa_algorithm_t requested_alg )
720{
Gilles Peskine549ea862019-05-22 11:45:59 +0200721 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200722 if( requested_alg == policy_alg )
723 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100724 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
725 * and requested_alg is the same hash-and-sign family with any hash,
726 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200727 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100728 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200729 {
Steven Cooreman03488022021-02-18 12:07:20 +0100730 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
731 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
732 }
733 /* If policy_alg is a wildcard AEAD algorithm of the same base as
734 * the requested algorithm, check the requested tag length to be
735 * equal-length or longer than the wildcard-specified length. */
736 if( PSA_ALG_IS_AEAD( policy_alg ) &&
737 PSA_ALG_IS_AEAD( requested_alg ) &&
738 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
739 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100740 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100741 {
742 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
743 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
744 }
Steven Cooremancd640932021-03-08 12:00:27 +0100745 /* If policy_alg is a MAC algorithm of the same base as the requested
746 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100747 if( PSA_ALG_IS_MAC( policy_alg ) &&
748 PSA_ALG_IS_MAC( requested_alg ) &&
749 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100750 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100751 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100752 /* Validate the combination of key type and algorithm. Since the policy
753 * and requested algorithms are the same, we only need this once. */
754 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100755 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756
Steven Cooreman31a876d2021-03-03 20:47:40 +0100757 /* Get both the requested output length for the algorithm which is to be
758 * verified, and the default output length for the base algorithm.
759 * Note that none of the currently supported algorithms have an output
760 * length dependent on actual key size, so setting it to a bogus value
761 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100762 size_t requested_output_length = PSA_MAC_LENGTH(
763 key_type, 0, requested_alg );
764 size_t default_output_length = PSA_MAC_LENGTH(
765 key_type, 0,
766 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100767
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768 /* If the policy is default-length, only allow an algorithm with
769 * a declared exact-length matching the default. */
770 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100772
773 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100774 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100775 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
776 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
777 {
778 return( 1 );
779 }
780
Steven Cooremancd640932021-03-08 12:00:27 +0100781 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
782 * check for the requested MAC length to be equal to or longer than the
783 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
785 {
786 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100787 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100788 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200789 }
Steven Cooremance48e852020-10-05 16:02:45 +0200790 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200791 * a key derivation with that key agreement should also be allowed. This
792 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200793 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
794 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
795 {
796 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
797 policy_alg );
798 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100799 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200800 return( 0 );
801}
802
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100803/** Test whether a policy permits an algorithm.
804 *
805 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100806 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100807 * \note This function requires providing the key type for which the policy is
808 * being validated, since some algorithm policy definitions (e.g. MAC)
809 * have different properties depending on what kind of cipher it is
810 * combined with.
811 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100812 * \retval PSA_SUCCESS When \p alg is a specific algorithm
813 * allowed by the \p policy.
814 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
815 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
816 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100817 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100818static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100819 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100821{
Steven Cooremand788fab2021-02-25 11:29:17 +0100822 /* '0' is not a valid algorithm */
823 if( alg == 0 )
824 return( PSA_ERROR_INVALID_ARGUMENT );
825
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 /* A requested algorithm cannot be a wildcard. */
827 if( PSA_ALG_IS_WILDCARD( alg ) )
828 return( PSA_ERROR_INVALID_ARGUMENT );
829
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100830 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
831 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 return( PSA_SUCCESS );
833 else
834 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100835}
836
Gilles Peskinef603c712019-01-19 13:40:11 +0100837/** Restrict a key policy based on a constraint.
838 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100839 * \note This function requires providing the key type for which the policy is
840 * being restricted, since some algorithm policy definitions (e.g. MAC)
841 * have different properties depending on what kind of cipher it is
842 * combined with.
843 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100844 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100845 * \param[in,out] policy The policy to restrict.
846 * \param[in] constraint The policy constraint to apply.
847 *
848 * \retval #PSA_SUCCESS
849 * \c *policy contains the intersection of the original value of
850 * \c *policy and \c *constraint.
851 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 * \c *policy is unchanged.
854 */
855static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100856 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100857 psa_key_policy_t *policy,
858 const psa_key_policy_t *constraint )
859{
860 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 psa_key_policy_algorithm_intersection( key_type, policy->alg,
862 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200863 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100864 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
865 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
867 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200868 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100870 policy->usage &= constraint->usage;
871 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 return( PSA_SUCCESS );
874}
875
Ronald Cron5c522922020-11-14 16:35:34 +0100876/** Get the description of a key given its identifier and policy constraints
877 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200878 *
Ronald Cron5c522922020-11-14 16:35:34 +0100879 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100880 * nonzero, the key must allow operations with this algorithm. If \p alg is
881 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100882 *
Ronald Cron5c522922020-11-14 16:35:34 +0100883 * In case of a persistent key, the function loads the description of the key
884 * into a key slot if not already done.
885 *
886 * On success, the returned key slot is locked. It is the responsibility of
887 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200888 */
Ronald Cron5c522922020-11-14 16:35:34 +0100889static psa_status_t psa_get_and_lock_key_slot_with_policy(
890 mbedtls_svc_key_id_t key,
891 psa_key_slot_t **p_slot,
892 psa_key_usage_t usage,
893 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100894{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
896 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100897
Ronald Cron5c522922020-11-14 16:35:34 +0100898 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100899 if( status != PSA_SUCCESS )
900 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200901 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200907 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100911 {
912 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200913 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100914 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100915
916 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100917 if( alg != 0 )
918 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100919 status = psa_key_policy_permits( &slot->attr.policy,
920 slot->attr.type,
921 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 if( status != PSA_SUCCESS )
923 goto error;
924 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Darryl Green06fd18d2018-07-16 11:21:11 +0100926 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928error:
929 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100930 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200931
932 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100933}
Darryl Green940d72c2018-07-13 13:18:51 +0100934
Ronald Cron5c522922020-11-14 16:35:34 +0100935/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
937 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200938 * available, as opposed to a key in a secure element and/or to be used
939 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200941 * This is a temporary function that may be used instead of
942 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
943 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200944 *
Ronald Cron5c522922020-11-14 16:35:34 +0100945 * On success, the returned key slot is locked. It is the responsibility of the
946 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200947 */
Ronald Cron5c522922020-11-14 16:35:34 +0100948static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
949 mbedtls_svc_key_id_t key,
950 psa_key_slot_t **p_slot,
951 psa_key_usage_t usage,
952 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200953{
Ronald Cron5c522922020-11-14 16:35:34 +0100954 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
955 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 if( status != PSA_SUCCESS )
957 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Ronald Cronddae0f52021-08-24 15:39:44 +0200959 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960 {
Ronald Cron5c522922020-11-14 16:35:34 +0100961 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 *p_slot = NULL;
963 return( PSA_ERROR_NOT_SUPPORTED );
964 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200965
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966 return( PSA_SUCCESS );
967}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200969psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000970{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100971 /* Data pointer will always be either a valid pointer or NULL in an
972 * initialized slot, so we can just free it. */
973 if( slot->key.data != NULL )
974 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
975
976 mbedtls_free( slot->key.data );
977 slot->key.data = NULL;
978 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000979
980 return( PSA_SUCCESS );
981}
982
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100983/** Completely wipe a slot in memory, including its policy.
984 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100985psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100986{
987 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100988
TRodziewicz18cddc02021-07-13 12:19:15 +0200989 /*
990 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200991 * do our best to report an unexpected lock counter. Assert with
992 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
993 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
994 * function is called as part of the execution of a test suite, the
995 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200996 */
Ronald Cron5c522922020-11-14 16:35:34 +0100997 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100998 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200999 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 status = PSA_ERROR_CORRUPTION_DETECTED;
1001 }
1002
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001003 /* Multipart operations may still be using the key. This is safe
1004 * because all multipart operation objects are independent from
1005 * the key slot: if they need to access the key after the setup
1006 * phase, they have a copy of the key. Note that this means that
1007 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001008 /* At this point, key material and other type-specific content has
1009 * been wiped. Clear remaining metadata. We can call memset and not
1010 * zeroize because the metadata is not particularly sensitive. */
1011 memset( slot, 0, sizeof( *slot ) );
1012 return( status );
1013}
1014
Ronald Croncf56a0a2020-08-04 09:51:30 +02001015psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001016{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001017 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001018 psa_status_t status; /* status of the last operation */
1019 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001020#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1021 psa_se_drv_table_entry_t *driver;
1022#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001023
Ronald Croncf56a0a2020-08-04 09:51:30 +02001024 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001025 return( PSA_SUCCESS );
1026
Ronald Cronf2911112020-10-29 17:51:10 +01001027 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001028 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001029 * key, this will load the key description from persistent memory if not
1030 * done yet. We cannot avoid this loading as without it we don't know if
1031 * the key is operated by an SE or not and this information is needed by
1032 * the current implementation.
1033 */
Ronald Cron5c522922020-11-14 16:35:34 +01001034 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001035 if( status != PSA_SUCCESS )
1036 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001037
Ronald Cronf2911112020-10-29 17:51:10 +01001038 /*
1039 * If the key slot containing the key description is under access by the
1040 * library (apart from the present access), the key cannot be destroyed
1041 * yet. For the time being, just return in error. Eventually (to be
1042 * implemented), the key should be destroyed when all accesses have
1043 * stopped.
1044 */
Ronald Cron5c522922020-11-14 16:35:34 +01001045 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001046 {
Ronald Cron5c522922020-11-14 16:35:34 +01001047 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001048 return( PSA_ERROR_GENERIC_ERROR );
1049 }
1050
Gilles Peskine6687cd02021-04-21 22:32:05 +02001051 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1052 {
1053 /* Refuse the destruction of a read-only key (which may or may not work
1054 * if we attempt it, depending on whether the key is merely read-only
1055 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001056 * Just do the best we can, which is to wipe the copy in memory
1057 * (done in this function's cleanup code). */
1058 overall_status = PSA_ERROR_NOT_PERMITTED;
1059 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001060 }
1061
Gilles Peskine354f7672019-07-12 23:46:38 +02001062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001063 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001064 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001065 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001066 /* For a key in a secure element, we need to do three things:
1067 * remove the key file in internal storage, destroy the
1068 * key inside the secure element, and update the driver's
1069 * persistent data. Start a transaction that will encompass these
1070 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001071 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001072 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001073 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001074 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001075 status = psa_crypto_save_transaction( );
1076 if( status != PSA_SUCCESS )
1077 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001078 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 /* We should still try to destroy the key in the secure
1080 * element and the key metadata in storage. This is especially
1081 * important if the error is that the storage is full.
1082 * But how to do it exactly without risking an inconsistent
1083 * state after a reset?
1084 * https://github.com/ARMmbed/mbed-crypto/issues/215
1085 */
1086 overall_status = status;
1087 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
1089
Ronald Cronea0f8a62020-11-25 17:52:23 +01001090 status = psa_destroy_se_key( driver,
1091 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 if( overall_status == PSA_SUCCESS )
1093 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001094 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001095#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1096
Darryl Greend49a4992018-06-18 17:27:26 +01001097#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001098 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001099 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001100 status = psa_destroy_persistent_key( slot->attr.id );
1101 if( overall_status == PSA_SUCCESS )
1102 overall_status = status;
1103
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001104 /* TODO: other slots may have a copy of the same key. We should
1105 * invalidate them.
1106 * https://github.com/ARMmbed/mbed-crypto/issues/214
1107 */
Darryl Greend49a4992018-06-18 17:27:26 +01001108 }
1109#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001110
Gilles Peskinefc762652019-07-22 19:30:34 +02001111#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1112 if( driver != NULL )
1113 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001114 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001115 if( overall_status == PSA_SUCCESS )
1116 overall_status = status;
1117 status = psa_crypto_stop_transaction( );
1118 if( overall_status == PSA_SUCCESS )
1119 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001120 }
1121#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1122
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001124 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001126 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 overall_status = status;
1128 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001129}
1130
John Durkop07cc04a2020-11-16 22:08:34 -08001131#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001132 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001133static psa_status_t psa_get_rsa_public_exponent(
1134 const mbedtls_rsa_context *rsa,
1135 psa_key_attributes_t *attributes )
1136{
1137 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001139 uint8_t *buffer = NULL;
1140 size_t buflen;
1141 mbedtls_mpi_init( &mpi );
1142
1143 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1144 if( ret != 0 )
1145 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001146 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1147 {
1148 /* It's the default value, which is reported as an empty string,
1149 * so there's nothing to do. */
1150 goto exit;
1151 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001152
1153 buflen = mbedtls_mpi_size( &mpi );
1154 buffer = mbedtls_calloc( 1, buflen );
1155 if( buffer == NULL )
1156 {
1157 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1158 goto exit;
1159 }
1160 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1161 if( ret != 0 )
1162 goto exit;
1163 attributes->domain_parameters = buffer;
1164 attributes->domain_parameters_size = buflen;
1165
1166exit:
1167 mbedtls_mpi_free( &mpi );
1168 if( ret != 0 )
1169 mbedtls_free( buffer );
1170 return( mbedtls_to_psa_error( ret ) );
1171}
John Durkop07cc04a2020-11-16 22:08:34 -08001172#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001173 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001174
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001175/** Retrieve all the publicly-accessible attributes of a key.
1176 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001177psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001178 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001180 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001181 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001182 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001183
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001184 psa_reset_key_attributes( attributes );
1185
Ronald Cron5c522922020-11-14 16:35:34 +01001186 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001187 if( status != PSA_SUCCESS )
1188 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001189
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001190 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001191 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1192 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1193
1194#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001195 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001196 psa_set_key_slot_number( attributes,
1197 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskine8e338702019-07-30 20:06:31 +02001200 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001201 {
John Durkop07cc04a2020-11-16 22:08:34 -08001202#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001203 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001204 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001205 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001206 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001207 * is not yet implemented.
1208 * https://github.com/ARMmbed/mbed-crypto/issues/216
1209 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001210 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001211 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001212 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001213
Ronald Cron90857082020-11-25 14:58:33 +01001214 status = mbedtls_psa_rsa_load_representation(
1215 slot->attr.type,
1216 slot->key.data,
1217 slot->key.bytes,
1218 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 if( status != PSA_SUCCESS )
1220 break;
1221
Steven Cooremana2371e52020-07-28 14:30:39 +02001222 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001223 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 mbedtls_rsa_free( rsa );
1225 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001226 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001227 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001228#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001229 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001230 default:
1231 /* Nothing else to do. */
1232 break;
1233 }
1234
1235 if( status != PSA_SUCCESS )
1236 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237
Ronald Cron5c522922020-11-14 16:35:34 +01001238 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001241}
1242
Gilles Peskinec8000c02019-08-02 20:15:51 +02001243#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1244psa_status_t psa_get_key_slot_number(
1245 const psa_key_attributes_t *attributes,
1246 psa_key_slot_number_t *slot_number )
1247{
1248 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1249 {
1250 *slot_number = attributes->slot_number;
1251 return( PSA_SUCCESS );
1252 }
1253 else
1254 return( PSA_ERROR_INVALID_ARGUMENT );
1255}
1256#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1257
Ronald Crond18b5f82020-11-25 16:46:05 +01001258static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1259 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001260 uint8_t *data,
1261 size_t data_size,
1262 size_t *data_length )
1263{
Ronald Crond18b5f82020-11-25 16:46:05 +01001264 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001265 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 memcpy( data, key_buffer, key_buffer_size );
1267 memset( data + key_buffer_size, 0,
1268 data_size - key_buffer_size );
1269 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001270 return( PSA_SUCCESS );
1271}
1272
Ronald Cron7285cda2020-11-26 14:46:37 +01001273psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 const psa_key_attributes_t *attributes,
1275 const uint8_t *key_buffer, size_t key_buffer_size,
1276 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001277{
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 psa_key_type_t type = attributes->core.type;
1279
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 if( key_type_is_raw_bytes( type ) ||
1281 PSA_KEY_TYPE_IS_RSA( type ) ||
1282 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001283 {
1284 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001285 key_buffer, key_buffer_size,
1286 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001287 }
1288 else
1289 {
1290 /* This shouldn't happen in the reference implementation, but
1291 it is valid for a special-purpose implementation to omit
1292 support for exporting certain key types. */
1293 return( PSA_ERROR_NOT_SUPPORTED );
1294 }
1295}
1296
1297psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1298 uint8_t *data,
1299 size_t data_size,
1300 size_t *data_length )
1301{
1302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1303 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1304 psa_key_slot_t *slot;
1305
Ronald Crone907e552021-01-18 13:22:38 +01001306 /* Reject a zero-length output buffer now, since this can never be a
1307 * valid key representation. This way we know that data must be a valid
1308 * pointer and we can do things like memset(data, ..., data_size). */
1309 if( data_size == 0 )
1310 return( PSA_ERROR_BUFFER_TOO_SMALL );
1311
Ronald Cron9486f9d2020-11-26 13:36:23 +01001312 /* Set the key to empty now, so that even when there are errors, we always
1313 * set data_length to a value between 0 and data_size. On error, setting
1314 * the key to empty is a good choice because an empty key representation is
1315 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001316 *data_length = 0;
1317
Ronald Cron9486f9d2020-11-26 13:36:23 +01001318 /* Export requires the EXPORT flag. There is an exception for public keys,
1319 * which don't require any flag, but
1320 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1321 */
1322 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1323 PSA_KEY_USAGE_EXPORT, 0 );
1324 if( status != PSA_SUCCESS )
1325 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001326
Ronald Crond18b5f82020-11-25 16:46:05 +01001327 psa_key_attributes_t attributes = {
1328 .core = slot->attr
1329 };
Ronald Cron67227982020-11-26 15:16:05 +01001330 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001331 slot->key.data, slot->key.bytes,
1332 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333
Ronald Cron9486f9d2020-11-26 13:36:23 +01001334 unlock_status = psa_unlock_key_slot( slot );
1335
1336 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1337}
1338
Ronald Cron7285cda2020-11-26 14:46:37 +01001339psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 const psa_key_attributes_t *attributes,
1341 const uint8_t *key_buffer,
1342 size_t key_buffer_size,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001346{
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001348
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001350 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001352 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001353 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 key_buffer, key_buffer_size,
1356 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001357 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001358
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001360 {
John Durkop0e005192020-10-31 22:06:54 -07001361#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1362 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001363 return( mbedtls_psa_rsa_export_public_key( attributes,
1364 key_buffer,
1365 key_buffer_size,
1366 data,
1367 data_size,
1368 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001369#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001370 /* We don't know how to convert a private RSA key to public. */
1371 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001372#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1373 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001374 }
1375 else
Moran Pekera998bc62018-04-16 18:16:20 +03001376 {
John Durkop6ba40d12020-11-10 08:50:04 -08001377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1378 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001379 return( mbedtls_psa_ecp_export_public_key( attributes,
1380 key_buffer,
1381 key_buffer_size,
1382 data,
1383 data_size,
1384 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001385#else
1386 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001387 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001390 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001391 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001392 else
1393 {
1394 /* This shouldn't happen in the reference implementation, but
1395 it is valid for a special-purpose implementation to omit
1396 support for exporting certain key types. */
1397 return( PSA_ERROR_NOT_SUPPORTED );
1398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399}
Ronald Crond18b5f82020-11-25 16:46:05 +01001400
Ronald Croncf56a0a2020-08-04 09:51:30 +02001401psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001402 uint8_t *data,
1403 size_t data_size,
1404 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001405{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001407 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001408 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001409
Ronald Crone907e552021-01-18 13:22:38 +01001410 /* Reject a zero-length output buffer now, since this can never be a
1411 * valid key representation. This way we know that data must be a valid
1412 * pointer and we can do things like memset(data, ..., data_size). */
1413 if( data_size == 0 )
1414 return( PSA_ERROR_BUFFER_TOO_SMALL );
1415
Darryl Greendd8fb772018-11-07 16:00:44 +00001416 /* Set the key to empty now, so that even when there are errors, we always
1417 * set data_length to a value between 0 and data_size. On error, setting
1418 * the key to empty is a good choice because an empty key representation is
1419 * unlikely to be accepted anywhere. */
1420 *data_length = 0;
1421
1422 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001423 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001424 if( status != PSA_SUCCESS )
1425 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001426
Ronald Cron9486f9d2020-11-26 13:36:23 +01001427 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1428 {
1429 status = PSA_ERROR_INVALID_ARGUMENT;
1430 goto exit;
1431 }
1432
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 psa_key_attributes_t attributes = {
1434 .core = slot->attr
1435 };
Ronald Cron67227982020-11-26 15:16:05 +01001436 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 &attributes, slot->key.data, slot->key.bytes,
1438 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001439
1440exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001441 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001442
Ronald Cron5c522922020-11-14 16:35:34 +01001443 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001444}
1445
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446#if defined(static_assert)
1447static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1448 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001449static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001450 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001452 "One or more key attribute flag is listed as both internal-only and external-only" );
1453#endif
1454
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001455/** Validate that a key policy is internally well-formed.
1456 *
1457 * This function only rejects invalid policies. It does not validate the
1458 * consistency of the policy with respect to other attributes of the key
1459 * such as the key type.
1460 */
1461static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001462{
1463 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001464 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001465 PSA_KEY_USAGE_ENCRYPT |
1466 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001467 PSA_KEY_USAGE_SIGN_MESSAGE |
1468 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001469 PSA_KEY_USAGE_SIGN_HASH |
1470 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001471 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001472 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1473 return( PSA_ERROR_INVALID_ARGUMENT );
1474
Gilles Peskine4747d192019-04-17 15:05:45 +02001475 return( PSA_SUCCESS );
1476}
1477
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001478/** Validate the internal consistency of key attributes.
1479 *
1480 * This function only rejects invalid attribute values. If does not
1481 * validate the consistency of the attributes with any key data that may
1482 * be involved in the creation of the key.
1483 *
1484 * Call this function early in the key creation process.
1485 *
1486 * \param[in] attributes Key attributes for the new key.
1487 * \param[out] p_drv On any return, the driver for the key, if any.
1488 * NULL for a transparent key.
1489 *
1490 */
1491static psa_status_t psa_validate_key_attributes(
1492 const psa_key_attributes_t *attributes,
1493 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001494{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001495 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001496 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001497 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001498
Ronald Cron54b90082020-10-29 15:26:43 +01001499 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001500 if( status != PSA_SUCCESS )
1501 return( status );
1502
Ronald Crond2ed4812020-07-17 16:11:30 +02001503 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001504 if( status != PSA_SUCCESS )
1505 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506
Ronald Cron65f38a32020-10-23 17:11:13 +02001507 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1508 {
1509 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1510 return( PSA_ERROR_INVALID_ARGUMENT );
1511 }
1512 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001513 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001514 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1515 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001516 }
1517
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001518 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001519 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001520 return( status );
1521
1522 /* Refuse to create overly large keys.
1523 * Note that this doesn't trigger on import if the attributes don't
1524 * explicitly specify a size (so psa_get_key_bits returns 0), so
1525 * psa_import_key() needs its own checks. */
1526 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1527 return( PSA_ERROR_NOT_SUPPORTED );
1528
Gilles Peskine91e8c332019-08-02 19:19:39 +02001529 /* Reject invalid flags. These should not be reachable through the API. */
1530 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1531 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1532 return( PSA_ERROR_INVALID_ARGUMENT );
1533
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534 return( PSA_SUCCESS );
1535}
1536
Gilles Peskine4747d192019-04-17 15:05:45 +02001537/** Prepare a key slot to receive key material.
1538 *
1539 * This function allocates a key slot and sets its metadata.
1540 *
1541 * If this function fails, call psa_fail_key_creation().
1542 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001543 * This function is intended to be used as follows:
1544 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001545 * it with the specified attributes, and in case of a volatile key assign it
1546 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001547 * -# Populate the slot with the key material.
1548 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1549 * In case of failure at any step, stop the sequence and call
1550 * psa_fail_key_creation().
1551 *
Ronald Cron5c522922020-11-14 16:35:34 +01001552 * On success, the key slot is locked. It is the responsibility of the caller
1553 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001554 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001555 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001557 * \param[out] p_slot On success, a pointer to the prepared slot.
1558 * \param[out] p_drv On any return, the driver for the key, if any.
1559 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001560 *
1561 * \retval #PSA_SUCCESS
1562 * The key slot is ready to receive key material.
1563 * \return If this function fails, the key slot is an invalid state.
1564 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001565 */
1566static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001567 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001570 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001571{
1572 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001573 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 psa_key_slot_t *slot;
1575
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 *p_drv = NULL;
1578
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001579 status = psa_validate_key_attributes( attributes, p_drv );
1580 if( status != PSA_SUCCESS )
1581 return( status );
1582
Ronald Cronc4d1b512020-07-31 11:26:37 +02001583 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001584 if( status != PSA_SUCCESS )
1585 return( status );
1586 slot = *p_slot;
1587
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001588 /* We're storing the declared bit-size of the key. It's up to each
1589 * creation mechanism to verify that this information is correct.
1590 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001591 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001592 * is optional (import, copy). In case of a volatile key, assign it the
1593 * volatile key identifier associated to the slot returned to contain its
1594 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001595
1596 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001597 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1598 {
1599#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1600 slot->attr.id = volatile_key_id;
1601#else
1602 slot->attr.id.key_id = volatile_key_id;
1603#endif
1604 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001605
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001607 * external-only flags, query `attributes`. Thanks to the check
1608 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001609 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001610 * may have set. */
1611 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001612
Gilles Peskinecbaff462019-07-12 23:46:04 +02001613#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001614 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001615 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001616 * create the key file in internal storage, create the
1617 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001618 * persistent data. This is done by starting a transaction that will
1619 * encompass these three actions.
1620 * For registering a volatile key, we just need to find an appropriate
1621 * slot number inside the SE. Since the key is designated volatile, creating
1622 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001623 /* The first thing to do is to find a slot number for the new key.
1624 * We save the slot number in persistent storage as part of the
1625 * transaction data. It will be needed to recover if the power
1626 * fails during the key creation process, to clean up on the secure
1627 * element side after restarting. Obtaining a slot number from the
1628 * secure element driver updates its persistent state, but we do not yet
1629 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001630 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001631 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001632 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001633 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001634 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001636 if( status != PSA_SUCCESS )
1637 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001638
1639 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001640 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001641 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1642 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001643 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644 psa_crypto_transaction.key.id = slot->attr.id;
1645 status = psa_crypto_save_transaction( );
1646 if( status != PSA_SUCCESS )
1647 {
1648 (void) psa_crypto_stop_transaction( );
1649 return( status );
1650 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001651 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652
1653 status = psa_copy_key_material_into_slot(
1654 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001655 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001656
1657 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1658 {
1659 /* Key registration only makes sense with a secure element. */
1660 return( PSA_ERROR_INVALID_ARGUMENT );
1661 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001662#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1663
Ronald Cronc4d1b512020-07-31 11:26:37 +02001664 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001665}
Gilles Peskine4747d192019-04-17 15:05:45 +02001666
1667/** Finalize the creation of a key once its key material has been set.
1668 *
1669 * This entails writing the key to persistent storage.
1670 *
1671 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001672 * See the documentation of psa_start_key_creation() for the intended use
1673 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001674 *
Ronald Cron5c522922020-11-14 16:35:34 +01001675 * If the finalization succeeds, the function unlocks the key slot (it was
1676 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1677 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001678 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001679 * \param[in,out] slot Pointer to the slot with key material.
1680 * \param[in] driver The secure element driver for the key,
1681 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001682 * \param[out] key On success, identifier of the key. Note that the
1683 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001684 *
1685 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001686 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001687 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1688 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1689 * \retval #PSA_ERROR_ALREADY_EXISTS
1690 * \retval #PSA_ERROR_DATA_INVALID
1691 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001692 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001693 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001694 * \return If this function fails, the key slot is an invalid state.
1695 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001696 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001697static psa_status_t psa_finish_key_creation(
1698 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001699 psa_se_drv_table_entry_t *driver,
1700 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001701{
1702 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001703 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001704 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001705
1706#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001707 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001708 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001709#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1710 if( driver != NULL )
1711 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001712 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001713 psa_key_slot_number_t slot_number =
1714 psa_key_slot_get_slot_number( slot ) ;
1715
Gilles Peskineb46bef22019-07-30 21:32:04 +02001716#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001717 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718 sizeof( data.slot_number ),
1719 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001722 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001723 (uint8_t*) &data,
1724 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001725 }
1726 else
1727#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1728 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001729 /* Key material is saved in export representation in the slot, so
1730 * just pass the slot buffer for storage. */
1731 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001732 slot->key.data,
1733 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001735 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001736#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1737
Gilles Peskinecbaff462019-07-12 23:46:04 +02001738#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001739 /* Finish the transaction for a key creation. This does not
1740 * happen when registering an existing key. Detect this case
1741 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 * creation of a persistent key in a secure element requires a transaction,
1743 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001744 if( driver != NULL &&
1745 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001746 {
1747 status = psa_save_se_persistent_data( driver );
1748 if( status != PSA_SUCCESS )
1749 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001750 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001751 return( status );
1752 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001754 }
1755#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1756
Ronald Cron50972942020-11-14 11:28:25 +01001757 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001758 {
1759 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001760 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001761 if( status != PSA_SUCCESS )
1762 *key = MBEDTLS_SVC_KEY_ID_INIT;
1763 }
Ronald Cron50972942020-11-14 11:28:25 +01001764
Gilles Peskine4747d192019-04-17 15:05:45 +02001765 return( status );
1766}
1767
1768/** Abort the creation of a key.
1769 *
1770 * You may call this function after calling psa_start_key_creation(),
1771 * or after psa_finish_key_creation() fails. In other circumstances, this
1772 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001773 * See the documentation of psa_start_key_creation() for the intended use
1774 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001776 * \param[in,out] slot Pointer to the slot with key material.
1777 * \param[in] driver The secure element driver for the key,
1778 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001780static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001781 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001782{
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 (void) driver;
1784
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 if( slot == NULL )
1786 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001787
1788#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001789 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 * element, and the failure happened later (when saving metadata
1791 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001792 * element.
1793 * https://github.com/ARMmbed/mbed-crypto/issues/217
1794 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001795
Gilles Peskined7729582019-08-05 15:55:54 +02001796 /* Abort the ongoing transaction if any (there may not be one if
1797 * the creation process failed before starting one, or if the
1798 * key creation is a registration of a key in a secure element).
1799 * Earlier functions must already have done what it takes to undo any
1800 * partial creation. All that's left is to update the transaction data
1801 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001802 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001803#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1804
Gilles Peskine4747d192019-04-17 15:05:45 +02001805 psa_wipe_key_slot( slot );
1806}
1807
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001808/** Validate optional attributes during key creation.
1809 *
1810 * Some key attributes are optional during key creation. If they are
1811 * specified in the attributes structure, check that they are consistent
1812 * with the data in the slot.
1813 *
1814 * This function should be called near the end of key creation, after
1815 * the slot in memory is fully populated but before saving persistent data.
1816 */
1817static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001818 const psa_key_slot_t *slot,
1819 const psa_key_attributes_t *attributes )
1820{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001821 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001822 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001823 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 return( PSA_ERROR_INVALID_ARGUMENT );
1825 }
1826
1827 if( attributes->domain_parameters_size != 0 )
1828 {
John Durkop0e005192020-10-31 22:06:54 -07001829#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1830 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001831 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001832 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001833 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001834 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001836
Ronald Cron90857082020-11-25 14:58:33 +01001837 psa_status_t status = mbedtls_psa_rsa_load_representation(
1838 slot->attr.type,
1839 slot->key.data,
1840 slot->key.bytes,
1841 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001842 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001843 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001844
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001845 mbedtls_mpi_init( &actual );
1846 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001847 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 mbedtls_rsa_free( rsa );
1850 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851 if( ret != 0 )
1852 goto rsa_exit;
1853 ret = mbedtls_mpi_read_binary( &required,
1854 attributes->domain_parameters,
1855 attributes->domain_parameters_size );
1856 if( ret != 0 )
1857 goto rsa_exit;
1858 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1859 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1860 rsa_exit:
1861 mbedtls_mpi_free( &actual );
1862 mbedtls_mpi_free( &required );
1863 if( ret != 0)
1864 return( mbedtls_to_psa_error( ret ) );
1865 }
1866 else
John Durkop9814fa22020-11-04 12:28:15 -08001867#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1868 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 {
1870 return( PSA_ERROR_INVALID_ARGUMENT );
1871 }
1872 }
1873
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001874 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001876 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 return( PSA_ERROR_INVALID_ARGUMENT );
1878 }
1879
1880 return( PSA_SUCCESS );
1881}
1882
Gilles Peskine4747d192019-04-17 15:05:45 +02001883psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001885 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001886 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001887{
1888 psa_status_t status;
1889 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001890 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001891 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301892 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893
Ronald Cron81709fc2020-11-14 12:10:32 +01001894 *key = MBEDTLS_SVC_KEY_ID_INIT;
1895
Gilles Peskine0f84d622019-09-12 19:03:13 +02001896 /* Reject zero-length symmetric keys (including raw data key objects).
1897 * This also rejects any key which might be encoded as an empty string,
1898 * which is never valid. */
1899 if( data_length == 0 )
1900 return( PSA_ERROR_INVALID_ARGUMENT );
1901
Archana449608b2021-09-08 15:36:05 +05301902 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301903 if( data_length > SIZE_MAX / 8 )
1904 return( PSA_ERROR_NOT_SUPPORTED );
1905
Gilles Peskinedf179142019-07-15 22:02:14 +02001906 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001907 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908 if( status != PSA_SUCCESS )
1909 goto exit;
1910
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001911 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301912 * storage ( thus not in the case of importing a key in a secure element
1913 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1914 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001915 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001916 {
Archanad8a83dc2021-06-14 10:04:16 +05301917 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1918 {
Archana449608b2021-09-08 15:36:05 +05301919 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1920 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301921 if( status != PSA_SUCCESS )
1922 goto exit;
1923 }
1924 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001925 if( status != PSA_SUCCESS )
1926 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001927 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001928
1929 bits = slot->attr.bits;
1930 status = psa_driver_wrapper_import_key( attributes,
1931 data, data_length,
1932 slot->key.data,
1933 slot->key.bytes,
1934 &slot->key.bytes, &bits );
1935 if( status != PSA_SUCCESS )
1936 goto exit;
1937
1938 if( slot->attr.bits == 0 )
1939 slot->attr.bits = (psa_key_bits_t) bits;
1940 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001941 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001942 status = PSA_ERROR_INVALID_ARGUMENT;
1943 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001944 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001945
Archana6ed4bda2021-08-04 10:47:15 +05301946 /* Enforce a size limit, and in particular ensure that the bit
1947 * size fits in its representation type.*/
1948 if( bits > PSA_MAX_KEY_BITS )
1949 {
1950 status = PSA_ERROR_NOT_SUPPORTED;
1951 goto exit;
1952 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001953 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001954 if( status != PSA_SUCCESS )
1955 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001956
Ronald Cron81709fc2020-11-14 12:10:32 +01001957 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001959 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001960 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001961
Gilles Peskine4747d192019-04-17 15:05:45 +02001962 return( status );
1963}
1964
Gilles Peskined7729582019-08-05 15:55:54 +02001965#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1966psa_status_t mbedtls_psa_register_se_key(
1967 const psa_key_attributes_t *attributes )
1968{
1969 psa_status_t status;
1970 psa_key_slot_t *slot = NULL;
1971 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001972 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001973
1974 /* Leaving attributes unspecified is not currently supported.
1975 * It could make sense to query the key type and size from the
1976 * secure element, but not all secure elements support this
1977 * and the driver HAL doesn't currently support it. */
1978 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1979 return( PSA_ERROR_NOT_SUPPORTED );
1980 if( psa_get_key_bits( attributes ) == 0 )
1981 return( PSA_ERROR_NOT_SUPPORTED );
1982
1983 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001984 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001985 if( status != PSA_SUCCESS )
1986 goto exit;
1987
Ronald Cron81709fc2020-11-14 12:10:32 +01001988 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001989
1990exit:
1991 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001992 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001993
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001995 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001996 return( status );
1997}
1998#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1999
Ronald Croncf56a0a2020-08-04 09:51:30 +02002000psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002001 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002003{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002004 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002005 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002006 psa_key_slot_t *source_slot = NULL;
2007 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002008 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002009 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302010 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011
Ronald Cron81709fc2020-11-14 12:10:32 +01002012 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2013
Archana8a180362021-07-05 02:18:48 +05302014 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002015 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002016 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002017 goto exit;
2018
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002019 status = psa_validate_optional_attributes( source_slot,
2020 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 if( status != PSA_SUCCESS )
2022 goto exit;
2023
Archana9d17bf42021-09-10 06:22:44 +05302024 /* The target key type and number of bits have been validated by
2025 * psa_validate_optional_attributes() to be either equal to zero or
2026 * equal to the ones of the source key. So it is safe to inherit
2027 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302028 * */
Archana9d17bf42021-09-10 06:22:44 +05302029 actual_attributes.core.bits = source_slot->attr.bits;
2030 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302031
2032
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002033 status = psa_restrict_key_policy( source_slot->attr.type,
2034 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002035 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 if( status != PSA_SUCCESS )
2037 goto exit;
2038
Ronald Cron81709fc2020-11-14 12:10:32 +01002039 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2040 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002041 if( status != PSA_SUCCESS )
2042 goto exit;
Archana8a180362021-07-05 02:18:48 +05302043 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2044 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002045 {
Archana8a180362021-07-05 02:18:48 +05302046 /*
Archana9d17bf42021-09-10 06:22:44 +05302047 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302048 * the source key would need to be exported as plaintext and re-imported
2049 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302050 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302051 * appropriate API invocations from the application, if needed.
2052 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002053 status = PSA_ERROR_NOT_SUPPORTED;
2054 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002055 }
Archana8a180362021-07-05 02:18:48 +05302056 /*
2057 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302058 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302059 * - For opaque keys this translates to an invocation of the drivers'
2060 * copy_key entry point through the dispatch layer.
2061 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002062 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2063 {
Archana8a180362021-07-05 02:18:48 +05302064 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302065 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302066 if( status != PSA_SUCCESS )
2067 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302068
Archana8a180362021-07-05 02:18:48 +05302069 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2070 if( status != PSA_SUCCESS )
2071 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302072
Archana8a180362021-07-05 02:18:48 +05302073 status = psa_driver_wrapper_copy_key( &actual_attributes,
2074 source_slot->key.data,
2075 source_slot->key.bytes,
2076 target_slot->key.data,
2077 target_slot->key.bytes,
2078 &target_slot->key.bytes );
2079 if( status != PSA_SUCCESS )
2080 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002081 }
Archana8a180362021-07-05 02:18:48 +05302082 else
2083 {
Archana9d17bf42021-09-10 06:22:44 +05302084 status = psa_copy_key_material_into_slot( target_slot,
2085 source_slot->key.data,
2086 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302087 if( status != PSA_SUCCESS )
2088 goto exit;
2089 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002090 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002091exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002092 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002093 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002094
Ronald Cron5c522922020-11-14 16:35:34 +01002095 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002096
Ronald Cron5c522922020-11-14 16:35:34 +01002097 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002098}
2099
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002100
2101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002102/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002103/* Message digests */
2104/****************************************************************/
2105
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002106psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2107{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002108 /* Aborting a non-active operation is allowed */
2109 if( operation->id == 0 )
2110 return( PSA_SUCCESS );
2111
2112 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2113 operation->id = 0;
2114
2115 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002116}
2117
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002118psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002119 psa_algorithm_t alg )
2120{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002122
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002123 /* A context must be freshly initialized before it can be set up. */
2124 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002125 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 status = PSA_ERROR_BAD_STATE;
2127 goto exit;
2128 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129
2130 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002131 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002132 status = PSA_ERROR_INVALID_ARGUMENT;
2133 goto exit;
2134 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002135
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002136 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2137 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002138 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2139
Dave Rodgman685b6a72021-06-24 11:49:14 +01002140 status = psa_driver_wrapper_hash_setup( operation, alg );
2141
2142exit:
2143 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002144 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002145
2146 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147}
2148
2149psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2150 const uint8_t *input,
2151 size_t input_length )
2152{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2154
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002156 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002157 status = PSA_ERROR_BAD_STATE;
2158 goto exit;
2159 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002160
Steven Cooremanc8288352021-03-04 14:02:19 +01002161 /* Don't require hash implementations to behave correctly on a
2162 * zero-length input, which may have an invalid pointer. */
2163 if( input_length == 0 )
2164 return( PSA_SUCCESS );
2165
Dave Rodgman685b6a72021-06-24 11:49:14 +01002166 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2167
2168exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169 if( status != PSA_SUCCESS )
2170 psa_hash_abort( operation );
2171
2172 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173}
2174
2175psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2176 uint8_t *hash,
2177 size_t hash_size,
2178 size_t *hash_length )
2179{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002180 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002181 if( operation->id == 0 )
2182 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183
Steven Cooreman1e582352021-02-18 17:24:37 +01002184 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002185 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002186 psa_hash_abort( operation );
2187 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188}
2189
Gilles Peskine2d277862018-06-18 15:41:12 +02002190psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2191 const uint8_t *hash,
2192 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002193{
Ronald Cron69a63422021-10-18 09:47:58 +02002194 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002196 psa_status_t status = psa_hash_finish(
2197 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002198 actual_hash, sizeof( actual_hash ),
2199 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202 goto exit;
2203
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002204 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002205 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206 status = PSA_ERROR_INVALID_SIGNATURE;
2207 goto exit;
2208 }
2209
Steven Cooreman36876a02021-04-29 16:37:59 +02002210 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002211 status = PSA_ERROR_INVALID_SIGNATURE;
2212
2213exit:
Gilles Peskine60aebec2021-12-13 12:33:18 +01002214 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002215 if( status != PSA_SUCCESS )
2216 psa_hash_abort(operation);
2217
2218 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219}
2220
Gilles Peskine0a749c82019-11-28 19:33:58 +01002221psa_status_t psa_hash_compute( psa_algorithm_t alg,
2222 const uint8_t *input, size_t input_length,
2223 uint8_t *hash, size_t hash_size,
2224 size_t *hash_length )
2225{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002226 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002227 if( !PSA_ALG_IS_HASH( alg ) )
2228 return( PSA_ERROR_INVALID_ARGUMENT );
2229
Steven Cooreman1e582352021-02-18 17:24:37 +01002230 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2231 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002232}
2233
2234psa_status_t psa_hash_compare( psa_algorithm_t alg,
2235 const uint8_t *input, size_t input_length,
2236 const uint8_t *hash, size_t hash_length )
2237{
Ronald Cron69a63422021-10-18 09:47:58 +02002238 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002239 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002240
2241 if( !PSA_ALG_IS_HASH( alg ) )
2242 return( PSA_ERROR_INVALID_ARGUMENT );
2243
Steven Cooreman1e582352021-02-18 17:24:37 +01002244 psa_status_t status = psa_driver_wrapper_hash_compute(
2245 alg, input, input_length,
2246 actual_hash, sizeof(actual_hash),
2247 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002248 if( status != PSA_SUCCESS )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002249 goto exit;
Steven Cooreman84d670d2021-02-18 16:22:53 +01002250 if( actual_hash_length != hash_length )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002251 {
2252 status = PSA_ERROR_INVALID_SIGNATURE;
2253 goto exit;
2254 }
Steven Cooreman36876a02021-04-29 16:37:59 +02002255 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002256 status = PSA_ERROR_INVALID_SIGNATURE;
2257
2258exit:
2259 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
2260 return( status );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002261}
2262
Gilles Peskineeb35d782019-01-22 17:56:16 +01002263psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2264 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002265{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002266 if( source_operation->id == 0 ||
2267 target_operation->id != 0 )
2268 {
2269 return( PSA_ERROR_BAD_STATE );
2270 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002271
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002272 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2273 target_operation );
2274 if( status != PSA_SUCCESS )
2275 psa_hash_abort( target_operation );
2276
2277 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002278}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002279
2280
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002281/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002282/* MAC */
2283/****************************************************************/
2284
Steven Cooremane6804192021-03-19 18:28:56 +01002285psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002286{
Steven Cooremane6804192021-03-19 18:28:56 +01002287 /* Aborting a non-active operation is allowed */
2288 if( operation->id == 0 )
2289 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002290
Steven Cooremane6804192021-03-19 18:28:56 +01002291 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002292 operation->mac_size = 0;
2293 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002294 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002295
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002296 return( status );
2297}
2298
Ronald Cron2dff3b22021-06-17 16:33:22 +02002299static psa_status_t psa_mac_finalize_alg_and_key_validation(
2300 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 const psa_key_attributes_t *attributes,
2302 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002303{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002305 psa_key_type_t key_type = psa_get_key_type( attributes );
2306 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002307
Ronald Cron28ea0502021-06-17 16:10:24 +02002308 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002310
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002311 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002312 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002313 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002314 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002315
Steven Cooremand1a68f12021-05-10 11:13:41 +02002316 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002317 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002318
Ronald Cron79bdd822021-06-17 16:46:44 +02002319 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002320 {
2321 /* A very short MAC is too short for security since it can be
2322 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2323 * so we make this our minimum, even though 32 bits is still
2324 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002325 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002326 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002327
Ronald Cron79bdd822021-06-17 16:46:44 +02002328 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2329 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002330 {
2331 /* It's impossible to "truncate" to a larger length than the full length
2332 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002333 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002334 }
2335
Ronald Cron79bdd822021-06-17 16:46:44 +02002336 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002337}
2338
Gilles Peskinee59236f2018-01-27 23:32:46 +01002339static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2340 mbedtls_svc_key_id_t key,
2341 psa_algorithm_t alg,
2342 int is_sign )
2343{
2344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2345 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002346 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002347
2348 /* A context must be freshly initialized before it can be set up. */
2349 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002350 {
Dave Rodgman54648242021-06-24 11:49:45 +01002351 status = PSA_ERROR_BAD_STATE;
2352 goto exit;
2353 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002354
2355 status = psa_get_and_lock_key_slot_with_policy(
2356 key,
2357 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002358 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002359 alg );
2360 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002361 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002362
2363 psa_key_attributes_t attributes = {
2364 .core = slot->attr
2365 };
2366
Ronald Cron79bdd822021-06-17 16:46:44 +02002367 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2368 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002369 if( status != PSA_SUCCESS )
2370 goto exit;
2371
2372 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002373 /* Dispatch the MAC setup call with validated input */
2374 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002375 {
Steven Cooremane6804192021-03-19 18:28:56 +01002376 status = psa_driver_wrapper_mac_sign_setup( operation,
2377 &attributes,
2378 slot->key.data,
2379 slot->key.bytes,
2380 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002381 }
2382 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002383 {
Steven Cooremane6804192021-03-19 18:28:56 +01002384 status = psa_driver_wrapper_mac_verify_setup( operation,
2385 &attributes,
2386 slot->key.data,
2387 slot->key.bytes,
2388 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002389 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002390
Gilles Peskinefbfac682018-07-08 20:51:54 +02002391exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002392 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002393 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002394
Ronald Cron5c522922020-11-14 16:35:34 +01002395 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002396
Ronald Cron5c522922020-11-14 16:35:34 +01002397 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002398}
2399
Gilles Peskine89167cb2018-07-08 20:12:23 +02002400psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002401 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002402 psa_algorithm_t alg )
2403{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002404 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002405}
2406
2407psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002408 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002409 psa_algorithm_t alg )
2410{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002411 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002412}
2413
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002414psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002415 const uint8_t *input,
2416 size_t input_length )
2417{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002418 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002419 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002421 /* Don't require hash implementations to behave correctly on a
2422 * zero-length input, which may have an invalid pointer. */
2423 if( input_length == 0 )
2424 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002425
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002426 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2427 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002428 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002429 psa_mac_abort( operation );
2430
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002431 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002432}
2433
Steven Cooremana5b860a2021-03-19 19:04:39 +01002434psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002435 uint8_t *mac,
2436 size_t mac_size,
2437 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002438{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2440 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002441
Steven Cooremana5b860a2021-03-19 19:04:39 +01002442 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002443 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002444 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002445 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002446 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002447
Steven Cooreman72f736a2021-05-07 14:14:37 +02002448 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002449 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002450 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002451 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002452 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002453
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002454 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2455 * once all the error checks are done. */
2456 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002457 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002458 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002459 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002460 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002461
2462 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002463 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002464 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002465 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002466 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002467
Steven Cooremana5b860a2021-03-19 19:04:39 +01002468 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002469 mac, operation->mac_size,
2470 mac_length );
2471
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002472exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002473 /* In case of success, set the potential excess room in the output buffer
2474 * to an invalid value, to avoid potentially leaking a longer MAC.
2475 * In case of error, set the output length and content to a safe default,
2476 * such that in case the caller misses an error check, the output would be
2477 * an unachievable MAC.
2478 */
2479 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002480 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002481 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002482 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002483 }
mohammad16036df908f2018-04-02 08:34:15 -07002484
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002485 if( mac_size > operation->mac_size )
2486 memset( &mac[operation->mac_size], '!',
2487 mac_size - operation->mac_size );
2488
Steven Cooremana5b860a2021-03-19 19:04:39 +01002489 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002490
Steven Cooremana5b860a2021-03-19 19:04:39 +01002491 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002492}
2493
Steven Cooremana5b860a2021-03-19 19:04:39 +01002494psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002495 const uint8_t *mac,
2496 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002497{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002498 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2499 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002500
Steven Cooremana5b860a2021-03-19 19:04:39 +01002501 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002502 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002503 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002504 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002505 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002506
Steven Cooreman72f736a2021-05-07 14:14:37 +02002507 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002508 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002509 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002510 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002511 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002512
2513 if( operation->mac_size != mac_length )
2514 {
2515 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002516 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002517 }
2518
Steven Cooremana5b860a2021-03-19 19:04:39 +01002519 status = psa_driver_wrapper_mac_verify_finish( operation,
2520 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002521
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002522exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002523 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002524
Steven Cooremana5b860a2021-03-19 19:04:39 +01002525 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002526}
2527
Ronald Croncd989b52021-06-18 14:23:33 +02002528static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2529 psa_algorithm_t alg,
2530 const uint8_t *input,
2531 size_t input_length,
2532 uint8_t *mac,
2533 size_t mac_size,
2534 size_t *mac_length,
2535 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002536{
2537 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002538 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2539 psa_key_slot_t *slot;
2540 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541
Ronald Cron51131b52021-06-17 17:17:20 +02002542 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002543 key,
2544 &slot,
2545 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002546 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002547 if( status != PSA_SUCCESS )
2548 goto exit;
2549
Ronald Cron51131b52021-06-17 17:17:20 +02002550 psa_key_attributes_t attributes = {
2551 .core = slot->attr
2552 };
2553
2554 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2555 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002556 if( status != PSA_SUCCESS )
2557 goto exit;
2558
Ronald Cron51131b52021-06-17 17:17:20 +02002559 if( mac_size < operation_mac_size )
2560 {
2561 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002562 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002563 }
2564
2565 status = psa_driver_wrapper_mac_compute(
2566 &attributes,
2567 slot->key.data, slot->key.bytes,
2568 alg,
2569 input, input_length,
2570 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002571
2572exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002573 /* In case of success, set the potential excess room in the output buffer
2574 * to an invalid value, to avoid potentially leaking a longer MAC.
2575 * In case of error, set the output length and content to a safe default,
2576 * such that in case the caller misses an error check, the output would be
2577 * an unachievable MAC.
2578 */
2579 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002580 {
Ronald Cron51131b52021-06-17 17:17:20 +02002581 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002582 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002583 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002584 if( mac_size > operation_mac_size )
2585 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002586
Ronald Cron51131b52021-06-17 17:17:20 +02002587 unlock_status = psa_unlock_key_slot( slot );
2588
2589 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002590}
2591
Ronald Croncd989b52021-06-18 14:23:33 +02002592psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2593 psa_algorithm_t alg,
2594 const uint8_t *input,
2595 size_t input_length,
2596 uint8_t *mac,
2597 size_t mac_size,
2598 size_t *mac_length)
2599{
2600 return( psa_mac_compute_internal( key, alg,
2601 input, input_length,
2602 mac, mac_size, mac_length, 1 ) );
2603}
2604
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002605psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2606 psa_algorithm_t alg,
2607 const uint8_t *input,
2608 size_t input_length,
2609 const uint8_t *mac,
2610 size_t mac_length)
2611{
2612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002613 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2614 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002615
Ronald Crona587cbc2021-06-18 14:51:29 +02002616 status = psa_mac_compute_internal( key, alg,
2617 input, input_length,
2618 actual_mac, sizeof( actual_mac ),
2619 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002620 if( status != PSA_SUCCESS )
2621 goto exit;
2622
Ronald Crona587cbc2021-06-18 14:51:29 +02002623 if( mac_length != actual_mac_length )
2624 {
2625 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002626 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002627 }
2628 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2629 {
2630 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002631 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002632 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002633
2634exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002635 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002636
2637 return ( status );
2638}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002639
Gilles Peskinee59236f2018-01-27 23:32:46 +01002640/****************************************************************/
2641/* Asymmetric cryptography */
2642/****************************************************************/
2643
gabor-mezei-armf0486182021-05-12 11:03:09 +02002644static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002645 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002646{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002647 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002648 {
2649 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2650 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002651
Gilles Peskinef7b41372021-09-22 16:15:05 +02002652 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002653 {
2654 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2655 return( PSA_ERROR_INVALID_ARGUMENT );
2656 }
2657 }
2658 else
2659 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002660 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002661 return( PSA_ERROR_INVALID_ARGUMENT );
2662 }
2663
2664 return( PSA_SUCCESS );
2665}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002666
2667static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002668 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002669 psa_algorithm_t alg,
2670 const uint8_t * input,
2671 size_t input_length,
2672 uint8_t * signature,
2673 size_t signature_size,
2674 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002675{
2676 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2677 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2678 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002679
2680 *signature_length = 0;
2681
gabor-mezei-armf0486182021-05-12 11:03:09 +02002682 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002683 if( status != PSA_SUCCESS )
2684 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002685
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002686 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002687 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002688 * buffer can in principle be empty since it doesn't actually have
2689 * to be a hash.) */
2690 if( signature_size == 0 )
2691 return( PSA_ERROR_BUFFER_TOO_SMALL );
2692
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002693 status = psa_get_and_lock_key_slot_with_policy(
2694 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002695 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2696 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002697 alg );
2698
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002699 if( status != PSA_SUCCESS )
2700 goto exit;
2701
2702 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2703 {
2704 status = PSA_ERROR_INVALID_ARGUMENT;
2705 goto exit;
2706 }
2707
2708 psa_key_attributes_t attributes = {
2709 .core = slot->attr
2710 };
2711
gabor-mezei-armf0486182021-05-12 11:03:09 +02002712 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002713 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002714 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002715 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002716 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002717 signature, signature_size, signature_length );
2718 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002719 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002720 {
2721
2722 status = psa_driver_wrapper_sign_hash(
2723 &attributes, slot->key.data, slot->key.bytes,
2724 alg, input, input_length,
2725 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002726 }
2727
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002728
2729exit:
2730 /* Fill the unused part of the output buffer (the whole buffer on error,
2731 * the trailing part on success) with something that isn't a valid signature
2732 * (barring an attack on the signature and deliberately-crafted input),
2733 * in case the caller doesn't check the return status properly. */
2734 if( status == PSA_SUCCESS )
2735 memset( signature + *signature_length, '!',
2736 signature_size - *signature_length );
2737 else
2738 memset( signature, '!', signature_size );
2739 /* If signature_size is 0 then we have nothing to do. We must not call
2740 * memset because signature may be NULL in this case. */
2741
2742 unlock_status = psa_unlock_key_slot( slot );
2743
2744 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2745}
2746
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002747static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002748 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002749 psa_algorithm_t alg,
2750 const uint8_t * input,
2751 size_t input_length,
2752 const uint8_t * signature,
2753 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002754{
2755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2756 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2757 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002758
gabor-mezei-armf0486182021-05-12 11:03:09 +02002759 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002760 if( status != PSA_SUCCESS )
2761 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002762
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763 status = psa_get_and_lock_key_slot_with_policy(
2764 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002765 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2766 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002767 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002768
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002769 if( status != PSA_SUCCESS )
2770 return( status );
2771
2772 psa_key_attributes_t attributes = {
2773 .core = slot->attr
2774 };
2775
gabor-mezei-armf0486182021-05-12 11:03:09 +02002776 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002777 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002778 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002779 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002780 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002781 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002782 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002783 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002784 {
2785 status = psa_driver_wrapper_verify_hash(
2786 &attributes, slot->key.data, slot->key.bytes,
2787 alg, input, input_length,
2788 signature, signature_length );
2789 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002790
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002791 unlock_status = psa_unlock_key_slot( slot );
2792
2793 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002794
2795}
2796
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002797psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002798 const psa_key_attributes_t *attributes,
2799 const uint8_t *key_buffer,
2800 size_t key_buffer_size,
2801 psa_algorithm_t alg,
2802 const uint8_t *input,
2803 size_t input_length,
2804 uint8_t *signature,
2805 size_t signature_size,
2806 size_t *signature_length )
2807{
2808 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002809
Gilles Peskinef7b41372021-09-22 16:15:05 +02002810 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002811 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002812 size_t hash_length;
2813 uint8_t hash[PSA_HASH_MAX_SIZE];
2814
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002815 status = psa_driver_wrapper_hash_compute(
2816 PSA_ALG_SIGN_GET_HASH( alg ),
2817 input, input_length,
2818 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002819
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002820 if( status != PSA_SUCCESS )
2821 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002822
2823 return psa_driver_wrapper_sign_hash(
2824 attributes, key_buffer, key_buffer_size,
2825 alg, hash, hash_length,
2826 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002827 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002828
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002829 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002830}
2831
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002832psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2833 psa_algorithm_t alg,
2834 const uint8_t * input,
2835 size_t input_length,
2836 uint8_t * signature,
2837 size_t signature_size,
2838 size_t * signature_length )
2839{
2840 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002841 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002842 signature, signature_size, signature_length );
2843}
2844
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002845psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002846 const psa_key_attributes_t *attributes,
2847 const uint8_t *key_buffer,
2848 size_t key_buffer_size,
2849 psa_algorithm_t alg,
2850 const uint8_t *input,
2851 size_t input_length,
2852 const uint8_t *signature,
2853 size_t signature_length )
2854{
2855 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002856
Gilles Peskinef7b41372021-09-22 16:15:05 +02002857 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002858 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002859 size_t hash_length;
2860 uint8_t hash[PSA_HASH_MAX_SIZE];
2861
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002862 status = psa_driver_wrapper_hash_compute(
2863 PSA_ALG_SIGN_GET_HASH( alg ),
2864 input, input_length,
2865 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002866
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002867 if( status != PSA_SUCCESS )
2868 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002869
2870 return psa_driver_wrapper_verify_hash(
2871 attributes, key_buffer, key_buffer_size,
2872 alg, hash, hash_length,
2873 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002874 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002875
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002876 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002877}
2878
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002879psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2880 psa_algorithm_t alg,
2881 const uint8_t * input,
2882 size_t input_length,
2883 const uint8_t * signature,
2884 size_t signature_length )
2885{
2886 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002887 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002888 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002889}
2890
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002891psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002892 const psa_key_attributes_t *attributes,
2893 const uint8_t *key_buffer, size_t key_buffer_size,
2894 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2895 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002896{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002897 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002898 {
Ronald Cron4501c982021-03-19 20:09:32 +01002899 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2900 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002901 {
Ronald Cron4501c982021-03-19 20:09:32 +01002902#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2903 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2904 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002905 attributes,
2906 key_buffer, key_buffer_size,
2907 alg, hash, hash_length,
2908 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002909#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2910 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002911 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002912 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002913 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002914 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002915 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002916 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002917 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Ronald Cron4501c982021-03-19 20:09:32 +01002918 {
2919 if( PSA_ALG_IS_ECDSA( alg ) )
2920 {
2921#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2922 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2923 return( mbedtls_psa_ecdsa_sign_hash(
2924 attributes,
2925 key_buffer, key_buffer_size,
2926 alg, hash, hash_length,
2927 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002928#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2929 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002930 }
2931 else
2932 {
2933 return( PSA_ERROR_INVALID_ARGUMENT );
2934 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002935 }
Ronald Cron4501c982021-03-19 20:09:32 +01002936
2937 (void)key_buffer;
2938 (void)key_buffer_size;
2939 (void)hash;
2940 (void)hash_length;
2941 (void)signature;
2942 (void)signature_size;
2943 (void)signature_length;
2944
2945 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002946}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002947
2948psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2949 psa_algorithm_t alg,
2950 const uint8_t *hash,
2951 size_t hash_length,
2952 uint8_t *signature,
2953 size_t signature_size,
2954 size_t *signature_length )
2955{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002956 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002957 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002958 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002959}
2960
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002961psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002962 const psa_key_attributes_t *attributes,
2963 const uint8_t *key_buffer, size_t key_buffer_size,
2964 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2965 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002966{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002967 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002968 {
Ronald Cron4501c982021-03-19 20:09:32 +01002969 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2970 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002971 {
Ronald Cron4501c982021-03-19 20:09:32 +01002972#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2973 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2974 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002975 attributes,
2976 key_buffer, key_buffer_size,
2977 alg, hash, hash_length,
2978 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002979#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2980 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002981 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002982 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002983 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002984 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002985 }
itayzafrir5c753392018-05-08 11:18:38 +03002986 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002987 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002988 {
Ronald Cron4501c982021-03-19 20:09:32 +01002989 if( PSA_ALG_IS_ECDSA( alg ) )
2990 {
2991#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2992 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2993 return( mbedtls_psa_ecdsa_verify_hash(
2994 attributes,
2995 key_buffer, key_buffer_size,
2996 alg, hash, hash_length,
2997 signature, signature_length ) );
2998#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2999 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3000 }
3001 else
3002 {
3003 return( PSA_ERROR_INVALID_ARGUMENT );
3004 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003005 }
Ronald Cron4501c982021-03-19 20:09:32 +01003006
3007 (void)key_buffer;
3008 (void)key_buffer_size;
3009 (void)hash;
3010 (void)hash_length;
3011 (void)signature;
3012 (void)signature_length;
3013
3014 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003015}
3016
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003017psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3018 psa_algorithm_t alg,
3019 const uint8_t *hash,
3020 size_t hash_length,
3021 const uint8_t *signature,
3022 size_t signature_length )
3023{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003024 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003025 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003026 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003027}
3028
Ronald Croncf56a0a2020-08-04 09:51:30 +02003029psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003030 psa_algorithm_t alg,
3031 const uint8_t *input,
3032 size_t input_length,
3033 const uint8_t *salt,
3034 size_t salt_length,
3035 uint8_t *output,
3036 size_t output_size,
3037 size_t *output_length )
3038{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003039 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003040 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003041 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003042
Darryl Green5cc689a2018-07-24 15:34:10 +01003043 (void) input;
3044 (void) input_length;
3045 (void) salt;
3046 (void) output;
3047 (void) output_size;
3048
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003049 *output_length = 0;
3050
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003051 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3052 return( PSA_ERROR_INVALID_ARGUMENT );
3053
Ronald Cron5c522922020-11-14 16:35:34 +01003054 status = psa_get_and_lock_transparent_key_slot_with_policy(
3055 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003056 if( status != PSA_SUCCESS )
3057 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003058 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3059 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003060 {
3061 status = PSA_ERROR_INVALID_ARGUMENT;
3062 goto exit;
3063 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003064
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003065 psa_key_attributes_t attributes = {
3066 .core = slot->attr
3067 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003068
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003069 status = psa_driver_wrapper_asymmetric_encrypt(
3070 &attributes, slot->key.data, slot->key.bytes,
3071 alg, input, input_length, salt, salt_length,
3072 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003073exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003074 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003075
Ronald Cron5c522922020-11-14 16:35:34 +01003076 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003077}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003078
Ronald Croncf56a0a2020-08-04 09:51:30 +02003079psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003080 psa_algorithm_t alg,
3081 const uint8_t *input,
3082 size_t input_length,
3083 const uint8_t *salt,
3084 size_t salt_length,
3085 uint8_t *output,
3086 size_t output_size,
3087 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003088{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003090 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003091 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003092
Darryl Green5cc689a2018-07-24 15:34:10 +01003093 (void) input;
3094 (void) input_length;
3095 (void) salt;
3096 (void) output;
3097 (void) output_size;
3098
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003099 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003101 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3102 return( PSA_ERROR_INVALID_ARGUMENT );
3103
Ronald Cron5c522922020-11-14 16:35:34 +01003104 status = psa_get_and_lock_transparent_key_slot_with_policy(
3105 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003106 if( status != PSA_SUCCESS )
3107 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003108 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003109 {
3110 status = PSA_ERROR_INVALID_ARGUMENT;
3111 goto exit;
3112 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003113
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003114 psa_key_attributes_t attributes = {
3115 .core = slot->attr
3116 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003117
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003118 status = psa_driver_wrapper_asymmetric_decrypt(
3119 &attributes, slot->key.data, slot->key.bytes,
3120 alg, input, input_length, salt, salt_length,
3121 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003122
3123exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003124 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003125
Ronald Cron5c522922020-11-14 16:35:34 +01003126 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003127}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003128
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003129
3130
mohammad1603503973b2018-03-12 15:59:30 +02003131/****************************************************************/
3132/* Symmetric cryptography */
3133/****************************************************************/
3134
Ronald Cronab99ac22020-10-01 16:38:28 +02003135static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3136 mbedtls_svc_key_id_t key,
3137 psa_algorithm_t alg,
3138 mbedtls_operation_t cipher_operation )
3139{
3140 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3141 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003142 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003143 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3144 PSA_KEY_USAGE_ENCRYPT :
3145 PSA_KEY_USAGE_DECRYPT );
3146
3147 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003148 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003149 {
Dave Rodgman54648242021-06-24 11:49:45 +01003150 status = PSA_ERROR_BAD_STATE;
3151 goto exit;
3152 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003153
Ronald Cronab99ac22020-10-01 16:38:28 +02003154 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003155 {
Dave Rodgman54648242021-06-24 11:49:45 +01003156 status = PSA_ERROR_INVALID_ARGUMENT;
3157 goto exit;
3158 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003159
Ronald Cronab99ac22020-10-01 16:38:28 +02003160 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3161 if( status != PSA_SUCCESS )
3162 goto exit;
3163
Ronald Cron49fafa92021-03-10 08:34:23 +01003164 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003165 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003166 * so we only set it (in the driver wrapper) after resources have been
3167 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003168 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003169 if( alg == PSA_ALG_ECB_NO_PADDING )
3170 operation->iv_required = 0;
3171 else
3172 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003173 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003174
Ronald Crona4af55f2020-12-14 14:36:06 +01003175 psa_key_attributes_t attributes = {
3176 .core = slot->attr
3177 };
3178
Ronald Cronab99ac22020-10-01 16:38:28 +02003179 /* Try doing the operation through a driver before using software fallback. */
3180 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003181 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3182 &attributes,
3183 slot->key.data,
3184 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003185 alg );
3186 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003187 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3188 &attributes,
3189 slot->key.data,
3190 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003191 alg );
3192
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003193exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003194 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003195 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003196
Ronald Cron5c522922020-11-14 16:35:34 +01003197 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003198
Ronald Cron5c522922020-11-14 16:35:34 +01003199 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003200}
3201
Gilles Peskinefe119512018-07-08 21:39:34 +02003202psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003203 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003204 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003205{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003206 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003207}
3208
Gilles Peskinefe119512018-07-08 21:39:34 +02003209psa_status_t psa_cipher_decrypt_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_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003214}
3215
Gilles Peskinefe119512018-07-08 21:39:34 +02003216psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003217 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003218 size_t iv_size,
3219 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003220{
Ronald Cron6d051732020-10-01 14:10:20 +02003221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003222 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3223 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003224
Ronald Cron49fafa92021-03-10 08:34:23 +01003225 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003226 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003227 status = PSA_ERROR_BAD_STATE;
3228 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003229 }
3230
Steven Cooreman7df02922020-09-09 15:28:49 +02003231 if( operation->iv_set || ! operation->iv_required )
3232 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003233 status = PSA_ERROR_BAD_STATE;
3234 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003235 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003236
Ronald Cron2fb90522021-07-05 12:31:44 +02003237 default_iv_length = operation->default_iv_length;
3238 if( iv_size < default_iv_length )
Ronald Cron5618a392021-03-26 09:52:26 +01003239 {
3240 status = PSA_ERROR_BUFFER_TOO_SMALL;
3241 goto exit;
3242 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003243
Ronald Cron2fb90522021-07-05 12:31:44 +02003244 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
3245 {
3246 status = PSA_ERROR_GENERIC_ERROR;
3247 goto exit;
3248 }
3249
3250 status = psa_generate_random( local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003251 if( status != PSA_SUCCESS )
3252 goto exit;
3253
3254 status = psa_driver_wrapper_cipher_set_iv( operation,
Ronald Cron2fb90522021-07-05 12:31:44 +02003255 local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003256
3257exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003258 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003259 {
Ronald Cron2fb90522021-07-05 12:31:44 +02003260 memcpy( iv, local_iv, default_iv_length );
3261 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003262 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003263 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003264 else
Ronald Cron2fb90522021-07-05 12:31:44 +02003265 {
3266 *iv_length = 0;
Moran Peker395db872018-05-31 14:07:14 +03003267 psa_cipher_abort( operation );
Ronald Cron2fb90522021-07-05 12:31:44 +02003268 }
Ronald Cron6d051732020-10-01 14:10:20 +02003269
itayzafrir534bd7c2018-08-02 13:56:32 +03003270 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003271}
3272
Gilles Peskinefe119512018-07-08 21:39:34 +02003273psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003274 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003275 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003276{
Ronald Cron6d051732020-10-01 14:10:20 +02003277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003278
Ronald Cron49fafa92021-03-10 08:34:23 +01003279 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003280 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003281 status = PSA_ERROR_BAD_STATE;
3282 goto exit;
3283 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003284
Steven Cooreman7df02922020-09-09 15:28:49 +02003285 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003286 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003287 status = PSA_ERROR_BAD_STATE;
3288 goto exit;
3289 }
Ronald Crona0d68172021-03-26 10:15:08 +01003290
3291 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003292 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003293 status = PSA_ERROR_INVALID_ARGUMENT;
3294 goto exit;
3295 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003296
Ronald Crondd24c9b2020-12-15 14:10:01 +01003297 status = psa_driver_wrapper_cipher_set_iv( operation,
3298 iv,
3299 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003300
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003301exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003302 if( status == PSA_SUCCESS )
3303 operation->iv_set = 1;
3304 else
mohammad1603503973b2018-03-12 15:59:30 +02003305 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003306 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003307}
3308
Gilles Peskinee553c652018-06-04 16:22:46 +02003309psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3310 const uint8_t *input,
3311 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003312 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003313 size_t output_size,
3314 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003315{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003317
Ronald Cron49fafa92021-03-10 08:34:23 +01003318 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003319 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003320 status = PSA_ERROR_BAD_STATE;
3321 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003322 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003323
Steven Cooreman7df02922020-09-09 15:28:49 +02003324 if( operation->iv_required && ! operation->iv_set )
3325 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003326 status = PSA_ERROR_BAD_STATE;
3327 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003328 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003329
Ronald Crondd24c9b2020-12-15 14:10:01 +01003330 status = psa_driver_wrapper_cipher_update( operation,
3331 input,
3332 input_length,
3333 output,
3334 output_size,
3335 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003336
3337exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003338 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003339 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003340
itayzafrir534bd7c2018-08-02 13:56:32 +03003341 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003342}
3343
Gilles Peskinee553c652018-06-04 16:22:46 +02003344psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3345 uint8_t *output,
3346 size_t output_size,
3347 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003348{
David Saadab4ecc272019-02-14 13:48:10 +02003349 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003350
Ronald Cron49fafa92021-03-10 08:34:23 +01003351 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003352 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003353 status = PSA_ERROR_BAD_STATE;
3354 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003355 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003356
Steven Cooreman7df02922020-09-09 15:28:49 +02003357 if( operation->iv_required && ! operation->iv_set )
3358 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003359 status = PSA_ERROR_BAD_STATE;
3360 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003361 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003362
Ronald Crondd24c9b2020-12-15 14:10:01 +01003363 status = psa_driver_wrapper_cipher_finish( operation,
3364 output,
3365 output_size,
3366 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003367
3368exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003369 if( status == PSA_SUCCESS )
3370 return( psa_cipher_abort( operation ) );
3371 else
3372 {
3373 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003374 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003375
Steven Cooremanef8575e2020-09-11 11:44:50 +02003376 return( status );
3377 }
mohammad1603503973b2018-03-12 15:59:30 +02003378}
3379
Gilles Peskinee553c652018-06-04 16:22:46 +02003380psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3381{
Ronald Cron49fafa92021-03-10 08:34:23 +01003382 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003383 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003384 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003385 * in use. It's ok to call abort on such an object, and there's
3386 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003387 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003388 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003389
Ronald Crondd24c9b2020-12-15 14:10:01 +01003390 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003391
Ronald Cron49fafa92021-03-10 08:34:23 +01003392 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003393 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003394 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003395
Moran Peker395db872018-05-31 14:07:14 +03003396 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003397}
3398
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003399psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3400 psa_algorithm_t alg,
3401 const uint8_t *input,
3402 size_t input_length,
3403 uint8_t *output,
3404 size_t output_size,
3405 size_t *output_length )
3406{
3407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003408 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003409 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02003410 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3411 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003412
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003413 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003414 {
3415 status = PSA_ERROR_INVALID_ARGUMENT;
3416 goto exit;
3417 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003418
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003419 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3420 PSA_KEY_USAGE_ENCRYPT,
3421 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003422 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003423 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003424
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003425 psa_key_attributes_t attributes = {
3426 .core = slot->attr
3427 };
3428
Ronald Cronc6e6f502021-07-09 18:44:58 +02003429 default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
3430 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003431 {
Ronald Cronc6e6f502021-07-09 18:44:58 +02003432 status = PSA_ERROR_GENERIC_ERROR;
3433 goto exit;
3434 }
3435
3436 if( default_iv_length > 0 )
3437 {
3438 if( output_size < default_iv_length )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003439 {
3440 status = PSA_ERROR_BUFFER_TOO_SMALL;
3441 goto exit;
3442 }
3443
Ronald Cronc6e6f502021-07-09 18:44:58 +02003444 status = psa_generate_random( local_iv, default_iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003445 if( status != PSA_SUCCESS )
3446 goto exit;
3447 }
3448
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003449 status = psa_driver_wrapper_cipher_encrypt(
3450 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02003451 alg, local_iv, default_iv_length, input, input_length,
3452 output + default_iv_length, output_size - default_iv_length,
3453 output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003454
3455exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003456 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003457 if( status == PSA_SUCCESS )
3458 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003459
Ronald Cron9b674282021-07-09 09:19:35 +02003460 if( status == PSA_SUCCESS )
Ronald Cronc6e6f502021-07-09 18:44:58 +02003461 {
3462 if( default_iv_length > 0 )
3463 memcpy( output, local_iv, default_iv_length );
3464 *output_length += default_iv_length;
3465 }
Ronald Cron9b674282021-07-09 09:19:35 +02003466 else
Ronald Cron23919522021-07-08 19:00:07 +02003467 *output_length = 0;
3468
3469 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003470}
3471
3472psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3473 psa_algorithm_t alg,
3474 const uint8_t *input,
3475 size_t input_length,
3476 uint8_t *output,
3477 size_t output_size,
3478 size_t *output_length )
3479{
3480 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003481 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003482 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003483
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003484 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003485 {
3486 status = PSA_ERROR_INVALID_ARGUMENT;
3487 goto exit;
3488 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003489
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003490 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3491 PSA_KEY_USAGE_DECRYPT,
3492 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003493 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003494 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003495
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003496 psa_key_attributes_t attributes = {
3497 .core = slot->attr
3498 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003499
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003500 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3501 {
3502 status = PSA_ERROR_INVALID_ARGUMENT;
3503 goto exit;
3504 }
3505 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003506 {
3507 status = PSA_ERROR_INVALID_ARGUMENT;
3508 goto exit;
3509 }
3510
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003511 status = psa_driver_wrapper_cipher_decrypt(
3512 &attributes, slot->key.data, slot->key.bytes,
3513 alg, input, input_length,
3514 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003515
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003516exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003517 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003518 if( status == PSA_SUCCESS )
3519 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003520
Ronald Cron23919522021-07-08 19:00:07 +02003521 if( status != PSA_SUCCESS )
3522 *output_length = 0;
3523
3524 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003525}
3526
3527
mohammad16035955c982018-04-26 00:53:03 +03003528/****************************************************************/
3529/* AEAD */
3530/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003531
Paul Elliottbaff51c2021-09-28 17:44:45 +01003532/* Helper function to get the base algorithm from its variants. */
3533static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3534{
3535 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3536}
3537
3538/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003539static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3540 size_t nonce_length )
3541{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003542 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3543
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003544 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003545 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003546#if defined(PSA_WANT_ALG_GCM)
3547 case PSA_ALG_GCM:
3548 /* Not checking max nonce size here as GCM spec allows almost
3549 * arbitrarily large nonces. Please note that we do not generally
3550 * recommend the usage of nonces of greater length than
3551 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3552 * size, which can then lead to collisions if you encrypt a very
3553 * large number of messages.*/
3554 if( nonce_length != 0 )
3555 return( PSA_SUCCESS );
3556 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003557#endif /* PSA_WANT_ALG_GCM */
3558#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003559 case PSA_ALG_CCM:
3560 if( nonce_length >= 7 && nonce_length <= 13 )
3561 return( PSA_SUCCESS );
3562 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003563#endif /* PSA_WANT_ALG_CCM */
3564#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003565 case PSA_ALG_CHACHA20_POLY1305:
3566 if( nonce_length == 12 )
3567 return( PSA_SUCCESS );
Bence Szépkúti6d48e202021-11-15 20:04:15 +01003568 else if( nonce_length == 8 )
3569 return( PSA_ERROR_NOT_SUPPORTED );
3570 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003571#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003572 default:
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003573 return( PSA_ERROR_NOT_SUPPORTED );
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003574 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003575
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003576 return( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003577}
3578
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01003579static psa_status_t psa_aead_check_algorithm( psa_algorithm_t alg )
3580{
Bence Szépkúti08f34652021-12-08 21:07:13 +01003581 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3582 return( PSA_ERROR_INVALID_ARGUMENT );
3583
3584 return( PSA_SUCCESS );
3585}
3586
Ronald Croncf56a0a2020-08-04 09:51:30 +02003587psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003588 psa_algorithm_t alg,
3589 const uint8_t *nonce,
3590 size_t nonce_length,
3591 const uint8_t *additional_data,
3592 size_t additional_data_length,
3593 const uint8_t *plaintext,
3594 size_t plaintext_length,
3595 uint8_t *ciphertext,
3596 size_t ciphertext_size,
3597 size_t *ciphertext_length )
3598{
Ronald Cron215633c2021-03-16 17:15:37 +01003599 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3600 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003601
mohammad1603f08a5502018-06-03 15:05:47 +03003602 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003603
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003604 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003605 if( status != PSA_SUCCESS )
3606 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003607
Ronald Cron9a986162021-03-26 12:40:07 +01003608 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003609 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003610 if( status != PSA_SUCCESS )
3611 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003612
Ronald Cron215633c2021-03-16 17:15:37 +01003613 psa_key_attributes_t attributes = {
3614 .core = slot->attr
3615 };
mohammad16035955c982018-04-26 00:53:03 +03003616
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003617 status = psa_aead_check_nonce_length( alg, nonce_length );
3618 if( status != PSA_SUCCESS )
3619 goto exit;
3620
Ronald Cronde822812021-03-17 16:08:20 +01003621 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003622 &attributes, slot->key.data, slot->key.bytes,
3623 alg,
3624 nonce, nonce_length,
3625 additional_data, additional_data_length,
3626 plaintext, plaintext_length,
3627 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003628
Gilles Peskineedf9a652018-08-17 18:11:56 +02003629 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3630 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003631
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003632exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003633 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003634
mohammad16035955c982018-04-26 00:53:03 +03003635 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003636}
3637
Ronald Croncf56a0a2020-08-04 09:51:30 +02003638psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003639 psa_algorithm_t alg,
3640 const uint8_t *nonce,
3641 size_t nonce_length,
3642 const uint8_t *additional_data,
3643 size_t additional_data_length,
3644 const uint8_t *ciphertext,
3645 size_t ciphertext_length,
3646 uint8_t *plaintext,
3647 size_t plaintext_size,
3648 size_t *plaintext_length )
3649{
Ronald Cron215633c2021-03-16 17:15:37 +01003650 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3651 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003652
Gilles Peskineee652a32018-06-01 19:23:52 +02003653 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003654
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003655 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003656 if( status != PSA_SUCCESS )
3657 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003658
Ronald Cron9a986162021-03-26 12:40:07 +01003659 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003660 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003661 if( status != PSA_SUCCESS )
3662 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003663
Ronald Cron215633c2021-03-16 17:15:37 +01003664 psa_key_attributes_t attributes = {
3665 .core = slot->attr
3666 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003667
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003668 status = psa_aead_check_nonce_length( alg, nonce_length );
3669 if( status != PSA_SUCCESS )
3670 goto exit;
3671
Ronald Cronde822812021-03-17 16:08:20 +01003672 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003673 &attributes, slot->key.data, slot->key.bytes,
3674 alg,
3675 nonce, nonce_length,
3676 additional_data, additional_data_length,
3677 ciphertext, ciphertext_length,
3678 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003679
Gilles Peskineedf9a652018-08-17 18:11:56 +02003680 if( status != PSA_SUCCESS && plaintext_size != 0 )
3681 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003682
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003683exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003684 psa_unlock_key_slot( slot );
3685
Gilles Peskineedf9a652018-08-17 18:11:56 +02003686 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003687}
3688
Andrzej Kurekf8816012021-12-19 17:00:12 +01003689static psa_status_t psa_validate_tag_length( psa_aead_operation_t *operation,
3690 psa_algorithm_t alg ) {
3691 uint8_t tag_len = 0;
3692 if( psa_driver_get_tag_len( operation, &tag_len ) != PSA_SUCCESS )
3693 {
3694 return( PSA_ERROR_INVALID_ARGUMENT );
3695 }
3696
3697 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
3698 {
3699#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
3700 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
3701 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
3702 if( tag_len < 4 || tag_len > 16 || tag_len % 2 )
3703 return( PSA_ERROR_INVALID_ARGUMENT );
3704 break;
3705#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3706
3707#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
3708 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
3709 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
3710 if( tag_len != 4 && tag_len != 8 && ( tag_len < 12 || tag_len > 16 ) )
3711 return( PSA_ERROR_INVALID_ARGUMENT );
3712 break;
3713#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3714
3715#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
3716 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
3717 /* We only support the default tag length. */
3718 if( tag_len != 16 )
3719 return( PSA_ERROR_INVALID_ARGUMENT );
3720 break;
3721#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
3722
3723 default:
3724 (void) tag_len;
3725 return( PSA_ERROR_NOT_SUPPORTED );
3726 }
3727 return( PSA_SUCCESS );
3728}
3729
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003730/* Set the key for a multipart authenticated operation. */
3731static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003732 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003733 mbedtls_svc_key_id_t key,
3734 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003735{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3737 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3738 psa_key_slot_t *slot = NULL;
3739 psa_key_usage_t key_usage = 0;
3740
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003741 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003742 if( status != PSA_SUCCESS )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003743 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003744
3745 if( operation->id != 0 )
3746 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003747 status = PSA_ERROR_BAD_STATE;
3748 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003749 }
3750
3751 if( operation->nonce_set || operation->lengths_set ||
3752 operation->ad_started || operation->body_started )
3753 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003754 status = PSA_ERROR_BAD_STATE;
3755 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003756 }
3757
Paul Elliottd9343f22021-08-23 18:59:49 +01003758 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003759 key_usage = PSA_KEY_USAGE_ENCRYPT;
3760 else
3761 key_usage = PSA_KEY_USAGE_DECRYPT;
3762
3763 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3764 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003765 if( status != PSA_SUCCESS )
3766 goto exit;
3767
3768 psa_key_attributes_t attributes = {
3769 .core = slot->attr
3770 };
3771
Paul Elliottd9343f22021-08-23 18:59:49 +01003772 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003773 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3774 &attributes,
3775 slot->key.data,
3776 slot->key.bytes,
3777 alg );
3778 else
3779 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3780 &attributes,
3781 slot->key.data,
3782 slot->key.bytes,
3783 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003784 if( status != PSA_SUCCESS )
3785 goto exit;
3786
Andrzej Kurekf8816012021-12-19 17:00:12 +01003787 if( ( status = psa_validate_tag_length( operation, alg ) ) != PSA_SUCCESS )
3788 goto exit;
3789
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003790 operation->key_type = psa_get_key_type( &attributes );
3791
3792exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003793 unlock_status = psa_unlock_key_slot( slot );
3794
3795 if( status == PSA_SUCCESS )
3796 {
3797 status = unlock_status;
3798 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003799 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003800 }
3801 else
3802 psa_aead_abort( operation );
3803
3804 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003805}
3806
Paul Elliott302ff6b2021-04-20 18:10:30 +01003807/* Set the key for a multipart authenticated encryption operation. */
3808psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3809 mbedtls_svc_key_id_t key,
3810 psa_algorithm_t alg )
3811{
Paul Elliottd9343f22021-08-23 18:59:49 +01003812 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003813}
3814
3815/* Set the key for a multipart authenticated decryption operation. */
3816psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3817 mbedtls_svc_key_id_t key,
3818 psa_algorithm_t alg )
3819{
Paul Elliottd9343f22021-08-23 18:59:49 +01003820 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003821}
3822
3823/* Generate a random nonce / IV for multipart AEAD operation */
3824psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3825 uint8_t *nonce,
3826 size_t nonce_size,
3827 size_t *nonce_length )
3828{
3829 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01003830 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01003831 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003832
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003833 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003834
Paul Elliottcee785c2021-05-20 14:29:20 +01003835 if( operation->id == 0 )
3836 {
3837 status = PSA_ERROR_BAD_STATE;
3838 goto exit;
3839 }
3840
Paul Elliottdaf5c892021-08-25 16:24:58 +01003841 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003842 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003843 status = PSA_ERROR_BAD_STATE;
3844 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003845 }
3846
Paul Elliotte193ea82021-10-01 13:00:16 +01003847 /* For CCM, this size may not be correct according to the PSA
3848 * specification. The PSA Crypto 1.0.1 specification states:
3849 *
3850 * CCM encodes the plaintext length pLen in L octets, with L the smallest
3851 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
3852 *
3853 * However this restriction that L has to be the smallest integer is not
3854 * applied in practice, and it is not implementable here since the
3855 * plaintext length may or may not be known at this time. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003856 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003857 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003858 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003859 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003860 status = PSA_ERROR_BUFFER_TOO_SMALL;
3861 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003862 }
3863
Ronald Croncae59092021-11-26 18:53:58 +01003864 status = psa_generate_random( local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003865 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003866 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003867
Ronald Croncae59092021-11-26 18:53:58 +01003868 status = psa_aead_set_nonce( operation, local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003869
Paul Elliott39dc6b82021-05-11 19:16:09 +01003870exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003871 if( status == PSA_SUCCESS )
Ronald Croncae59092021-11-26 18:53:58 +01003872 {
3873 memcpy( nonce, local_nonce, required_nonce_size );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003874 *nonce_length = required_nonce_size;
Ronald Croncae59092021-11-26 18:53:58 +01003875 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003876 else
3877 psa_aead_abort( operation );
3878
3879 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003880}
3881
3882/* Set the nonce for a multipart authenticated encryption or decryption
3883 operation.*/
3884psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3885 const uint8_t *nonce,
3886 size_t nonce_length )
3887{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003888 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3889
Paul Elliottcee785c2021-05-20 14:29:20 +01003890 if( operation->id == 0 )
3891 {
3892 status = PSA_ERROR_BAD_STATE;
3893 goto exit;
3894 }
3895
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003896 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003897 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003898 status = PSA_ERROR_BAD_STATE;
3899 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003900 }
3901
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003902 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003903 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003904 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003905 status = PSA_ERROR_INVALID_ARGUMENT;
3906 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003907 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003908
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003909 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3910 nonce_length );
3911
Paul Elliott39dc6b82021-05-11 19:16:09 +01003912exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003913 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003914 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003915 else
3916 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003917
3918 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003919}
3920
3921/* Declare the lengths of the message and additional data for multipart AEAD. */
3922psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3923 size_t ad_length,
3924 size_t plaintext_length )
3925{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3927
Paul Elliottcee785c2021-05-20 14:29:20 +01003928 if( operation->id == 0 )
3929 {
3930 status = PSA_ERROR_BAD_STATE;
3931 goto exit;
3932 }
3933
Paul Elliott6eb95982021-05-21 17:41:41 +01003934 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003935 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003936 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003937 status = PSA_ERROR_BAD_STATE;
3938 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003939 }
3940
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003941 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003942 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003943#if defined(PSA_WANT_ALG_GCM)
3944 case PSA_ALG_GCM:
3945 /* Lengths can only be too large for GCM if size_t is bigger than 32
3946 * bits. Without the guard this code will generate warnings on 32bit
3947 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003948#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003949 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3950 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3951 {
3952 status = PSA_ERROR_INVALID_ARGUMENT;
3953 goto exit;
3954 }
Paul Elliott325d3742021-09-27 17:56:28 +01003955#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003956 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003957#endif /* PSA_WANT_ALG_GCM */
3958#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003959 case PSA_ALG_CCM:
3960 if( ad_length > 0xFF00 )
3961 {
3962 status = PSA_ERROR_INVALID_ARGUMENT;
3963 goto exit;
3964 }
3965 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003966#endif /* PSA_WANT_ALG_CCM */
3967#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003968 case PSA_ALG_CHACHA20_POLY1305:
3969 /* No length restrictions for ChaChaPoly. */
3970 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003971#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003972 default:
3973 break;
3974 }
Paul Elliott325d3742021-09-27 17:56:28 +01003975
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003976 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3977 plaintext_length );
3978
Paul Elliott39dc6b82021-05-11 19:16:09 +01003979exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003980 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003981 {
3982 operation->ad_remaining = ad_length;
3983 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003984 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01003985 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003986 else
3987 psa_aead_abort( operation );
3988
3989 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003990}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003991
3992/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01003993psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
3994 const uint8_t *input,
3995 size_t input_length )
3996{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003997 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3998
Paul Elliottcee785c2021-05-20 14:29:20 +01003999 if( operation->id == 0 )
4000 {
4001 status = PSA_ERROR_BAD_STATE;
4002 goto exit;
4003 }
4004
Paul Elliott6eb95982021-05-21 17:41:41 +01004005 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004006 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004007 status = PSA_ERROR_BAD_STATE;
4008 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004009 }
4010
Paul Elliottee4ffe02021-05-20 17:25:06 +01004011 if( operation->lengths_set )
4012 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004013 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004014 {
4015 status = PSA_ERROR_INVALID_ARGUMENT;
4016 goto exit;
4017 }
4018
4019 operation->ad_remaining -= input_length;
4020 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004021#if defined(PSA_WANT_ALG_CCM)
4022 else if( operation->alg == PSA_ALG_CCM )
4023 {
4024 status = PSA_ERROR_BAD_STATE;
4025 goto exit;
4026 }
4027#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004028
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004029 status = psa_driver_wrapper_aead_update_ad( operation, input,
4030 input_length );
4031
Paul Elliott39dc6b82021-05-11 19:16:09 +01004032exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004033 if( status == PSA_SUCCESS )
4034 operation->ad_started = 1;
4035 else
4036 psa_aead_abort( operation );
4037
4038 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004039}
4040
4041/* Encrypt or decrypt a message fragment in an active multipart AEAD
4042 operation.*/
4043psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4044 const uint8_t *input,
4045 size_t input_length,
4046 uint8_t *output,
4047 size_t output_size,
4048 size_t *output_length )
4049{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004051
4052 *output_length = 0;
4053
Paul Elliottcee785c2021-05-20 14:29:20 +01004054 if( operation->id == 0 )
4055 {
4056 status = PSA_ERROR_BAD_STATE;
4057 goto exit;
4058 }
4059
Paul Elliott6eb95982021-05-21 17:41:41 +01004060 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004061 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004062 status = PSA_ERROR_BAD_STATE;
4063 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004064 }
4065
Paul Elliottee4ffe02021-05-20 17:25:06 +01004066 if( operation->lengths_set )
4067 {
4068 /* Additional data length was supplied, but not all the additional
4069 data was supplied.*/
4070 if( operation->ad_remaining != 0 )
4071 {
4072 status = PSA_ERROR_INVALID_ARGUMENT;
4073 goto exit;
4074 }
4075
4076 /* Too much data provided. */
4077 if( operation->body_remaining < input_length )
4078 {
4079 status = PSA_ERROR_INVALID_ARGUMENT;
4080 goto exit;
4081 }
4082
4083 operation->body_remaining -= input_length;
4084 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004085#if defined(PSA_WANT_ALG_CCM)
4086 else if( operation->alg == PSA_ALG_CCM )
4087 {
4088 status = PSA_ERROR_BAD_STATE;
4089 goto exit;
4090 }
4091#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004092
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004093 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4094 output, output_size,
4095 output_length );
4096
Paul Elliott39dc6b82021-05-11 19:16:09 +01004097exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004098 if( status == PSA_SUCCESS )
4099 operation->body_started = 1;
4100 else
4101 psa_aead_abort( operation );
4102
4103 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004104}
4105
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004106static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004107{
Paul Elliott7f429b72021-06-24 18:08:54 +01004108 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004109 return( PSA_ERROR_BAD_STATE );
4110
Paul Elliotta5614442021-07-14 14:54:11 +01004111 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004112 operation->body_remaining != 0 ) )
4113 return( PSA_ERROR_INVALID_ARGUMENT );
4114
4115 return( PSA_SUCCESS );
4116}
4117
Paul Elliott302ff6b2021-04-20 18:10:30 +01004118/* Finish encrypting a message in a multipart AEAD operation. */
4119psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4120 uint8_t *ciphertext,
4121 size_t ciphertext_size,
4122 size_t *ciphertext_length,
4123 uint8_t *tag,
4124 size_t tag_size,
4125 size_t *tag_length )
4126{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4128
Paul Elliott302ff6b2021-04-20 18:10:30 +01004129 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004130 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004131
Paul Elliott814fffb2021-08-16 18:20:36 +01004132 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004133 if( status != PSA_SUCCESS )
4134 goto exit;
4135
Paul Elliott7f429b72021-06-24 18:08:54 +01004136 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004137 {
4138 status = PSA_ERROR_BAD_STATE;
4139 goto exit;
4140 }
4141
Paul Elliott39dc6b82021-05-11 19:16:09 +01004142 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4143 ciphertext_size,
4144 ciphertext_length,
4145 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004146
Paul Elliott39dc6b82021-05-11 19:16:09 +01004147exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004148 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004149 * the zero tag size, make sure the tag is set to something implausible.
4150 * Even if the operation succeeds, make sure we clear the rest of the
4151 * buffer to prevent potential leakage of anything previously placed in
4152 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004153 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004154 {
4155 if( status != PSA_SUCCESS )
4156 memset( tag, '!', tag_size );
4157 else if( *tag_length < tag_size )
4158 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4159 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004160
Paul Elliott39dc6b82021-05-11 19:16:09 +01004161 psa_aead_abort( operation );
4162
4163 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004164}
4165
4166/* Finish authenticating and decrypting a message in a multipart AEAD
4167 operation.*/
4168psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4169 uint8_t *plaintext,
4170 size_t plaintext_size,
4171 size_t *plaintext_length,
4172 const uint8_t *tag,
4173 size_t tag_length )
4174{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4176
Paul Elliott302ff6b2021-04-20 18:10:30 +01004177 *plaintext_length = 0;
4178
Paul Elliott814fffb2021-08-16 18:20:36 +01004179 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004180 if( status != PSA_SUCCESS )
4181 goto exit;
4182
Paul Elliott7f429b72021-06-24 18:08:54 +01004183 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004184 {
4185 status = PSA_ERROR_BAD_STATE;
4186 goto exit;
4187 }
4188
Paul Elliott39dc6b82021-05-11 19:16:09 +01004189 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4190 plaintext_size,
4191 plaintext_length,
4192 tag, tag_length );
4193
4194exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004195 psa_aead_abort( operation );
4196
4197 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004198}
4199
4200/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004201psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004202{
4203 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4204
4205 if( operation->id == 0 )
4206 {
4207 /* The object has (apparently) been initialized but it is not (yet)
4208 * in use. It's ok to call abort on such an object, and there's
4209 * nothing to do. */
4210 return( PSA_SUCCESS );
4211 }
4212
4213 status = psa_driver_wrapper_aead_abort( operation );
4214
Paul Elliott70618b22021-09-22 17:12:16 +01004215 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004216
4217 return( status );
4218}
4219
Gilles Peskinee59236f2018-01-27 23:32:46 +01004220/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004221/* Generators */
4222/****************************************************************/
4223
John Durkop07cc04a2020-11-16 22:08:34 -08004224#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4225 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4226 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4227#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004228#endif /* At least one builtin KDF */
4229
4230#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4231 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4232 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4233static psa_status_t psa_key_derivation_start_hmac(
4234 psa_mac_operation_t *operation,
4235 psa_algorithm_t hash_alg,
4236 const uint8_t *hmac_key,
4237 size_t hmac_key_length )
4238{
4239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4240 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4241 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4242 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4243 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4244
Steven Cooreman72f736a2021-05-07 14:14:37 +02004245 operation->is_sign = 1;
4246 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4247
Steven Cooreman094a77e2021-05-06 17:58:36 +02004248 status = psa_driver_wrapper_mac_sign_setup( operation,
4249 &attributes,
4250 hmac_key, hmac_key_length,
4251 PSA_ALG_HMAC( hash_alg ) );
4252
4253 psa_reset_key_attributes( &attributes );
4254 return( status );
4255}
4256#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004257
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004258#define HKDF_STATE_INIT 0 /* no input yet */
4259#define HKDF_STATE_STARTED 1 /* got salt */
4260#define HKDF_STATE_KEYED 2 /* got key */
4261#define HKDF_STATE_OUTPUT 3 /* output started */
4262
Gilles Peskinecbe66502019-05-16 16:59:18 +02004263static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004264 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004265{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004266 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4267 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004268 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004269 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004270}
4271
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004272psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004273{
4274 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004275 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004276 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004277 {
4278 /* The object has (apparently) been initialized but it is not
4279 * in use. It's ok to call abort on such an object, and there's
4280 * nothing to do. */
4281 }
4282 else
John Durkopd0321952020-10-29 21:37:36 -07004283#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004285 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004286 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004287 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004288 }
John Durkop07cc04a2020-11-16 22:08:34 -08004289 else
4290#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4291#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4292 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4293 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004294 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004295 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004296 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004297 if( operation->ctx.tls12_prf.secret != NULL )
4298 {
4299 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4300 operation->ctx.tls12_prf.secret_length );
4301 mbedtls_free( operation->ctx.tls12_prf.secret );
4302 }
4303
Janos Follath6a1d2622019-06-11 10:37:28 +01004304 if( operation->ctx.tls12_prf.seed != NULL )
4305 {
4306 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4307 operation->ctx.tls12_prf.seed_length );
4308 mbedtls_free( operation->ctx.tls12_prf.seed );
4309 }
4310
4311 if( operation->ctx.tls12_prf.label != NULL )
4312 {
4313 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4314 operation->ctx.tls12_prf.label_length );
4315 mbedtls_free( operation->ctx.tls12_prf.label );
4316 }
4317
Steven Cooremana6df6042021-04-29 19:32:25 +02004318 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004319
4320 /* We leave the fields Ai and output_block to be erased safely by the
4321 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004322 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004323 else
John Durkop07cc04a2020-11-16 22:08:34 -08004324#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4325 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004326 {
4327 status = PSA_ERROR_BAD_STATE;
4328 }
Janos Follath083036a2019-06-11 10:22:26 +01004329 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004330 return( status );
4331}
4332
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004333psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004334 size_t *capacity)
4335{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004336 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004337 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004338 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004339 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004340 }
4341
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004342 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004343 return( PSA_SUCCESS );
4344}
4345
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004346psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004347 size_t capacity )
4348{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004349 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004350 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004351 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004352 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004353 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004354 return( PSA_SUCCESS );
4355}
4356
John Durkopd0321952020-10-29 21:37:36 -07004357#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004358/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004359 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004360static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004361 psa_algorithm_t hash_alg,
4362 uint8_t *output,
4363 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004364{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004365 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004366 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004367 psa_status_t status;
4368
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004369 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4370 return( PSA_ERROR_BAD_STATE );
4371 hkdf->state = HKDF_STATE_OUTPUT;
4372
Gilles Peskinebef7f142018-07-12 17:22:21 +02004373 while( output_length != 0 )
4374 {
4375 /* Copy what remains of the current block */
4376 uint8_t n = hash_length - hkdf->offset_in_block;
4377 if( n > output_length )
4378 n = (uint8_t) output_length;
4379 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4380 output += n;
4381 output_length -= n;
4382 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004383 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004384 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004385 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004386 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004387 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004388 * object was corrupted or if this function is called directly
4389 * inside the library. */
4390 if( hkdf->block_number == 0xff )
4391 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004392
4393 /* We need a new block */
4394 ++hkdf->block_number;
4395 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004396
Steven Cooreman094a77e2021-05-06 17:58:36 +02004397 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4398 hash_alg,
4399 hkdf->prk,
4400 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004401 if( status != PSA_SUCCESS )
4402 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004403
Gilles Peskinebef7f142018-07-12 17:22:21 +02004404 if( hkdf->block_number != 1 )
4405 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004406 status = psa_mac_update( &hkdf->hmac,
4407 hkdf->output_block,
4408 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004409 if( status != PSA_SUCCESS )
4410 return( status );
4411 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004412 status = psa_mac_update( &hkdf->hmac,
4413 hkdf->info,
4414 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004415 if( status != PSA_SUCCESS )
4416 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004417 status = psa_mac_update( &hkdf->hmac,
4418 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004419 if( status != PSA_SUCCESS )
4420 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004421 status = psa_mac_sign_finish( &hkdf->hmac,
4422 hkdf->output_block,
4423 sizeof( hkdf->output_block ),
4424 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004425 if( status != PSA_SUCCESS )
4426 return( status );
4427 }
4428
4429 return( PSA_SUCCESS );
4430}
John Durkop07cc04a2020-11-16 22:08:34 -08004431#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004432
John Durkop07cc04a2020-11-16 22:08:34 -08004433#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4434 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004435static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4436 psa_tls12_prf_key_derivation_t *tls12_prf,
4437 psa_algorithm_t alg )
4438{
4439 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004440 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004441 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4442 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004443 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004444
Janos Follath7742fee2019-06-17 12:58:10 +01004445 /* We can't be wanting more output after block 0xff, otherwise
4446 * the capacity check in psa_key_derivation_output_bytes() would have
4447 * prevented this call. It could happen only if the operation
4448 * object was corrupted or if this function is called directly
4449 * inside the library. */
4450 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004451 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004452
4453 /* We need a new block */
4454 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004455 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004456
4457 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4458 *
4459 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4460 *
4461 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4462 * HMAC_hash(secret, A(2) + seed) +
4463 * HMAC_hash(secret, A(3) + seed) + ...
4464 *
4465 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004466 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004467 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004468 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004469 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004470 * is currently extracted as `output_block` and where i is
4471 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004472 */
4473
Steven Cooreman094a77e2021-05-06 17:58:36 +02004474 status = psa_key_derivation_start_hmac( &hmac,
4475 hash_alg,
4476 tls12_prf->secret,
4477 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004478 if( status != PSA_SUCCESS )
4479 goto cleanup;
4480
4481 /* Calculate A(i) where i = tls12_prf->block_number. */
4482 if( tls12_prf->block_number == 1 )
4483 {
4484 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4485 * the variable seed and in this instance means it in the context of the
4486 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004487 status = psa_mac_update( &hmac,
4488 tls12_prf->label,
4489 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004490 if( status != PSA_SUCCESS )
4491 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004492 status = psa_mac_update( &hmac,
4493 tls12_prf->seed,
4494 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004495 if( status != PSA_SUCCESS )
4496 goto cleanup;
4497 }
4498 else
4499 {
4500 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004501 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004502 if( status != PSA_SUCCESS )
4503 goto cleanup;
4504 }
4505
Steven Cooremana6df6042021-04-29 19:32:25 +02004506 status = psa_mac_sign_finish( &hmac,
4507 tls12_prf->Ai, hash_length,
4508 &hmac_output_length );
4509 if( hmac_output_length != hash_length )
4510 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004511 if( status != PSA_SUCCESS )
4512 goto cleanup;
4513
4514 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004515 status = psa_key_derivation_start_hmac( &hmac,
4516 hash_alg,
4517 tls12_prf->secret,
4518 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004519 if( status != PSA_SUCCESS )
4520 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004521 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004522 if( status != PSA_SUCCESS )
4523 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004524 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004525 if( status != PSA_SUCCESS )
4526 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004527 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004528 if( status != PSA_SUCCESS )
4529 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004530 status = psa_mac_sign_finish( &hmac,
4531 tls12_prf->output_block, hash_length,
4532 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004533 if( status != PSA_SUCCESS )
4534 goto cleanup;
4535
Janos Follath7742fee2019-06-17 12:58:10 +01004536
4537cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004538 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004539 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4540 status = cleanup_status;
4541
4542 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004543}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004544
Janos Follath844eb0e2019-06-19 12:10:49 +01004545static psa_status_t psa_key_derivation_tls12_prf_read(
4546 psa_tls12_prf_key_derivation_t *tls12_prf,
4547 psa_algorithm_t alg,
4548 uint8_t *output,
4549 size_t output_length )
4550{
4551 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004552 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004553 psa_status_t status;
4554 uint8_t offset, length;
4555
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004556 switch( tls12_prf->state )
4557 {
4558 case PSA_TLS12_PRF_STATE_LABEL_SET:
4559 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4560 break;
4561 case PSA_TLS12_PRF_STATE_OUTPUT:
4562 break;
4563 default:
4564 return( PSA_ERROR_BAD_STATE );
4565 }
4566
Janos Follath844eb0e2019-06-19 12:10:49 +01004567 while( output_length != 0 )
4568 {
4569 /* Check if we have fully processed the current block. */
4570 if( tls12_prf->left_in_block == 0 )
4571 {
4572 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4573 alg );
4574 if( status != PSA_SUCCESS )
4575 return( status );
4576
4577 continue;
4578 }
4579
4580 if( tls12_prf->left_in_block > output_length )
4581 length = (uint8_t) output_length;
4582 else
4583 length = tls12_prf->left_in_block;
4584
4585 offset = hash_length - tls12_prf->left_in_block;
4586 memcpy( output, tls12_prf->output_block + offset, length );
4587 output += length;
4588 output_length -= length;
4589 tls12_prf->left_in_block -= length;
4590 }
4591
4592 return( PSA_SUCCESS );
4593}
John Durkop07cc04a2020-11-16 22:08:34 -08004594#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4595 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004596
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004597psa_status_t psa_key_derivation_output_bytes(
4598 psa_key_derivation_operation_t *operation,
4599 uint8_t *output,
4600 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004601{
4602 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004603 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004604
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004605 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004606 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004607 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004608 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004609 }
4610
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004611 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004612 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004613 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004614 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004615 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004616 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004617 goto exit;
4618 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004619 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004620 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004621 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004622 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004623 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4624 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004625 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004626 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004627 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004628 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004629 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004630
John Durkopd0321952020-10-29 21:37:36 -07004631#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004632 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004633 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004634 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004635 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004636 output, output_length );
4637 }
Janos Follathadbec812019-06-14 11:05:39 +01004638 else
John Durkop07cc04a2020-11-16 22:08:34 -08004639#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4640#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4641 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004642 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004643 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004644 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004645 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004646 kdf_alg, output,
4647 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004648 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004649 else
John Durkop07cc04a2020-11-16 22:08:34 -08004650#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4651 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004652 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004653 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004654 return( PSA_ERROR_BAD_STATE );
4655 }
4656
4657exit:
4658 if( status != PSA_SUCCESS )
4659 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004660 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004661 * This allows us to differentiate between exhausted operations and
4662 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4663 * operations. */
4664 psa_algorithm_t alg = operation->alg;
4665 psa_key_derivation_abort( operation );
4666 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004667 memset( output, '!', output_length );
4668 }
4669 return( status );
4670}
4671
David Brown7807bf72021-02-09 16:28:23 -07004672#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004673static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4674{
4675 if( data_size >= 8 )
4676 mbedtls_des_key_set_parity( data );
4677 if( data_size >= 16 )
4678 mbedtls_des_key_set_parity( data + 8 );
4679 if( data_size >= 24 )
4680 mbedtls_des_key_set_parity( data + 16 );
4681}
David Brown7807bf72021-02-09 16:28:23 -07004682#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004683
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004684/*
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +01004685* ECC keys on a Weierstrass elliptic curve require the generation
4686* of a private key which is an integer
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004687* in the range [1, N - 1], where N is the boundary of the private key domain:
4688* N is the prime p for Diffie-Hellman, or the order of the
4689* curve’s base point for ECC.
4690*
4691* Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
4692* This function generates the private key using the following process:
4693*
4694* 1. Draw a byte string of length ceiling(m/8) bytes.
4695* 2. If m is not a multiple of 8, set the most significant
4696* (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
4697* 3. Convert the string to integer k by decoding it as a big-endian byte string.
4698* 4. If k > N - 2, discard the result and return to step 1.
4699* 5. Output k + 1 as the private key.
4700*
4701* This method allows compliance to NIST standards, specifically the methods titled
4702* Key-Pair Generation by Testing Candidates in the following publications:
4703* - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
4704* Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
4705* Diffie-Hellman keys.
4706*
4707* - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
4708* Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004709*
4710* Note: Function allocates memory for *data buffer, so given *data should be
4711* always NULL.
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004712*/
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004713#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4714 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4715 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4716 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4717 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004718static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004719 psa_key_slot_t *slot,
4720 size_t bits,
4721 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004722 uint8_t **data
4723 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004724{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004725 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004726 mbedtls_mpi k;
4727 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004729 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004730
4731 mbedtls_mpi_init( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004732 mbedtls_mpi_init( &diff_N_2 );
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004733
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004734 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
4735 slot->attr.type );
4736 mbedtls_ecp_group_id grp_id =
4737 mbedtls_ecc_group_of_psa( curve, bits, 0 );
4738
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004739 if( grp_id == MBEDTLS_ECP_DP_NONE )
4740 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004741 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004742 goto cleanup;
4743 }
4744
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004745 mbedtls_ecp_group ecp_group;
Przemyslaw Stekiel65348162021-11-18 11:57:07 +01004746 mbedtls_ecp_group_init( &ecp_group );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004747
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004748 MBEDTLS_MPI_CHK( mbedtls_ecp_group_load( &ecp_group, grp_id ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004749
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004750 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004751 /* Let m be the bit size of N. */
4752 size_t m = ecp_group.nbits;
4753
4754 size_t m_bytes = PSA_BITS_TO_BYTES( m );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004755
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004756 /* Calculate N - 2 - it will be needed later. */
4757 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &diff_N_2, &ecp_group.N, 2 ) );
4758
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004759 /* Note: This function is always called with *data == NULL and it
4760 * allocates memory for the data buffer. */
4761 *data = mbedtls_calloc( 1, m_bytes );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004762 if( *data == NULL )
4763 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004764 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004765 goto cleanup;
4766 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004767
Przemek Stekielc85f0912022-03-08 11:37:54 +01004768 while( key_out_of_range )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004769 {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004770 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004771 if( ( status = psa_key_derivation_output_bytes( operation, *data, m_bytes ) ) != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004772 goto cleanup;
4773
4774 /* 2. If m is not a multiple of 8 */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004775 if( m % 8 != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004776 {
4777 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004778 * (8 * ceiling(m/8) - m) bits of the first byte in
4779 * the string to zero.
4780 */
4781 uint8_t clear_bit_mask = ( 1 << ( m % 8 ) ) - 1;
4782 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004783 }
4784
4785 /* 3. Convert the string to integer k by decoding it as a
4786 * big-endian byte string.
4787 */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004788 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &k, *data, m_bytes ) );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004789
4790 /* 4. If k > N - 2, discard the result and return to step 1.
4791 * Result of comparison is returned. When it indicates error
4792 * then this fuction is called again.
4793 */
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004794 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( &diff_N_2, &k, &key_out_of_range ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004795 }
4796
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004797 /* 5. Output k + 1 as the private key. */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004798 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &k, &k, 1 ) );
4799 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &k, *data, m_bytes ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004800cleanup:
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004801 if( ret != 0 )
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004802 status = mbedtls_to_psa_error( ret );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004803 if( status != PSA_SUCCESS ) {
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004804 mbedtls_free( *data );
4805 *data = NULL;
4806 }
4807 mbedtls_mpi_free( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004808 mbedtls_mpi_free( &diff_N_2 );
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004809 return( status );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004810}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004811
4812/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
4813 * is determined by the curve, and sets the mandatory bits accordingly. That is:
4814 *
4815 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
4816 * draw a 32-byte string and process it as specified in
4817 * Elliptic Curves for Security [RFC7748] §5.
4818 *
4819 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
4820 * draw a 56-byte string and process it as specified in [RFC7748] §5.
4821 *
4822 * Note: Function allocates memory for *data buffer, so given *data should be
4823 * always NULL.
4824 */
4825
4826static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
4827 size_t bits,
4828 psa_key_derivation_operation_t *operation,
4829 uint8_t **data
4830 )
4831{
4832 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004833 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004834
4835 switch( bits )
4836 {
4837 case 255:
4838 output_length = 32;
4839 break;
4840 case 448:
4841 output_length = 56;
4842 break;
4843 default:
4844 return( PSA_ERROR_INVALID_ARGUMENT );
4845 break;
4846 }
4847
4848 *data = mbedtls_calloc( 1, output_length );
4849
4850 if( *data == NULL )
4851 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4852
4853 status = psa_key_derivation_output_bytes( operation, *data, output_length );
4854
4855 if( status != PSA_SUCCESS )
4856 return status;
4857
4858 switch( bits )
4859 {
4860 case 255:
4861 (*data)[0] &= 248;
4862 (*data)[31] &= 127;
4863 (*data)[31] |= 64;
4864 break;
4865 case 448:
4866 (*data)[0] &= 252;
4867 (*data)[55] |= 128;
4868 break;
4869 default:
Przemek Stekiela81aed22022-03-01 15:13:30 +01004870 return( PSA_ERROR_CORRUPTION_DETECTED );
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004871 break;
4872 }
4873
4874 return status;
4875}
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004876#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4877 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4878 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4879 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4880 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004881
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004882static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004883 psa_key_slot_t *slot,
4884 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004885 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004886{
4887 uint8_t *data = NULL;
4888 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304889 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004891
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004892 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004893 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004894
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004895#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4896 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4897 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4898 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4899 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemek Stekielc85f0912022-03-08 11:37:54 +01004900 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004901 {
Przemyslaw Stekiel92481592022-01-04 10:09:46 +01004902 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004903 if( PSA_ECC_FAMILY_IS_WEIERSTRASS( curve ) )
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004904 {
4905 /* Weierstrass elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004906 status = psa_generate_derived_ecc_key_weierstrass_helper( slot, bits, operation, &data );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004907 if( status != PSA_SUCCESS )
4908 goto exit;
Przemyslaw Stekiel50fcc532021-11-26 10:54:52 +01004909 }
4910 else
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004911 {
4912 /* Montgomery elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004913 status = psa_generate_derived_ecc_key_montgomery_helper( bits, operation, &data );
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004914 if( status != PSA_SUCCESS )
4915 goto exit;
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004916 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004917 } else
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004918#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4919 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4920 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4921 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4922 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004923 if( key_type_is_raw_bytes( slot->attr.type ) )
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004924 {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004925 if( bits % 8 != 0 )
4926 return( PSA_ERROR_INVALID_ARGUMENT );
4927 data = mbedtls_calloc( 1, bytes );
4928 if( data == NULL )
4929 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4930
4931 status = psa_key_derivation_output_bytes( operation, data, bytes );
4932 if( status != PSA_SUCCESS )
4933 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004934#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004935 if( slot->attr.type == PSA_KEY_TYPE_DES )
4936 psa_des_set_key_parity( data, bytes );
Przemek Stekielf110dc02022-03-01 14:48:05 +01004937#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004938 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004939 else
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004940 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Crondd04d422020-11-28 15:14:42 +01004941
Ronald Cronbf33c932020-11-28 18:06:53 +01004942 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004943 psa_key_attributes_t attributes = {
4944 .core = slot->attr
4945 };
4946
Archanad8a83dc2021-06-14 10:04:16 +05304947 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4948 {
Archana449608b2021-09-08 15:36:05 +05304949 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4950 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304951 if( status != PSA_SUCCESS )
4952 goto exit;
4953 }
4954 status = psa_allocate_buffer_to_slot( slot, storage_size );
4955 if( status != PSA_SUCCESS )
4956 goto exit;
4957
Ronald Cronbf33c932020-11-28 18:06:53 +01004958 status = psa_driver_wrapper_import_key( &attributes,
4959 data, bytes,
4960 slot->key.data,
4961 slot->key.bytes,
4962 &slot->key.bytes, &bits );
4963 if( bits != slot->attr.bits )
4964 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004965
4966exit:
4967 mbedtls_free( data );
4968 return( status );
4969}
4970
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004971psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004972 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004973 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004974{
4975 psa_status_t status;
4976 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004977 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004978
Ronald Cron81709fc2020-11-14 12:10:32 +01004979 *key = MBEDTLS_SVC_KEY_ID_INIT;
4980
Gilles Peskine0f84d622019-09-12 19:03:13 +02004981 /* Reject any attempt to create a zero-length key so that we don't
4982 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4983 if( psa_get_key_bits( attributes ) == 0 )
4984 return( PSA_ERROR_INVALID_ARGUMENT );
4985
Dave Rodgmand69da6c2021-11-16 10:32:48 +00004986 if( operation->alg == PSA_ALG_NONE )
4987 return( PSA_ERROR_BAD_STATE );
4988
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004989 if( ! operation->can_output_key )
4990 return( PSA_ERROR_NOT_PERMITTED );
4991
Ronald Cron81709fc2020-11-14 12:10:32 +01004992 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4993 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004994#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4995 if( driver != NULL )
4996 {
4997 /* Deriving a key in a secure element is not implemented yet. */
4998 status = PSA_ERROR_NOT_SUPPORTED;
4999 }
5000#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005001 if( status == PSA_SUCCESS )
5002 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005003 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005004 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005005 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005006 }
5007 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005008 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005009 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005010 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005011
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005012 return( status );
5013}
5014
Gilles Peskineeab56e42018-07-12 17:12:33 +02005015
5016
5017/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005018/* Key derivation */
5019/****************************************************************/
5020
Steven Cooreman932ffb72021-02-15 12:14:32 +01005021#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005022static int is_kdf_alg_supported( psa_algorithm_t kdf_alg )
5023{
5024#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
5025 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5026 return( 1 );
5027#endif
5028#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5029 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5030 return( 1 );
5031#endif
5032#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5033 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5034 return( 1 );
5035#endif
5036 return( 0 );
5037}
5038
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005039static psa_status_t psa_hash_try_support( psa_algorithm_t alg )
5040{
5041 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
5042 psa_status_t status = psa_hash_setup( &operation, alg );
5043 psa_hash_abort( &operation );
5044 return( status );
5045}
5046
Gilles Peskine969c5d62019-01-16 15:53:06 +01005047static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005048 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005049 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005050{
Janos Follath5fe19732019-06-20 15:09:30 +01005051 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5052 * initialisers for this union leave some bytes unspecified.) */
5053 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5054
Gilles Peskine969c5d62019-01-16 15:53:06 +01005055 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005056 if( ! is_kdf_alg_supported( kdf_alg ) )
5057 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop07cc04a2020-11-16 22:08:34 -08005058
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005059 /* All currently supported key derivation algorithms are based on a
5060 * hash algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005061 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
5062 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
5063 if( hash_size == 0 )
5064 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005065
5066 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
5067 * we might fail later, which is somewhat unfriendly and potentially
5068 * risk-prone. */
5069 psa_status_t status = psa_hash_try_support( hash_alg );
5070 if( status != PSA_SUCCESS )
5071 return( status );
5072
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005073 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5074 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
5075 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005076 {
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005077 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005078 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005079
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005080 operation->capacity = 255 * hash_size;
5081 return( PSA_SUCCESS );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005082}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005083
5084static psa_status_t psa_key_agreement_try_support( psa_algorithm_t alg )
5085{
5086#if defined(PSA_WANT_ALG_ECDH)
5087 if( alg == PSA_ALG_ECDH )
5088 return( PSA_SUCCESS );
5089#endif
5090 (void) alg;
5091 return( PSA_ERROR_NOT_SUPPORTED );
5092}
John Durkop07cc04a2020-11-16 22:08:34 -08005093#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005094
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005095psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005096 psa_algorithm_t alg )
5097{
5098 psa_status_t status;
5099
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005100 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005101 return( PSA_ERROR_BAD_STATE );
5102
Gilles Peskine6843c292019-01-18 16:44:49 +01005103 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5104 return( PSA_ERROR_INVALID_ARGUMENT );
5105 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005106 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005107#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005108 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005109 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( alg );
5110 status = psa_key_agreement_try_support( ka_alg );
5111 if( status != PSA_SUCCESS )
5112 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005114#else
5115 return( PSA_ERROR_NOT_SUPPORTED );
5116#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005117 }
5118 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5119 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005120#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005121 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005122#else
5123 return( PSA_ERROR_NOT_SUPPORTED );
5124#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005125 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005126 else
5127 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005128
5129 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005130 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005131 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005132}
5133
John Durkopd0321952020-10-29 21:37:36 -07005134#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005135static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005136 psa_algorithm_t hash_alg,
5137 psa_key_derivation_step_t step,
5138 const uint8_t *data,
5139 size_t data_length )
5140{
5141 psa_status_t status;
5142 switch( step )
5143 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005144 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005145 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005146 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005147 else
5148 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005149 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5150 hash_alg,
5151 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005152 if( status != PSA_SUCCESS )
5153 return( status );
5154 hkdf->state = HKDF_STATE_STARTED;
5155 return( PSA_SUCCESS );
5156 }
Gilles Peskine03410b52019-05-16 16:05:19 +02005157 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005158 /* If no salt was provided, use an empty salt. */
5159 if( hkdf->state == HKDF_STATE_INIT )
5160 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005161 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5162 hash_alg,
5163 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005164 if( status != PSA_SUCCESS )
5165 return( status );
5166 hkdf->state = HKDF_STATE_STARTED;
5167 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005168 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005169 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005170 status = psa_mac_update( &hkdf->hmac,
5171 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005172 if( status != PSA_SUCCESS )
5173 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005174 status = psa_mac_sign_finish( &hkdf->hmac,
5175 hkdf->prk,
5176 sizeof( hkdf->prk ),
5177 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005178 if( status != PSA_SUCCESS )
5179 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005180 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005181 hkdf->block_number = 0;
5182 hkdf->state = HKDF_STATE_KEYED;
5183 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005184 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005185 if( hkdf->state == HKDF_STATE_OUTPUT )
5186 return( PSA_ERROR_BAD_STATE );
5187 if( hkdf->info_set )
5188 return( PSA_ERROR_BAD_STATE );
5189 hkdf->info_length = data_length;
5190 if( data_length != 0 )
5191 {
5192 hkdf->info = mbedtls_calloc( 1, data_length );
5193 if( hkdf->info == NULL )
5194 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5195 memcpy( hkdf->info, data, data_length );
5196 }
5197 hkdf->info_set = 1;
5198 return( PSA_SUCCESS );
5199 default:
5200 return( PSA_ERROR_INVALID_ARGUMENT );
5201 }
5202}
John Durkop07cc04a2020-11-16 22:08:34 -08005203#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005204
John Durkop07cc04a2020-11-16 22:08:34 -08005205#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5206 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005207static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5208 const uint8_t *data,
5209 size_t data_length )
5210{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005211 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005212 return( PSA_ERROR_BAD_STATE );
5213
Janos Follathd6dce9f2019-07-04 09:11:38 +01005214 if( data_length != 0 )
5215 {
5216 prf->seed = mbedtls_calloc( 1, data_length );
5217 if( prf->seed == NULL )
5218 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005219
Janos Follathd6dce9f2019-07-04 09:11:38 +01005220 memcpy( prf->seed, data, data_length );
5221 prf->seed_length = data_length;
5222 }
Janos Follathf08e2652019-06-13 09:05:41 +01005223
Gilles Peskine43f958b2020-12-13 14:55:14 +01005224 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005225
5226 return( PSA_SUCCESS );
5227}
5228
Janos Follath81550542019-06-13 14:26:34 +01005229static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01005230 const uint8_t *data,
5231 size_t data_length )
5232{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005233 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01005234 return( PSA_ERROR_BAD_STATE );
5235
Steven Cooremana6df6042021-04-29 19:32:25 +02005236 if( data_length != 0 )
5237 {
5238 prf->secret = mbedtls_calloc( 1, data_length );
5239 if( prf->secret == NULL )
5240 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5241
5242 memcpy( prf->secret, data, data_length );
5243 prf->secret_length = data_length;
5244 }
Janos Follath81550542019-06-13 14:26:34 +01005245
Gilles Peskine43f958b2020-12-13 14:55:14 +01005246 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005247
5248 return( PSA_SUCCESS );
5249}
5250
Janos Follath63028dd2019-06-13 09:15:47 +01005251static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5252 const uint8_t *data,
5253 size_t data_length )
5254{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005255 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005256 return( PSA_ERROR_BAD_STATE );
5257
Janos Follathd6dce9f2019-07-04 09:11:38 +01005258 if( data_length != 0 )
5259 {
5260 prf->label = mbedtls_calloc( 1, data_length );
5261 if( prf->label == NULL )
5262 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005263
Janos Follathd6dce9f2019-07-04 09:11:38 +01005264 memcpy( prf->label, data, data_length );
5265 prf->label_length = data_length;
5266 }
Janos Follath63028dd2019-06-13 09:15:47 +01005267
Gilles Peskine43f958b2020-12-13 14:55:14 +01005268 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005269
5270 return( PSA_SUCCESS );
5271}
5272
Janos Follathb03233e2019-06-11 15:30:30 +01005273static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005274 psa_key_derivation_step_t step,
5275 const uint8_t *data,
5276 size_t data_length )
5277{
Janos Follathb03233e2019-06-11 15:30:30 +01005278 switch( step )
5279 {
Janos Follathf08e2652019-06-13 09:05:41 +01005280 case PSA_KEY_DERIVATION_INPUT_SEED:
5281 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005282 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005283 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005284 case PSA_KEY_DERIVATION_INPUT_LABEL:
5285 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005286 default:
5287 return( PSA_ERROR_INVALID_ARGUMENT );
5288 }
5289}
John Durkop07cc04a2020-11-16 22:08:34 -08005290#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5291 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5292
5293#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5294static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5295 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005296 const uint8_t *data,
5297 size_t data_length )
5298{
5299 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005300 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005301 uint8_t *cur = pms;
5302
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005303 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005304 return( PSA_ERROR_INVALID_ARGUMENT );
5305
5306 /* Quoting RFC 4279, Section 2:
5307 *
5308 * The premaster secret is formed as follows: if the PSK is N octets
5309 * long, concatenate a uint16 with the value N, N zero octets, a second
5310 * uint16 with the value N, and the PSK itself.
5311 */
5312
Joe Subbiani5ecac212021-06-24 13:00:03 +01005313 *cur++ = MBEDTLS_BYTE_1( data_length );
5314 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005315 memset( cur, 0, data_length );
5316 cur += data_length;
5317 *cur++ = pms[0];
5318 *cur++ = pms[1];
5319 memcpy( cur, data, data_length );
5320 cur += data_length;
5321
Steven Cooremana6df6042021-04-29 19:32:25 +02005322 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005323
5324 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5325 return( status );
5326}
Janos Follath6660f0e2019-06-17 08:44:03 +01005327
5328static psa_status_t psa_tls12_prf_psk_to_ms_input(
5329 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005330 psa_key_derivation_step_t step,
5331 const uint8_t *data,
5332 size_t data_length )
5333{
5334 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005335 {
Steven Cooremana6df6042021-04-29 19:32:25 +02005336 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005337 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005338 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005339
Steven Cooremana6df6042021-04-29 19:32:25 +02005340 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01005341}
John Durkop07cc04a2020-11-16 22:08:34 -08005342#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005343
Gilles Peskineb8965192019-09-24 16:21:10 +02005344/** Check whether the given key type is acceptable for the given
5345 * input step of a key derivation.
5346 *
5347 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5348 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5349 * Both secret and non-secret inputs can alternatively have the type
5350 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5351 * that the input was passed as a buffer rather than via a key object.
5352 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005353static int psa_key_derivation_check_input_type(
5354 psa_key_derivation_step_t step,
5355 psa_key_type_t key_type )
5356{
5357 switch( step )
5358 {
5359 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005360 if( key_type == PSA_KEY_TYPE_DERIVE )
5361 return( PSA_SUCCESS );
5362 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005363 return( PSA_SUCCESS );
5364 break;
5365 case PSA_KEY_DERIVATION_INPUT_LABEL:
5366 case PSA_KEY_DERIVATION_INPUT_SALT:
5367 case PSA_KEY_DERIVATION_INPUT_INFO:
5368 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005369 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5370 return( PSA_SUCCESS );
5371 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005372 return( PSA_SUCCESS );
5373 break;
5374 }
5375 return( PSA_ERROR_INVALID_ARGUMENT );
5376}
5377
Janos Follathb80a94e2019-06-12 15:54:46 +01005378static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005379 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005380 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005381 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005382 const uint8_t *data,
5383 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005384{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005385 psa_status_t status;
5386 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5387
5388 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005389 if( status != PSA_SUCCESS )
5390 goto exit;
5391
John Durkopd0321952020-10-29 21:37:36 -07005392#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005393 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005394 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005395 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005396 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005397 step, data, data_length );
5398 }
John Durkop07cc04a2020-11-16 22:08:34 -08005399 else
5400#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5401#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5402 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005403 {
Janos Follathb03233e2019-06-11 15:30:30 +01005404 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005405 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005406 }
John Durkop07cc04a2020-11-16 22:08:34 -08005407 else
5408#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5409#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5410 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005411 {
5412 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005413 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005414 }
5415 else
John Durkop07cc04a2020-11-16 22:08:34 -08005416#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005417 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005418 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005419 (void) data;
5420 (void) data_length;
5421 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005422 return( PSA_ERROR_BAD_STATE );
5423 }
5424
Gilles Peskine224b0d62019-09-23 18:13:17 +02005425exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005426 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005427 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005428 return( status );
5429}
5430
Janos Follath51f4a0f2019-06-14 11:35:55 +01005431psa_status_t psa_key_derivation_input_bytes(
5432 psa_key_derivation_operation_t *operation,
5433 psa_key_derivation_step_t step,
5434 const uint8_t *data,
5435 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005436{
Gilles Peskineb8965192019-09-24 16:21:10 +02005437 return( psa_key_derivation_input_internal( operation, step,
5438 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005439 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005440}
5441
Janos Follath51f4a0f2019-06-14 11:35:55 +01005442psa_status_t psa_key_derivation_input_key(
5443 psa_key_derivation_operation_t *operation,
5444 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005445 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005446{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005448 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005449 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005450
Ronald Cron5c522922020-11-14 16:35:34 +01005451 status = psa_get_and_lock_transparent_key_slot_with_policy(
5452 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005453 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005454 {
5455 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005456 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005457 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005458
5459 /* Passing a key object as a SECRET input unlocks the permission
5460 * to output to a key object. */
5461 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5462 operation->can_output_key = 1;
5463
Ronald Cronf95a2b12020-10-22 15:24:49 +02005464 status = psa_key_derivation_input_internal( operation,
5465 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005466 slot->key.data,
5467 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005468
Ronald Cron5c522922020-11-14 16:35:34 +01005469 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005470
Ronald Cron5c522922020-11-14 16:35:34 +01005471 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005472}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005473
5474
5475
5476/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005477/* Key agreement */
5478/****************************************************************/
5479
John Durkop6ba40d12020-11-10 08:50:04 -08005480#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005481static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5482 size_t peer_key_length,
5483 const mbedtls_ecp_keypair *our_key,
5484 uint8_t *shared_secret,
5485 size_t shared_secret_size,
5486 size_t *shared_secret_length )
5487{
Steven Cooremand4867872020-08-05 16:31:39 +02005488 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005489 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005490 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005491 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005492 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005493 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005494
Ronald Cron90857082020-11-25 14:58:33 +01005495 status = mbedtls_psa_ecp_load_representation(
5496 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005497 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005498 peer_key,
5499 peer_key_length,
5500 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005501 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005502 goto exit;
5503
Jaeden Amero97271b32019-01-10 19:38:51 +00005504 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005505 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005506 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005507 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005508 status = mbedtls_to_psa_error(
5509 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5510 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005511 goto exit;
5512
Jaeden Amero97271b32019-01-10 19:38:51 +00005513 status = mbedtls_to_psa_error(
5514 mbedtls_ecdh_calc_secret( &ecdh,
5515 shared_secret_length,
5516 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005517 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005518 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005519 if( status != PSA_SUCCESS )
5520 goto exit;
5521 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5522 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005523
5524exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005525 if( status != PSA_SUCCESS )
5526 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005527 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005528 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005529 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005530
Jaeden Amero97271b32019-01-10 19:38:51 +00005531 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005532}
John Durkop6ba40d12020-11-10 08:50:04 -08005533#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005534
Gilles Peskine01d718c2018-09-18 12:01:02 +02005535#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5536
Gilles Peskine0216fe12019-04-11 21:23:21 +02005537static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5538 psa_key_slot_t *private_key,
5539 const uint8_t *peer_key,
5540 size_t peer_key_length,
5541 uint8_t *shared_secret,
5542 size_t shared_secret_size,
5543 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005544{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005545 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005546 {
John Durkop6ba40d12020-11-10 08:50:04 -08005547#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005548 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005549 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005550 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005551 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005552 psa_status_t status = mbedtls_psa_ecp_load_representation(
5553 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005554 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005555 private_key->key.data,
5556 private_key->key.bytes,
5557 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005558 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005559 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005560 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005561 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005562 shared_secret, shared_secret_size,
5563 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005564 mbedtls_ecp_keypair_free( ecp );
5565 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005566 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005567#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005568 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005569 (void) private_key;
5570 (void) peer_key;
5571 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005572 (void) shared_secret;
5573 (void) shared_secret_size;
5574 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005575 return( PSA_ERROR_NOT_SUPPORTED );
5576 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005577}
5578
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005579/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005580 * to potentially free embedded data structures and wipe confidential data.
5581 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005582static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005583 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005584 psa_key_slot_t *private_key,
5585 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005586 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005587{
5588 psa_status_t status;
5589 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5590 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005592
5593 /* Step 1: run the secret agreement algorithm to generate the shared
5594 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005595 status = psa_key_agreement_raw_internal( ka_alg,
5596 private_key,
5597 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005598 shared_secret,
5599 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005600 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005601 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005602 goto exit;
5603
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005604 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005605 * the shared secret. A shared secret is permitted wherever a key
5606 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005607 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005608 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005609 shared_secret,
5610 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005611exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005612 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005613 return( status );
5614}
5615
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005616psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005617 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005618 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005619 const uint8_t *peer_key,
5620 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005621{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005623 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005624 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005625
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005626 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005627 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005628 status = psa_get_and_lock_transparent_key_slot_with_policy(
5629 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005630 if( status != PSA_SUCCESS )
5631 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005632 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005633 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005634 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005635 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005636 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005637 else
5638 {
5639 /* If a private key has been added as SECRET, we allow the derived
5640 * key material to be used as a key in PSA Crypto. */
5641 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5642 operation->can_output_key = 1;
5643 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005644
Ronald Cron5c522922020-11-14 16:35:34 +01005645 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005646
Ronald Cron5c522922020-11-14 16:35:34 +01005647 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005648}
5649
Gilles Peskinebe697d82019-05-16 18:00:41 +02005650psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005651 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005652 const uint8_t *peer_key,
5653 size_t peer_key_length,
5654 uint8_t *output,
5655 size_t output_size,
5656 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005657{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005658 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005659 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005660 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005661
5662 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5663 {
5664 status = PSA_ERROR_INVALID_ARGUMENT;
5665 goto exit;
5666 }
Ronald Cron5c522922020-11-14 16:35:34 +01005667 status = psa_get_and_lock_transparent_key_slot_with_policy(
5668 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005669 if( status != PSA_SUCCESS )
5670 goto exit;
5671
5672 status = psa_key_agreement_raw_internal( alg, slot,
5673 peer_key, peer_key_length,
5674 output, output_size,
5675 output_length );
5676
5677exit:
5678 if( status != PSA_SUCCESS )
5679 {
5680 /* If an error happens and is not handled properly, the output
5681 * may be used as a key to protect sensitive data. Arrange for such
5682 * a key to be random, which is likely to result in decryption or
5683 * verification errors. This is better than filling the buffer with
5684 * some constant data such as zeros, which would result in the data
5685 * being protected with a reproducible, easily knowable key.
5686 */
5687 psa_generate_random( output, output_size );
5688 *output_length = output_size;
5689 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005690
Ronald Cron5c522922020-11-14 16:35:34 +01005691 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005692
Ronald Cron5c522922020-11-14 16:35:34 +01005693 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005694}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005695
5696
Gilles Peskine30524eb2020-11-13 17:02:26 +01005697
Gilles Peskine86a440b2018-11-12 18:39:40 +01005698/****************************************************************/
5699/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005700/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005701
Gilles Peskine30524eb2020-11-13 17:02:26 +01005702/** Initialize the PSA random generator.
5703 */
5704static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5705{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005706#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5707 memset( rng, 0, sizeof( *rng ) );
5708#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5709
Gilles Peskine30524eb2020-11-13 17:02:26 +01005710 /* Set default configuration if
5711 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5712 if( rng->entropy_init == NULL )
5713 rng->entropy_init = mbedtls_entropy_init;
5714 if( rng->entropy_free == NULL )
5715 rng->entropy_free = mbedtls_entropy_free;
5716
5717 rng->entropy_init( &rng->entropy );
5718#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5719 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5720 /* The PSA entropy injection feature depends on using NV seed as an entropy
5721 * source. Add NV seed as an entropy source for PSA entropy injection. */
5722 mbedtls_entropy_add_source( &rng->entropy,
5723 mbedtls_nv_seed_poll, NULL,
5724 MBEDTLS_ENTROPY_BLOCK_SIZE,
5725 MBEDTLS_ENTROPY_SOURCE_STRONG );
5726#endif
5727
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005728 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005729#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005730}
5731
5732/** Deinitialize the PSA random generator.
5733 */
5734static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5735{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005736#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5737 memset( rng, 0, sizeof( *rng ) );
5738#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005739 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005740 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005741#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005742}
5743
5744/** Seed the PSA random generator.
5745 */
5746static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5747{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005748#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5749 /* Do nothing: the external RNG seeds itself. */
5750 (void) rng;
5751 return( PSA_SUCCESS );
5752#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005753 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005754 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5755 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005756 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005757#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005758}
5759
Gilles Peskinee59236f2018-01-27 23:32:46 +01005760psa_status_t psa_generate_random( uint8_t *output,
5761 size_t output_size )
5762{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005763 GUARD_MODULE_INITIALIZED;
5764
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005765#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5766
5767 size_t output_length = 0;
5768 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5769 output, output_size,
5770 &output_length );
5771 if( status != PSA_SUCCESS )
5772 return( status );
5773 /* Breaking up a request into smaller chunks is currently not supported
5774 * for the extrernal RNG interface. */
5775 if( output_length != output_size )
5776 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5777 return( PSA_SUCCESS );
5778
5779#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5780
Gilles Peskine71ddab92021-01-04 21:01:07 +01005781 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005782 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005783 size_t request_size =
5784 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5785 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5786 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005787 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5788 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005789 if( ret != 0 )
5790 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005791 output_size -= request_size;
5792 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005793 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005794 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005795#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005796}
5797
Gilles Peskine8814fc42020-12-14 15:33:44 +01005798/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005799 *
5800 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5801 * `psa_generate_random(...)`. The state parameter is ignored since the
5802 * PSA API doesn't support passing an explicit state.
5803 *
5804 * In the non-external case, psa_generate_random() calls an
5805 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5806 * and semantics as mbedtls_psa_get_random(). As an optimization,
5807 * instead of doing this back-and-forth between the PSA API and the
5808 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5809 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005810 */
5811#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5812int mbedtls_psa_get_random( void *p_rng,
5813 unsigned char *output,
5814 size_t output_size )
5815{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005816 /* This function takes a pointer to the RNG state because that's what
5817 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5818 * its own state internally and doesn't let the caller access that state.
5819 * So we just ignore the state parameter, and in practice we'll pass
5820 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005821 (void) p_rng;
5822 psa_status_t status = psa_generate_random( output, output_size );
5823 if( status == PSA_SUCCESS )
5824 return( 0 );
5825 else
5826 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5827}
5828#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5829
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005830#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005831#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005832
Gilles Peskine7228da22019-07-15 11:06:15 +02005833psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005834 size_t seed_size )
5835{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005836 if( global_data.initialized )
5837 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005838
5839 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5840 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5841 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5842 return( PSA_ERROR_INVALID_ARGUMENT );
5843
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005844 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005845}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005846#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005847
Ronald Cron3772afe2021-02-08 16:10:05 +01005848/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005849 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005850 * \param type The key type
5851 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005852 *
5853 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005854 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005855 * \retval #PSA_ERROR_INVALID_ARGUMENT
5856 * The size in bits of the key is not valid.
5857 * \retval #PSA_ERROR_NOT_SUPPORTED
5858 * The type and/or the size in bits of the key or the combination of
5859 * the two is not supported.
5860 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005861static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5862 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005863{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005864 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005865
Gilles Peskinee59236f2018-01-27 23:32:46 +01005866 if( key_type_is_raw_bytes( type ) )
5867 {
Archana4d7ae1d2021-07-07 02:50:22 +05305868 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005869 if( status != PSA_SUCCESS )
5870 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005871 }
5872 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005873#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005874 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5875 {
5876 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5877 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005878
Ronald Cron01b2aba2020-10-05 09:42:02 +02005879 /* Accept only byte-aligned keys, for the same reasons as
5880 * in psa_import_rsa_key(). */
5881 if( bits % 8 != 0 )
5882 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005883 }
5884 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005885#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005886
Ronald Cron5c4d3862020-12-07 11:07:24 +01005887#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005888 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5889 {
Ronald Crond81ab562021-02-16 09:01:16 +01005890 /* To avoid empty block, return successfully here. */
5891 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005892 }
5893 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005894#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005895 {
5896 return( PSA_ERROR_NOT_SUPPORTED );
5897 }
5898
5899 return( PSA_SUCCESS );
5900}
5901
Ronald Cron55ed0592020-10-05 10:30:40 +02005902psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005903 const psa_key_attributes_t *attributes,
5904 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005905{
5906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005907 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005908
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005909 if( ( attributes->domain_parameters == NULL ) &&
5910 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02005911 return( PSA_ERROR_INVALID_ARGUMENT );
5912
Ronald Cron01b2aba2020-10-05 09:42:02 +02005913 if( key_type_is_raw_bytes( type ) )
5914 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005915 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005916 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005917 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005918
David Brown12ca5032021-02-11 11:02:00 -07005919#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005920 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005921 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07005922#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005923 }
5924 else
5925
Jaeden Amero424fa932021-05-14 08:34:32 +01005926#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5927 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005928 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005929 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005930 return( mbedtls_psa_rsa_generate_key( attributes,
5931 key_buffer,
5932 key_buffer_size,
5933 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005934 }
5935 else
Jaeden Amero424fa932021-05-14 08:34:32 +01005936#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5937 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005938
John Durkop9814fa22020-11-04 12:28:15 -08005939#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005940 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005941 {
Ronald Cron7023db52020-11-20 18:17:42 +01005942 return( mbedtls_psa_ecp_generate_key( attributes,
5943 key_buffer,
5944 key_buffer_size,
5945 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005946 }
5947 else
John Durkop9814fa22020-11-04 12:28:15 -08005948#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005949 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005950 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005951 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005952 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005953
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005954 return( PSA_SUCCESS );
5955}
Darryl Green0c6575a2018-11-07 16:05:30 +00005956
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005957psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005958 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005959{
5960 psa_status_t status;
5961 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005962 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005963 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005964
Ronald Cron81709fc2020-11-14 12:10:32 +01005965 *key = MBEDTLS_SVC_KEY_ID_INIT;
5966
Gilles Peskine0f84d622019-09-12 19:03:13 +02005967 /* Reject any attempt to create a zero-length key so that we don't
5968 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5969 if( psa_get_key_bits( attributes ) == 0 )
5970 return( PSA_ERROR_INVALID_ARGUMENT );
5971
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02005972 /* Reject any attempt to create a public key. */
5973 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
5974 return( PSA_ERROR_INVALID_ARGUMENT );
5975
Ronald Cron81709fc2020-11-14 12:10:32 +01005976 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5977 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005978 if( status != PSA_SUCCESS )
5979 goto exit;
5980
Ronald Cron977c2472020-10-13 08:32:21 +02005981 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05305982 * storage ( thus not in the case of generating a key in a secure element
5983 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
5984 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02005985 if( slot->key.data == NULL )
5986 {
5987 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5988 PSA_KEY_LOCATION_LOCAL_STORAGE )
5989 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005990 status = psa_validate_key_type_and_size_for_key_generation(
5991 attributes->core.type, attributes->core.bits );
5992 if( status != PSA_SUCCESS )
5993 goto exit;
5994
5995 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5996 attributes->core.type,
5997 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005998 }
5999 else
6000 {
6001 status = psa_driver_wrapper_get_key_buffer_size(
6002 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01006003 if( status != PSA_SUCCESS )
6004 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02006005 }
Ronald Cron977c2472020-10-13 08:32:21 +02006006
6007 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
6008 if( status != PSA_SUCCESS )
6009 goto exit;
6010 }
6011
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006012 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02006013 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02006014
Ronald Cron2b56bc82020-10-05 10:02:26 +02006015 if( status != PSA_SUCCESS )
6016 psa_remove_key_data_from_memory( slot );
6017
Gilles Peskine11792082019-08-06 18:36:36 +02006018exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006019 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006020 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006021 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006022 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006023
Darryl Green0c6575a2018-11-07 16:05:30 +00006024 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006025}
6026
Gilles Peskinee59236f2018-01-27 23:32:46 +01006027/****************************************************************/
6028/* Module setup */
6029/****************************************************************/
6030
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006031#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006032psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6033 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6034 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6035{
6036 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6037 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006038 global_data.rng.entropy_init = entropy_init;
6039 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006040 return( PSA_SUCCESS );
6041}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006042#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006043
Gilles Peskinee59236f2018-01-27 23:32:46 +01006044void mbedtls_psa_crypto_free( void )
6045{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006046 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006047 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6048 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006049 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006050 }
6051 /* Wipe all remaining data, including configuration.
6052 * In particular, this sets all state indicator to the value
6053 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006054 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Ronald Cron9ba76912021-04-10 16:57:30 +02006055
6056 /* Terminate drivers */
6057 psa_driver_wrapper_free( );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006058}
6059
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006060#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6061/** Recover a transaction that was interrupted by a power failure.
6062 *
6063 * This function is called during initialization, before psa_crypto_init()
6064 * returns. If this function returns a failure status, the initialization
6065 * fails.
6066 */
6067static psa_status_t psa_crypto_recover_transaction(
6068 const psa_crypto_transaction_t *transaction )
6069{
6070 switch( transaction->unknown.type )
6071 {
6072 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6073 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006074 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006075 * is implemented.
6076 * https://github.com/ARMmbed/mbed-crypto/issues/218
6077 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006078 default:
6079 /* We found an unsupported transaction in the storage.
6080 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006081 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006082 }
6083}
6084#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6085
Gilles Peskinee59236f2018-01-27 23:32:46 +01006086psa_status_t psa_crypto_init( void )
6087{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006088 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006089
Gilles Peskinec6b69072018-11-20 21:42:52 +01006090 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006091 if( global_data.initialized != 0 )
6092 return( PSA_SUCCESS );
6093
Gilles Peskine30524eb2020-11-13 17:02:26 +01006094 /* Initialize and seed the random generator. */
6095 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006096 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006097 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006098 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006099 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006100 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006101
Gilles Peskine66fb1262018-12-10 16:29:04 +01006102 status = psa_initialize_key_slots( );
6103 if( status != PSA_SUCCESS )
6104 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006105
Ronald Cron9ba76912021-04-10 16:57:30 +02006106 /* Init drivers */
6107 status = psa_driver_wrapper_init( );
Gilles Peskined9348f22019-10-01 15:22:29 +02006108 if( status != PSA_SUCCESS )
6109 goto exit;
Gilles Peskined9348f22019-10-01 15:22:29 +02006110
Gilles Peskine4b734222019-07-24 15:56:31 +02006111#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006112 status = psa_crypto_load_transaction( );
6113 if( status == PSA_SUCCESS )
6114 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006115 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6116 if( status != PSA_SUCCESS )
6117 goto exit;
6118 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006119 }
6120 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6121 {
6122 /* There's no transaction to complete. It's all good. */
6123 status = PSA_SUCCESS;
6124 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006125#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006126
Gilles Peskinec6b69072018-11-20 21:42:52 +01006127 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006128 global_data.initialized = 1;
6129
6130exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006131 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006132 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006133 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006134}
6135
6136#endif /* MBEDTLS_PSA_CRYPTO_C */