blob: 7bce3916bef69706f5afe18f67d655fc5d585cac [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
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020091#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
92 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
93 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020094#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020095#endif
96
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010097/****************************************************************/
98/* Global data, support functions and library management */
99/****************************************************************/
100
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200101static int key_type_is_raw_bytes( psa_key_type_t type )
102{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200103 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200104}
105
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100106/* Values for psa_global_data_t::rng_state */
107#define RNG_NOT_INITIALIZED 0
108#define RNG_INITIALIZED 1
109#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100110
Gilles Peskine2d277862018-06-18 15:41:12 +0200111typedef struct
112{
Gilles Peskinec6b69072018-11-20 21:42:52 +0100113 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100114 unsigned rng_state : 2;
Gilles Peskine2d8a1822021-11-08 22:20:03 +0100115 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100116} psa_global_data_t;
117
118static psa_global_data_t global_data;
119
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100120#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
121mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
122 &global_data.rng.drbg;
123#endif
124
itayzafrir0adf0fc2018-09-06 16:24:41 +0300125#define GUARD_MODULE_INITIALIZED \
126 if( global_data.initialized == 0 ) \
127 return( PSA_ERROR_BAD_STATE );
128
Steven Cooreman01164162020-07-20 15:31:37 +0200129psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100130{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100131 /* Mbed TLS error codes can combine a high-level error code and a
132 * low-level error code. The low-level error usually reflects the
133 * root cause better, so dispatch on that preferably. */
134 int low_level_ret = - ( -ret & 0x007f );
135 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100136 {
137 case 0:
138 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100139
140 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
141 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100142 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200143 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
144 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
145 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
146 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
147 case MBEDTLS_ERR_ASN1_INVALID_DATA:
148 return( PSA_ERROR_INVALID_ARGUMENT );
149 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
150 return( PSA_ERROR_INSUFFICIENT_MEMORY );
151 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
152 return( PSA_ERROR_BUFFER_TOO_SMALL );
153
Jaeden Amero93e21112019-02-20 13:57:28 +0000154#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000155 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000156#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100157 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
158 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100159
160 case MBEDTLS_ERR_CCM_BAD_INPUT:
161 return( PSA_ERROR_INVALID_ARGUMENT );
162 case MBEDTLS_ERR_CCM_AUTH_FAILED:
163 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100164
Gilles Peskine26869f22019-05-06 15:25:00 +0200165 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
166 return( PSA_ERROR_INVALID_ARGUMENT );
167
168 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
169 return( PSA_ERROR_BAD_STATE );
170 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
171 return( PSA_ERROR_INVALID_SIGNATURE );
172
Gilles Peskinea5905292018-02-07 20:59:33 +0100173 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
174 return( PSA_ERROR_NOT_SUPPORTED );
175 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
176 return( PSA_ERROR_INVALID_ARGUMENT );
177 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
178 return( PSA_ERROR_INSUFFICIENT_MEMORY );
179 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
180 return( PSA_ERROR_INVALID_PADDING );
181 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200182 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100183 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
184 return( PSA_ERROR_INVALID_SIGNATURE );
185 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200186 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100187
Gilles Peskine82e57d12020-11-13 21:31:17 +0100188#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
189 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100190 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
191 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100192 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
193 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
194 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
195 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
196 return( PSA_ERROR_NOT_SUPPORTED );
197 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
198 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100199#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100200
201 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
202 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100203
Gilles Peskinee59236f2018-01-27 23:32:46 +0100204 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
205 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
206 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
207 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100208
209 case MBEDTLS_ERR_GCM_AUTH_FAILED:
210 return( PSA_ERROR_INVALID_SIGNATURE );
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200211 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
212 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100213 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200214 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100215
Gilles Peskine82e57d12020-11-13 21:31:17 +0100216#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
217 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100218 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
219 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100220 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
221 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
222 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
223 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
224 return( PSA_ERROR_NOT_SUPPORTED );
225 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
226 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
227#endif
228
Gilles Peskinea5905292018-02-07 20:59:33 +0100229 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
230 return( PSA_ERROR_NOT_SUPPORTED );
231 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
232 return( PSA_ERROR_INVALID_ARGUMENT );
233 case MBEDTLS_ERR_MD_ALLOC_FAILED:
234 return( PSA_ERROR_INSUFFICIENT_MEMORY );
235 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
236 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100237
Gilles Peskinef76aa772018-10-29 19:24:33 +0100238 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
239 return( PSA_ERROR_STORAGE_FAILURE );
240 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
241 return( PSA_ERROR_INVALID_ARGUMENT );
242 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
243 return( PSA_ERROR_INVALID_ARGUMENT );
244 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
245 return( PSA_ERROR_BUFFER_TOO_SMALL );
246 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
247 return( PSA_ERROR_INVALID_ARGUMENT );
248 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
249 return( PSA_ERROR_INVALID_ARGUMENT );
250 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
251 return( PSA_ERROR_INVALID_ARGUMENT );
252 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
253 return( PSA_ERROR_INSUFFICIENT_MEMORY );
254
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100255 case MBEDTLS_ERR_PK_ALLOC_FAILED:
256 return( PSA_ERROR_INSUFFICIENT_MEMORY );
257 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
258 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
259 return( PSA_ERROR_INVALID_ARGUMENT );
260 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100261 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100262 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
263 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
264 return( PSA_ERROR_INVALID_ARGUMENT );
265 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
266 return( PSA_ERROR_NOT_SUPPORTED );
267 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
268 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
269 return( PSA_ERROR_NOT_PERMITTED );
270 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
271 return( PSA_ERROR_INVALID_ARGUMENT );
272 case MBEDTLS_ERR_PK_INVALID_ALG:
273 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
274 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
275 return( PSA_ERROR_NOT_SUPPORTED );
276 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
277 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200278 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
279 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100280
Gilles Peskineff2d2002019-05-06 15:26:23 +0200281 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
284 return( PSA_ERROR_NOT_SUPPORTED );
285
Gilles Peskinea5905292018-02-07 20:59:33 +0100286 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_RSA_INVALID_PADDING:
289 return( PSA_ERROR_INVALID_PADDING );
290 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
291 return( PSA_ERROR_HARDWARE_FAILURE );
292 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
293 return( PSA_ERROR_INVALID_ARGUMENT );
294 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
295 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200296 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100297 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
298 return( PSA_ERROR_INVALID_SIGNATURE );
299 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
300 return( PSA_ERROR_BUFFER_TOO_SMALL );
301 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100302 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200303
itayzafrir5c753392018-05-08 11:18:38 +0300304 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300305 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300306 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300307 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
308 return( PSA_ERROR_BUFFER_TOO_SMALL );
309 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
310 return( PSA_ERROR_NOT_SUPPORTED );
311 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
312 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
313 return( PSA_ERROR_INVALID_SIGNATURE );
314 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
315 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100316 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
317 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100318
Janos Follatha13b9052019-11-22 12:48:59 +0000319 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
320 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300321
Gilles Peskinee59236f2018-01-27 23:32:46 +0100322 default:
David Saadab4ecc272019-02-14 13:48:10 +0200323 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100324 }
325}
326
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200327
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200328
329
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100330/****************************************************************/
331/* Key management */
332/****************************************************************/
333
John Durkop9814fa22020-11-04 12:28:15 -0800334#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800335 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100336 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
337 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
338 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100339mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100340 size_t bits,
341 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200342{
343 switch( curve )
344 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100345 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100346 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100347 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100348#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100349 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100350 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100351#endif
352#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100353 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100354 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100355#endif
356#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100357 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100358 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100359#endif
360#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100362 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100363#endif
364#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100365 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100366 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100367 case 528:
368 if( bits_is_sloppy )
369 return( MBEDTLS_ECP_DP_SECP521R1 );
370 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100371#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100372 }
373 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100374
Paul Elliott8ff510a2020-06-02 17:19:28 +0100375 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100376 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100377 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100378#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100379 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100380 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100381#endif
382#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100383 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100384 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100385#endif
386#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100387 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100388 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100389#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100390 }
391 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100392
Paul Elliott8ff510a2020-06-02 17:19:28 +0100393 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100394 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100395 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100396#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100397 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100398 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 256:
400 if( bits_is_sloppy )
401 return( MBEDTLS_ECP_DP_CURVE25519 );
402 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100403#endif
404#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100405 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100406 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100407#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100408 }
409 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100410
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#endif
418#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100421#endif
422#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100425#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100426 }
427 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200428 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100429
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100430 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432}
John Durkop9814fa22020-11-04 12:28:15 -0800433#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100434 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
435 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
436 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
437 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200438
Archana4d7ae1d2021-07-07 02:50:22 +0530439psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530440 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200441{
442 /* Check that the bit size is acceptable for the key type */
443 switch( type )
444 {
445 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200446 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200447 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200448 case PSA_KEY_TYPE_PASSWORD:
449 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200450 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100451#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200452 case PSA_KEY_TYPE_AES:
453 if( bits != 128 && bits != 192 && bits != 256 )
454 return( PSA_ERROR_INVALID_ARGUMENT );
455 break;
456#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200457#if defined(PSA_WANT_KEY_TYPE_ARIA)
458 case PSA_KEY_TYPE_ARIA:
459 if( bits != 128 && bits != 192 && bits != 256 )
460 return( PSA_ERROR_INVALID_ARGUMENT );
461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_CAMELLIA:
465 if( bits != 128 && bits != 192 && bits != 256 )
466 return( PSA_ERROR_INVALID_ARGUMENT );
467 break;
468#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100469#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200470 case PSA_KEY_TYPE_DES:
471 if( bits != 64 && bits != 128 && bits != 192 )
472 return( PSA_ERROR_INVALID_ARGUMENT );
473 break;
474#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100475#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200476 case PSA_KEY_TYPE_CHACHA20:
477 if( bits != 256 )
478 return( PSA_ERROR_INVALID_ARGUMENT );
479 break;
480#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200481 default:
482 return( PSA_ERROR_NOT_SUPPORTED );
483 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200484 if( bits % 8 != 0 )
485 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200487 return( PSA_SUCCESS );
488}
489
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100490/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100491 *
Steven Cooremancd640932021-03-08 12:00:27 +0100492 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
493 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 *
495 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100496 * \param[in] key_type The key type of the key to be used with the
497 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100498 *
499 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100500 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100501 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100503 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100505 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507{
Steven Cooremancd640932021-03-08 12:00:27 +0100508 if( PSA_ALG_IS_HMAC( algorithm ) )
509 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100510 if( key_type == PSA_KEY_TYPE_HMAC )
511 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100512 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100513
514 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100515 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100516 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
517 * key. */
518 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
519 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
520 {
521 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
522 * the block length (larger than 1) for block ciphers. */
523 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
524 return( PSA_SUCCESS );
525 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100526 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100527
528 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100529}
530
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200531psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
532 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200533{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100534 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200535 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200536
Ronald Cronea0f8a62020-11-25 17:52:23 +0100537 slot->key.data = mbedtls_calloc( 1, buffer_length );
538 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200539 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200540
Ronald Cronea0f8a62020-11-25 17:52:23 +0100541 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200542 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200543}
544
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200545psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
546 const uint8_t* data,
547 size_t data_length )
548{
549 psa_status_t status = psa_allocate_buffer_to_slot( slot,
550 data_length );
551 if( status != PSA_SUCCESS )
552 return( status );
553
Ronald Cronea0f8a62020-11-25 17:52:23 +0100554 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200555 return( PSA_SUCCESS );
556}
557
Ronald Crona0fe59f2020-11-29 11:14:53 +0100558psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100559 const psa_key_attributes_t *attributes,
560 const uint8_t *data, size_t data_length,
561 uint8_t *key_buffer, size_t key_buffer_size,
562 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100563{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100564 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
565 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100566
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200567 /* zero-length keys are never supported. */
568 if( data_length == 0 )
569 return( PSA_ERROR_NOT_SUPPORTED );
570
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100571 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100573 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200574
Archana449608b2021-09-08 15:36:05 +0530575 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
576 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200577 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200578 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200579
Ronald Crondd04d422020-11-28 15:14:42 +0100580 /* Copy the key material. */
581 memcpy( key_buffer, data, data_length );
582 *key_buffer_length = data_length;
583 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200584
Steven Cooreman40120f62020-10-29 11:42:22 +0100585 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100586 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100587 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200588 {
John Durkop9814fa22020-11-04 12:28:15 -0800589#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
590 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100591 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200592 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 return( mbedtls_psa_ecp_import_key( attributes,
594 data, data_length,
595 key_buffer, key_buffer_size,
596 key_buffer_length,
597 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100598 }
John Durkop9814fa22020-11-04 12:28:15 -0800599#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
600 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700601#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
602 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100603 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200604 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 return( mbedtls_psa_rsa_import_key( attributes,
606 data, data_length,
607 key_buffer, key_buffer_size,
608 key_buffer_length,
609 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200610 }
John Durkop9814fa22020-11-04 12:28:15 -0800611#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
612 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100613 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100614
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100615 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100616}
617
Gilles Peskinef603c712019-01-19 13:40:11 +0100618/** Calculate the intersection of two algorithm usage policies.
619 *
620 * Return 0 (which allows no operation) on incompatibility.
621 */
622static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100623 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100624 psa_algorithm_t alg1,
625 psa_algorithm_t alg2 )
626{
Gilles Peskine549ea862019-05-22 11:45:59 +0200627 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100628 if( alg1 == alg2 )
629 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100630 /* If the policies are from the same hash-and-sign family, check
631 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200632 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
633 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100634 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100635 {
Steven Cooreman03488022021-02-18 12:07:20 +0100636 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
637 return( alg2 );
638 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
639 return( alg1 );
640 }
641 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100642 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100643 * restrictive tag length. */
644 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
645 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
646 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
647 {
648 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
649 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100650 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100651
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100652 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100653 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
654 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100655 {
Steven Cooremancd640932021-03-08 12:00:27 +0100656 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
657 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100658 }
659 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100660 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100661 ( alg1_len <= alg2_len ) )
662 {
663 return( alg2 );
664 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100665 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100666 ( alg2_len <= alg1_len ) )
667 {
668 return( alg1 );
669 }
670 }
671 /* If the policies are from the same MAC family, check whether one
672 * of them is a minimum-MAC-length policy. Calculate the most
673 * restrictive tag length. */
674 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
675 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
676 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
677 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100678 /* Validate the combination of key type and algorithm. Since the base
679 * algorithm of alg1 and alg2 are the same, we only need this once. */
680 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100681 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100682
Steven Cooreman31a876d2021-03-03 20:47:40 +0100683 /* Get the (exact or at-least) output lengths for both sides of the
684 * requested intersection. None of the currently supported algorithms
685 * have an output length dependent on the actual key size, so setting it
686 * to a bogus value of 0 is currently OK.
687 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100688 * Note that for at-least-this-length wildcard algorithms, the output
689 * length is set to the shortest allowed length, which allows us to
690 * calculate the most restrictive tag length for the intersection. */
691 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
692 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100693 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100694
Steven Cooremana1d83222021-02-25 10:20:29 +0100695 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100696 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
697 ( ( alg2 & 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( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100701
702 /* If only one is an at-least-this-length policy, the intersection would
703 * be the other (fixed-length) policy as long as said fixed length is
704 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100705 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100706 {
Steven Cooremancd640932021-03-08 12:00:27 +0100707 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100708 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100709 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100710 {
Steven Cooremancd640932021-03-08 12:00:27 +0100711 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100712 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100713
Steven Cooremancd640932021-03-08 12:00:27 +0100714 /* If none of them are wildcards, check whether they define the same tag
715 * length. This is still possible here when one is default-length and
716 * the other specific-length. Ensure to always return the
717 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100718 if( alg1_len == alg2_len )
719 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100720 }
721 /* If the policies are incompatible, allow nothing. */
722 return( 0 );
723}
724
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100725static int psa_key_algorithm_permits( psa_key_type_t key_type,
726 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200727 psa_algorithm_t requested_alg )
728{
Gilles Peskine549ea862019-05-22 11:45:59 +0200729 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200730 if( requested_alg == policy_alg )
731 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100732 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
733 * and requested_alg is the same hash-and-sign family with any hash,
734 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200735 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100736 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200737 {
Steven Cooreman03488022021-02-18 12:07:20 +0100738 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
739 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
740 }
741 /* If policy_alg is a wildcard AEAD algorithm of the same base as
742 * the requested algorithm, check the requested tag length to be
743 * equal-length or longer than the wildcard-specified length. */
744 if( PSA_ALG_IS_AEAD( policy_alg ) &&
745 PSA_ALG_IS_AEAD( requested_alg ) &&
746 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
747 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100748 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100749 {
750 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
751 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
752 }
Steven Cooremancd640932021-03-08 12:00:27 +0100753 /* If policy_alg is a MAC algorithm of the same base as the requested
754 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100755 if( PSA_ALG_IS_MAC( policy_alg ) &&
756 PSA_ALG_IS_MAC( requested_alg ) &&
757 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100758 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100759 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100760 /* Validate the combination of key type and algorithm. Since the policy
761 * and requested algorithms are the same, we only need this once. */
762 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100763 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100764
Steven Cooreman31a876d2021-03-03 20:47:40 +0100765 /* Get both the requested output length for the algorithm which is to be
766 * verified, and the default output length for the base algorithm.
767 * Note that none of the currently supported algorithms have an output
768 * length dependent on actual key size, so setting it to a bogus value
769 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100770 size_t requested_output_length = PSA_MAC_LENGTH(
771 key_type, 0, requested_alg );
772 size_t default_output_length = PSA_MAC_LENGTH(
773 key_type, 0,
774 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100775
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100776 /* If the policy is default-length, only allow an algorithm with
777 * a declared exact-length matching the default. */
778 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100779 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100780
781 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100782 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100783 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
784 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
785 {
786 return( 1 );
787 }
788
Steven Cooremancd640932021-03-08 12:00:27 +0100789 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
790 * check for the requested MAC length to be equal to or longer than the
791 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100792 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
793 {
794 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100795 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200797 }
Steven Cooremance48e852020-10-05 16:02:45 +0200798 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200799 * a key derivation with that key agreement should also be allowed. This
800 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200801 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
802 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
803 {
804 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
805 policy_alg );
806 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100807 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200808 return( 0 );
809}
810
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100811/** Test whether a policy permits an algorithm.
812 *
813 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100814 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100815 * \note This function requires providing the key type for which the policy is
816 * being validated, since some algorithm policy definitions (e.g. MAC)
817 * have different properties depending on what kind of cipher it is
818 * combined with.
819 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 * \retval PSA_SUCCESS When \p alg is a specific algorithm
821 * allowed by the \p policy.
822 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
823 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
824 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100825 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100827 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100828 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100829{
Steven Cooremand788fab2021-02-25 11:29:17 +0100830 /* '0' is not a valid algorithm */
831 if( alg == 0 )
832 return( PSA_ERROR_INVALID_ARGUMENT );
833
Steven Cooreman7e39f052021-02-23 14:18:32 +0100834 /* A requested algorithm cannot be a wildcard. */
835 if( PSA_ALG_IS_WILDCARD( alg ) )
836 return( PSA_ERROR_INVALID_ARGUMENT );
837
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100838 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
839 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100840 return( PSA_SUCCESS );
841 else
842 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100843}
844
Gilles Peskinef603c712019-01-19 13:40:11 +0100845/** Restrict a key policy based on a constraint.
846 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100847 * \note This function requires providing the key type for which the policy is
848 * being restricted, since some algorithm policy definitions (e.g. MAC)
849 * have different properties depending on what kind of cipher it is
850 * combined with.
851 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 * \param[in,out] policy The policy to restrict.
854 * \param[in] constraint The policy constraint to apply.
855 *
856 * \retval #PSA_SUCCESS
857 * \c *policy contains the intersection of the original value of
858 * \c *policy and \c *constraint.
859 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100860 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100861 * \c *policy is unchanged.
862 */
863static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100864 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100865 psa_key_policy_t *policy,
866 const psa_key_policy_t *constraint )
867{
868 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100869 psa_key_policy_algorithm_intersection( key_type, policy->alg,
870 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200871 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100872 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
873 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100874 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
875 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200876 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
877 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100878 policy->usage &= constraint->usage;
879 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200880 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100881 return( PSA_SUCCESS );
882}
883
Ronald Cron5c522922020-11-14 16:35:34 +0100884/** Get the description of a key given its identifier and policy constraints
885 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200886 *
Ronald Cron5c522922020-11-14 16:35:34 +0100887 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100888 * nonzero, the key must allow operations with this algorithm. If \p alg is
889 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100890 *
Ronald Cron5c522922020-11-14 16:35:34 +0100891 * In case of a persistent key, the function loads the description of the key
892 * into a key slot if not already done.
893 *
894 * On success, the returned key slot is locked. It is the responsibility of
895 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200896 */
Ronald Cron5c522922020-11-14 16:35:34 +0100897static psa_status_t psa_get_and_lock_key_slot_with_policy(
898 mbedtls_svc_key_id_t key,
899 psa_key_slot_t **p_slot,
900 psa_key_usage_t usage,
901 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100902{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
904 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
Ronald Cron5c522922020-11-14 16:35:34 +0100906 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100907 if( status != PSA_SUCCESS )
908 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100910
911 /* Enforce that usage policy for the key slot contains all the flags
912 * required by the usage parameter. There is one exception: public
913 * keys can always be exported, so we treat public key objects as
914 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200915 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100916 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200917
Gilles Peskine8e338702019-07-30 20:06:31 +0200918 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100919 {
920 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100922 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100923
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800924 /* Enforce that the usage policy permits the requested algorithm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100925 if( alg != 0 )
926 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100927 status = psa_key_policy_permits( &slot->attr.policy,
928 slot->attr.type,
929 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100930 if( status != PSA_SUCCESS )
931 goto error;
932 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100933
Darryl Green06fd18d2018-07-16 11:21:11 +0100934 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200935
936error:
937 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100938 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200939
940 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100941}
Darryl Green940d72c2018-07-13 13:18:51 +0100942
Ronald Cron5c522922020-11-14 16:35:34 +0100943/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200944 *
945 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200946 * available, as opposed to a key in a secure element and/or to be used
947 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200948 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200949 * This is a temporary function that may be used instead of
950 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
951 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200952 *
Ronald Cron5c522922020-11-14 16:35:34 +0100953 * On success, the returned key slot is locked. It is the responsibility of the
954 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 */
Ronald Cron5c522922020-11-14 16:35:34 +0100956static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
957 mbedtls_svc_key_id_t key,
958 psa_key_slot_t **p_slot,
959 psa_key_usage_t usage,
960 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961{
Ronald Cron5c522922020-11-14 16:35:34 +0100962 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
963 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200964 if( status != PSA_SUCCESS )
965 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200966
Ronald Cronddae0f52021-08-24 15:39:44 +0200967 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 {
Ronald Cron5c522922020-11-14 16:35:34 +0100969 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200970 *p_slot = NULL;
971 return( PSA_ERROR_NOT_SUPPORTED );
972 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200973
Gilles Peskine28f8f302019-07-24 13:30:31 +0200974 return( PSA_SUCCESS );
975}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200976
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200977psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000978{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100979 /* Data pointer will always be either a valid pointer or NULL in an
980 * initialized slot, so we can just free it. */
981 if( slot->key.data != NULL )
982 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
983
984 mbedtls_free( slot->key.data );
985 slot->key.data = NULL;
986 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000987
988 return( PSA_SUCCESS );
989}
990
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100991/** Completely wipe a slot in memory, including its policy.
992 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100993psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100994{
995 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100996
TRodziewicz18cddc02021-07-13 12:19:15 +0200997 /*
998 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200999 * do our best to report an unexpected lock counter. Assert with
1000 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1001 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1002 * function is called as part of the execution of a test suite, the
1003 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +02001004 */
Ronald Cron5c522922020-11-14 16:35:34 +01001005 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001006 {
TRodziewicz7871c2e2021-07-07 17:29:43 +02001007 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001008 status = PSA_ERROR_CORRUPTION_DETECTED;
1009 }
1010
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001011 /* Multipart operations may still be using the key. This is safe
1012 * because all multipart operation objects are independent from
1013 * the key slot: if they need to access the key after the setup
1014 * phase, they have a copy of the key. Note that this means that
1015 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001016 /* At this point, key material and other type-specific content has
1017 * been wiped. Clear remaining metadata. We can call memset and not
1018 * zeroize because the metadata is not particularly sensitive. */
1019 memset( slot, 0, sizeof( *slot ) );
1020 return( status );
1021}
1022
Ronald Croncf56a0a2020-08-04 09:51:30 +02001023psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001024{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001025 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001026 psa_status_t status; /* status of the last operation */
1027 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001028#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1029 psa_se_drv_table_entry_t *driver;
1030#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001031
Ronald Croncf56a0a2020-08-04 09:51:30 +02001032 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001033 return( PSA_SUCCESS );
1034
Ronald Cronf2911112020-10-29 17:51:10 +01001035 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001036 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001037 * key, this will load the key description from persistent memory if not
1038 * done yet. We cannot avoid this loading as without it we don't know if
1039 * the key is operated by an SE or not and this information is needed by
1040 * the current implementation.
1041 */
Ronald Cron5c522922020-11-14 16:35:34 +01001042 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001043 if( status != PSA_SUCCESS )
1044 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001045
Ronald Cronf2911112020-10-29 17:51:10 +01001046 /*
1047 * If the key slot containing the key description is under access by the
1048 * library (apart from the present access), the key cannot be destroyed
1049 * yet. For the time being, just return in error. Eventually (to be
1050 * implemented), the key should be destroyed when all accesses have
1051 * stopped.
1052 */
Ronald Cron5c522922020-11-14 16:35:34 +01001053 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001054 {
Ronald Cron5c522922020-11-14 16:35:34 +01001055 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001056 return( PSA_ERROR_GENERIC_ERROR );
1057 }
1058
Gilles Peskine6687cd02021-04-21 22:32:05 +02001059 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1060 {
1061 /* Refuse the destruction of a read-only key (which may or may not work
1062 * if we attempt it, depending on whether the key is merely read-only
1063 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001064 * Just do the best we can, which is to wipe the copy in memory
1065 * (done in this function's cleanup code). */
1066 overall_status = PSA_ERROR_NOT_PERMITTED;
1067 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001068 }
1069
Gilles Peskine354f7672019-07-12 23:46:38 +02001070#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001071 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001072 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001073 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001074 /* For a key in a secure element, we need to do three things:
1075 * remove the key file in internal storage, destroy the
1076 * key inside the secure element, and update the driver's
1077 * persistent data. Start a transaction that will encompass these
1078 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001079 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001080 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001081 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001082 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001083 status = psa_crypto_save_transaction( );
1084 if( status != PSA_SUCCESS )
1085 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001086 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001087 /* We should still try to destroy the key in the secure
1088 * element and the key metadata in storage. This is especially
1089 * important if the error is that the storage is full.
1090 * But how to do it exactly without risking an inconsistent
1091 * state after a reset?
1092 * https://github.com/ARMmbed/mbed-crypto/issues/215
1093 */
1094 overall_status = status;
1095 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001096 }
1097
Ronald Cronea0f8a62020-11-25 17:52:23 +01001098 status = psa_destroy_se_key( driver,
1099 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001100 if( overall_status == PSA_SUCCESS )
1101 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001102 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001103#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1104
Darryl Greend49a4992018-06-18 17:27:26 +01001105#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001106 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001107 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001108 status = psa_destroy_persistent_key( slot->attr.id );
1109 if( overall_status == PSA_SUCCESS )
1110 overall_status = status;
1111
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001112 /* TODO: other slots may have a copy of the same key. We should
1113 * invalidate them.
1114 * https://github.com/ARMmbed/mbed-crypto/issues/214
1115 */
Darryl Greend49a4992018-06-18 17:27:26 +01001116 }
1117#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001118
Gilles Peskinefc762652019-07-22 19:30:34 +02001119#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1120 if( driver != NULL )
1121 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001122 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123 if( overall_status == PSA_SUCCESS )
1124 overall_status = status;
1125 status = psa_crypto_stop_transaction( );
1126 if( overall_status == PSA_SUCCESS )
1127 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001128 }
1129#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1130
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001131exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001132 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001133 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001134 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001135 overall_status = status;
1136 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001137}
1138
John Durkop07cc04a2020-11-16 22:08:34 -08001139#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001140 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001141static psa_status_t psa_get_rsa_public_exponent(
1142 const mbedtls_rsa_context *rsa,
1143 psa_key_attributes_t *attributes )
1144{
1145 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001147 uint8_t *buffer = NULL;
1148 size_t buflen;
1149 mbedtls_mpi_init( &mpi );
1150
1151 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1152 if( ret != 0 )
1153 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001154 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1155 {
1156 /* It's the default value, which is reported as an empty string,
1157 * so there's nothing to do. */
1158 goto exit;
1159 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001160
1161 buflen = mbedtls_mpi_size( &mpi );
1162 buffer = mbedtls_calloc( 1, buflen );
1163 if( buffer == NULL )
1164 {
1165 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1166 goto exit;
1167 }
1168 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1169 if( ret != 0 )
1170 goto exit;
1171 attributes->domain_parameters = buffer;
1172 attributes->domain_parameters_size = buflen;
1173
1174exit:
1175 mbedtls_mpi_free( &mpi );
1176 if( ret != 0 )
1177 mbedtls_free( buffer );
1178 return( mbedtls_to_psa_error( ret ) );
1179}
John Durkop07cc04a2020-11-16 22:08:34 -08001180#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001181 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001182
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001183/** Retrieve all the publicly-accessible attributes of a key.
1184 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001185psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001186 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001187{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001189 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001190 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001191
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001192 psa_reset_key_attributes( attributes );
1193
Ronald Cron5c522922020-11-14 16:35:34 +01001194 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001195 if( status != PSA_SUCCESS )
1196 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001197
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001198 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001199 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1200 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1201
1202#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001203 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001204 psa_set_key_slot_number( attributes,
1205 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001206#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001207
Gilles Peskine8e338702019-07-30 20:06:31 +02001208 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001209 {
John Durkop07cc04a2020-11-16 22:08:34 -08001210#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001211 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001212 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001213 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001214 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001215 * is not yet implemented.
1216 * https://github.com/ARMmbed/mbed-crypto/issues/216
1217 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001218 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001220 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001221
Ronald Cron90857082020-11-25 14:58:33 +01001222 status = mbedtls_psa_rsa_load_representation(
1223 slot->attr.type,
1224 slot->key.data,
1225 slot->key.bytes,
1226 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001227 if( status != PSA_SUCCESS )
1228 break;
1229
Steven Cooremana2371e52020-07-28 14:30:39 +02001230 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001231 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001232 mbedtls_rsa_free( rsa );
1233 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001234 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001235 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001236#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001237 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001238 default:
1239 /* Nothing else to do. */
1240 break;
1241 }
1242
1243 if( status != PSA_SUCCESS )
1244 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001245
Ronald Cron5c522922020-11-14 16:35:34 +01001246 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001247
Ronald Cron5c522922020-11-14 16:35:34 +01001248 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001249}
1250
Gilles Peskinec8000c02019-08-02 20:15:51 +02001251#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1252psa_status_t psa_get_key_slot_number(
1253 const psa_key_attributes_t *attributes,
1254 psa_key_slot_number_t *slot_number )
1255{
1256 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1257 {
1258 *slot_number = attributes->slot_number;
1259 return( PSA_SUCCESS );
1260 }
1261 else
1262 return( PSA_ERROR_INVALID_ARGUMENT );
1263}
1264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1265
Ronald Crond18b5f82020-11-25 16:46:05 +01001266static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1267 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001268 uint8_t *data,
1269 size_t data_size,
1270 size_t *data_length )
1271{
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001273 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 memcpy( data, key_buffer, key_buffer_size );
1275 memset( data + key_buffer_size, 0,
1276 data_size - key_buffer_size );
1277 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001278 return( PSA_SUCCESS );
1279}
1280
Ronald Cron7285cda2020-11-26 14:46:37 +01001281psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001282 const psa_key_attributes_t *attributes,
1283 const uint8_t *key_buffer, size_t key_buffer_size,
1284 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001285{
Ronald Crond18b5f82020-11-25 16:46:05 +01001286 psa_key_type_t type = attributes->core.type;
1287
Ronald Crond18b5f82020-11-25 16:46:05 +01001288 if( key_type_is_raw_bytes( type ) ||
1289 PSA_KEY_TYPE_IS_RSA( type ) ||
1290 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001291 {
1292 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001293 key_buffer, key_buffer_size,
1294 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001295 }
1296 else
1297 {
1298 /* This shouldn't happen in the reference implementation, but
1299 it is valid for a special-purpose implementation to omit
1300 support for exporting certain key types. */
1301 return( PSA_ERROR_NOT_SUPPORTED );
1302 }
1303}
1304
1305psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1306 uint8_t *data,
1307 size_t data_size,
1308 size_t *data_length )
1309{
1310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1312 psa_key_slot_t *slot;
1313
Ronald Crone907e552021-01-18 13:22:38 +01001314 /* Reject a zero-length output buffer now, since this can never be a
1315 * valid key representation. This way we know that data must be a valid
1316 * pointer and we can do things like memset(data, ..., data_size). */
1317 if( data_size == 0 )
1318 return( PSA_ERROR_BUFFER_TOO_SMALL );
1319
Ronald Cron9486f9d2020-11-26 13:36:23 +01001320 /* Set the key to empty now, so that even when there are errors, we always
1321 * set data_length to a value between 0 and data_size. On error, setting
1322 * the key to empty is a good choice because an empty key representation is
1323 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001324 *data_length = 0;
1325
Ronald Cron9486f9d2020-11-26 13:36:23 +01001326 /* Export requires the EXPORT flag. There is an exception for public keys,
1327 * which don't require any flag, but
1328 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1329 */
1330 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1331 PSA_KEY_USAGE_EXPORT, 0 );
1332 if( status != PSA_SUCCESS )
1333 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001334
Ronald Crond18b5f82020-11-25 16:46:05 +01001335 psa_key_attributes_t attributes = {
1336 .core = slot->attr
1337 };
Ronald Cron67227982020-11-26 15:16:05 +01001338 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001339 slot->key.data, slot->key.bytes,
1340 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001341
Ronald Cron9486f9d2020-11-26 13:36:23 +01001342 unlock_status = psa_unlock_key_slot( slot );
1343
1344 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1345}
1346
Ronald Cron7285cda2020-11-26 14:46:37 +01001347psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001348 const psa_key_attributes_t *attributes,
1349 const uint8_t *key_buffer,
1350 size_t key_buffer_size,
1351 uint8_t *data,
1352 size_t data_size,
1353 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354{
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001356
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001358 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001360 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001361 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 key_buffer, key_buffer_size,
1364 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001365 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001366
Ronald Crond18b5f82020-11-25 16:46:05 +01001367 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001368 {
John Durkop0e005192020-10-31 22:06:54 -07001369#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1370 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001371 return( mbedtls_psa_rsa_export_public_key( attributes,
1372 key_buffer,
1373 key_buffer_size,
1374 data,
1375 data_size,
1376 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001377#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001378 /* We don't know how to convert a private RSA key to public. */
1379 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001380#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1381 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001382 }
1383 else
Moran Pekera998bc62018-04-16 18:16:20 +03001384 {
John Durkop6ba40d12020-11-10 08:50:04 -08001385#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1386 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001387 return( mbedtls_psa_ecp_export_public_key( attributes,
1388 key_buffer,
1389 key_buffer_size,
1390 data,
1391 data_size,
1392 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001393#else
1394 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001395 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001396#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1397 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001400 else
1401 {
1402 /* This shouldn't happen in the reference implementation, but
1403 it is valid for a special-purpose implementation to omit
1404 support for exporting certain key types. */
1405 return( PSA_ERROR_NOT_SUPPORTED );
1406 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001407}
Ronald Crond18b5f82020-11-25 16:46:05 +01001408
Ronald Croncf56a0a2020-08-04 09:51:30 +02001409psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001410 uint8_t *data,
1411 size_t data_size,
1412 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001413{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001415 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001416 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001417
Ronald Crone907e552021-01-18 13:22:38 +01001418 /* Reject a zero-length output buffer now, since this can never be a
1419 * valid key representation. This way we know that data must be a valid
1420 * pointer and we can do things like memset(data, ..., data_size). */
1421 if( data_size == 0 )
1422 return( PSA_ERROR_BUFFER_TOO_SMALL );
1423
Darryl Greendd8fb772018-11-07 16:00:44 +00001424 /* Set the key to empty now, so that even when there are errors, we always
1425 * set data_length to a value between 0 and data_size. On error, setting
1426 * the key to empty is a good choice because an empty key representation is
1427 * unlikely to be accepted anywhere. */
1428 *data_length = 0;
1429
1430 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001431 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001432 if( status != PSA_SUCCESS )
1433 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001434
Ronald Cron9486f9d2020-11-26 13:36:23 +01001435 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1436 {
1437 status = PSA_ERROR_INVALID_ARGUMENT;
1438 goto exit;
1439 }
1440
Ronald Crond18b5f82020-11-25 16:46:05 +01001441 psa_key_attributes_t attributes = {
1442 .core = slot->attr
1443 };
Ronald Cron67227982020-11-26 15:16:05 +01001444 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001445 &attributes, slot->key.data, slot->key.bytes,
1446 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001447
1448exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001449 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001450
Ronald Cron5c522922020-11-14 16:35:34 +01001451 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001452}
1453
Gilles Peskine91e8c332019-08-02 19:19:39 +02001454#if defined(static_assert)
1455static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1456 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001457static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001458 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001459static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001460 "One or more key attribute flag is listed as both internal-only and external-only" );
1461#endif
1462
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001463/** Validate that a key policy is internally well-formed.
1464 *
1465 * This function only rejects invalid policies. It does not validate the
1466 * consistency of the policy with respect to other attributes of the key
1467 * such as the key type.
1468 */
1469static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001470{
1471 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001472 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001473 PSA_KEY_USAGE_ENCRYPT |
1474 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001475 PSA_KEY_USAGE_SIGN_MESSAGE |
1476 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001477 PSA_KEY_USAGE_SIGN_HASH |
1478 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001479 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001480 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1481 return( PSA_ERROR_INVALID_ARGUMENT );
1482
Gilles Peskine4747d192019-04-17 15:05:45 +02001483 return( PSA_SUCCESS );
1484}
1485
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001486/** Validate the internal consistency of key attributes.
1487 *
1488 * This function only rejects invalid attribute values. If does not
1489 * validate the consistency of the attributes with any key data that may
1490 * be involved in the creation of the key.
1491 *
1492 * Call this function early in the key creation process.
1493 *
1494 * \param[in] attributes Key attributes for the new key.
1495 * \param[out] p_drv On any return, the driver for the key, if any.
1496 * NULL for a transparent key.
1497 *
1498 */
1499static psa_status_t psa_validate_key_attributes(
1500 const psa_key_attributes_t *attributes,
1501 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001502{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001503 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001504 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001505 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506
Ronald Cron54b90082020-10-29 15:26:43 +01001507 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001508 if( status != PSA_SUCCESS )
1509 return( status );
1510
Ronald Crond2ed4812020-07-17 16:11:30 +02001511 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001512 if( status != PSA_SUCCESS )
1513 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001514
Ronald Cron65f38a32020-10-23 17:11:13 +02001515 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1516 {
1517 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1518 return( PSA_ERROR_INVALID_ARGUMENT );
1519 }
1520 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001521 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001522 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1523 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001524 }
1525
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001526 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001527 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001528 return( status );
1529
1530 /* Refuse to create overly large keys.
1531 * Note that this doesn't trigger on import if the attributes don't
1532 * explicitly specify a size (so psa_get_key_bits returns 0), so
1533 * psa_import_key() needs its own checks. */
1534 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1535 return( PSA_ERROR_NOT_SUPPORTED );
1536
Gilles Peskine91e8c332019-08-02 19:19:39 +02001537 /* Reject invalid flags. These should not be reachable through the API. */
1538 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1539 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1540 return( PSA_ERROR_INVALID_ARGUMENT );
1541
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001542 return( PSA_SUCCESS );
1543}
1544
Gilles Peskine4747d192019-04-17 15:05:45 +02001545/** Prepare a key slot to receive key material.
1546 *
1547 * This function allocates a key slot and sets its metadata.
1548 *
1549 * If this function fails, call psa_fail_key_creation().
1550 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001551 * This function is intended to be used as follows:
1552 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001553 * it with the specified attributes, and in case of a volatile key assign it
1554 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001555 * -# Populate the slot with the key material.
1556 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1557 * In case of failure at any step, stop the sequence and call
1558 * psa_fail_key_creation().
1559 *
Ronald Cron5c522922020-11-14 16:35:34 +01001560 * On success, the key slot is locked. It is the responsibility of the caller
1561 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001562 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001563 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001564 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001565 * \param[out] p_slot On success, a pointer to the prepared slot.
1566 * \param[out] p_drv On any return, the driver for the key, if any.
1567 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001568 *
1569 * \retval #PSA_SUCCESS
1570 * The key slot is ready to receive key material.
1571 * \return If this function fails, the key slot is an invalid state.
1572 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001573 */
1574static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001575 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001576 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001578 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001579{
1580 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001581 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001582 psa_key_slot_t *slot;
1583
Gilles Peskinedf179142019-07-15 22:02:14 +02001584 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001585 *p_drv = NULL;
1586
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001587 status = psa_validate_key_attributes( attributes, p_drv );
1588 if( status != PSA_SUCCESS )
1589 return( status );
1590
Ronald Cronc4d1b512020-07-31 11:26:37 +02001591 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001592 if( status != PSA_SUCCESS )
1593 return( status );
1594 slot = *p_slot;
1595
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001596 /* We're storing the declared bit-size of the key. It's up to each
1597 * creation mechanism to verify that this information is correct.
1598 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001599 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001600 * is optional (import, copy). In case of a volatile key, assign it the
1601 * volatile key identifier associated to the slot returned to contain its
1602 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001603
1604 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001605 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1606 {
1607#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1608 slot->attr.id = volatile_key_id;
1609#else
1610 slot->attr.id.key_id = volatile_key_id;
1611#endif
1612 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001613
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001615 * external-only flags, query `attributes`. Thanks to the check
1616 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001617 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001618 * may have set. */
1619 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001620
Gilles Peskinecbaff462019-07-12 23:46:04 +02001621#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001622 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001623 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001624 * create the key file in internal storage, create the
1625 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001626 * persistent data. This is done by starting a transaction that will
1627 * encompass these three actions.
1628 * For registering a volatile key, we just need to find an appropriate
1629 * slot number inside the SE. Since the key is designated volatile, creating
1630 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001631 /* The first thing to do is to find a slot number for the new key.
1632 * We save the slot number in persistent storage as part of the
1633 * transaction data. It will be needed to recover if the power
1634 * fails during the key creation process, to clean up on the secure
1635 * element side after restarting. Obtaining a slot number from the
1636 * secure element driver updates its persistent state, but we do not yet
1637 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001638 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001639 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001640 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001641 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001642 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001643 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001644 if( status != PSA_SUCCESS )
1645 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001646
1647 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001648 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001649 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1650 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001651 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001652 psa_crypto_transaction.key.id = slot->attr.id;
1653 status = psa_crypto_save_transaction( );
1654 if( status != PSA_SUCCESS )
1655 {
1656 (void) psa_crypto_stop_transaction( );
1657 return( status );
1658 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001659 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001660
1661 status = psa_copy_key_material_into_slot(
1662 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001663 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001664
1665 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1666 {
1667 /* Key registration only makes sense with a secure element. */
1668 return( PSA_ERROR_INVALID_ARGUMENT );
1669 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001670#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1671
Ronald Cronc4d1b512020-07-31 11:26:37 +02001672 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001673}
Gilles Peskine4747d192019-04-17 15:05:45 +02001674
1675/** Finalize the creation of a key once its key material has been set.
1676 *
1677 * This entails writing the key to persistent storage.
1678 *
1679 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001680 * See the documentation of psa_start_key_creation() for the intended use
1681 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001682 *
Ronald Cron5c522922020-11-14 16:35:34 +01001683 * If the finalization succeeds, the function unlocks the key slot (it was
1684 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1685 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001686 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001687 * \param[in,out] slot Pointer to the slot with key material.
1688 * \param[in] driver The secure element driver for the key,
1689 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001690 * \param[out] key On success, identifier of the key. Note that the
1691 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001692 *
1693 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001694 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001695 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1696 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1697 * \retval #PSA_ERROR_ALREADY_EXISTS
1698 * \retval #PSA_ERROR_DATA_INVALID
1699 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001700 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001701 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001702 * \return If this function fails, the key slot is an invalid state.
1703 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001704 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001705static psa_status_t psa_finish_key_creation(
1706 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001707 psa_se_drv_table_entry_t *driver,
1708 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001709{
1710 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001711 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001712 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001713
1714#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001715 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001716 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001717#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1718 if( driver != NULL )
1719 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 psa_key_slot_number_t slot_number =
1722 psa_key_slot_get_slot_number( slot ) ;
1723
Gilles Peskineb46bef22019-07-30 21:32:04 +02001724#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001725 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001726 sizeof( data.slot_number ),
1727 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001728#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001729 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001730 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001731 (uint8_t*) &data,
1732 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001733 }
1734 else
1735#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1736 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001737 /* Key material is saved in export representation in the slot, so
1738 * just pass the slot buffer for storage. */
1739 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001740 slot->key.data,
1741 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001742 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001743 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001744#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1745
Gilles Peskinecbaff462019-07-12 23:46:04 +02001746#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001747 /* Finish the transaction for a key creation. This does not
1748 * happen when registering an existing key. Detect this case
1749 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001750 * creation of a persistent key in a secure element requires a transaction,
1751 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001752 if( driver != NULL &&
1753 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001754 {
1755 status = psa_save_se_persistent_data( driver );
1756 if( status != PSA_SUCCESS )
1757 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001758 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001759 return( status );
1760 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001761 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001762 }
1763#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1764
Ronald Cron50972942020-11-14 11:28:25 +01001765 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001766 {
1767 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001768 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001769 if( status != PSA_SUCCESS )
1770 *key = MBEDTLS_SVC_KEY_ID_INIT;
1771 }
Ronald Cron50972942020-11-14 11:28:25 +01001772
Gilles Peskine4747d192019-04-17 15:05:45 +02001773 return( status );
1774}
1775
1776/** Abort the creation of a key.
1777 *
1778 * You may call this function after calling psa_start_key_creation(),
1779 * or after psa_finish_key_creation() fails. In other circumstances, this
1780 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001781 * See the documentation of psa_start_key_creation() for the intended use
1782 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001783 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001784 * \param[in,out] slot Pointer to the slot with key material.
1785 * \param[in] driver The secure element driver for the key,
1786 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001787 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001788static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001789 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001790{
Gilles Peskine011e4282019-06-26 18:34:38 +02001791 (void) driver;
1792
Gilles Peskine4747d192019-04-17 15:05:45 +02001793 if( slot == NULL )
1794 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001795
1796#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001797 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001798 * element, and the failure happened later (when saving metadata
1799 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001800 * element.
1801 * https://github.com/ARMmbed/mbed-crypto/issues/217
1802 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001803
Gilles Peskined7729582019-08-05 15:55:54 +02001804 /* Abort the ongoing transaction if any (there may not be one if
1805 * the creation process failed before starting one, or if the
1806 * key creation is a registration of a key in a secure element).
1807 * Earlier functions must already have done what it takes to undo any
1808 * partial creation. All that's left is to update the transaction data
1809 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001810 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001811#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1812
Gilles Peskine4747d192019-04-17 15:05:45 +02001813 psa_wipe_key_slot( slot );
1814}
1815
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001816/** Validate optional attributes during key creation.
1817 *
1818 * Some key attributes are optional during key creation. If they are
1819 * specified in the attributes structure, check that they are consistent
1820 * with the data in the slot.
1821 *
1822 * This function should be called near the end of key creation, after
1823 * the slot in memory is fully populated but before saving persistent data.
1824 */
1825static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 const psa_key_slot_t *slot,
1827 const psa_key_attributes_t *attributes )
1828{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001829 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001831 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001832 return( PSA_ERROR_INVALID_ARGUMENT );
1833 }
1834
1835 if( attributes->domain_parameters_size != 0 )
1836 {
John Durkop0e005192020-10-31 22:06:54 -07001837#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1838 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001839 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001840 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001841 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001842 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001844
Ronald Cron90857082020-11-25 14:58:33 +01001845 psa_status_t status = mbedtls_psa_rsa_load_representation(
1846 slot->attr.type,
1847 slot->key.data,
1848 slot->key.bytes,
1849 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001850 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001851 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001852
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 mbedtls_mpi_init( &actual );
1854 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001855 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001856 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001857 mbedtls_rsa_free( rsa );
1858 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001859 if( ret != 0 )
1860 goto rsa_exit;
1861 ret = mbedtls_mpi_read_binary( &required,
1862 attributes->domain_parameters,
1863 attributes->domain_parameters_size );
1864 if( ret != 0 )
1865 goto rsa_exit;
1866 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1867 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1868 rsa_exit:
1869 mbedtls_mpi_free( &actual );
1870 mbedtls_mpi_free( &required );
1871 if( ret != 0)
1872 return( mbedtls_to_psa_error( ret ) );
1873 }
1874 else
John Durkop9814fa22020-11-04 12:28:15 -08001875#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1876 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 {
1878 return( PSA_ERROR_INVALID_ARGUMENT );
1879 }
1880 }
1881
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001882 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001883 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001884 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001885 return( PSA_ERROR_INVALID_ARGUMENT );
1886 }
1887
1888 return( PSA_SUCCESS );
1889}
1890
Gilles Peskine4747d192019-04-17 15:05:45 +02001891psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001892 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001893 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001894 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001895{
1896 psa_status_t status;
1897 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001898 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001899 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301900 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901
Ronald Cron81709fc2020-11-14 12:10:32 +01001902 *key = MBEDTLS_SVC_KEY_ID_INIT;
1903
Gilles Peskine0f84d622019-09-12 19:03:13 +02001904 /* Reject zero-length symmetric keys (including raw data key objects).
1905 * This also rejects any key which might be encoded as an empty string,
1906 * which is never valid. */
1907 if( data_length == 0 )
1908 return( PSA_ERROR_INVALID_ARGUMENT );
1909
Archana449608b2021-09-08 15:36:05 +05301910 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301911 if( data_length > SIZE_MAX / 8 )
1912 return( PSA_ERROR_NOT_SUPPORTED );
1913
Gilles Peskinedf179142019-07-15 22:02:14 +02001914 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001915 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001916 if( status != PSA_SUCCESS )
1917 goto exit;
1918
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001919 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301920 * storage ( thus not in the case of importing a key in a secure element
1921 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1922 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001923 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001924 {
Archanad8a83dc2021-06-14 10:04:16 +05301925 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1926 {
Archana449608b2021-09-08 15:36:05 +05301927 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1928 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301929 if( status != PSA_SUCCESS )
1930 goto exit;
1931 }
1932 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001933 if( status != PSA_SUCCESS )
1934 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001935 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001936
1937 bits = slot->attr.bits;
1938 status = psa_driver_wrapper_import_key( attributes,
1939 data, data_length,
1940 slot->key.data,
1941 slot->key.bytes,
1942 &slot->key.bytes, &bits );
1943 if( status != PSA_SUCCESS )
1944 goto exit;
1945
1946 if( slot->attr.bits == 0 )
1947 slot->attr.bits = (psa_key_bits_t) bits;
1948 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001949 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001950 status = PSA_ERROR_INVALID_ARGUMENT;
1951 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001952 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001953
Archana6ed4bda2021-08-04 10:47:15 +05301954 /* Enforce a size limit, and in particular ensure that the bit
1955 * size fits in its representation type.*/
1956 if( bits > PSA_MAX_KEY_BITS )
1957 {
1958 status = PSA_ERROR_NOT_SUPPORTED;
1959 goto exit;
1960 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001961 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001962 if( status != PSA_SUCCESS )
1963 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001964
Ronald Cron81709fc2020-11-14 12:10:32 +01001965 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001966exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001967 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001968 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001969
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 return( status );
1971}
1972
Gilles Peskined7729582019-08-05 15:55:54 +02001973#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1974psa_status_t mbedtls_psa_register_se_key(
1975 const psa_key_attributes_t *attributes )
1976{
1977 psa_status_t status;
1978 psa_key_slot_t *slot = NULL;
1979 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001980 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001981
1982 /* Leaving attributes unspecified is not currently supported.
1983 * It could make sense to query the key type and size from the
1984 * secure element, but not all secure elements support this
1985 * and the driver HAL doesn't currently support it. */
1986 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1987 return( PSA_ERROR_NOT_SUPPORTED );
1988 if( psa_get_key_bits( attributes ) == 0 )
1989 return( PSA_ERROR_NOT_SUPPORTED );
1990
1991 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001992 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001993 if( status != PSA_SUCCESS )
1994 goto exit;
1995
Ronald Cron81709fc2020-11-14 12:10:32 +01001996 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001997
1998exit:
1999 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002000 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002001
Gilles Peskined7729582019-08-05 15:55:54 +02002002 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002003 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002004 return( status );
2005}
2006#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2007
Ronald Croncf56a0a2020-08-04 09:51:30 +02002008psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002009 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002010 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002011{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002013 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002014 psa_key_slot_t *source_slot = NULL;
2015 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002016 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002017 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302018 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002019
Ronald Cron81709fc2020-11-14 12:10:32 +01002020 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2021
Archana8a180362021-07-05 02:18:48 +05302022 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002023 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002024 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002025 goto exit;
2026
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002027 status = psa_validate_optional_attributes( source_slot,
2028 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002029 if( status != PSA_SUCCESS )
2030 goto exit;
2031
Archana9d17bf42021-09-10 06:22:44 +05302032 /* The target key type and number of bits have been validated by
2033 * psa_validate_optional_attributes() to be either equal to zero or
2034 * equal to the ones of the source key. So it is safe to inherit
2035 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302036 * */
Archana9d17bf42021-09-10 06:22:44 +05302037 actual_attributes.core.bits = source_slot->attr.bits;
2038 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302039
2040
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002041 status = psa_restrict_key_policy( source_slot->attr.type,
2042 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002043 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002044 if( status != PSA_SUCCESS )
2045 goto exit;
2046
Ronald Cron81709fc2020-11-14 12:10:32 +01002047 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2048 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002049 if( status != PSA_SUCCESS )
2050 goto exit;
Archana8a180362021-07-05 02:18:48 +05302051 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2052 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002053 {
Archana8a180362021-07-05 02:18:48 +05302054 /*
Archana9d17bf42021-09-10 06:22:44 +05302055 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302056 * the source key would need to be exported as plaintext and re-imported
2057 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302058 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302059 * appropriate API invocations from the application, if needed.
2060 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002061 status = PSA_ERROR_NOT_SUPPORTED;
2062 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002063 }
Archana8a180362021-07-05 02:18:48 +05302064 /*
2065 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302066 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302067 * - For opaque keys this translates to an invocation of the drivers'
2068 * copy_key entry point through the dispatch layer.
2069 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002070 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2071 {
Archana8a180362021-07-05 02:18:48 +05302072 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302073 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302074 if( status != PSA_SUCCESS )
2075 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302076
Archana8a180362021-07-05 02:18:48 +05302077 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2078 if( status != PSA_SUCCESS )
2079 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302080
Archana8a180362021-07-05 02:18:48 +05302081 status = psa_driver_wrapper_copy_key( &actual_attributes,
2082 source_slot->key.data,
2083 source_slot->key.bytes,
2084 target_slot->key.data,
2085 target_slot->key.bytes,
2086 &target_slot->key.bytes );
2087 if( status != PSA_SUCCESS )
2088 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002089 }
Archana8a180362021-07-05 02:18:48 +05302090 else
2091 {
Archana9d17bf42021-09-10 06:22:44 +05302092 status = psa_copy_key_material_into_slot( target_slot,
2093 source_slot->key.data,
2094 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302095 if( status != PSA_SUCCESS )
2096 goto exit;
2097 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002098 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002099exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002101 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002102
Ronald Cron5c522922020-11-14 16:35:34 +01002103 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002104
Ronald Cron5c522922020-11-14 16:35:34 +01002105 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002106}
2107
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002108
2109
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002110/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002111/* Message digests */
2112/****************************************************************/
2113
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002114psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2115{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002116 /* Aborting a non-active operation is allowed */
2117 if( operation->id == 0 )
2118 return( PSA_SUCCESS );
2119
2120 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2121 operation->id = 0;
2122
2123 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002124}
2125
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002126psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002127 psa_algorithm_t alg )
2128{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002130
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002131 /* A context must be freshly initialized before it can be set up. */
2132 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002133 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002134 status = PSA_ERROR_BAD_STATE;
2135 goto exit;
2136 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002137
2138 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002139 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002140 status = PSA_ERROR_INVALID_ARGUMENT;
2141 goto exit;
2142 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002143
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002144 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2145 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002146 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2147
Dave Rodgman685b6a72021-06-24 11:49:14 +01002148 status = psa_driver_wrapper_hash_setup( operation, alg );
2149
2150exit:
2151 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002152 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153
2154 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155}
2156
2157psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2158 const uint8_t *input,
2159 size_t input_length )
2160{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2162
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002164 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002165 status = PSA_ERROR_BAD_STATE;
2166 goto exit;
2167 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002168
Steven Cooremanc8288352021-03-04 14:02:19 +01002169 /* Don't require hash implementations to behave correctly on a
2170 * zero-length input, which may have an invalid pointer. */
2171 if( input_length == 0 )
2172 return( PSA_SUCCESS );
2173
Dave Rodgman685b6a72021-06-24 11:49:14 +01002174 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2175
2176exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002177 if( status != PSA_SUCCESS )
2178 psa_hash_abort( operation );
2179
2180 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002181}
2182
2183psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2184 uint8_t *hash,
2185 size_t hash_size,
2186 size_t *hash_length )
2187{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002188 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002189 if( operation->id == 0 )
2190 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002191
Steven Cooreman1e582352021-02-18 17:24:37 +01002192 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002193 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002194 psa_hash_abort( operation );
2195 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002196}
2197
Gilles Peskine2d277862018-06-18 15:41:12 +02002198psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2199 const uint8_t *hash,
2200 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201{
Ronald Cron69a63422021-10-18 09:47:58 +02002202 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002204 psa_status_t status = psa_hash_finish(
2205 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002206 actual_hash, sizeof( actual_hash ),
2207 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002208
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002209 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002210 goto exit;
2211
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002213 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002214 status = PSA_ERROR_INVALID_SIGNATURE;
2215 goto exit;
2216 }
2217
Steven Cooreman36876a02021-04-29 16:37:59 +02002218 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002219 status = PSA_ERROR_INVALID_SIGNATURE;
2220
2221exit:
Gilles Peskine60aebec2021-12-13 12:33:18 +01002222 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002223 if( status != PSA_SUCCESS )
2224 psa_hash_abort(operation);
2225
2226 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227}
2228
Gilles Peskine0a749c82019-11-28 19:33:58 +01002229psa_status_t psa_hash_compute( psa_algorithm_t alg,
2230 const uint8_t *input, size_t input_length,
2231 uint8_t *hash, size_t hash_size,
2232 size_t *hash_length )
2233{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002234 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002235 if( !PSA_ALG_IS_HASH( alg ) )
2236 return( PSA_ERROR_INVALID_ARGUMENT );
2237
Steven Cooreman1e582352021-02-18 17:24:37 +01002238 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2239 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002240}
2241
2242psa_status_t psa_hash_compare( psa_algorithm_t alg,
2243 const uint8_t *input, size_t input_length,
2244 const uint8_t *hash, size_t hash_length )
2245{
Ronald Cron69a63422021-10-18 09:47:58 +02002246 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002247 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002248
2249 if( !PSA_ALG_IS_HASH( alg ) )
2250 return( PSA_ERROR_INVALID_ARGUMENT );
2251
Steven Cooreman1e582352021-02-18 17:24:37 +01002252 psa_status_t status = psa_driver_wrapper_hash_compute(
2253 alg, input, input_length,
2254 actual_hash, sizeof(actual_hash),
2255 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002256 if( status != PSA_SUCCESS )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002257 goto exit;
Steven Cooreman84d670d2021-02-18 16:22:53 +01002258 if( actual_hash_length != hash_length )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002259 {
2260 status = PSA_ERROR_INVALID_SIGNATURE;
2261 goto exit;
2262 }
Steven Cooreman36876a02021-04-29 16:37:59 +02002263 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002264 status = PSA_ERROR_INVALID_SIGNATURE;
2265
2266exit:
2267 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
2268 return( status );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002269}
2270
Gilles Peskineeb35d782019-01-22 17:56:16 +01002271psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2272 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002273{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002274 if( source_operation->id == 0 ||
2275 target_operation->id != 0 )
2276 {
2277 return( PSA_ERROR_BAD_STATE );
2278 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002279
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002280 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2281 target_operation );
2282 if( status != PSA_SUCCESS )
2283 psa_hash_abort( target_operation );
2284
2285 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002286}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002287
2288
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002289/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002290/* MAC */
2291/****************************************************************/
2292
Steven Cooremane6804192021-03-19 18:28:56 +01002293psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002294{
Steven Cooremane6804192021-03-19 18:28:56 +01002295 /* Aborting a non-active operation is allowed */
2296 if( operation->id == 0 )
2297 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002298
Steven Cooremane6804192021-03-19 18:28:56 +01002299 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002300 operation->mac_size = 0;
2301 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002302 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002303
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002304 return( status );
2305}
2306
Ronald Cron2dff3b22021-06-17 16:33:22 +02002307static psa_status_t psa_mac_finalize_alg_and_key_validation(
2308 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 const psa_key_attributes_t *attributes,
2310 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002311{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002312 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002313 psa_key_type_t key_type = psa_get_key_type( attributes );
2314 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002315
Ronald Cron28ea0502021-06-17 16:10:24 +02002316 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002317 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002318
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002319 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002320 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002321 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002322 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002323
Steven Cooremand1a68f12021-05-10 11:13:41 +02002324 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002325 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002326
Ronald Cron79bdd822021-06-17 16:46:44 +02002327 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002328 {
2329 /* A very short MAC is too short for security since it can be
2330 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2331 * so we make this our minimum, even though 32 bits is still
2332 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002333 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002334 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002335
Ronald Cron79bdd822021-06-17 16:46:44 +02002336 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2337 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002338 {
2339 /* It's impossible to "truncate" to a larger length than the full length
2340 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002341 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002342 }
2343
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002344 if( *mac_size > PSA_MAC_MAX_SIZE )
2345 {
2346 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2347 * that is disabled in the compile-time configuration. The result can
2348 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2349 * configuration into account. In this case, force a return of
2350 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2351 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2352 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2353 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2354 * systematically generated tests. */
2355 return( PSA_ERROR_NOT_SUPPORTED );
2356 }
2357
Ronald Cron79bdd822021-06-17 16:46:44 +02002358 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002359}
2360
Gilles Peskinee59236f2018-01-27 23:32:46 +01002361static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2362 mbedtls_svc_key_id_t key,
2363 psa_algorithm_t alg,
2364 int is_sign )
2365{
2366 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2367 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002368 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002369
2370 /* A context must be freshly initialized before it can be set up. */
2371 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002372 {
Dave Rodgman54648242021-06-24 11:49:45 +01002373 status = PSA_ERROR_BAD_STATE;
2374 goto exit;
2375 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002376
2377 status = psa_get_and_lock_key_slot_with_policy(
2378 key,
2379 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002380 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002381 alg );
2382 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002383 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002384
2385 psa_key_attributes_t attributes = {
2386 .core = slot->attr
2387 };
2388
Ronald Cron79bdd822021-06-17 16:46:44 +02002389 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2390 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002391 if( status != PSA_SUCCESS )
2392 goto exit;
2393
2394 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002395 /* Dispatch the MAC setup call with validated input */
2396 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002397 {
Steven Cooremane6804192021-03-19 18:28:56 +01002398 status = psa_driver_wrapper_mac_sign_setup( operation,
2399 &attributes,
2400 slot->key.data,
2401 slot->key.bytes,
2402 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002403 }
2404 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002405 {
Steven Cooremane6804192021-03-19 18:28:56 +01002406 status = psa_driver_wrapper_mac_verify_setup( operation,
2407 &attributes,
2408 slot->key.data,
2409 slot->key.bytes,
2410 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002411 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002412
Gilles Peskinefbfac682018-07-08 20:51:54 +02002413exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002414 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002415 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002416
Ronald Cron5c522922020-11-14 16:35:34 +01002417 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002418
Ronald Cron5c522922020-11-14 16:35:34 +01002419 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002420}
2421
Gilles Peskine89167cb2018-07-08 20:12:23 +02002422psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002423 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002424 psa_algorithm_t alg )
2425{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002426 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002427}
2428
2429psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002430 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002431 psa_algorithm_t alg )
2432{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002433 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002434}
2435
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002436psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002437 const uint8_t *input,
2438 size_t input_length )
2439{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002440 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002441 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002442
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002443 /* Don't require hash implementations to behave correctly on a
2444 * zero-length input, which may have an invalid pointer. */
2445 if( input_length == 0 )
2446 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002447
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002448 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2449 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002450 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002451 psa_mac_abort( operation );
2452
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002453 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002454}
2455
Steven Cooremana5b860a2021-03-19 19:04:39 +01002456psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002457 uint8_t *mac,
2458 size_t mac_size,
2459 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002460{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002461 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2462 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002463
Steven Cooremana5b860a2021-03-19 19:04:39 +01002464 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002465 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002466 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002467 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002468 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002469
Steven Cooreman72f736a2021-05-07 14:14:37 +02002470 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002471 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002472 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002473 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002474 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002475
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002476 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2477 * once all the error checks are done. */
2478 if( operation->mac_size == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002479 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002480 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002481 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002482 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002483
2484 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002485 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002486 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002487 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002488 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002489
Steven Cooremana5b860a2021-03-19 19:04:39 +01002490 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002491 mac, operation->mac_size,
2492 mac_length );
2493
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002494exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002495 /* In case of success, set the potential excess room in the output buffer
2496 * to an invalid value, to avoid potentially leaking a longer MAC.
2497 * In case of error, set the output length and content to a safe default,
2498 * such that in case the caller misses an error check, the output would be
2499 * an unachievable MAC.
2500 */
2501 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002502 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002503 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002504 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002505 }
mohammad16036df908f2018-04-02 08:34:15 -07002506
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002507 if( mac_size > operation->mac_size )
2508 memset( &mac[operation->mac_size], '!',
2509 mac_size - operation->mac_size );
2510
Steven Cooremana5b860a2021-03-19 19:04:39 +01002511 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002512
Steven Cooremana5b860a2021-03-19 19:04:39 +01002513 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002514}
2515
Steven Cooremana5b860a2021-03-19 19:04:39 +01002516psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002517 const uint8_t *mac,
2518 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002519{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002520 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2521 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002522
Steven Cooremana5b860a2021-03-19 19:04:39 +01002523 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002524 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002525 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002526 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002527 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002528
Steven Cooreman72f736a2021-05-07 14:14:37 +02002529 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002530 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002531 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002532 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002533 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002534
2535 if( operation->mac_size != mac_length )
2536 {
2537 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002538 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002539 }
2540
Steven Cooremana5b860a2021-03-19 19:04:39 +01002541 status = psa_driver_wrapper_mac_verify_finish( operation,
2542 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002543
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002544exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002545 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002546
Steven Cooremana5b860a2021-03-19 19:04:39 +01002547 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002548}
2549
Ronald Croncd989b52021-06-18 14:23:33 +02002550static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2551 psa_algorithm_t alg,
2552 const uint8_t *input,
2553 size_t input_length,
2554 uint8_t *mac,
2555 size_t mac_size,
2556 size_t *mac_length,
2557 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002558{
2559 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002560 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2561 psa_key_slot_t *slot;
2562 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002563
Ronald Cron51131b52021-06-17 17:17:20 +02002564 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002565 key,
2566 &slot,
2567 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002568 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002569 if( status != PSA_SUCCESS )
2570 goto exit;
2571
Ronald Cron51131b52021-06-17 17:17:20 +02002572 psa_key_attributes_t attributes = {
2573 .core = slot->attr
2574 };
2575
2576 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2577 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002578 if( status != PSA_SUCCESS )
2579 goto exit;
2580
Ronald Cron51131b52021-06-17 17:17:20 +02002581 if( mac_size < operation_mac_size )
2582 {
2583 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002584 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002585 }
2586
2587 status = psa_driver_wrapper_mac_compute(
2588 &attributes,
2589 slot->key.data, slot->key.bytes,
2590 alg,
2591 input, input_length,
2592 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002593
2594exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002595 /* In case of success, set the potential excess room in the output buffer
2596 * to an invalid value, to avoid potentially leaking a longer MAC.
2597 * In case of error, set the output length and content to a safe default,
2598 * such that in case the caller misses an error check, the output would be
2599 * an unachievable MAC.
2600 */
2601 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002602 {
Ronald Cron51131b52021-06-17 17:17:20 +02002603 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002604 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002605 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002606 if( mac_size > operation_mac_size )
2607 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002608
Ronald Cron51131b52021-06-17 17:17:20 +02002609 unlock_status = psa_unlock_key_slot( slot );
2610
2611 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002612}
2613
Ronald Croncd989b52021-06-18 14:23:33 +02002614psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2615 psa_algorithm_t alg,
2616 const uint8_t *input,
2617 size_t input_length,
2618 uint8_t *mac,
2619 size_t mac_size,
2620 size_t *mac_length)
2621{
2622 return( psa_mac_compute_internal( key, alg,
2623 input, input_length,
2624 mac, mac_size, mac_length, 1 ) );
2625}
2626
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002627psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2628 psa_algorithm_t alg,
2629 const uint8_t *input,
2630 size_t input_length,
2631 const uint8_t *mac,
2632 size_t mac_length)
2633{
2634 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002635 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2636 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002637
Ronald Crona587cbc2021-06-18 14:51:29 +02002638 status = psa_mac_compute_internal( key, alg,
2639 input, input_length,
2640 actual_mac, sizeof( actual_mac ),
2641 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002642 if( status != PSA_SUCCESS )
2643 goto exit;
2644
Ronald Crona587cbc2021-06-18 14:51:29 +02002645 if( mac_length != actual_mac_length )
2646 {
2647 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002648 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002649 }
2650 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2651 {
2652 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002653 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002654 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002655
2656exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002657 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002658
2659 return ( status );
2660}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002661
Gilles Peskinee59236f2018-01-27 23:32:46 +01002662/****************************************************************/
2663/* Asymmetric cryptography */
2664/****************************************************************/
2665
gabor-mezei-armf0486182021-05-12 11:03:09 +02002666static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002667 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002668{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002669 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002670 {
2671 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2672 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002673
Gilles Peskinef7b41372021-09-22 16:15:05 +02002674 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002675 {
2676 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2677 return( PSA_ERROR_INVALID_ARGUMENT );
2678 }
2679 }
2680 else
2681 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002682 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002683 return( PSA_ERROR_INVALID_ARGUMENT );
2684 }
2685
2686 return( PSA_SUCCESS );
2687}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002688
2689static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002690 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002691 psa_algorithm_t alg,
2692 const uint8_t * input,
2693 size_t input_length,
2694 uint8_t * signature,
2695 size_t signature_size,
2696 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002697{
2698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2699 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2700 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002701
2702 *signature_length = 0;
2703
gabor-mezei-armf0486182021-05-12 11:03:09 +02002704 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002705 if( status != PSA_SUCCESS )
2706 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002708 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002709 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002710 * buffer can in principle be empty since it doesn't actually have
2711 * to be a hash.) */
2712 if( signature_size == 0 )
2713 return( PSA_ERROR_BUFFER_TOO_SMALL );
2714
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002715 status = psa_get_and_lock_key_slot_with_policy(
2716 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002717 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2718 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002719 alg );
2720
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002721 if( status != PSA_SUCCESS )
2722 goto exit;
2723
2724 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2725 {
2726 status = PSA_ERROR_INVALID_ARGUMENT;
2727 goto exit;
2728 }
2729
2730 psa_key_attributes_t attributes = {
2731 .core = slot->attr
2732 };
2733
gabor-mezei-armf0486182021-05-12 11:03:09 +02002734 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002735 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002736 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002737 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002738 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002739 signature, signature_size, signature_length );
2740 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002741 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002742 {
2743
2744 status = psa_driver_wrapper_sign_hash(
2745 &attributes, slot->key.data, slot->key.bytes,
2746 alg, input, input_length,
2747 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002748 }
2749
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002750
2751exit:
2752 /* Fill the unused part of the output buffer (the whole buffer on error,
2753 * the trailing part on success) with something that isn't a valid signature
2754 * (barring an attack on the signature and deliberately-crafted input),
2755 * in case the caller doesn't check the return status properly. */
2756 if( status == PSA_SUCCESS )
2757 memset( signature + *signature_length, '!',
2758 signature_size - *signature_length );
2759 else
2760 memset( signature, '!', signature_size );
2761 /* If signature_size is 0 then we have nothing to do. We must not call
2762 * memset because signature may be NULL in this case. */
2763
2764 unlock_status = psa_unlock_key_slot( slot );
2765
2766 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2767}
2768
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002769static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002770 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002771 psa_algorithm_t alg,
2772 const uint8_t * input,
2773 size_t input_length,
2774 const uint8_t * signature,
2775 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002776{
2777 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2778 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2779 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002780
gabor-mezei-armf0486182021-05-12 11:03:09 +02002781 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002782 if( status != PSA_SUCCESS )
2783 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002784
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002785 status = psa_get_and_lock_key_slot_with_policy(
2786 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002787 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2788 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002789 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002790
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002791 if( status != PSA_SUCCESS )
2792 return( status );
2793
2794 psa_key_attributes_t attributes = {
2795 .core = slot->attr
2796 };
2797
gabor-mezei-armf0486182021-05-12 11:03:09 +02002798 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002799 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002800 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002801 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002802 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002803 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002804 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002805 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002806 {
2807 status = psa_driver_wrapper_verify_hash(
2808 &attributes, slot->key.data, slot->key.bytes,
2809 alg, input, input_length,
2810 signature, signature_length );
2811 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002812
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002813 unlock_status = psa_unlock_key_slot( slot );
2814
2815 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002816
2817}
2818
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002819psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002820 const psa_key_attributes_t *attributes,
2821 const uint8_t *key_buffer,
2822 size_t key_buffer_size,
2823 psa_algorithm_t alg,
2824 const uint8_t *input,
2825 size_t input_length,
2826 uint8_t *signature,
2827 size_t signature_size,
2828 size_t *signature_length )
2829{
2830 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002831
Gilles Peskinef7b41372021-09-22 16:15:05 +02002832 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002833 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002834 size_t hash_length;
2835 uint8_t hash[PSA_HASH_MAX_SIZE];
2836
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002837 status = psa_driver_wrapper_hash_compute(
2838 PSA_ALG_SIGN_GET_HASH( alg ),
2839 input, input_length,
2840 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002841
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002842 if( status != PSA_SUCCESS )
2843 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002844
2845 return psa_driver_wrapper_sign_hash(
2846 attributes, key_buffer, key_buffer_size,
2847 alg, hash, hash_length,
2848 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002849 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002850
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002851 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002852}
2853
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002854psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2855 psa_algorithm_t alg,
2856 const uint8_t * input,
2857 size_t input_length,
2858 uint8_t * signature,
2859 size_t signature_size,
2860 size_t * signature_length )
2861{
2862 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002863 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002864 signature, signature_size, signature_length );
2865}
2866
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002867psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002868 const psa_key_attributes_t *attributes,
2869 const uint8_t *key_buffer,
2870 size_t key_buffer_size,
2871 psa_algorithm_t alg,
2872 const uint8_t *input,
2873 size_t input_length,
2874 const uint8_t *signature,
2875 size_t signature_length )
2876{
2877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002878
Gilles Peskinef7b41372021-09-22 16:15:05 +02002879 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002880 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002881 size_t hash_length;
2882 uint8_t hash[PSA_HASH_MAX_SIZE];
2883
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002884 status = psa_driver_wrapper_hash_compute(
2885 PSA_ALG_SIGN_GET_HASH( alg ),
2886 input, input_length,
2887 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002888
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002889 if( status != PSA_SUCCESS )
2890 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002891
2892 return psa_driver_wrapper_verify_hash(
2893 attributes, key_buffer, key_buffer_size,
2894 alg, hash, hash_length,
2895 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002896 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002897
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002898 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002899}
2900
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002901psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2902 psa_algorithm_t alg,
2903 const uint8_t * input,
2904 size_t input_length,
2905 const uint8_t * signature,
2906 size_t signature_length )
2907{
2908 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002909 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002910 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002911}
2912
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002913psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002914 const psa_key_attributes_t *attributes,
2915 const uint8_t *key_buffer, size_t key_buffer_size,
2916 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2917 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002918{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002919 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002920 {
Ronald Cron4501c982021-03-19 20:09:32 +01002921 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2922 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002923 {
Ronald Cron4501c982021-03-19 20:09:32 +01002924#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2925 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2926 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002927 attributes,
2928 key_buffer, key_buffer_size,
2929 alg, hash, hash_length,
2930 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002931#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2932 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002933 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002934 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002935 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002936 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002937 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002938 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002939 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Ronald Cron4501c982021-03-19 20:09:32 +01002940 {
2941 if( PSA_ALG_IS_ECDSA( alg ) )
2942 {
2943#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2944 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2945 return( mbedtls_psa_ecdsa_sign_hash(
2946 attributes,
2947 key_buffer, key_buffer_size,
2948 alg, hash, hash_length,
2949 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002950#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2951 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002952 }
2953 else
2954 {
2955 return( PSA_ERROR_INVALID_ARGUMENT );
2956 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002957 }
Ronald Cron4501c982021-03-19 20:09:32 +01002958
2959 (void)key_buffer;
2960 (void)key_buffer_size;
2961 (void)hash;
2962 (void)hash_length;
2963 (void)signature;
2964 (void)signature_size;
2965 (void)signature_length;
2966
2967 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002968}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002969
2970psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2971 psa_algorithm_t alg,
2972 const uint8_t *hash,
2973 size_t hash_length,
2974 uint8_t *signature,
2975 size_t signature_size,
2976 size_t *signature_length )
2977{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002978 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002979 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002980 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002981}
2982
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002983psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002984 const psa_key_attributes_t *attributes,
2985 const uint8_t *key_buffer, size_t key_buffer_size,
2986 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2987 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002988{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002989 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002990 {
Ronald Cron4501c982021-03-19 20:09:32 +01002991 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2992 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002993 {
Ronald Cron4501c982021-03-19 20:09:32 +01002994#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2995 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2996 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002997 attributes,
2998 key_buffer, key_buffer_size,
2999 alg, hash, hash_length,
3000 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01003001#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3002 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02003003 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003004 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003005 {
Ronald Cron8a494f32021-02-17 09:49:51 +01003006 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003007 }
itayzafrir5c753392018-05-08 11:18:38 +03003008 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02003009 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003010 {
Ronald Cron4501c982021-03-19 20:09:32 +01003011 if( PSA_ALG_IS_ECDSA( alg ) )
3012 {
3013#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3014 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3015 return( mbedtls_psa_ecdsa_verify_hash(
3016 attributes,
3017 key_buffer, key_buffer_size,
3018 alg, hash, hash_length,
3019 signature, signature_length ) );
3020#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3021 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3022 }
3023 else
3024 {
3025 return( PSA_ERROR_INVALID_ARGUMENT );
3026 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003027 }
Ronald Cron4501c982021-03-19 20:09:32 +01003028
3029 (void)key_buffer;
3030 (void)key_buffer_size;
3031 (void)hash;
3032 (void)hash_length;
3033 (void)signature;
3034 (void)signature_length;
3035
3036 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003037}
3038
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003039psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3040 psa_algorithm_t alg,
3041 const uint8_t *hash,
3042 size_t hash_length,
3043 const uint8_t *signature,
3044 size_t signature_length )
3045{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003046 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003047 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003048 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003049}
3050
Ronald Croncf56a0a2020-08-04 09:51:30 +02003051psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003052 psa_algorithm_t alg,
3053 const uint8_t *input,
3054 size_t input_length,
3055 const uint8_t *salt,
3056 size_t salt_length,
3057 uint8_t *output,
3058 size_t output_size,
3059 size_t *output_length )
3060{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003061 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003062 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003063 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003064
Darryl Green5cc689a2018-07-24 15:34:10 +01003065 (void) input;
3066 (void) input_length;
3067 (void) salt;
3068 (void) output;
3069 (void) output_size;
3070
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003071 *output_length = 0;
3072
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003073 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3074 return( PSA_ERROR_INVALID_ARGUMENT );
3075
Ronald Cron5c522922020-11-14 16:35:34 +01003076 status = psa_get_and_lock_transparent_key_slot_with_policy(
3077 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003078 if( status != PSA_SUCCESS )
3079 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003080 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3081 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003082 {
3083 status = PSA_ERROR_INVALID_ARGUMENT;
3084 goto exit;
3085 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003086
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003087 psa_key_attributes_t attributes = {
3088 .core = slot->attr
3089 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003090
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003091 status = psa_driver_wrapper_asymmetric_encrypt(
3092 &attributes, slot->key.data, slot->key.bytes,
3093 alg, input, input_length, salt, salt_length,
3094 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003095exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003096 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003097
Ronald Cron5c522922020-11-14 16:35:34 +01003098 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003099}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003100
Ronald Croncf56a0a2020-08-04 09:51:30 +02003101psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003102 psa_algorithm_t alg,
3103 const uint8_t *input,
3104 size_t input_length,
3105 const uint8_t *salt,
3106 size_t salt_length,
3107 uint8_t *output,
3108 size_t output_size,
3109 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003110{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003112 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003113 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003114
Darryl Green5cc689a2018-07-24 15:34:10 +01003115 (void) input;
3116 (void) input_length;
3117 (void) salt;
3118 (void) output;
3119 (void) output_size;
3120
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003121 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003123 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3124 return( PSA_ERROR_INVALID_ARGUMENT );
3125
Ronald Cron5c522922020-11-14 16:35:34 +01003126 status = psa_get_and_lock_transparent_key_slot_with_policy(
3127 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003128 if( status != PSA_SUCCESS )
3129 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003130 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003131 {
3132 status = PSA_ERROR_INVALID_ARGUMENT;
3133 goto exit;
3134 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003135
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003136 psa_key_attributes_t attributes = {
3137 .core = slot->attr
3138 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003139
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003140 status = psa_driver_wrapper_asymmetric_decrypt(
3141 &attributes, slot->key.data, slot->key.bytes,
3142 alg, input, input_length, salt, salt_length,
3143 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003144
3145exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003146 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003147
Ronald Cron5c522922020-11-14 16:35:34 +01003148 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003149}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003150
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003151
3152
mohammad1603503973b2018-03-12 15:59:30 +02003153/****************************************************************/
3154/* Symmetric cryptography */
3155/****************************************************************/
3156
Ronald Cronab99ac22020-10-01 16:38:28 +02003157static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3158 mbedtls_svc_key_id_t key,
3159 psa_algorithm_t alg,
3160 mbedtls_operation_t cipher_operation )
3161{
3162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3163 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003164 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003165 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3166 PSA_KEY_USAGE_ENCRYPT :
3167 PSA_KEY_USAGE_DECRYPT );
3168
3169 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003170 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003171 {
Dave Rodgman54648242021-06-24 11:49:45 +01003172 status = PSA_ERROR_BAD_STATE;
3173 goto exit;
3174 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003175
Ronald Cronab99ac22020-10-01 16:38:28 +02003176 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003177 {
Dave Rodgman54648242021-06-24 11:49:45 +01003178 status = PSA_ERROR_INVALID_ARGUMENT;
3179 goto exit;
3180 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003181
Ronald Cronab99ac22020-10-01 16:38:28 +02003182 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3183 if( status != PSA_SUCCESS )
3184 goto exit;
3185
Ronald Cron49fafa92021-03-10 08:34:23 +01003186 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003187 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003188 * so we only set it (in the driver wrapper) after resources have been
3189 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003190 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003191 if( alg == PSA_ALG_ECB_NO_PADDING )
3192 operation->iv_required = 0;
3193 else
3194 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003195 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003196
Ronald Crona4af55f2020-12-14 14:36:06 +01003197 psa_key_attributes_t attributes = {
3198 .core = slot->attr
3199 };
3200
Ronald Cronab99ac22020-10-01 16:38:28 +02003201 /* Try doing the operation through a driver before using software fallback. */
3202 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003203 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3204 &attributes,
3205 slot->key.data,
3206 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003207 alg );
3208 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003209 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3210 &attributes,
3211 slot->key.data,
3212 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003213 alg );
3214
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003215exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003216 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003217 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003218
Ronald Cron5c522922020-11-14 16:35:34 +01003219 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003220
Ronald Cron5c522922020-11-14 16:35:34 +01003221 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003222}
3223
Gilles Peskinefe119512018-07-08 21:39:34 +02003224psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003225 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003226 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003227{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003228 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003229}
3230
Gilles Peskinefe119512018-07-08 21:39:34 +02003231psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003232 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003233 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003234{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003235 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003236}
3237
Gilles Peskinefe119512018-07-08 21:39:34 +02003238psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003239 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003240 size_t iv_size,
3241 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003242{
Ronald Cron6d051732020-10-01 14:10:20 +02003243 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003244 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3245 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003246
Ronald Cron49fafa92021-03-10 08:34:23 +01003247 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003248 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003249 status = PSA_ERROR_BAD_STATE;
3250 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003251 }
3252
Steven Cooreman7df02922020-09-09 15:28:49 +02003253 if( operation->iv_set || ! operation->iv_required )
3254 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003255 status = PSA_ERROR_BAD_STATE;
3256 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003257 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003258
Ronald Cron2fb90522021-07-05 12:31:44 +02003259 default_iv_length = operation->default_iv_length;
3260 if( iv_size < default_iv_length )
Ronald Cron5618a392021-03-26 09:52:26 +01003261 {
3262 status = PSA_ERROR_BUFFER_TOO_SMALL;
3263 goto exit;
3264 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003265
Ronald Cron2fb90522021-07-05 12:31:44 +02003266 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
3267 {
3268 status = PSA_ERROR_GENERIC_ERROR;
3269 goto exit;
3270 }
3271
3272 status = psa_generate_random( local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003273 if( status != PSA_SUCCESS )
3274 goto exit;
3275
3276 status = psa_driver_wrapper_cipher_set_iv( operation,
Ronald Cron2fb90522021-07-05 12:31:44 +02003277 local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003278
3279exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003280 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003281 {
Ronald Cron2fb90522021-07-05 12:31:44 +02003282 memcpy( iv, local_iv, default_iv_length );
3283 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003284 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003285 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003286 else
Ronald Cron2fb90522021-07-05 12:31:44 +02003287 {
3288 *iv_length = 0;
Moran Peker395db872018-05-31 14:07:14 +03003289 psa_cipher_abort( operation );
Ronald Cron2fb90522021-07-05 12:31:44 +02003290 }
Ronald Cron6d051732020-10-01 14:10:20 +02003291
itayzafrir534bd7c2018-08-02 13:56:32 +03003292 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003293}
3294
Gilles Peskinefe119512018-07-08 21:39:34 +02003295psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003296 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003297 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003298{
Ronald Cron6d051732020-10-01 14:10:20 +02003299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003300
Ronald Cron49fafa92021-03-10 08:34:23 +01003301 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003302 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003303 status = PSA_ERROR_BAD_STATE;
3304 goto exit;
3305 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003306
Steven Cooreman7df02922020-09-09 15:28:49 +02003307 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003308 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003309 status = PSA_ERROR_BAD_STATE;
3310 goto exit;
3311 }
Ronald Crona0d68172021-03-26 10:15:08 +01003312
3313 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003314 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003315 status = PSA_ERROR_INVALID_ARGUMENT;
3316 goto exit;
3317 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003318
Ronald Crondd24c9b2020-12-15 14:10:01 +01003319 status = psa_driver_wrapper_cipher_set_iv( operation,
3320 iv,
3321 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003322
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003323exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003324 if( status == PSA_SUCCESS )
3325 operation->iv_set = 1;
3326 else
mohammad1603503973b2018-03-12 15:59:30 +02003327 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003328 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003329}
3330
Gilles Peskinee553c652018-06-04 16:22:46 +02003331psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3332 const uint8_t *input,
3333 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003334 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003335 size_t output_size,
3336 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003337{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003339
Ronald Cron49fafa92021-03-10 08:34:23 +01003340 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003341 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003342 status = PSA_ERROR_BAD_STATE;
3343 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003344 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003345
Steven Cooreman7df02922020-09-09 15:28:49 +02003346 if( operation->iv_required && ! operation->iv_set )
3347 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003348 status = PSA_ERROR_BAD_STATE;
3349 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003350 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003351
Ronald Crondd24c9b2020-12-15 14:10:01 +01003352 status = psa_driver_wrapper_cipher_update( operation,
3353 input,
3354 input_length,
3355 output,
3356 output_size,
3357 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003358
3359exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003360 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003361 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003362
itayzafrir534bd7c2018-08-02 13:56:32 +03003363 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003364}
3365
Gilles Peskinee553c652018-06-04 16:22:46 +02003366psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3367 uint8_t *output,
3368 size_t output_size,
3369 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003370{
David Saadab4ecc272019-02-14 13:48:10 +02003371 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003372
Ronald Cron49fafa92021-03-10 08:34:23 +01003373 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003374 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003375 status = PSA_ERROR_BAD_STATE;
3376 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003377 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003378
Steven Cooreman7df02922020-09-09 15:28:49 +02003379 if( operation->iv_required && ! operation->iv_set )
3380 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003381 status = PSA_ERROR_BAD_STATE;
3382 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003383 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003384
Ronald Crondd24c9b2020-12-15 14:10:01 +01003385 status = psa_driver_wrapper_cipher_finish( operation,
3386 output,
3387 output_size,
3388 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003389
3390exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003391 if( status == PSA_SUCCESS )
3392 return( psa_cipher_abort( operation ) );
3393 else
3394 {
3395 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003396 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003397
Steven Cooremanef8575e2020-09-11 11:44:50 +02003398 return( status );
3399 }
mohammad1603503973b2018-03-12 15:59:30 +02003400}
3401
Gilles Peskinee553c652018-06-04 16:22:46 +02003402psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3403{
Ronald Cron49fafa92021-03-10 08:34:23 +01003404 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003405 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003406 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003407 * in use. It's ok to call abort on such an object, and there's
3408 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003409 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003410 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003411
Ronald Crondd24c9b2020-12-15 14:10:01 +01003412 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003413
Ronald Cron49fafa92021-03-10 08:34:23 +01003414 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003415 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003416 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003417
Moran Peker395db872018-05-31 14:07:14 +03003418 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003419}
3420
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003421psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3422 psa_algorithm_t alg,
3423 const uint8_t *input,
3424 size_t input_length,
3425 uint8_t *output,
3426 size_t output_size,
3427 size_t *output_length )
3428{
3429 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003430 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003431 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02003432 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3433 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003434
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003435 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003436 {
3437 status = PSA_ERROR_INVALID_ARGUMENT;
3438 goto exit;
3439 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003440
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003441 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3442 PSA_KEY_USAGE_ENCRYPT,
3443 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003444 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003445 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003446
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003447 psa_key_attributes_t attributes = {
3448 .core = slot->attr
3449 };
3450
Ronald Cronc6e6f502021-07-09 18:44:58 +02003451 default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
3452 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003453 {
Ronald Cronc6e6f502021-07-09 18:44:58 +02003454 status = PSA_ERROR_GENERIC_ERROR;
3455 goto exit;
3456 }
3457
3458 if( default_iv_length > 0 )
3459 {
3460 if( output_size < default_iv_length )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003461 {
3462 status = PSA_ERROR_BUFFER_TOO_SMALL;
3463 goto exit;
3464 }
3465
Ronald Cronc6e6f502021-07-09 18:44:58 +02003466 status = psa_generate_random( local_iv, default_iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003467 if( status != PSA_SUCCESS )
3468 goto exit;
3469 }
3470
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003471 status = psa_driver_wrapper_cipher_encrypt(
3472 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02003473 alg, local_iv, default_iv_length, input, input_length,
3474 output + default_iv_length, output_size - default_iv_length,
3475 output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003476
3477exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003478 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003479 if( status == PSA_SUCCESS )
3480 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003481
Ronald Cron9b674282021-07-09 09:19:35 +02003482 if( status == PSA_SUCCESS )
Ronald Cronc6e6f502021-07-09 18:44:58 +02003483 {
3484 if( default_iv_length > 0 )
3485 memcpy( output, local_iv, default_iv_length );
3486 *output_length += default_iv_length;
3487 }
Ronald Cron9b674282021-07-09 09:19:35 +02003488 else
Ronald Cron23919522021-07-08 19:00:07 +02003489 *output_length = 0;
3490
3491 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003492}
3493
3494psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3495 psa_algorithm_t alg,
3496 const uint8_t *input,
3497 size_t input_length,
3498 uint8_t *output,
3499 size_t output_size,
3500 size_t *output_length )
3501{
3502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003503 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003504 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003505
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003506 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003507 {
3508 status = PSA_ERROR_INVALID_ARGUMENT;
3509 goto exit;
3510 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003511
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003512 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3513 PSA_KEY_USAGE_DECRYPT,
3514 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003515 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003516 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003517
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003518 psa_key_attributes_t attributes = {
3519 .core = slot->attr
3520 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003521
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003522 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3523 {
3524 status = PSA_ERROR_INVALID_ARGUMENT;
3525 goto exit;
3526 }
3527 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003528 {
3529 status = PSA_ERROR_INVALID_ARGUMENT;
3530 goto exit;
3531 }
3532
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003533 status = psa_driver_wrapper_cipher_decrypt(
3534 &attributes, slot->key.data, slot->key.bytes,
3535 alg, input, input_length,
3536 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003537
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003538exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003539 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003540 if( status == PSA_SUCCESS )
3541 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003542
Ronald Cron23919522021-07-08 19:00:07 +02003543 if( status != PSA_SUCCESS )
3544 *output_length = 0;
3545
3546 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003547}
3548
3549
mohammad16035955c982018-04-26 00:53:03 +03003550/****************************************************************/
3551/* AEAD */
3552/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003553
Paul Elliottbaff51c2021-09-28 17:44:45 +01003554/* Helper function to get the base algorithm from its variants. */
3555static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3556{
3557 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3558}
3559
3560/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003561static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3562 size_t nonce_length )
3563{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003564 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3565
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003566 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003567 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003568#if defined(PSA_WANT_ALG_GCM)
3569 case PSA_ALG_GCM:
3570 /* Not checking max nonce size here as GCM spec allows almost
3571 * arbitrarily large nonces. Please note that we do not generally
3572 * recommend the usage of nonces of greater length than
3573 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3574 * size, which can then lead to collisions if you encrypt a very
3575 * large number of messages.*/
3576 if( nonce_length != 0 )
3577 return( PSA_SUCCESS );
3578 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003579#endif /* PSA_WANT_ALG_GCM */
3580#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003581 case PSA_ALG_CCM:
3582 if( nonce_length >= 7 && nonce_length <= 13 )
3583 return( PSA_SUCCESS );
3584 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003585#endif /* PSA_WANT_ALG_CCM */
3586#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003587 case PSA_ALG_CHACHA20_POLY1305:
3588 if( nonce_length == 12 )
3589 return( PSA_SUCCESS );
Bence Szépkúti6d48e202021-11-15 20:04:15 +01003590 else if( nonce_length == 8 )
3591 return( PSA_ERROR_NOT_SUPPORTED );
3592 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003593#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003594 default:
Przemek Stekielff1efc92022-10-02 21:12:17 +02003595 (void) nonce_length;
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003596 return( PSA_ERROR_NOT_SUPPORTED );
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003597 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003598
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003599 return( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003600}
3601
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01003602static psa_status_t psa_aead_check_algorithm( psa_algorithm_t alg )
3603{
Bence Szépkúti08f34652021-12-08 21:07:13 +01003604 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3605 return( PSA_ERROR_INVALID_ARGUMENT );
3606
3607 return( PSA_SUCCESS );
3608}
3609
Ronald Croncf56a0a2020-08-04 09:51:30 +02003610psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003611 psa_algorithm_t alg,
3612 const uint8_t *nonce,
3613 size_t nonce_length,
3614 const uint8_t *additional_data,
3615 size_t additional_data_length,
3616 const uint8_t *plaintext,
3617 size_t plaintext_length,
3618 uint8_t *ciphertext,
3619 size_t ciphertext_size,
3620 size_t *ciphertext_length )
3621{
Ronald Cron215633c2021-03-16 17:15:37 +01003622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3623 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003624
mohammad1603f08a5502018-06-03 15:05:47 +03003625 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003626
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003627 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003628 if( status != PSA_SUCCESS )
3629 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003630
Ronald Cron9a986162021-03-26 12:40:07 +01003631 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003632 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003633 if( status != PSA_SUCCESS )
3634 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003635
Ronald Cron215633c2021-03-16 17:15:37 +01003636 psa_key_attributes_t attributes = {
3637 .core = slot->attr
3638 };
mohammad16035955c982018-04-26 00:53:03 +03003639
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003640 status = psa_aead_check_nonce_length( alg, nonce_length );
3641 if( status != PSA_SUCCESS )
3642 goto exit;
3643
Ronald Cronde822812021-03-17 16:08:20 +01003644 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003645 &attributes, slot->key.data, slot->key.bytes,
3646 alg,
3647 nonce, nonce_length,
3648 additional_data, additional_data_length,
3649 plaintext, plaintext_length,
3650 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003651
Gilles Peskineedf9a652018-08-17 18:11:56 +02003652 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3653 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003654
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003655exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003656 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003657
mohammad16035955c982018-04-26 00:53:03 +03003658 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003659}
3660
Ronald Croncf56a0a2020-08-04 09:51:30 +02003661psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003662 psa_algorithm_t alg,
3663 const uint8_t *nonce,
3664 size_t nonce_length,
3665 const uint8_t *additional_data,
3666 size_t additional_data_length,
3667 const uint8_t *ciphertext,
3668 size_t ciphertext_length,
3669 uint8_t *plaintext,
3670 size_t plaintext_size,
3671 size_t *plaintext_length )
3672{
Ronald Cron215633c2021-03-16 17:15:37 +01003673 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3674 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003675
Gilles Peskineee652a32018-06-01 19:23:52 +02003676 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003677
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003678 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003679 if( status != PSA_SUCCESS )
3680 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003681
Ronald Cron9a986162021-03-26 12:40:07 +01003682 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003683 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003684 if( status != PSA_SUCCESS )
3685 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003686
Ronald Cron215633c2021-03-16 17:15:37 +01003687 psa_key_attributes_t attributes = {
3688 .core = slot->attr
3689 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003690
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003691 status = psa_aead_check_nonce_length( alg, nonce_length );
3692 if( status != PSA_SUCCESS )
3693 goto exit;
3694
Ronald Cronde822812021-03-17 16:08:20 +01003695 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003696 &attributes, slot->key.data, slot->key.bytes,
3697 alg,
3698 nonce, nonce_length,
3699 additional_data, additional_data_length,
3700 ciphertext, ciphertext_length,
3701 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003702
Gilles Peskineedf9a652018-08-17 18:11:56 +02003703 if( status != PSA_SUCCESS && plaintext_size != 0 )
3704 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003705
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003706exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003707 psa_unlock_key_slot( slot );
3708
Gilles Peskineedf9a652018-08-17 18:11:56 +02003709 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003710}
3711
Przemek Stekiel86679c72022-10-06 17:06:56 +02003712static psa_status_t psa_validate_tag_length( psa_algorithm_t alg ) {
Przemek Stekiel8a05a642022-10-06 17:01:58 +02003713 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg );
Andrzej Kurekf8816012021-12-19 17:00:12 +01003714
3715 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
3716 {
Przemek Stekiel86679c72022-10-06 17:06:56 +02003717#if defined(PSA_WANT_ALG_CCM)
Andrzej Kurekf8816012021-12-19 17:00:12 +01003718 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
3719 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
3720 if( tag_len < 4 || tag_len > 16 || tag_len % 2 )
3721 return( PSA_ERROR_INVALID_ARGUMENT );
3722 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02003723#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01003724
Przemek Stekiel86679c72022-10-06 17:06:56 +02003725#if defined(PSA_WANT_ALG_GCM)
Andrzej Kurekf8816012021-12-19 17:00:12 +01003726 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
3727 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
3728 if( tag_len != 4 && tag_len != 8 && ( tag_len < 12 || tag_len > 16 ) )
3729 return( PSA_ERROR_INVALID_ARGUMENT );
3730 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02003731#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01003732
Przemek Stekiel86679c72022-10-06 17:06:56 +02003733#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Andrzej Kurekf8816012021-12-19 17:00:12 +01003734 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
3735 /* We only support the default tag length. */
3736 if( tag_len != 16 )
3737 return( PSA_ERROR_INVALID_ARGUMENT );
3738 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02003739#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01003740
3741 default:
3742 (void) tag_len;
3743 return( PSA_ERROR_NOT_SUPPORTED );
3744 }
3745 return( PSA_SUCCESS );
3746}
3747
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003748/* Set the key for a multipart authenticated operation. */
3749static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003750 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003751 mbedtls_svc_key_id_t key,
3752 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003753{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003754 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3755 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3756 psa_key_slot_t *slot = NULL;
3757 psa_key_usage_t key_usage = 0;
3758
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003759 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003760 if( status != PSA_SUCCESS )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003761 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003762
3763 if( operation->id != 0 )
3764 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003765 status = PSA_ERROR_BAD_STATE;
3766 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003767 }
3768
3769 if( operation->nonce_set || operation->lengths_set ||
3770 operation->ad_started || operation->body_started )
3771 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003772 status = PSA_ERROR_BAD_STATE;
3773 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003774 }
3775
Paul Elliottd9343f22021-08-23 18:59:49 +01003776 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003777 key_usage = PSA_KEY_USAGE_ENCRYPT;
3778 else
3779 key_usage = PSA_KEY_USAGE_DECRYPT;
3780
3781 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3782 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003783 if( status != PSA_SUCCESS )
3784 goto exit;
3785
3786 psa_key_attributes_t attributes = {
3787 .core = slot->attr
3788 };
3789
Paul Elliottd9343f22021-08-23 18:59:49 +01003790 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003791 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3792 &attributes,
3793 slot->key.data,
3794 slot->key.bytes,
3795 alg );
3796 else
3797 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3798 &attributes,
3799 slot->key.data,
3800 slot->key.bytes,
3801 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003802 if( status != PSA_SUCCESS )
3803 goto exit;
3804
Przemek Stekiel86679c72022-10-06 17:06:56 +02003805 if( ( status = psa_validate_tag_length( alg ) ) != PSA_SUCCESS )
Andrzej Kurekf8816012021-12-19 17:00:12 +01003806 goto exit;
3807
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003808 operation->key_type = psa_get_key_type( &attributes );
3809
3810exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003811 unlock_status = psa_unlock_key_slot( slot );
3812
3813 if( status == PSA_SUCCESS )
3814 {
3815 status = unlock_status;
3816 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003817 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003818 }
3819 else
3820 psa_aead_abort( operation );
3821
3822 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003823}
3824
Paul Elliott302ff6b2021-04-20 18:10:30 +01003825/* Set the key for a multipart authenticated encryption operation. */
3826psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3827 mbedtls_svc_key_id_t key,
3828 psa_algorithm_t alg )
3829{
Paul Elliottd9343f22021-08-23 18:59:49 +01003830 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003831}
3832
3833/* Set the key for a multipart authenticated decryption operation. */
3834psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3835 mbedtls_svc_key_id_t key,
3836 psa_algorithm_t alg )
3837{
Paul Elliottd9343f22021-08-23 18:59:49 +01003838 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003839}
3840
3841/* Generate a random nonce / IV for multipart AEAD operation */
3842psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3843 uint8_t *nonce,
3844 size_t nonce_size,
3845 size_t *nonce_length )
3846{
3847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01003848 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01003849 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003850
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003851 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003852
Paul Elliottcee785c2021-05-20 14:29:20 +01003853 if( operation->id == 0 )
3854 {
3855 status = PSA_ERROR_BAD_STATE;
3856 goto exit;
3857 }
3858
Paul Elliottdaf5c892021-08-25 16:24:58 +01003859 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003860 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003861 status = PSA_ERROR_BAD_STATE;
3862 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003863 }
3864
Paul Elliotte193ea82021-10-01 13:00:16 +01003865 /* For CCM, this size may not be correct according to the PSA
3866 * specification. The PSA Crypto 1.0.1 specification states:
3867 *
3868 * CCM encodes the plaintext length pLen in L octets, with L the smallest
3869 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
3870 *
3871 * However this restriction that L has to be the smallest integer is not
3872 * applied in practice, and it is not implementable here since the
3873 * plaintext length may or may not be known at this time. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003874 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003875 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003876 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003877 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003878 status = PSA_ERROR_BUFFER_TOO_SMALL;
3879 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003880 }
3881
Ronald Croncae59092021-11-26 18:53:58 +01003882 status = psa_generate_random( local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003883 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003884 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003885
Ronald Croncae59092021-11-26 18:53:58 +01003886 status = psa_aead_set_nonce( operation, local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003887
Paul Elliott39dc6b82021-05-11 19:16:09 +01003888exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003889 if( status == PSA_SUCCESS )
Ronald Croncae59092021-11-26 18:53:58 +01003890 {
3891 memcpy( nonce, local_nonce, required_nonce_size );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003892 *nonce_length = required_nonce_size;
Ronald Croncae59092021-11-26 18:53:58 +01003893 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003894 else
3895 psa_aead_abort( operation );
3896
3897 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003898}
3899
3900/* Set the nonce for a multipart authenticated encryption or decryption
3901 operation.*/
3902psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3903 const uint8_t *nonce,
3904 size_t nonce_length )
3905{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3907
Paul Elliottcee785c2021-05-20 14:29:20 +01003908 if( operation->id == 0 )
3909 {
3910 status = PSA_ERROR_BAD_STATE;
3911 goto exit;
3912 }
3913
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003914 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003915 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003916 status = PSA_ERROR_BAD_STATE;
3917 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003918 }
3919
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003920 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003921 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003922 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003923 status = PSA_ERROR_INVALID_ARGUMENT;
3924 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003925 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003926
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003927 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3928 nonce_length );
3929
Paul Elliott39dc6b82021-05-11 19:16:09 +01003930exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003931 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003932 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003933 else
3934 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003935
3936 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003937}
3938
3939/* Declare the lengths of the message and additional data for multipart AEAD. */
3940psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3941 size_t ad_length,
3942 size_t plaintext_length )
3943{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003944 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3945
Paul Elliottcee785c2021-05-20 14:29:20 +01003946 if( operation->id == 0 )
3947 {
3948 status = PSA_ERROR_BAD_STATE;
3949 goto exit;
3950 }
3951
Paul Elliott6eb95982021-05-21 17:41:41 +01003952 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003953 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003954 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003955 status = PSA_ERROR_BAD_STATE;
3956 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003957 }
3958
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003959 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003960 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003961#if defined(PSA_WANT_ALG_GCM)
3962 case PSA_ALG_GCM:
3963 /* Lengths can only be too large for GCM if size_t is bigger than 32
3964 * bits. Without the guard this code will generate warnings on 32bit
3965 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003966#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003967 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3968 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3969 {
3970 status = PSA_ERROR_INVALID_ARGUMENT;
3971 goto exit;
3972 }
Paul Elliott325d3742021-09-27 17:56:28 +01003973#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003974 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003975#endif /* PSA_WANT_ALG_GCM */
3976#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003977 case PSA_ALG_CCM:
3978 if( ad_length > 0xFF00 )
3979 {
3980 status = PSA_ERROR_INVALID_ARGUMENT;
3981 goto exit;
3982 }
3983 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003984#endif /* PSA_WANT_ALG_CCM */
3985#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003986 case PSA_ALG_CHACHA20_POLY1305:
3987 /* No length restrictions for ChaChaPoly. */
3988 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003989#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003990 default:
3991 break;
3992 }
Paul Elliott325d3742021-09-27 17:56:28 +01003993
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003994 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3995 plaintext_length );
3996
Paul Elliott39dc6b82021-05-11 19:16:09 +01003997exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003998 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003999 {
4000 operation->ad_remaining = ad_length;
4001 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004002 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01004003 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004004 else
4005 psa_aead_abort( operation );
4006
4007 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004008}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004009
4010/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004011psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4012 const uint8_t *input,
4013 size_t input_length )
4014{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4016
Paul Elliottcee785c2021-05-20 14:29:20 +01004017 if( operation->id == 0 )
4018 {
4019 status = PSA_ERROR_BAD_STATE;
4020 goto exit;
4021 }
4022
Paul Elliott6eb95982021-05-21 17:41:41 +01004023 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004024 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004025 status = PSA_ERROR_BAD_STATE;
4026 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004027 }
4028
Paul Elliottee4ffe02021-05-20 17:25:06 +01004029 if( operation->lengths_set )
4030 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004031 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004032 {
4033 status = PSA_ERROR_INVALID_ARGUMENT;
4034 goto exit;
4035 }
4036
4037 operation->ad_remaining -= input_length;
4038 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004039#if defined(PSA_WANT_ALG_CCM)
4040 else if( operation->alg == PSA_ALG_CCM )
4041 {
4042 status = PSA_ERROR_BAD_STATE;
4043 goto exit;
4044 }
4045#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004046
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004047 status = psa_driver_wrapper_aead_update_ad( operation, input,
4048 input_length );
4049
Paul Elliott39dc6b82021-05-11 19:16:09 +01004050exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004051 if( status == PSA_SUCCESS )
4052 operation->ad_started = 1;
4053 else
4054 psa_aead_abort( operation );
4055
4056 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004057}
4058
4059/* Encrypt or decrypt a message fragment in an active multipart AEAD
4060 operation.*/
4061psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4062 const uint8_t *input,
4063 size_t input_length,
4064 uint8_t *output,
4065 size_t output_size,
4066 size_t *output_length )
4067{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004068 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004069
4070 *output_length = 0;
4071
Paul Elliottcee785c2021-05-20 14:29:20 +01004072 if( operation->id == 0 )
4073 {
4074 status = PSA_ERROR_BAD_STATE;
4075 goto exit;
4076 }
4077
Paul Elliott6eb95982021-05-21 17:41:41 +01004078 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004079 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004080 status = PSA_ERROR_BAD_STATE;
4081 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004082 }
4083
Paul Elliottee4ffe02021-05-20 17:25:06 +01004084 if( operation->lengths_set )
4085 {
4086 /* Additional data length was supplied, but not all the additional
4087 data was supplied.*/
4088 if( operation->ad_remaining != 0 )
4089 {
4090 status = PSA_ERROR_INVALID_ARGUMENT;
4091 goto exit;
4092 }
4093
4094 /* Too much data provided. */
4095 if( operation->body_remaining < input_length )
4096 {
4097 status = PSA_ERROR_INVALID_ARGUMENT;
4098 goto exit;
4099 }
4100
4101 operation->body_remaining -= input_length;
4102 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004103#if defined(PSA_WANT_ALG_CCM)
4104 else if( operation->alg == PSA_ALG_CCM )
4105 {
4106 status = PSA_ERROR_BAD_STATE;
4107 goto exit;
4108 }
4109#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004110
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004111 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4112 output, output_size,
4113 output_length );
4114
Paul Elliott39dc6b82021-05-11 19:16:09 +01004115exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004116 if( status == PSA_SUCCESS )
4117 operation->body_started = 1;
4118 else
4119 psa_aead_abort( operation );
4120
4121 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004122}
4123
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004124static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004125{
Paul Elliott7f429b72021-06-24 18:08:54 +01004126 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004127 return( PSA_ERROR_BAD_STATE );
4128
Paul Elliotta5614442021-07-14 14:54:11 +01004129 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004130 operation->body_remaining != 0 ) )
4131 return( PSA_ERROR_INVALID_ARGUMENT );
4132
4133 return( PSA_SUCCESS );
4134}
4135
Paul Elliott302ff6b2021-04-20 18:10:30 +01004136/* Finish encrypting a message in a multipart AEAD operation. */
4137psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4138 uint8_t *ciphertext,
4139 size_t ciphertext_size,
4140 size_t *ciphertext_length,
4141 uint8_t *tag,
4142 size_t tag_size,
4143 size_t *tag_length )
4144{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004145 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4146
Paul Elliott302ff6b2021-04-20 18:10:30 +01004147 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004148 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004149
Paul Elliott814fffb2021-08-16 18:20:36 +01004150 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004151 if( status != PSA_SUCCESS )
4152 goto exit;
4153
Paul Elliott7f429b72021-06-24 18:08:54 +01004154 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004155 {
4156 status = PSA_ERROR_BAD_STATE;
4157 goto exit;
4158 }
4159
Paul Elliott39dc6b82021-05-11 19:16:09 +01004160 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4161 ciphertext_size,
4162 ciphertext_length,
4163 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004164
Paul Elliott39dc6b82021-05-11 19:16:09 +01004165exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004166 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004167 * the zero tag size, make sure the tag is set to something implausible.
4168 * Even if the operation succeeds, make sure we clear the rest of the
4169 * buffer to prevent potential leakage of anything previously placed in
4170 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004171 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004172 {
4173 if( status != PSA_SUCCESS )
4174 memset( tag, '!', tag_size );
4175 else if( *tag_length < tag_size )
4176 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4177 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004178
Paul Elliott39dc6b82021-05-11 19:16:09 +01004179 psa_aead_abort( operation );
4180
4181 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004182}
4183
4184/* Finish authenticating and decrypting a message in a multipart AEAD
4185 operation.*/
4186psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4187 uint8_t *plaintext,
4188 size_t plaintext_size,
4189 size_t *plaintext_length,
4190 const uint8_t *tag,
4191 size_t tag_length )
4192{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4194
Paul Elliott302ff6b2021-04-20 18:10:30 +01004195 *plaintext_length = 0;
4196
Paul Elliott814fffb2021-08-16 18:20:36 +01004197 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004198 if( status != PSA_SUCCESS )
4199 goto exit;
4200
Paul Elliott7f429b72021-06-24 18:08:54 +01004201 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004202 {
4203 status = PSA_ERROR_BAD_STATE;
4204 goto exit;
4205 }
4206
Paul Elliott39dc6b82021-05-11 19:16:09 +01004207 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4208 plaintext_size,
4209 plaintext_length,
4210 tag, tag_length );
4211
4212exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004213 psa_aead_abort( operation );
4214
4215 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004216}
4217
4218/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004219psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004220{
4221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4222
4223 if( operation->id == 0 )
4224 {
4225 /* The object has (apparently) been initialized but it is not (yet)
4226 * in use. It's ok to call abort on such an object, and there's
4227 * nothing to do. */
4228 return( PSA_SUCCESS );
4229 }
4230
4231 status = psa_driver_wrapper_aead_abort( operation );
4232
Paul Elliott70618b22021-09-22 17:12:16 +01004233 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004234
4235 return( status );
4236}
4237
Gilles Peskinee59236f2018-01-27 23:32:46 +01004238/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004239/* Generators */
4240/****************************************************************/
4241
Przemek Stekiel69c46792022-06-10 12:59:51 +02004242#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08004243 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4244 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4245#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004246#endif /* At least one builtin KDF */
4247
Przemek Stekiel69c46792022-06-10 12:59:51 +02004248#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02004249 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4250 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4251static psa_status_t psa_key_derivation_start_hmac(
4252 psa_mac_operation_t *operation,
4253 psa_algorithm_t hash_alg,
4254 const uint8_t *hmac_key,
4255 size_t hmac_key_length )
4256{
4257 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4258 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4259 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4260 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4261 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4262
Steven Cooreman72f736a2021-05-07 14:14:37 +02004263 operation->is_sign = 1;
4264 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4265
Steven Cooreman094a77e2021-05-06 17:58:36 +02004266 status = psa_driver_wrapper_mac_sign_setup( operation,
4267 &attributes,
4268 hmac_key, hmac_key_length,
4269 PSA_ALG_HMAC( hash_alg ) );
4270
4271 psa_reset_key_attributes( &attributes );
4272 return( status );
4273}
4274#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004275
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004276#define HKDF_STATE_INIT 0 /* no input yet */
4277#define HKDF_STATE_STARTED 1 /* got salt */
4278#define HKDF_STATE_KEYED 2 /* got key */
4279#define HKDF_STATE_OUTPUT 3 /* output started */
4280
Gilles Peskinecbe66502019-05-16 16:59:18 +02004281static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004282 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004283{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004284 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4285 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004286 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004287 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004288}
4289
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004290psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004291{
4292 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004293 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004294 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004295 {
4296 /* The object has (apparently) been initialized but it is not
4297 * in use. It's ok to call abort on such an object, and there's
4298 * nothing to do. */
4299 }
4300 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004301#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiela29b4882022-06-02 11:37:03 +02004302 if( PSA_ALG_IS_ANY_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004303 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004304 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004305 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004306 }
John Durkop07cc04a2020-11-16 22:08:34 -08004307 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004308#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08004309#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4310 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4311 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004313 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004314 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004315 if( operation->ctx.tls12_prf.secret != NULL )
4316 {
4317 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4318 operation->ctx.tls12_prf.secret_length );
4319 mbedtls_free( operation->ctx.tls12_prf.secret );
4320 }
4321
Janos Follath6a1d2622019-06-11 10:37:28 +01004322 if( operation->ctx.tls12_prf.seed != NULL )
4323 {
4324 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4325 operation->ctx.tls12_prf.seed_length );
4326 mbedtls_free( operation->ctx.tls12_prf.seed );
4327 }
4328
4329 if( operation->ctx.tls12_prf.label != NULL )
4330 {
4331 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4332 operation->ctx.tls12_prf.label_length );
4333 mbedtls_free( operation->ctx.tls12_prf.label );
4334 }
4335
Przemek Stekiele3ee2212022-04-07 14:29:56 +02004336 if( operation->ctx.tls12_prf.other_secret != NULL )
4337 {
4338 mbedtls_platform_zeroize( operation->ctx.tls12_prf.other_secret,
4339 operation->ctx.tls12_prf.other_secret_length );
4340 mbedtls_free( operation->ctx.tls12_prf.other_secret );
4341 }
4342
Steven Cooremana6df6042021-04-29 19:32:25 +02004343 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004344
4345 /* We leave the fields Ai and output_block to be erased safely by the
4346 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004347 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004348 else
John Durkop07cc04a2020-11-16 22:08:34 -08004349#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4350 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004351 {
4352 status = PSA_ERROR_BAD_STATE;
4353 }
Janos Follath083036a2019-06-11 10:22:26 +01004354 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004355 return( status );
4356}
4357
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004358psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004359 size_t *capacity)
4360{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004361 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004362 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004363 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004364 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004365 }
4366
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004367 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004368 return( PSA_SUCCESS );
4369}
4370
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004371psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004372 size_t capacity )
4373{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004374 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004375 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004376 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004377 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004378 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004379 return( PSA_SUCCESS );
4380}
4381
Przemek Stekiel69c46792022-06-10 12:59:51 +02004382#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004383/* Read some bytes from an HKDF-based operation. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004384static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004385 psa_algorithm_t kdf_alg,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004386 uint8_t *output,
4387 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004388{
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004389 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004390 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004391 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004392 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02004393#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004394 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02004395#else
4396 const uint8_t last_block = 0xff;
4397#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004398
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004399 if( hkdf->state < HKDF_STATE_KEYED ||
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02004400 ( !hkdf->info_set
4401#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
4402 && !PSA_ALG_IS_HKDF_EXTRACT( kdf_alg )
4403#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
4404 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004405 return( PSA_ERROR_BAD_STATE );
4406 hkdf->state = HKDF_STATE_OUTPUT;
4407
Gilles Peskinebef7f142018-07-12 17:22:21 +02004408 while( output_length != 0 )
4409 {
4410 /* Copy what remains of the current block */
4411 uint8_t n = hash_length - hkdf->offset_in_block;
4412 if( n > output_length )
4413 n = (uint8_t) output_length;
4414 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4415 output += n;
4416 output_length -= n;
4417 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004418 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004419 break;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004420 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004421 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004422 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004423 * object was corrupted or if this function is called directly
4424 * inside the library. */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02004425 if( hkdf->block_number == last_block )
Gilles Peskined54931c2018-07-17 21:06:59 +02004426 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004427
4428 /* We need a new block */
4429 ++hkdf->block_number;
4430 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004431
Steven Cooreman094a77e2021-05-06 17:58:36 +02004432 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4433 hash_alg,
4434 hkdf->prk,
4435 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004436 if( status != PSA_SUCCESS )
4437 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004438
Gilles Peskinebef7f142018-07-12 17:22:21 +02004439 if( hkdf->block_number != 1 )
4440 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004441 status = psa_mac_update( &hkdf->hmac,
4442 hkdf->output_block,
4443 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004444 if( status != PSA_SUCCESS )
4445 return( status );
4446 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004447 status = psa_mac_update( &hkdf->hmac,
4448 hkdf->info,
4449 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004450 if( status != PSA_SUCCESS )
4451 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004452 status = psa_mac_update( &hkdf->hmac,
4453 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004454 if( status != PSA_SUCCESS )
4455 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004456 status = psa_mac_sign_finish( &hkdf->hmac,
4457 hkdf->output_block,
4458 sizeof( hkdf->output_block ),
4459 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004460 if( status != PSA_SUCCESS )
4461 return( status );
4462 }
4463
4464 return( PSA_SUCCESS );
4465}
Przemek Stekiel69c46792022-06-10 12:59:51 +02004466#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004467
John Durkop07cc04a2020-11-16 22:08:34 -08004468#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4469 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004470static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4471 psa_tls12_prf_key_derivation_t *tls12_prf,
4472 psa_algorithm_t alg )
4473{
4474 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004475 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004476 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4477 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004478 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004479
Janos Follath7742fee2019-06-17 12:58:10 +01004480 /* We can't be wanting more output after block 0xff, otherwise
4481 * the capacity check in psa_key_derivation_output_bytes() would have
4482 * prevented this call. It could happen only if the operation
4483 * object was corrupted or if this function is called directly
4484 * inside the library. */
4485 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004486 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004487
4488 /* We need a new block */
4489 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004490 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004491
4492 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4493 *
4494 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4495 *
4496 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4497 * HMAC_hash(secret, A(2) + seed) +
4498 * HMAC_hash(secret, A(3) + seed) + ...
4499 *
4500 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004501 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004502 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004503 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004504 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004505 * is currently extracted as `output_block` and where i is
4506 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004507 */
4508
Steven Cooreman094a77e2021-05-06 17:58:36 +02004509 status = psa_key_derivation_start_hmac( &hmac,
4510 hash_alg,
4511 tls12_prf->secret,
4512 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004513 if( status != PSA_SUCCESS )
4514 goto cleanup;
4515
4516 /* Calculate A(i) where i = tls12_prf->block_number. */
4517 if( tls12_prf->block_number == 1 )
4518 {
4519 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4520 * the variable seed and in this instance means it in the context of the
4521 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004522 status = psa_mac_update( &hmac,
4523 tls12_prf->label,
4524 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,
4528 tls12_prf->seed,
4529 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004530 if( status != PSA_SUCCESS )
4531 goto cleanup;
4532 }
4533 else
4534 {
4535 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004536 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004537 if( status != PSA_SUCCESS )
4538 goto cleanup;
4539 }
4540
Steven Cooremana6df6042021-04-29 19:32:25 +02004541 status = psa_mac_sign_finish( &hmac,
4542 tls12_prf->Ai, hash_length,
4543 &hmac_output_length );
4544 if( hmac_output_length != hash_length )
4545 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004546 if( status != PSA_SUCCESS )
4547 goto cleanup;
4548
4549 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004550 status = psa_key_derivation_start_hmac( &hmac,
4551 hash_alg,
4552 tls12_prf->secret,
4553 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004554 if( status != PSA_SUCCESS )
4555 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004556 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004557 if( status != PSA_SUCCESS )
4558 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004559 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004560 if( status != PSA_SUCCESS )
4561 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004562 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004563 if( status != PSA_SUCCESS )
4564 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004565 status = psa_mac_sign_finish( &hmac,
4566 tls12_prf->output_block, hash_length,
4567 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004568 if( status != PSA_SUCCESS )
4569 goto cleanup;
4570
Janos Follath7742fee2019-06-17 12:58:10 +01004571
4572cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004573 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004574 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4575 status = cleanup_status;
4576
4577 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004578}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004579
Janos Follath844eb0e2019-06-19 12:10:49 +01004580static psa_status_t psa_key_derivation_tls12_prf_read(
4581 psa_tls12_prf_key_derivation_t *tls12_prf,
4582 psa_algorithm_t alg,
4583 uint8_t *output,
4584 size_t output_length )
4585{
4586 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004587 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004588 psa_status_t status;
4589 uint8_t offset, length;
4590
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004591 switch( tls12_prf->state )
4592 {
4593 case PSA_TLS12_PRF_STATE_LABEL_SET:
4594 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4595 break;
4596 case PSA_TLS12_PRF_STATE_OUTPUT:
4597 break;
4598 default:
4599 return( PSA_ERROR_BAD_STATE );
4600 }
4601
Janos Follath844eb0e2019-06-19 12:10:49 +01004602 while( output_length != 0 )
4603 {
4604 /* Check if we have fully processed the current block. */
4605 if( tls12_prf->left_in_block == 0 )
4606 {
4607 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4608 alg );
4609 if( status != PSA_SUCCESS )
4610 return( status );
4611
4612 continue;
4613 }
4614
4615 if( tls12_prf->left_in_block > output_length )
4616 length = (uint8_t) output_length;
4617 else
4618 length = tls12_prf->left_in_block;
4619
4620 offset = hash_length - tls12_prf->left_in_block;
4621 memcpy( output, tls12_prf->output_block + offset, length );
4622 output += length;
4623 output_length -= length;
4624 tls12_prf->left_in_block -= length;
4625 }
4626
4627 return( PSA_SUCCESS );
4628}
John Durkop07cc04a2020-11-16 22:08:34 -08004629#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4630 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004631
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004632psa_status_t psa_key_derivation_output_bytes(
4633 psa_key_derivation_operation_t *operation,
4634 uint8_t *output,
4635 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004636{
4637 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004638 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004639
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004641 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004642 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004643 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004644 }
4645
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004647 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004648 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004649 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004650 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004651 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004652 goto exit;
4653 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004654 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004655 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004657 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004658 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4659 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004660 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004661 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004662 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004663 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004664 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004665
Przemek Stekiel69c46792022-06-10 12:59:51 +02004666#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiela29b4882022-06-02 11:37:03 +02004667 if( PSA_ALG_IS_ANY_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004668 {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02004669 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, kdf_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004670 output, output_length );
4671 }
Janos Follathadbec812019-06-14 11:05:39 +01004672 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02004673#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08004674#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4675 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004676 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004677 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004678 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004679 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004680 kdf_alg, output,
4681 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004682 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004683 else
John Durkop07cc04a2020-11-16 22:08:34 -08004684#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4685 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004686 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004687 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004688 return( PSA_ERROR_BAD_STATE );
4689 }
4690
4691exit:
4692 if( status != PSA_SUCCESS )
4693 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004694 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004695 * This allows us to differentiate between exhausted operations and
4696 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4697 * operations. */
4698 psa_algorithm_t alg = operation->alg;
4699 psa_key_derivation_abort( operation );
4700 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004701 memset( output, '!', output_length );
4702 }
4703 return( status );
4704}
4705
David Brown7807bf72021-02-09 16:28:23 -07004706#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004707static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4708{
4709 if( data_size >= 8 )
4710 mbedtls_des_key_set_parity( data );
4711 if( data_size >= 16 )
4712 mbedtls_des_key_set_parity( data + 8 );
4713 if( data_size >= 24 )
4714 mbedtls_des_key_set_parity( data + 16 );
4715}
David Brown7807bf72021-02-09 16:28:23 -07004716#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004717
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004718/*
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +01004719* ECC keys on a Weierstrass elliptic curve require the generation
4720* of a private key which is an integer
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004721* in the range [1, N - 1], where N is the boundary of the private key domain:
4722* N is the prime p for Diffie-Hellman, or the order of the
4723* curve’s base point for ECC.
4724*
4725* Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
4726* This function generates the private key using the following process:
4727*
4728* 1. Draw a byte string of length ceiling(m/8) bytes.
4729* 2. If m is not a multiple of 8, set the most significant
4730* (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
4731* 3. Convert the string to integer k by decoding it as a big-endian byte string.
4732* 4. If k > N - 2, discard the result and return to step 1.
4733* 5. Output k + 1 as the private key.
4734*
4735* This method allows compliance to NIST standards, specifically the methods titled
4736* Key-Pair Generation by Testing Candidates in the following publications:
4737* - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
4738* Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
4739* Diffie-Hellman keys.
4740*
4741* - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
4742* Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004743*
4744* Note: Function allocates memory for *data buffer, so given *data should be
4745* always NULL.
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004746*/
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004747#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4748 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4749 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4750 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4751 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004752static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004753 psa_key_slot_t *slot,
4754 size_t bits,
4755 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004756 uint8_t **data
4757 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004758{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004759 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004760 mbedtls_mpi k;
4761 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004762 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004763 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004764
4765 mbedtls_mpi_init( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004766 mbedtls_mpi_init( &diff_N_2 );
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004767
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004768 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
4769 slot->attr.type );
4770 mbedtls_ecp_group_id grp_id =
4771 mbedtls_ecc_group_of_psa( curve, bits, 0 );
4772
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004773 if( grp_id == MBEDTLS_ECP_DP_NONE )
4774 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004775 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004776 goto cleanup;
4777 }
4778
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004779 mbedtls_ecp_group ecp_group;
Przemyslaw Stekiel65348162021-11-18 11:57:07 +01004780 mbedtls_ecp_group_init( &ecp_group );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004781
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004782 MBEDTLS_MPI_CHK( mbedtls_ecp_group_load( &ecp_group, grp_id ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004783
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004784 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004785 /* Let m be the bit size of N. */
4786 size_t m = ecp_group.nbits;
4787
4788 size_t m_bytes = PSA_BITS_TO_BYTES( m );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004789
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004790 /* Calculate N - 2 - it will be needed later. */
4791 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &diff_N_2, &ecp_group.N, 2 ) );
4792
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004793 /* Note: This function is always called with *data == NULL and it
4794 * allocates memory for the data buffer. */
4795 *data = mbedtls_calloc( 1, m_bytes );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004796 if( *data == NULL )
4797 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004798 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004799 goto cleanup;
4800 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004801
Przemek Stekielc85f0912022-03-08 11:37:54 +01004802 while( key_out_of_range )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004803 {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004804 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004805 if( ( status = psa_key_derivation_output_bytes( operation, *data, m_bytes ) ) != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004806 goto cleanup;
4807
4808 /* 2. If m is not a multiple of 8 */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004809 if( m % 8 != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004810 {
4811 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004812 * (8 * ceiling(m/8) - m) bits of the first byte in
4813 * the string to zero.
4814 */
4815 uint8_t clear_bit_mask = ( 1 << ( m % 8 ) ) - 1;
4816 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004817 }
4818
4819 /* 3. Convert the string to integer k by decoding it as a
4820 * big-endian byte string.
4821 */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004822 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &k, *data, m_bytes ) );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004823
4824 /* 4. If k > N - 2, discard the result and return to step 1.
4825 * Result of comparison is returned. When it indicates error
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004826 * then this function is called again.
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004827 */
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004828 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( &diff_N_2, &k, &key_out_of_range ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004829 }
4830
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004831 /* 5. Output k + 1 as the private key. */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004832 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &k, &k, 1 ) );
4833 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &k, *data, m_bytes ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004834cleanup:
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004835 if( ret != 0 )
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004836 status = mbedtls_to_psa_error( ret );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004837 if( status != PSA_SUCCESS ) {
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004838 mbedtls_free( *data );
4839 *data = NULL;
4840 }
4841 mbedtls_mpi_free( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004842 mbedtls_mpi_free( &diff_N_2 );
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004843 return( status );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004844}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004845
4846/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
4847 * is determined by the curve, and sets the mandatory bits accordingly. That is:
4848 *
4849 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
4850 * draw a 32-byte string and process it as specified in
4851 * Elliptic Curves for Security [RFC7748] §5.
4852 *
4853 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
4854 * draw a 56-byte string and process it as specified in [RFC7748] §5.
4855 *
4856 * Note: Function allocates memory for *data buffer, so given *data should be
4857 * always NULL.
4858 */
4859
4860static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
4861 size_t bits,
4862 psa_key_derivation_operation_t *operation,
4863 uint8_t **data
4864 )
4865{
4866 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004867 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004868
4869 switch( bits )
4870 {
4871 case 255:
4872 output_length = 32;
4873 break;
4874 case 448:
4875 output_length = 56;
4876 break;
4877 default:
4878 return( PSA_ERROR_INVALID_ARGUMENT );
4879 break;
4880 }
4881
4882 *data = mbedtls_calloc( 1, output_length );
4883
4884 if( *data == NULL )
4885 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4886
4887 status = psa_key_derivation_output_bytes( operation, *data, output_length );
4888
4889 if( status != PSA_SUCCESS )
4890 return status;
4891
4892 switch( bits )
4893 {
4894 case 255:
4895 (*data)[0] &= 248;
4896 (*data)[31] &= 127;
4897 (*data)[31] |= 64;
4898 break;
4899 case 448:
4900 (*data)[0] &= 252;
4901 (*data)[55] |= 128;
4902 break;
4903 default:
Przemek Stekiela81aed22022-03-01 15:13:30 +01004904 return( PSA_ERROR_CORRUPTION_DETECTED );
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004905 break;
4906 }
4907
4908 return status;
4909}
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004910#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4911 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4912 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4913 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4914 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004915
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004916static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004917 psa_key_slot_t *slot,
4918 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004919 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004920{
4921 uint8_t *data = NULL;
4922 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304923 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004924 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004925
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004926 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004927 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004928
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004929#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4930 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4931 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4932 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4933 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemek Stekielc85f0912022-03-08 11:37:54 +01004934 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004935 {
Przemyslaw Stekiel92481592022-01-04 10:09:46 +01004936 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004937 if( PSA_ECC_FAMILY_IS_WEIERSTRASS( curve ) )
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004938 {
4939 /* Weierstrass elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004940 status = psa_generate_derived_ecc_key_weierstrass_helper( slot, bits, operation, &data );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004941 if( status != PSA_SUCCESS )
4942 goto exit;
Przemyslaw Stekiel50fcc532021-11-26 10:54:52 +01004943 }
4944 else
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004945 {
4946 /* Montgomery elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004947 status = psa_generate_derived_ecc_key_montgomery_helper( bits, operation, &data );
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004948 if( status != PSA_SUCCESS )
4949 goto exit;
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004950 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004951 } else
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004952#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4953 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4954 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4955 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4956 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004957 if( key_type_is_raw_bytes( slot->attr.type ) )
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004958 {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004959 if( bits % 8 != 0 )
4960 return( PSA_ERROR_INVALID_ARGUMENT );
4961 data = mbedtls_calloc( 1, bytes );
4962 if( data == NULL )
4963 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4964
4965 status = psa_key_derivation_output_bytes( operation, data, bytes );
4966 if( status != PSA_SUCCESS )
4967 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004968#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004969 if( slot->attr.type == PSA_KEY_TYPE_DES )
4970 psa_des_set_key_parity( data, bytes );
Przemek Stekielf110dc02022-03-01 14:48:05 +01004971#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004972 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004973 else
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004974 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Crondd04d422020-11-28 15:14:42 +01004975
Ronald Cronbf33c932020-11-28 18:06:53 +01004976 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004977 psa_key_attributes_t attributes = {
4978 .core = slot->attr
4979 };
4980
Archanad8a83dc2021-06-14 10:04:16 +05304981 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4982 {
Archana449608b2021-09-08 15:36:05 +05304983 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4984 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304985 if( status != PSA_SUCCESS )
4986 goto exit;
4987 }
4988 status = psa_allocate_buffer_to_slot( slot, storage_size );
4989 if( status != PSA_SUCCESS )
4990 goto exit;
4991
Ronald Cronbf33c932020-11-28 18:06:53 +01004992 status = psa_driver_wrapper_import_key( &attributes,
4993 data, bytes,
4994 slot->key.data,
4995 slot->key.bytes,
4996 &slot->key.bytes, &bits );
4997 if( bits != slot->attr.bits )
4998 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004999
5000exit:
5001 mbedtls_free( data );
5002 return( status );
5003}
5004
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005005psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005006 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005007 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005008{
5009 psa_status_t status;
5010 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005011 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005012
Ronald Cron81709fc2020-11-14 12:10:32 +01005013 *key = MBEDTLS_SVC_KEY_ID_INIT;
5014
Gilles Peskine0f84d622019-09-12 19:03:13 +02005015 /* Reject any attempt to create a zero-length key so that we don't
5016 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5017 if( psa_get_key_bits( attributes ) == 0 )
5018 return( PSA_ERROR_INVALID_ARGUMENT );
5019
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005020 if( operation->alg == PSA_ALG_NONE )
5021 return( PSA_ERROR_BAD_STATE );
5022
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005023 if( ! operation->can_output_key )
5024 return( PSA_ERROR_NOT_PERMITTED );
5025
Ronald Cron81709fc2020-11-14 12:10:32 +01005026 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5027 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005028#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5029 if( driver != NULL )
5030 {
5031 /* Deriving a key in a secure element is not implemented yet. */
5032 status = PSA_ERROR_NOT_SUPPORTED;
5033 }
5034#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005035 if( status == PSA_SUCCESS )
5036 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005037 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005038 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005039 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005040 }
5041 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005042 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005043 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005044 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005045
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005046 return( status );
5047}
5048
Gilles Peskineeab56e42018-07-12 17:12:33 +02005049
5050
5051/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005052/* Key derivation */
5053/****************************************************************/
5054
Steven Cooreman932ffb72021-02-15 12:14:32 +01005055#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005056static int is_kdf_alg_supported( psa_algorithm_t kdf_alg )
5057{
5058#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
5059 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5060 return( 1 );
5061#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02005062#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
5063 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5064 return( 1 );
5065#endif
5066#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
5067 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) )
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005068 return( 1 );
5069#endif
5070#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5071 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5072 return( 1 );
5073#endif
5074#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5075 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5076 return( 1 );
5077#endif
5078 return( 0 );
5079}
5080
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005081static psa_status_t psa_hash_try_support( psa_algorithm_t alg )
5082{
5083 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
5084 psa_status_t status = psa_hash_setup( &operation, alg );
5085 psa_hash_abort( &operation );
5086 return( status );
5087}
5088
Gilles Peskine969c5d62019-01-16 15:53:06 +01005089static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005090 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005091 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005092{
Janos Follath5fe19732019-06-20 15:09:30 +01005093 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5094 * initialisers for this union leave some bytes unspecified.) */
5095 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5096
Gilles Peskine969c5d62019-01-16 15:53:06 +01005097 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005098 if( ! is_kdf_alg_supported( kdf_alg ) )
5099 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop07cc04a2020-11-16 22:08:34 -08005100
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005101 /* All currently supported key derivation algorithms are based on a
5102 * hash algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005103 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
5104 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
5105 if( hash_size == 0 )
5106 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005107
5108 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
5109 * we might fail later, which is somewhat unfriendly and potentially
5110 * risk-prone. */
5111 psa_status_t status = psa_hash_try_support( hash_alg );
5112 if( status != PSA_SUCCESS )
5113 return( status );
5114
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005115 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5116 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
5117 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005118 {
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005119 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005120 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005121#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005122 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5123 operation->capacity = hash_size;
5124 else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005125#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005126 operation->capacity = 255 * hash_size;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005127 return( PSA_SUCCESS );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005128}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005129
5130static psa_status_t psa_key_agreement_try_support( psa_algorithm_t alg )
5131{
5132#if defined(PSA_WANT_ALG_ECDH)
5133 if( alg == PSA_ALG_ECDH )
5134 return( PSA_SUCCESS );
5135#endif
5136 (void) alg;
5137 return( PSA_ERROR_NOT_SUPPORTED );
5138}
John Durkop07cc04a2020-11-16 22:08:34 -08005139#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005140
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005141psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005142 psa_algorithm_t alg )
5143{
5144 psa_status_t status;
5145
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005146 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005147 return( PSA_ERROR_BAD_STATE );
5148
Gilles Peskine6843c292019-01-18 16:44:49 +01005149 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5150 return( PSA_ERROR_INVALID_ARGUMENT );
5151 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005152 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005153#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005154 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005155 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( alg );
5156 status = psa_key_agreement_try_support( ka_alg );
5157 if( status != PSA_SUCCESS )
5158 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005159 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005160#else
5161 return( PSA_ERROR_NOT_SUPPORTED );
5162#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005163 }
5164 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5165 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005166#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005167 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005168#else
5169 return( PSA_ERROR_NOT_SUPPORTED );
5170#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005171 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005172 else
5173 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005174
5175 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005176 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005177 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005178}
5179
Przemek Stekiel69c46792022-06-10 12:59:51 +02005180#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005181static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005182 psa_algorithm_t kdf_alg,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005183 psa_key_derivation_step_t step,
5184 const uint8_t *data,
5185 size_t data_length )
5186{
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005187 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005188 psa_status_t status;
5189 switch( step )
5190 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005191 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005192#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005193 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) )
5194 return( PSA_ERROR_INVALID_ARGUMENT );
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005195#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine2b522db2019-04-12 15:11:49 +02005196 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005197 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005198 else
5199 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005200 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5201 hash_alg,
5202 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005203 if( status != PSA_SUCCESS )
5204 return( status );
5205 hkdf->state = HKDF_STATE_STARTED;
5206 return( PSA_SUCCESS );
5207 }
Gilles Peskine03410b52019-05-16 16:05:19 +02005208 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005209#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005210 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005211 {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02005212 /* We shouldn't be in different state as HKDF_EXPAND only allows
5213 * two inputs: SECRET (this case) and INFO which does not modify
5214 * the state. It could happen only if the hkdf
5215 * object was corrupted. */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005216 if( hkdf->state != HKDF_STATE_INIT )
5217 return( PSA_ERROR_BAD_STATE );
5218
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02005219 /* Allow only input that fits expected prk size */
5220 if( data_length != PSA_HASH_LENGTH( hash_alg ) )
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005221 return( PSA_ERROR_INVALID_ARGUMENT );
5222
5223 memcpy( hkdf->prk, data, data_length );
5224 }
5225 else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005226#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005227 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005228 /* HKDF: If no salt was provided, use an empty salt.
5229 * HKDF-EXTRACT: salt is mandatory. */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005230 if( hkdf->state == HKDF_STATE_INIT )
5231 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02005232#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
5233 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5234 return( PSA_ERROR_BAD_STATE );
5235#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005236 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5237 hash_alg,
5238 NULL, 0 );
5239 if( status != PSA_SUCCESS )
5240 return( status );
5241 hkdf->state = HKDF_STATE_STARTED;
5242 }
5243 if( hkdf->state != HKDF_STATE_STARTED )
5244 return( PSA_ERROR_BAD_STATE );
5245 status = psa_mac_update( &hkdf->hmac,
5246 data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005247 if( status != PSA_SUCCESS )
5248 return( status );
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005249 status = psa_mac_sign_finish( &hkdf->hmac,
5250 hkdf->prk,
5251 sizeof( hkdf->prk ),
5252 &data_length );
5253 if( status != PSA_SUCCESS )
5254 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005255 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005256
Gilles Peskine2b522db2019-04-12 15:11:49 +02005257 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005258 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005259#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005260 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5261 {
5262 /* The only block of output is the PRK. */
5263 memcpy( hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH( hash_alg ) );
5264 hkdf->offset_in_block = 0;
5265 }
5266 else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005267#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005268 {
5269 /* Block 0 is empty, and the next block will be
5270 * generated by psa_key_derivation_hkdf_read(). */
5271 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
5272 }
5273
Gilles Peskine2b522db2019-04-12 15:11:49 +02005274 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005275 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005276#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005277 if( PSA_ALG_IS_HKDF_EXTRACT( kdf_alg ) )
5278 return( PSA_ERROR_INVALID_ARGUMENT );
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005279#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02005280#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
5281 if( PSA_ALG_IS_HKDF_EXPAND( kdf_alg ) &&
5282 hkdf->state == HKDF_STATE_INIT )
5283 return( PSA_ERROR_BAD_STATE );
5284#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005285 if( hkdf->state == HKDF_STATE_OUTPUT )
5286 return( PSA_ERROR_BAD_STATE );
5287 if( hkdf->info_set )
5288 return( PSA_ERROR_BAD_STATE );
5289 hkdf->info_length = data_length;
5290 if( data_length != 0 )
5291 {
5292 hkdf->info = mbedtls_calloc( 1, data_length );
5293 if( hkdf->info == NULL )
5294 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5295 memcpy( hkdf->info, data, data_length );
5296 }
5297 hkdf->info_set = 1;
5298 return( PSA_SUCCESS );
5299 default:
5300 return( PSA_ERROR_INVALID_ARGUMENT );
5301 }
5302}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005303#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005304
John Durkop07cc04a2020-11-16 22:08:34 -08005305#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5306 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005307static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5308 const uint8_t *data,
5309 size_t data_length )
5310{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005311 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005312 return( PSA_ERROR_BAD_STATE );
5313
Janos Follathd6dce9f2019-07-04 09:11:38 +01005314 if( data_length != 0 )
5315 {
5316 prf->seed = mbedtls_calloc( 1, data_length );
5317 if( prf->seed == NULL )
5318 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005319
Janos Follathd6dce9f2019-07-04 09:11:38 +01005320 memcpy( prf->seed, data, data_length );
5321 prf->seed_length = data_length;
5322 }
Janos Follathf08e2652019-06-13 09:05:41 +01005323
Gilles Peskine43f958b2020-12-13 14:55:14 +01005324 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005325
5326 return( PSA_SUCCESS );
5327}
5328
Janos Follath81550542019-06-13 14:26:34 +01005329static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01005330 const uint8_t *data,
5331 size_t data_length )
5332{
Przemek Stekield7a28642022-04-07 14:58:33 +02005333 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
5334 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET )
Janos Follath81550542019-06-13 14:26:34 +01005335 return( PSA_ERROR_BAD_STATE );
5336
Steven Cooremana6df6042021-04-29 19:32:25 +02005337 if( data_length != 0 )
5338 {
5339 prf->secret = mbedtls_calloc( 1, data_length );
5340 if( prf->secret == NULL )
5341 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5342
5343 memcpy( prf->secret, data, data_length );
5344 prf->secret_length = data_length;
5345 }
Janos Follath81550542019-06-13 14:26:34 +01005346
Gilles Peskine43f958b2020-12-13 14:55:14 +01005347 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005348
5349 return( PSA_SUCCESS );
5350}
5351
Janos Follath63028dd2019-06-13 09:15:47 +01005352static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5353 const uint8_t *data,
5354 size_t data_length )
5355{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005356 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005357 return( PSA_ERROR_BAD_STATE );
5358
Janos Follathd6dce9f2019-07-04 09:11:38 +01005359 if( data_length != 0 )
5360 {
5361 prf->label = mbedtls_calloc( 1, data_length );
5362 if( prf->label == NULL )
5363 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005364
Janos Follathd6dce9f2019-07-04 09:11:38 +01005365 memcpy( prf->label, data, data_length );
5366 prf->label_length = data_length;
5367 }
Janos Follath63028dd2019-06-13 09:15:47 +01005368
Gilles Peskine43f958b2020-12-13 14:55:14 +01005369 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005370
5371 return( PSA_SUCCESS );
5372}
5373
Janos Follathb03233e2019-06-11 15:30:30 +01005374static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005375 psa_key_derivation_step_t step,
5376 const uint8_t *data,
5377 size_t data_length )
5378{
Janos Follathb03233e2019-06-11 15:30:30 +01005379 switch( step )
5380 {
Janos Follathf08e2652019-06-13 09:05:41 +01005381 case PSA_KEY_DERIVATION_INPUT_SEED:
5382 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005383 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005384 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005385 case PSA_KEY_DERIVATION_INPUT_LABEL:
5386 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005387 default:
5388 return( PSA_ERROR_INVALID_ARGUMENT );
5389 }
5390}
John Durkop07cc04a2020-11-16 22:08:34 -08005391#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5392 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5393
5394#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5395static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5396 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005397 const uint8_t *data,
5398 size_t data_length )
5399{
5400 psa_status_t status;
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005401 const size_t pms_len = ( prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
5402 4 + data_length + prf->other_secret_length :
5403 4 + 2 * data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005404
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005405 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005406 return( PSA_ERROR_INVALID_ARGUMENT );
5407
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005408 uint8_t *pms = mbedtls_calloc( 1, pms_len );
Przemek Stekiel937b90f2022-04-20 08:33:13 +02005409 if( pms == NULL )
5410 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005411 uint8_t *cur = pms;
5412
5413 /* pure-PSK:
5414 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08005415 *
5416 * The premaster secret is formed as follows: if the PSK is N octets
5417 * long, concatenate a uint16 with the value N, N zero octets, a second
5418 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005419 *
5420 * mixed-PSK:
5421 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
5422 * follows: concatenate a uint16 with the length of the other secret,
5423 * the other secret itself, uint16 with the length of PSK, and the
5424 * PSK itself.
5425 * For details please check:
5426 * - RFC 4279, Section 4 for the definition of RSA-PSK,
5427 * - RFC 4279, Section 3 for the definition of DHE-PSK,
5428 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08005429 */
5430
Przemek Stekiel4e47a912022-04-21 11:40:18 +02005431 if( prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET )
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005432 {
5433 *cur++ = MBEDTLS_BYTE_1( prf->other_secret_length );
5434 *cur++ = MBEDTLS_BYTE_0( prf->other_secret_length );
Przemek Stekiel4e47a912022-04-21 11:40:18 +02005435 if( prf->other_secret_length != 0 )
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02005436 {
5437 memcpy( cur, prf->other_secret, prf->other_secret_length );
Przemek Stekiel03faf5d22022-04-20 08:37:43 +02005438 mbedtls_platform_zeroize( prf->other_secret, prf->other_secret_length );
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02005439 cur += prf->other_secret_length;
5440 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005441 }
5442 else
5443 {
5444 *cur++ = MBEDTLS_BYTE_1( data_length );
5445 *cur++ = MBEDTLS_BYTE_0( data_length );
5446 memset( cur, 0, data_length );
5447 cur += data_length;
5448 }
5449
Joe Subbiani5ecac212021-06-24 13:00:03 +01005450 *cur++ = MBEDTLS_BYTE_1( data_length );
5451 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005452 memcpy( cur, data, data_length );
5453 cur += data_length;
5454
Steven Cooremana6df6042021-04-29 19:32:25 +02005455 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005456
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005457 mbedtls_platform_zeroize( pms, pms_len );
5458 mbedtls_free( pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005459 return( status );
5460}
Janos Follath6660f0e2019-06-17 08:44:03 +01005461
Przemek Stekiele47201b2022-04-19 13:53:28 +02005462static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
5463 psa_tls12_prf_key_derivation_t *prf,
5464 const uint8_t *data,
5465 size_t data_length )
5466{
5467 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
5468 return( PSA_ERROR_BAD_STATE );
5469
5470 if( data_length != 0 )
5471 {
5472 prf->other_secret = mbedtls_calloc( 1, data_length );
5473 if( prf->other_secret == NULL )
5474 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5475
5476 memcpy( prf->other_secret, data, data_length );
5477 prf->other_secret_length = data_length;
5478 }
5479 else
5480 {
5481 prf->other_secret_length = 0;
5482 }
5483
5484 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
5485
5486 return( PSA_SUCCESS );
5487}
5488
Janos Follath6660f0e2019-06-17 08:44:03 +01005489static psa_status_t psa_tls12_prf_psk_to_ms_input(
5490 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005491 psa_key_derivation_step_t step,
5492 const uint8_t *data,
5493 size_t data_length )
5494{
Przemek Stekiele47201b2022-04-19 13:53:28 +02005495 switch( step )
Janos Follath0c1ed842019-06-28 13:35:36 +01005496 {
Przemek Stekiele47201b2022-04-19 13:53:28 +02005497 case PSA_KEY_DERIVATION_INPUT_SECRET:
5498 return( psa_tls12_prf_psk_to_ms_set_key( prf,
5499 data, data_length ) );
5500 break;
5501 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
5502 return( psa_tls12_prf_psk_to_ms_set_other_key( prf,
5503 data,
5504 data_length ) );
5505 break;
5506 default:
5507 return( psa_tls12_prf_input( prf, step, data, data_length ) );
5508 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01005509
Przemek Stekiele47201b2022-04-19 13:53:28 +02005510 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005511}
John Durkop07cc04a2020-11-16 22:08:34 -08005512#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005513
Gilles Peskineb8965192019-09-24 16:21:10 +02005514/** Check whether the given key type is acceptable for the given
5515 * input step of a key derivation.
5516 *
5517 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5518 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5519 * Both secret and non-secret inputs can alternatively have the type
5520 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5521 * that the input was passed as a buffer rather than via a key object.
5522 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005523static int psa_key_derivation_check_input_type(
5524 psa_key_derivation_step_t step,
5525 psa_key_type_t key_type )
5526{
5527 switch( step )
5528 {
5529 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005530 if( key_type == PSA_KEY_TYPE_DERIVE )
5531 return( PSA_SUCCESS );
5532 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005533 return( PSA_SUCCESS );
5534 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02005535 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
5536 if( key_type == PSA_KEY_TYPE_DERIVE )
5537 return( PSA_SUCCESS );
5538 if( key_type == PSA_KEY_TYPE_NONE )
5539 return( PSA_SUCCESS );
5540 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02005541 case PSA_KEY_DERIVATION_INPUT_LABEL:
5542 case PSA_KEY_DERIVATION_INPUT_SALT:
5543 case PSA_KEY_DERIVATION_INPUT_INFO:
5544 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005545 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5546 return( PSA_SUCCESS );
5547 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005548 return( PSA_SUCCESS );
5549 break;
5550 }
5551 return( PSA_ERROR_INVALID_ARGUMENT );
5552}
5553
Janos Follathb80a94e2019-06-12 15:54:46 +01005554static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005555 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005556 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005557 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005558 const uint8_t *data,
5559 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005560{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005561 psa_status_t status;
5562 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5563
5564 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005565 if( status != PSA_SUCCESS )
5566 goto exit;
5567
Przemek Stekiel69c46792022-06-10 12:59:51 +02005568#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiela29b4882022-06-02 11:37:03 +02005569 if( PSA_ALG_IS_ANY_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570 {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02005571 status = psa_hkdf_input( &operation->ctx.hkdf, kdf_alg,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005572 step, data, data_length );
5573 }
John Durkop07cc04a2020-11-16 22:08:34 -08005574 else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005575#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005576#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5577 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005578 {
Janos Follathb03233e2019-06-11 15:30:30 +01005579 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005580 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005581 }
John Durkop07cc04a2020-11-16 22:08:34 -08005582 else
5583#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5584#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5585 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005586 {
5587 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005588 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005589 }
5590 else
John Durkop07cc04a2020-11-16 22:08:34 -08005591#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005592 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005593 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005594 (void) data;
5595 (void) data_length;
5596 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005597 return( PSA_ERROR_BAD_STATE );
5598 }
5599
Gilles Peskine224b0d62019-09-23 18:13:17 +02005600exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005601 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005602 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005603 return( status );
5604}
5605
Janos Follath51f4a0f2019-06-14 11:35:55 +01005606psa_status_t psa_key_derivation_input_bytes(
5607 psa_key_derivation_operation_t *operation,
5608 psa_key_derivation_step_t step,
5609 const uint8_t *data,
5610 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005611{
Gilles Peskineb8965192019-09-24 16:21:10 +02005612 return( psa_key_derivation_input_internal( operation, step,
5613 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005614 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005615}
5616
Janos Follath51f4a0f2019-06-14 11:35:55 +01005617psa_status_t psa_key_derivation_input_key(
5618 psa_key_derivation_operation_t *operation,
5619 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005620 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005621{
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 Peskineb70a0fd2019-01-07 22:59:38 +01005624 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005625
Ronald Cron5c522922020-11-14 16:35:34 +01005626 status = psa_get_and_lock_transparent_key_slot_with_policy(
5627 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005628 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005629 {
5630 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005631 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005632 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005633
5634 /* Passing a key object as a SECRET input unlocks the permission
5635 * to output to a key object. */
5636 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5637 operation->can_output_key = 1;
5638
Ronald Cronf95a2b12020-10-22 15:24:49 +02005639 status = psa_key_derivation_input_internal( operation,
5640 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005641 slot->key.data,
5642 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005643
Ronald Cron5c522922020-11-14 16:35:34 +01005644 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005645
Ronald Cron5c522922020-11-14 16:35:34 +01005646 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005647}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005648
5649
5650
5651/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005652/* Key agreement */
5653/****************************************************************/
5654
John Durkop6ba40d12020-11-10 08:50:04 -08005655#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005656static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5657 size_t peer_key_length,
5658 const mbedtls_ecp_keypair *our_key,
5659 uint8_t *shared_secret,
5660 size_t shared_secret_size,
5661 size_t *shared_secret_length )
5662{
Steven Cooremand4867872020-08-05 16:31:39 +02005663 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005664 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005665 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005666 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005667 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005668 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005669
Ronald Cron90857082020-11-25 14:58:33 +01005670 status = mbedtls_psa_ecp_load_representation(
5671 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005672 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005673 peer_key,
5674 peer_key_length,
5675 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005676 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005677 goto exit;
5678
Jaeden Amero97271b32019-01-10 19:38:51 +00005679 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005680 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005681 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005682 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005683 status = mbedtls_to_psa_error(
5684 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5685 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005686 goto exit;
5687
Jaeden Amero97271b32019-01-10 19:38:51 +00005688 status = mbedtls_to_psa_error(
5689 mbedtls_ecdh_calc_secret( &ecdh,
5690 shared_secret_length,
5691 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005692 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005693 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005694 if( status != PSA_SUCCESS )
5695 goto exit;
5696 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5697 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005698
5699exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005700 if( status != PSA_SUCCESS )
5701 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005702 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005703 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005704 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005705
Jaeden Amero97271b32019-01-10 19:38:51 +00005706 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005707}
John Durkop6ba40d12020-11-10 08:50:04 -08005708#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005709
Gilles Peskine01d718c2018-09-18 12:01:02 +02005710#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5711
Gilles Peskine0216fe12019-04-11 21:23:21 +02005712static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5713 psa_key_slot_t *private_key,
5714 const uint8_t *peer_key,
5715 size_t peer_key_length,
5716 uint8_t *shared_secret,
5717 size_t shared_secret_size,
5718 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005719{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005720 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005721 {
John Durkop6ba40d12020-11-10 08:50:04 -08005722#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005723 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005724 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005725 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005726 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005727 psa_status_t status = mbedtls_psa_ecp_load_representation(
5728 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005729 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005730 private_key->key.data,
5731 private_key->key.bytes,
5732 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005733 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005734 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005735 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005736 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005737 shared_secret, shared_secret_size,
5738 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005739 mbedtls_ecp_keypair_free( ecp );
5740 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005741 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005742#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005743 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005744 (void) private_key;
5745 (void) peer_key;
5746 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005747 (void) shared_secret;
5748 (void) shared_secret_size;
5749 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005750 return( PSA_ERROR_NOT_SUPPORTED );
5751 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005752}
5753
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005754/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005755 * to potentially free embedded data structures and wipe confidential data.
5756 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005757static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005758 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005759 psa_key_slot_t *private_key,
5760 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005761 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005762{
5763 psa_status_t status;
5764 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5765 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005766 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005767
5768 /* Step 1: run the secret agreement algorithm to generate the shared
5769 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005770 status = psa_key_agreement_raw_internal( ka_alg,
5771 private_key,
5772 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005773 shared_secret,
5774 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005775 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005776 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005777 goto exit;
5778
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005779 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005780 * the shared secret. A shared secret is permitted wherever a key
5781 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005782 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005783 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005784 shared_secret,
5785 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005786exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005787 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005788 return( status );
5789}
5790
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005791psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005792 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005793 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005794 const uint8_t *peer_key,
5795 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005796{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005797 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005798 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005799 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005800
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005801 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005802 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005803 status = psa_get_and_lock_transparent_key_slot_with_policy(
5804 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005805 if( status != PSA_SUCCESS )
5806 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005807 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005808 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005809 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005810 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005811 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005812 else
5813 {
5814 /* If a private key has been added as SECRET, we allow the derived
5815 * key material to be used as a key in PSA Crypto. */
5816 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5817 operation->can_output_key = 1;
5818 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005819
Ronald Cron5c522922020-11-14 16:35:34 +01005820 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005821
Ronald Cron5c522922020-11-14 16:35:34 +01005822 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005823}
5824
Gilles Peskinebe697d82019-05-16 18:00:41 +02005825psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005826 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005827 const uint8_t *peer_key,
5828 size_t peer_key_length,
5829 uint8_t *output,
5830 size_t output_size,
5831 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005832{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005833 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005834 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005835 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005836
5837 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5838 {
5839 status = PSA_ERROR_INVALID_ARGUMENT;
5840 goto exit;
5841 }
Ronald Cron5c522922020-11-14 16:35:34 +01005842 status = psa_get_and_lock_transparent_key_slot_with_policy(
5843 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005844 if( status != PSA_SUCCESS )
5845 goto exit;
5846
Gilles Peskine3e561302022-04-14 00:17:15 +02005847 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5848 * for the output size. The PSA specification only guarantees that this
5849 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5850 * but it might be nice to allow smaller buffers if the output fits.
5851 * At the time of writing this comment, with only ECDH implemented,
5852 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5853 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5854 * be exact for it as well. */
5855 size_t expected_length =
5856 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE( slot->attr.type, slot->attr.bits );
5857 if( output_size < expected_length )
5858 {
5859 status = PSA_ERROR_BUFFER_TOO_SMALL;
5860 goto exit;
5861 }
5862
Gilles Peskine0216fe12019-04-11 21:23:21 +02005863 status = psa_key_agreement_raw_internal( alg, slot,
5864 peer_key, peer_key_length,
5865 output, output_size,
5866 output_length );
5867
5868exit:
5869 if( status != PSA_SUCCESS )
5870 {
5871 /* If an error happens and is not handled properly, the output
5872 * may be used as a key to protect sensitive data. Arrange for such
5873 * a key to be random, which is likely to result in decryption or
5874 * verification errors. This is better than filling the buffer with
5875 * some constant data such as zeros, which would result in the data
5876 * being protected with a reproducible, easily knowable key.
5877 */
5878 psa_generate_random( output, output_size );
5879 *output_length = output_size;
5880 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005881
Ronald Cron5c522922020-11-14 16:35:34 +01005882 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005883
Ronald Cron5c522922020-11-14 16:35:34 +01005884 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005885}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005886
5887
Gilles Peskine30524eb2020-11-13 17:02:26 +01005888
Gilles Peskine86a440b2018-11-12 18:39:40 +01005889/****************************************************************/
5890/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005891/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005892
Gilles Peskine30524eb2020-11-13 17:02:26 +01005893/** Initialize the PSA random generator.
5894 */
5895static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5896{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005897#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5898 memset( rng, 0, sizeof( *rng ) );
5899#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5900
Gilles Peskine30524eb2020-11-13 17:02:26 +01005901 /* Set default configuration if
5902 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5903 if( rng->entropy_init == NULL )
5904 rng->entropy_init = mbedtls_entropy_init;
5905 if( rng->entropy_free == NULL )
5906 rng->entropy_free = mbedtls_entropy_free;
5907
5908 rng->entropy_init( &rng->entropy );
5909#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5910 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5911 /* The PSA entropy injection feature depends on using NV seed as an entropy
5912 * source. Add NV seed as an entropy source for PSA entropy injection. */
5913 mbedtls_entropy_add_source( &rng->entropy,
5914 mbedtls_nv_seed_poll, NULL,
5915 MBEDTLS_ENTROPY_BLOCK_SIZE,
5916 MBEDTLS_ENTROPY_SOURCE_STRONG );
5917#endif
5918
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005919 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005920#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005921}
5922
5923/** Deinitialize the PSA random generator.
5924 */
5925static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5926{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005927#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5928 memset( rng, 0, sizeof( *rng ) );
5929#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005930 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005931 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005932#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005933}
5934
5935/** Seed the PSA random generator.
5936 */
5937static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5938{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005939#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5940 /* Do nothing: the external RNG seeds itself. */
5941 (void) rng;
5942 return( PSA_SUCCESS );
5943#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005944 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005945 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5946 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005947 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005948#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005949}
5950
Gilles Peskinee59236f2018-01-27 23:32:46 +01005951psa_status_t psa_generate_random( uint8_t *output,
5952 size_t output_size )
5953{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005954 GUARD_MODULE_INITIALIZED;
5955
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005956#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5957
5958 size_t output_length = 0;
5959 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5960 output, output_size,
5961 &output_length );
5962 if( status != PSA_SUCCESS )
5963 return( status );
5964 /* Breaking up a request into smaller chunks is currently not supported
5965 * for the extrernal RNG interface. */
5966 if( output_length != output_size )
5967 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5968 return( PSA_SUCCESS );
5969
5970#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5971
Gilles Peskine71ddab92021-01-04 21:01:07 +01005972 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005973 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005974 size_t request_size =
5975 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5976 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5977 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005978 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5979 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005980 if( ret != 0 )
5981 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005982 output_size -= request_size;
5983 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005984 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005985 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005986#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005987}
5988
Gilles Peskine8814fc42020-12-14 15:33:44 +01005989/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005990 *
5991 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5992 * `psa_generate_random(...)`. The state parameter is ignored since the
5993 * PSA API doesn't support passing an explicit state.
5994 *
5995 * In the non-external case, psa_generate_random() calls an
5996 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5997 * and semantics as mbedtls_psa_get_random(). As an optimization,
5998 * instead of doing this back-and-forth between the PSA API and the
5999 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6000 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006001 */
6002#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6003int mbedtls_psa_get_random( void *p_rng,
6004 unsigned char *output,
6005 size_t output_size )
6006{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006007 /* This function takes a pointer to the RNG state because that's what
6008 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6009 * its own state internally and doesn't let the caller access that state.
6010 * So we just ignore the state parameter, and in practice we'll pass
6011 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006012 (void) p_rng;
6013 psa_status_t status = psa_generate_random( output, output_size );
6014 if( status == PSA_SUCCESS )
6015 return( 0 );
6016 else
6017 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6018}
6019#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6020
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006021#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00006022#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006023
Gilles Peskine7228da22019-07-15 11:06:15 +02006024psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006025 size_t seed_size )
6026{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006027 if( global_data.initialized )
6028 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006029
6030 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6031 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6032 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6033 return( PSA_ERROR_INVALID_ARGUMENT );
6034
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006035 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006036}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006037#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006038
Ronald Cron3772afe2021-02-08 16:10:05 +01006039/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02006040 *
Ronald Cron3772afe2021-02-08 16:10:05 +01006041 * \param type The key type
6042 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02006043 *
6044 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01006045 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02006046 * \retval #PSA_ERROR_INVALID_ARGUMENT
6047 * The size in bits of the key is not valid.
6048 * \retval #PSA_ERROR_NOT_SUPPORTED
6049 * The type and/or the size in bits of the key or the combination of
6050 * the two is not supported.
6051 */
Ronald Cron3772afe2021-02-08 16:10:05 +01006052static psa_status_t psa_validate_key_type_and_size_for_key_generation(
6053 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006054{
Ronald Cronf3bb7612020-10-02 20:11:59 +02006055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006056
Gilles Peskinee59236f2018-01-27 23:32:46 +01006057 if( key_type_is_raw_bytes( type ) )
6058 {
Archana4d7ae1d2021-07-07 02:50:22 +05306059 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006060 if( status != PSA_SUCCESS )
6061 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006062 }
6063 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006064#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006065 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6066 {
6067 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6068 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006069
Ronald Cron01b2aba2020-10-05 09:42:02 +02006070 /* Accept only byte-aligned keys, for the same reasons as
6071 * in psa_import_rsa_key(). */
6072 if( bits % 8 != 0 )
6073 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006074 }
6075 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006076#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006077
Ronald Cron5c4d3862020-12-07 11:07:24 +01006078#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02006079 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
6080 {
Ronald Crond81ab562021-02-16 09:01:16 +01006081 /* To avoid empty block, return successfully here. */
6082 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02006083 }
6084 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01006085#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02006086 {
6087 return( PSA_ERROR_NOT_SUPPORTED );
6088 }
6089
6090 return( PSA_SUCCESS );
6091}
6092
Ronald Cron55ed0592020-10-05 10:30:40 +02006093psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006094 const psa_key_attributes_t *attributes,
6095 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006096{
6097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006098 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006099
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006100 if( ( attributes->domain_parameters == NULL ) &&
6101 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006102 return( PSA_ERROR_INVALID_ARGUMENT );
6103
Ronald Cron01b2aba2020-10-05 09:42:02 +02006104 if( key_type_is_raw_bytes( type ) )
6105 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006106 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006107 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006108 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006109
David Brown12ca5032021-02-11 11:02:00 -07006110#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006111 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006112 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07006113#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006114 }
6115 else
6116
Jaeden Amero424fa932021-05-14 08:34:32 +01006117#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
6118 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006119 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006120 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01006121 return( mbedtls_psa_rsa_generate_key( attributes,
6122 key_buffer,
6123 key_buffer_size,
6124 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006125 }
6126 else
Jaeden Amero424fa932021-05-14 08:34:32 +01006127#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
6128 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006129
John Durkop9814fa22020-11-04 12:28:15 -08006130#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006131 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006132 {
Ronald Cron7023db52020-11-20 18:17:42 +01006133 return( mbedtls_psa_ecp_generate_key( attributes,
6134 key_buffer,
6135 key_buffer_size,
6136 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006137 }
6138 else
John Durkop9814fa22020-11-04 12:28:15 -08006139#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006140 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006141 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006142 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006143 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006144
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006145 return( PSA_SUCCESS );
6146}
Darryl Green0c6575a2018-11-07 16:05:30 +00006147
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006148psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006149 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006150{
6151 psa_status_t status;
6152 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006153 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02006154 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02006155
Ronald Cron81709fc2020-11-14 12:10:32 +01006156 *key = MBEDTLS_SVC_KEY_ID_INIT;
6157
Gilles Peskine0f84d622019-09-12 19:03:13 +02006158 /* Reject any attempt to create a zero-length key so that we don't
6159 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6160 if( psa_get_key_bits( attributes ) == 0 )
6161 return( PSA_ERROR_INVALID_ARGUMENT );
6162
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02006163 /* Reject any attempt to create a public key. */
6164 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
6165 return( PSA_ERROR_INVALID_ARGUMENT );
6166
Ronald Cron81709fc2020-11-14 12:10:32 +01006167 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6168 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006169 if( status != PSA_SUCCESS )
6170 goto exit;
6171
Ronald Cron977c2472020-10-13 08:32:21 +02006172 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05306173 * storage ( thus not in the case of generating a key in a secure element
6174 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
6175 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02006176 if( slot->key.data == NULL )
6177 {
6178 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
6179 PSA_KEY_LOCATION_LOCAL_STORAGE )
6180 {
Ronald Cron3772afe2021-02-08 16:10:05 +01006181 status = psa_validate_key_type_and_size_for_key_generation(
6182 attributes->core.type, attributes->core.bits );
6183 if( status != PSA_SUCCESS )
6184 goto exit;
6185
6186 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
6187 attributes->core.type,
6188 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02006189 }
6190 else
6191 {
6192 status = psa_driver_wrapper_get_key_buffer_size(
6193 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01006194 if( status != PSA_SUCCESS )
6195 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02006196 }
Ronald Cron977c2472020-10-13 08:32:21 +02006197
6198 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
6199 if( status != PSA_SUCCESS )
6200 goto exit;
6201 }
6202
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006203 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02006204 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02006205
Ronald Cron2b56bc82020-10-05 10:02:26 +02006206 if( status != PSA_SUCCESS )
6207 psa_remove_key_data_from_memory( slot );
6208
Gilles Peskine11792082019-08-06 18:36:36 +02006209exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006210 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006211 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006212 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006213 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006214
Darryl Green0c6575a2018-11-07 16:05:30 +00006215 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006216}
6217
Gilles Peskinee59236f2018-01-27 23:32:46 +01006218/****************************************************************/
6219/* Module setup */
6220/****************************************************************/
6221
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006222#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006223psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6224 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6225 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6226{
6227 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6228 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006229 global_data.rng.entropy_init = entropy_init;
6230 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006231 return( PSA_SUCCESS );
6232}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006233#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006234
Gilles Peskinee59236f2018-01-27 23:32:46 +01006235void mbedtls_psa_crypto_free( void )
6236{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006237 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006238 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6239 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006240 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006241 }
6242 /* Wipe all remaining data, including configuration.
6243 * In particular, this sets all state indicator to the value
6244 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006245 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Ronald Cron9ba76912021-04-10 16:57:30 +02006246
6247 /* Terminate drivers */
6248 psa_driver_wrapper_free( );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006249}
6250
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006251#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6252/** Recover a transaction that was interrupted by a power failure.
6253 *
6254 * This function is called during initialization, before psa_crypto_init()
6255 * returns. If this function returns a failure status, the initialization
6256 * fails.
6257 */
6258static psa_status_t psa_crypto_recover_transaction(
6259 const psa_crypto_transaction_t *transaction )
6260{
6261 switch( transaction->unknown.type )
6262 {
6263 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6264 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006265 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006266 * is implemented.
6267 * https://github.com/ARMmbed/mbed-crypto/issues/218
6268 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006269 default:
6270 /* We found an unsupported transaction in the storage.
6271 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006272 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006273 }
6274}
6275#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6276
Gilles Peskinee59236f2018-01-27 23:32:46 +01006277psa_status_t psa_crypto_init( void )
6278{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006279 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006280
Gilles Peskinec6b69072018-11-20 21:42:52 +01006281 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006282 if( global_data.initialized != 0 )
6283 return( PSA_SUCCESS );
6284
Gilles Peskine30524eb2020-11-13 17:02:26 +01006285 /* Initialize and seed the random generator. */
6286 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006287 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006288 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006289 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006290 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006291 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006292
Gilles Peskine66fb1262018-12-10 16:29:04 +01006293 status = psa_initialize_key_slots( );
6294 if( status != PSA_SUCCESS )
6295 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006296
Ronald Cron9ba76912021-04-10 16:57:30 +02006297 /* Init drivers */
6298 status = psa_driver_wrapper_init( );
Gilles Peskined9348f22019-10-01 15:22:29 +02006299 if( status != PSA_SUCCESS )
6300 goto exit;
Gilles Peskined9348f22019-10-01 15:22:29 +02006301
Gilles Peskine4b734222019-07-24 15:56:31 +02006302#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006303 status = psa_crypto_load_transaction( );
6304 if( status == PSA_SUCCESS )
6305 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006306 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6307 if( status != PSA_SUCCESS )
6308 goto exit;
6309 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006310 }
6311 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6312 {
6313 /* There's no transaction to complete. It's all good. */
6314 status = PSA_SUCCESS;
6315 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006316#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006317
Gilles Peskinec6b69072018-11-20 21:42:52 +01006318 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006319 global_data.initialized = 1;
6320
6321exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006322 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006323 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006324 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006325}
6326
6327#endif /* MBEDTLS_PSA_CRYPTO_C */