blob: 635981d95c9318ef815cf2135ff5d381fd0ec3b5 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
Gilles Peskinee59236f2018-01-27 23:32:46 +010029#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010030#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010031
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020055#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056#define mbedtls_calloc calloc
57#define mbedtls_free free
58#endif
59
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010060#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020061#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000062#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020063#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010064#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020065#include "mbedtls/chacha20.h"
66#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010067#include "mbedtls/cipher.h"
68#include "mbedtls/ccm.h"
69#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020071#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010072#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010073#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074#include "mbedtls/error.h"
75#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010077#include "mbedtls/md.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000078#include "md_wrap.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010079#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000080#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010081#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000082#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010083#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/sha1.h"
86#include "mbedtls/sha256.h"
87#include "mbedtls/sha512.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010088
Gilles Peskine996deb12018-08-01 15:45:45 +020089#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
90
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010091/****************************************************************/
92/* Global data, support functions and library management */
93/****************************************************************/
94
Gilles Peskine48c0ea12018-06-21 14:15:31 +020095static int key_type_is_raw_bytes( psa_key_type_t type )
96{
Gilles Peskine78b3bb62018-08-10 16:03:41 +020097 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +020098}
99
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100100/* Values for psa_global_data_t::rng_state */
101#define RNG_NOT_INITIALIZED 0
102#define RNG_INITIALIZED 1
103#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100104
Gilles Peskine2d277862018-06-18 15:41:12 +0200105typedef struct
106{
Gilles Peskinec6b69072018-11-20 21:42:52 +0100107 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100108 unsigned rng_state : 2;
Gilles Peskine2d8a1822021-11-08 22:20:03 +0100109 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100110} psa_global_data_t;
111
112static psa_global_data_t global_data;
113
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100114#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
115mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
116 &global_data.rng.drbg;
117#endif
118
itayzafrir0adf0fc2018-09-06 16:24:41 +0300119#define GUARD_MODULE_INITIALIZED \
120 if( global_data.initialized == 0 ) \
121 return( PSA_ERROR_BAD_STATE );
122
Steven Cooreman01164162020-07-20 15:31:37 +0200123psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100124{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100125 /* Mbed TLS error codes can combine a high-level error code and a
126 * low-level error code. The low-level error usually reflects the
127 * root cause better, so dispatch on that preferably. */
128 int low_level_ret = - ( -ret & 0x007f );
129 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100130 {
131 case 0:
132 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100133
134 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
135 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskinea5905292018-02-07 20:59:33 +0100136 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine9a944802018-06-21 09:35:35 +0200137 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
138 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
139 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
140 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
141 case MBEDTLS_ERR_ASN1_INVALID_DATA:
142 return( PSA_ERROR_INVALID_ARGUMENT );
143 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
144 return( PSA_ERROR_INSUFFICIENT_MEMORY );
145 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
146 return( PSA_ERROR_BUFFER_TOO_SMALL );
147
Jaeden Amero93e21112019-02-20 13:57:28 +0000148#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000149 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000150#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100151 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
152 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100153
154 case MBEDTLS_ERR_CCM_BAD_INPUT:
155 return( PSA_ERROR_INVALID_ARGUMENT );
156 case MBEDTLS_ERR_CCM_AUTH_FAILED:
157 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100158
Gilles Peskine26869f22019-05-06 15:25:00 +0200159 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
160 return( PSA_ERROR_INVALID_ARGUMENT );
161
162 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
163 return( PSA_ERROR_BAD_STATE );
164 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
165 return( PSA_ERROR_INVALID_SIGNATURE );
166
Gilles Peskinea5905292018-02-07 20:59:33 +0100167 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
168 return( PSA_ERROR_NOT_SUPPORTED );
169 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
170 return( PSA_ERROR_INVALID_ARGUMENT );
171 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
172 return( PSA_ERROR_INSUFFICIENT_MEMORY );
173 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
174 return( PSA_ERROR_INVALID_PADDING );
175 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200176 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100177 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
178 return( PSA_ERROR_INVALID_SIGNATURE );
179 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200180 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100181
Gilles Peskine82e57d12020-11-13 21:31:17 +0100182#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
183 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100184 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
185 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100186 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
187 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
188 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
189 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
190 return( PSA_ERROR_NOT_SUPPORTED );
191 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
192 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100193#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100194
195 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
196 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Gilles Peskinee59236f2018-01-27 23:32:46 +0100198 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
199 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
200 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
201 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100202
203 case MBEDTLS_ERR_GCM_AUTH_FAILED:
204 return( PSA_ERROR_INVALID_SIGNATURE );
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200205 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
206 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100207 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200208 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100209
Gilles Peskine82e57d12020-11-13 21:31:17 +0100210#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
211 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100212 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
213 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100214 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
215 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
216 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
217 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
218 return( PSA_ERROR_NOT_SUPPORTED );
219 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
220 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
221#endif
222
Gilles Peskinea5905292018-02-07 20:59:33 +0100223 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
224 return( PSA_ERROR_NOT_SUPPORTED );
225 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
226 return( PSA_ERROR_INVALID_ARGUMENT );
227 case MBEDTLS_ERR_MD_ALLOC_FAILED:
228 return( PSA_ERROR_INSUFFICIENT_MEMORY );
229 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
230 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100231
Gilles Peskinef76aa772018-10-29 19:24:33 +0100232 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
233 return( PSA_ERROR_STORAGE_FAILURE );
234 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
235 return( PSA_ERROR_INVALID_ARGUMENT );
236 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
237 return( PSA_ERROR_INVALID_ARGUMENT );
238 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
239 return( PSA_ERROR_BUFFER_TOO_SMALL );
240 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
241 return( PSA_ERROR_INVALID_ARGUMENT );
242 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
243 return( PSA_ERROR_INVALID_ARGUMENT );
244 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
245 return( PSA_ERROR_INVALID_ARGUMENT );
246 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
247 return( PSA_ERROR_INSUFFICIENT_MEMORY );
248
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100249 case MBEDTLS_ERR_PK_ALLOC_FAILED:
250 return( PSA_ERROR_INSUFFICIENT_MEMORY );
251 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
252 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
253 return( PSA_ERROR_INVALID_ARGUMENT );
254 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100255 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100256 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
257 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
258 return( PSA_ERROR_INVALID_ARGUMENT );
259 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
260 return( PSA_ERROR_NOT_SUPPORTED );
261 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
262 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
263 return( PSA_ERROR_NOT_PERMITTED );
264 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
265 return( PSA_ERROR_INVALID_ARGUMENT );
266 case MBEDTLS_ERR_PK_INVALID_ALG:
267 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
268 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
269 return( PSA_ERROR_NOT_SUPPORTED );
270 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
271 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200272 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
273 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea5905292018-02-07 20:59:33 +0100274
Gilles Peskineff2d2002019-05-06 15:26:23 +0200275 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
276 return( PSA_ERROR_HARDWARE_FAILURE );
277 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
278 return( PSA_ERROR_NOT_SUPPORTED );
279
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
281 return( PSA_ERROR_INVALID_ARGUMENT );
282 case MBEDTLS_ERR_RSA_INVALID_PADDING:
283 return( PSA_ERROR_INVALID_PADDING );
284 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
285 return( PSA_ERROR_HARDWARE_FAILURE );
286 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
289 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200290 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100291 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
292 return( PSA_ERROR_INVALID_SIGNATURE );
293 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
294 return( PSA_ERROR_BUFFER_TOO_SMALL );
295 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100296 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200297
itayzafrir5c753392018-05-08 11:18:38 +0300298 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300299 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300300 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300301 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
302 return( PSA_ERROR_BUFFER_TOO_SMALL );
303 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
304 return( PSA_ERROR_NOT_SUPPORTED );
305 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
306 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
307 return( PSA_ERROR_INVALID_SIGNATURE );
308 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
309 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100310 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
311 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100312
Janos Follatha13b9052019-11-22 12:48:59 +0000313 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
314 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300315
Gilles Peskinee59236f2018-01-27 23:32:46 +0100316 default:
David Saadab4ecc272019-02-14 13:48:10 +0200317 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100318 }
319}
320
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200321
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200322
323
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100324/****************************************************************/
325/* Key management */
326/****************************************************************/
327
John Durkop9814fa22020-11-04 12:28:15 -0800328#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800329 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cronf467d632021-11-19 18:02:34 +0100330 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
331 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
332 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100333mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100334 size_t bits,
335 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200336{
337 switch( curve )
338 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100339 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100340 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100341 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100342#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100343 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100344 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100345#endif
346#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100347 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100348 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100349#endif
350#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100351 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100352 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100353#endif
354#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100355 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100356 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100357#endif
358#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100359 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100360 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100361 case 528:
362 if( bits_is_sloppy )
363 return( MBEDTLS_ECP_DP_SECP521R1 );
364 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100365#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100366 }
367 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100368
Paul Elliott8ff510a2020-06-02 17:19:28 +0100369 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100370 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100371 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100372#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100373 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100374 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100375#endif
376#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100377 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100378 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100379#endif
380#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100381 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100382 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100383#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100384 }
385 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100386
Paul Elliott8ff510a2020-06-02 17:19:28 +0100387 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100388 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100389 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100390#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100391 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100392 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100393 case 256:
394 if( bits_is_sloppy )
395 return( MBEDTLS_ECP_DP_CURVE25519 );
396 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100397#endif
398#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100399 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100400 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100401#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100402 }
403 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100404
Paul Elliott8ff510a2020-06-02 17:19:28 +0100405 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100406 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100407 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100408#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100409 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100410 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100411#endif
412#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100413 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100414 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100415#endif
416#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100417 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100418 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100419#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 }
421 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200422 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100424 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100425 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200426}
John Durkop9814fa22020-11-04 12:28:15 -0800427#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cronf467d632021-11-19 18:02:34 +0100428 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
429 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
430 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
431 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200432
Archana4d7ae1d2021-07-07 02:50:22 +0530433psa_status_t psa_validate_unstructured_key_bit_size( psa_key_type_t type,
Archana449608b2021-09-08 15:36:05 +0530434 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200435{
436 /* Check that the bit size is acceptable for the key type */
437 switch( type )
438 {
439 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200441 case PSA_KEY_TYPE_DERIVE:
442 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100443#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_AES:
445 if( bits != 128 && bits != 192 && bits != 256 )
446 return( PSA_ERROR_INVALID_ARGUMENT );
447 break;
448#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200449#if defined(PSA_WANT_KEY_TYPE_ARIA)
450 case PSA_KEY_TYPE_ARIA:
451 if( bits != 128 && bits != 192 && bits != 256 )
452 return( PSA_ERROR_INVALID_ARGUMENT );
453 break;
454#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100455#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200456 case PSA_KEY_TYPE_CAMELLIA:
457 if( bits != 128 && bits != 192 && bits != 256 )
458 return( PSA_ERROR_INVALID_ARGUMENT );
459 break;
460#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100461#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200462 case PSA_KEY_TYPE_DES:
463 if( bits != 64 && bits != 128 && bits != 192 )
464 return( PSA_ERROR_INVALID_ARGUMENT );
465 break;
466#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100467#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200468 case PSA_KEY_TYPE_CHACHA20:
469 if( bits != 256 )
470 return( PSA_ERROR_INVALID_ARGUMENT );
471 break;
472#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200473 default:
474 return( PSA_ERROR_NOT_SUPPORTED );
475 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200476 if( bits % 8 != 0 )
477 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200478
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200479 return( PSA_SUCCESS );
480}
481
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100482/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100483 *
Steven Cooremancd640932021-03-08 12:00:27 +0100484 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
485 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100486 *
487 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100488 * \param[in] key_type The key type of the key to be used with the
489 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100490 *
491 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100492 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100493 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100496MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100497 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100499{
Steven Cooremancd640932021-03-08 12:00:27 +0100500 if( PSA_ALG_IS_HMAC( algorithm ) )
501 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100502 if( key_type == PSA_KEY_TYPE_HMAC )
503 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100504 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100505
506 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
509 * key. */
510 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
511 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
512 {
513 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
514 * the block length (larger than 1) for block ciphers. */
515 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
516 return( PSA_SUCCESS );
517 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100518 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100519
520 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100521}
522
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200523psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
524 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200525{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100526 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200527 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200528
Ronald Cronea0f8a62020-11-25 17:52:23 +0100529 slot->key.data = mbedtls_calloc( 1, buffer_length );
530 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200531 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200532
Ronald Cronea0f8a62020-11-25 17:52:23 +0100533 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200534 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200535}
536
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200537psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
538 const uint8_t* data,
539 size_t data_length )
540{
541 psa_status_t status = psa_allocate_buffer_to_slot( slot,
542 data_length );
543 if( status != PSA_SUCCESS )
544 return( status );
545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200547 return( PSA_SUCCESS );
548}
549
Ronald Crona0fe59f2020-11-29 11:14:53 +0100550psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100551 const psa_key_attributes_t *attributes,
552 const uint8_t *data, size_t data_length,
553 uint8_t *key_buffer, size_t key_buffer_size,
554 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100555{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
557 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100558
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200559 /* zero-length keys are never supported. */
560 if( data_length == 0 )
561 return( PSA_ERROR_NOT_SUPPORTED );
562
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100563 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100564 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200566
Archana449608b2021-09-08 15:36:05 +0530567 status = psa_validate_unstructured_key_bit_size( attributes->core.type,
568 *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200569 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200570 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200571
Ronald Crondd04d422020-11-28 15:14:42 +0100572 /* Copy the key material. */
573 memcpy( key_buffer, data, data_length );
574 *key_buffer_length = data_length;
575 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200576
Steven Cooreman40120f62020-10-29 11:42:22 +0100577 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100578 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100579 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200580 {
John Durkop9814fa22020-11-04 12:28:15 -0800581#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
582 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100583 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200584 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100585 return( mbedtls_psa_ecp_import_key( attributes,
586 data, data_length,
587 key_buffer, key_buffer_size,
588 key_buffer_length,
589 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100590 }
John Durkop9814fa22020-11-04 12:28:15 -0800591#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
592 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700593#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100595 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200596 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100597 return( mbedtls_psa_rsa_import_key( attributes,
598 data, data_length,
599 key_buffer, key_buffer_size,
600 key_buffer_length,
601 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200602 }
John Durkop9814fa22020-11-04 12:28:15 -0800603#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
604 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100606
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100608}
609
Gilles Peskinef603c712019-01-19 13:40:11 +0100610/** Calculate the intersection of two algorithm usage policies.
611 *
612 * Return 0 (which allows no operation) on incompatibility.
613 */
614static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100615 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100616 psa_algorithm_t alg1,
617 psa_algorithm_t alg2 )
618{
Gilles Peskine549ea862019-05-22 11:45:59 +0200619 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100620 if( alg1 == alg2 )
621 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100622 /* If the policies are from the same hash-and-sign family, check
623 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200624 if( PSA_ALG_IS_SIGN_HASH( alg1 ) &&
625 PSA_ALG_IS_SIGN_HASH( alg2 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100626 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100627 {
Steven Cooreman03488022021-02-18 12:07:20 +0100628 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
629 return( alg2 );
630 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
631 return( alg1 );
632 }
633 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100634 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100635 * restrictive tag length. */
636 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
637 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
638 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
639 {
640 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
641 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100642 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100643
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100644 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100645 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
646 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100647 {
Steven Cooremancd640932021-03-08 12:00:27 +0100648 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
649 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100650 }
651 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100652 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100653 ( alg1_len <= alg2_len ) )
654 {
655 return( alg2 );
656 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100657 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100658 ( alg2_len <= alg1_len ) )
659 {
660 return( alg1 );
661 }
662 }
663 /* If the policies are from the same MAC family, check whether one
664 * of them is a minimum-MAC-length policy. Calculate the most
665 * restrictive tag length. */
666 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
667 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
668 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
669 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100670 /* Validate the combination of key type and algorithm. Since the base
671 * algorithm of alg1 and alg2 are the same, we only need this once. */
672 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100673 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100674
Steven Cooreman31a876d2021-03-03 20:47:40 +0100675 /* Get the (exact or at-least) output lengths for both sides of the
676 * requested intersection. None of the currently supported algorithms
677 * have an output length dependent on the actual key size, so setting it
678 * to a bogus value of 0 is currently OK.
679 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100680 * Note that for at-least-this-length wildcard algorithms, the output
681 * length is set to the shortest allowed length, which allows us to
682 * calculate the most restrictive tag length for the intersection. */
683 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
684 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100685 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100686
Steven Cooremana1d83222021-02-25 10:20:29 +0100687 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100688 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
689 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100690 {
Steven Cooremancd640932021-03-08 12:00:27 +0100691 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100692 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100693
694 /* If only one is an at-least-this-length policy, the intersection would
695 * be the other (fixed-length) policy as long as said fixed length is
696 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100697 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100698 {
Steven Cooremancd640932021-03-08 12:00:27 +0100699 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100700 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100701 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100702 {
Steven Cooremancd640932021-03-08 12:00:27 +0100703 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100704 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100705
Steven Cooremancd640932021-03-08 12:00:27 +0100706 /* If none of them are wildcards, check whether they define the same tag
707 * length. This is still possible here when one is default-length and
708 * the other specific-length. Ensure to always return the
709 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100710 if( alg1_len == alg2_len )
711 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100712 }
713 /* If the policies are incompatible, allow nothing. */
714 return( 0 );
715}
716
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100717static int psa_key_algorithm_permits( psa_key_type_t key_type,
718 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200719 psa_algorithm_t requested_alg )
720{
Gilles Peskine549ea862019-05-22 11:45:59 +0200721 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200722 if( requested_alg == policy_alg )
723 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100724 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
725 * and requested_alg is the same hash-and-sign family with any hash,
726 * then requested_alg is compliant with policy_alg. */
Gilles Peskinef7b41372021-09-22 16:15:05 +0200727 if( PSA_ALG_IS_SIGN_HASH( requested_alg ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100728 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200729 {
Steven Cooreman03488022021-02-18 12:07:20 +0100730 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
731 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
732 }
733 /* If policy_alg is a wildcard AEAD algorithm of the same base as
734 * the requested algorithm, check the requested tag length to be
735 * equal-length or longer than the wildcard-specified length. */
736 if( PSA_ALG_IS_AEAD( policy_alg ) &&
737 PSA_ALG_IS_AEAD( requested_alg ) &&
738 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
739 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100740 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100741 {
742 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
743 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
744 }
Steven Cooremancd640932021-03-08 12:00:27 +0100745 /* If policy_alg is a MAC algorithm of the same base as the requested
746 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100747 if( PSA_ALG_IS_MAC( policy_alg ) &&
748 PSA_ALG_IS_MAC( requested_alg ) &&
749 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100750 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100751 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100752 /* Validate the combination of key type and algorithm. Since the policy
753 * and requested algorithms are the same, we only need this once. */
754 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100755 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100756
Steven Cooreman31a876d2021-03-03 20:47:40 +0100757 /* Get both the requested output length for the algorithm which is to be
758 * verified, and the default output length for the base algorithm.
759 * Note that none of the currently supported algorithms have an output
760 * length dependent on actual key size, so setting it to a bogus value
761 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100762 size_t requested_output_length = PSA_MAC_LENGTH(
763 key_type, 0, requested_alg );
764 size_t default_output_length = PSA_MAC_LENGTH(
765 key_type, 0,
766 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100767
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100768 /* If the policy is default-length, only allow an algorithm with
769 * a declared exact-length matching the default. */
770 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100772
773 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100774 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100775 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
776 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
777 {
778 return( 1 );
779 }
780
Steven Cooremancd640932021-03-08 12:00:27 +0100781 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
782 * check for the requested MAC length to be equal to or longer than the
783 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
785 {
786 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100787 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100788 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200789 }
Steven Cooremance48e852020-10-05 16:02:45 +0200790 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200791 * a key derivation with that key agreement should also be allowed. This
792 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200793 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
794 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
795 {
796 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
797 policy_alg );
798 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100799 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200800 return( 0 );
801}
802
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100803/** Test whether a policy permits an algorithm.
804 *
805 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100806 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100807 * \note This function requires providing the key type for which the policy is
808 * being validated, since some algorithm policy definitions (e.g. MAC)
809 * have different properties depending on what kind of cipher it is
810 * combined with.
811 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100812 * \retval PSA_SUCCESS When \p alg is a specific algorithm
813 * allowed by the \p policy.
814 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
815 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
816 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100817 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100818static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100819 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100820 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100821{
Steven Cooremand788fab2021-02-25 11:29:17 +0100822 /* '0' is not a valid algorithm */
823 if( alg == 0 )
824 return( PSA_ERROR_INVALID_ARGUMENT );
825
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 /* A requested algorithm cannot be a wildcard. */
827 if( PSA_ALG_IS_WILDCARD( alg ) )
828 return( PSA_ERROR_INVALID_ARGUMENT );
829
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100830 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
831 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 return( PSA_SUCCESS );
833 else
834 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100835}
836
Gilles Peskinef603c712019-01-19 13:40:11 +0100837/** Restrict a key policy based on a constraint.
838 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100839 * \note This function requires providing the key type for which the policy is
840 * being restricted, since some algorithm policy definitions (e.g. MAC)
841 * have different properties depending on what kind of cipher it is
842 * combined with.
843 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100844 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100845 * \param[in,out] policy The policy to restrict.
846 * \param[in] constraint The policy constraint to apply.
847 *
848 * \retval #PSA_SUCCESS
849 * \c *policy contains the intersection of the original value of
850 * \c *policy and \c *constraint.
851 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100852 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100853 * \c *policy is unchanged.
854 */
855static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100856 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100857 psa_key_policy_t *policy,
858 const psa_key_policy_t *constraint )
859{
860 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 psa_key_policy_algorithm_intersection( key_type, policy->alg,
862 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200863 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100864 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
865 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
867 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200868 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
869 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100870 policy->usage &= constraint->usage;
871 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100873 return( PSA_SUCCESS );
874}
875
Ronald Cron5c522922020-11-14 16:35:34 +0100876/** Get the description of a key given its identifier and policy constraints
877 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200878 *
Ronald Cron5c522922020-11-14 16:35:34 +0100879 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100880 * nonzero, the key must allow operations with this algorithm. If \p alg is
881 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100882 *
Ronald Cron5c522922020-11-14 16:35:34 +0100883 * In case of a persistent key, the function loads the description of the key
884 * into a key slot if not already done.
885 *
886 * On success, the returned key slot is locked. It is the responsibility of
887 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200888 */
Ronald Cron5c522922020-11-14 16:35:34 +0100889static psa_status_t psa_get_and_lock_key_slot_with_policy(
890 mbedtls_svc_key_id_t key,
891 psa_key_slot_t **p_slot,
892 psa_key_usage_t usage,
893 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100894{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
896 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100897
Ronald Cron5c522922020-11-14 16:35:34 +0100898 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100899 if( status != PSA_SUCCESS )
900 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200901 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100902
903 /* Enforce that usage policy for the key slot contains all the flags
904 * required by the usage parameter. There is one exception: public
905 * keys can always be exported, so we treat public key objects as
906 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200907 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100908 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200909
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100911 {
912 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200913 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100914 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100915
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800916 /* Enforce that the usage policy permits the requested algorithm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100917 if( alg != 0 )
918 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100919 status = psa_key_policy_permits( &slot->attr.policy,
920 slot->attr.type,
921 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 if( status != PSA_SUCCESS )
923 goto error;
924 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100925
Darryl Green06fd18d2018-07-16 11:21:11 +0100926 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200927
928error:
929 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100930 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200931
932 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100933}
Darryl Green940d72c2018-07-13 13:18:51 +0100934
Ronald Cron5c522922020-11-14 16:35:34 +0100935/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200936 *
937 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200938 * available, as opposed to a key in a secure element and/or to be used
939 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200940 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200941 * This is a temporary function that may be used instead of
942 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
943 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200944 *
Ronald Cron5c522922020-11-14 16:35:34 +0100945 * On success, the returned key slot is locked. It is the responsibility of the
946 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200947 */
Ronald Cron5c522922020-11-14 16:35:34 +0100948static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
949 mbedtls_svc_key_id_t key,
950 psa_key_slot_t **p_slot,
951 psa_key_usage_t usage,
952 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200953{
Ronald Cron5c522922020-11-14 16:35:34 +0100954 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
955 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200956 if( status != PSA_SUCCESS )
957 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Ronald Cronddae0f52021-08-24 15:39:44 +0200959 if( psa_key_lifetime_is_external( (*p_slot)->attr.lifetime ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200960 {
Ronald Cron5c522922020-11-14 16:35:34 +0100961 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200962 *p_slot = NULL;
963 return( PSA_ERROR_NOT_SUPPORTED );
964 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200965
Gilles Peskine28f8f302019-07-24 13:30:31 +0200966 return( PSA_SUCCESS );
967}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968
Steven Cooreman7ddee7f2021-04-07 18:08:30 +0200969psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000970{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100971 /* Data pointer will always be either a valid pointer or NULL in an
972 * initialized slot, so we can just free it. */
973 if( slot->key.data != NULL )
974 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
975
976 mbedtls_free( slot->key.data );
977 slot->key.data = NULL;
978 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000979
980 return( PSA_SUCCESS );
981}
982
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100983/** Completely wipe a slot in memory, including its policy.
984 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100985psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100986{
987 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100988
TRodziewicz18cddc02021-07-13 12:19:15 +0200989 /*
990 * As the return error code may not be handled in case of multiple errors,
TRodziewiczc9890e92021-07-14 10:16:26 +0200991 * do our best to report an unexpected lock counter. Assert with
992 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
993 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
994 * function is called as part of the execution of a test suite, the
995 * execution of the test suite is stopped in error if the assertion fails.
TRodziewicz18cddc02021-07-13 12:19:15 +0200996 */
Ronald Cron5c522922020-11-14 16:35:34 +0100997 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100998 {
TRodziewicz7871c2e2021-07-07 17:29:43 +0200999 MBEDTLS_TEST_HOOK_TEST_ASSERT( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 status = PSA_ERROR_CORRUPTION_DETECTED;
1001 }
1002
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001003 /* Multipart operations may still be using the key. This is safe
1004 * because all multipart operation objects are independent from
1005 * the key slot: if they need to access the key after the setup
1006 * phase, they have a copy of the key. Note that this means that
1007 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001008 /* At this point, key material and other type-specific content has
1009 * been wiped. Clear remaining metadata. We can call memset and not
1010 * zeroize because the metadata is not particularly sensitive. */
1011 memset( slot, 0, sizeof( *slot ) );
1012 return( status );
1013}
1014
Ronald Croncf56a0a2020-08-04 09:51:30 +02001015psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001016{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001017 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001018 psa_status_t status; /* status of the last operation */
1019 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001020#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1021 psa_se_drv_table_entry_t *driver;
1022#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001023
Ronald Croncf56a0a2020-08-04 09:51:30 +02001024 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001025 return( PSA_SUCCESS );
1026
Ronald Cronf2911112020-10-29 17:51:10 +01001027 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001028 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001029 * key, this will load the key description from persistent memory if not
1030 * done yet. We cannot avoid this loading as without it we don't know if
1031 * the key is operated by an SE or not and this information is needed by
1032 * the current implementation.
1033 */
Ronald Cron5c522922020-11-14 16:35:34 +01001034 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001035 if( status != PSA_SUCCESS )
1036 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001037
Ronald Cronf2911112020-10-29 17:51:10 +01001038 /*
1039 * If the key slot containing the key description is under access by the
1040 * library (apart from the present access), the key cannot be destroyed
1041 * yet. For the time being, just return in error. Eventually (to be
1042 * implemented), the key should be destroyed when all accesses have
1043 * stopped.
1044 */
Ronald Cron5c522922020-11-14 16:35:34 +01001045 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001046 {
Ronald Cron5c522922020-11-14 16:35:34 +01001047 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001048 return( PSA_ERROR_GENERIC_ERROR );
1049 }
1050
Gilles Peskine6687cd02021-04-21 22:32:05 +02001051 if( PSA_KEY_LIFETIME_IS_READ_ONLY( slot->attr.lifetime ) )
1052 {
1053 /* Refuse the destruction of a read-only key (which may or may not work
1054 * if we attempt it, depending on whether the key is merely read-only
1055 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001056 * Just do the best we can, which is to wipe the copy in memory
1057 * (done in this function's cleanup code). */
1058 overall_status = PSA_ERROR_NOT_PERMITTED;
1059 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001060 }
1061
Gilles Peskine354f7672019-07-12 23:46:38 +02001062#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001063 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001064 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001065 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001066 /* For a key in a secure element, we need to do three things:
1067 * remove the key file in internal storage, destroy the
1068 * key inside the secure element, and update the driver's
1069 * persistent data. Start a transaction that will encompass these
1070 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001071 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001072 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001073 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001074 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001075 status = psa_crypto_save_transaction( );
1076 if( status != PSA_SUCCESS )
1077 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001078 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001079 /* We should still try to destroy the key in the secure
1080 * element and the key metadata in storage. This is especially
1081 * important if the error is that the storage is full.
1082 * But how to do it exactly without risking an inconsistent
1083 * state after a reset?
1084 * https://github.com/ARMmbed/mbed-crypto/issues/215
1085 */
1086 overall_status = status;
1087 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001088 }
1089
Ronald Cronea0f8a62020-11-25 17:52:23 +01001090 status = psa_destroy_se_key( driver,
1091 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 if( overall_status == PSA_SUCCESS )
1093 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001094 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001095#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1096
Darryl Greend49a4992018-06-18 17:27:26 +01001097#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001098 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001099 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001100 status = psa_destroy_persistent_key( slot->attr.id );
1101 if( overall_status == PSA_SUCCESS )
1102 overall_status = status;
1103
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001104 /* TODO: other slots may have a copy of the same key. We should
1105 * invalidate them.
1106 * https://github.com/ARMmbed/mbed-crypto/issues/214
1107 */
Darryl Greend49a4992018-06-18 17:27:26 +01001108 }
1109#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001110
Gilles Peskinefc762652019-07-22 19:30:34 +02001111#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1112 if( driver != NULL )
1113 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001114 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001115 if( overall_status == PSA_SUCCESS )
1116 overall_status = status;
1117 status = psa_crypto_stop_transaction( );
1118 if( overall_status == PSA_SUCCESS )
1119 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001120 }
1121#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1122
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001123exit:
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001124 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001125 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001126 if( status != PSA_SUCCESS )
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 overall_status = status;
1128 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001129}
1130
John Durkop07cc04a2020-11-16 22:08:34 -08001131#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001132 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001133static psa_status_t psa_get_rsa_public_exponent(
1134 const mbedtls_rsa_context *rsa,
1135 psa_key_attributes_t *attributes )
1136{
1137 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001139 uint8_t *buffer = NULL;
1140 size_t buflen;
1141 mbedtls_mpi_init( &mpi );
1142
1143 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1144 if( ret != 0 )
1145 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001146 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1147 {
1148 /* It's the default value, which is reported as an empty string,
1149 * so there's nothing to do. */
1150 goto exit;
1151 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001152
1153 buflen = mbedtls_mpi_size( &mpi );
1154 buffer = mbedtls_calloc( 1, buflen );
1155 if( buffer == NULL )
1156 {
1157 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1158 goto exit;
1159 }
1160 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1161 if( ret != 0 )
1162 goto exit;
1163 attributes->domain_parameters = buffer;
1164 attributes->domain_parameters_size = buflen;
1165
1166exit:
1167 mbedtls_mpi_free( &mpi );
1168 if( ret != 0 )
1169 mbedtls_free( buffer );
1170 return( mbedtls_to_psa_error( ret ) );
1171}
John Durkop07cc04a2020-11-16 22:08:34 -08001172#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001173 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001174
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001175/** Retrieve all the publicly-accessible attributes of a key.
1176 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001177psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001178 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001180 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001181 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001182 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001183
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001184 psa_reset_key_attributes( attributes );
1185
Ronald Cron5c522922020-11-14 16:35:34 +01001186 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001187 if( status != PSA_SUCCESS )
1188 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001189
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001190 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001191 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1192 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1193
1194#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron512ad812021-08-24 15:50:05 +02001195 if( psa_get_se_driver_entry( slot->attr.lifetime ) != NULL )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001196 psa_set_key_slot_number( attributes,
1197 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001198#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskine8e338702019-07-30 20:06:31 +02001200 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001201 {
John Durkop07cc04a2020-11-16 22:08:34 -08001202#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001203 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001204 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001205 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001206 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001207 * is not yet implemented.
1208 * https://github.com/ARMmbed/mbed-crypto/issues/216
1209 */
Ronald Cron9b8b69c2021-08-24 16:00:51 +02001210 if( ! psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02001211 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001212 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001213
Ronald Cron90857082020-11-25 14:58:33 +01001214 status = mbedtls_psa_rsa_load_representation(
1215 slot->attr.type,
1216 slot->key.data,
1217 slot->key.bytes,
1218 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001219 if( status != PSA_SUCCESS )
1220 break;
1221
Steven Cooremana2371e52020-07-28 14:30:39 +02001222 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001223 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001224 mbedtls_rsa_free( rsa );
1225 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001226 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001227 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001228#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001229 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001230 default:
1231 /* Nothing else to do. */
1232 break;
1233 }
1234
1235 if( status != PSA_SUCCESS )
1236 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001237
Ronald Cron5c522922020-11-14 16:35:34 +01001238 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001239
Ronald Cron5c522922020-11-14 16:35:34 +01001240 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001241}
1242
Gilles Peskinec8000c02019-08-02 20:15:51 +02001243#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1244psa_status_t psa_get_key_slot_number(
1245 const psa_key_attributes_t *attributes,
1246 psa_key_slot_number_t *slot_number )
1247{
1248 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1249 {
1250 *slot_number = attributes->slot_number;
1251 return( PSA_SUCCESS );
1252 }
1253 else
1254 return( PSA_ERROR_INVALID_ARGUMENT );
1255}
1256#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1257
Ronald Crond18b5f82020-11-25 16:46:05 +01001258static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1259 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001260 uint8_t *data,
1261 size_t data_size,
1262 size_t *data_length )
1263{
Ronald Crond18b5f82020-11-25 16:46:05 +01001264 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001265 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001266 memcpy( data, key_buffer, key_buffer_size );
1267 memset( data + key_buffer_size, 0,
1268 data_size - key_buffer_size );
1269 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001270 return( PSA_SUCCESS );
1271}
1272
Ronald Cron7285cda2020-11-26 14:46:37 +01001273psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001274 const psa_key_attributes_t *attributes,
1275 const uint8_t *key_buffer, size_t key_buffer_size,
1276 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001277{
Ronald Crond18b5f82020-11-25 16:46:05 +01001278 psa_key_type_t type = attributes->core.type;
1279
Ronald Crond18b5f82020-11-25 16:46:05 +01001280 if( key_type_is_raw_bytes( type ) ||
1281 PSA_KEY_TYPE_IS_RSA( type ) ||
1282 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001283 {
1284 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001285 key_buffer, key_buffer_size,
1286 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001287 }
1288 else
1289 {
1290 /* This shouldn't happen in the reference implementation, but
1291 it is valid for a special-purpose implementation to omit
1292 support for exporting certain key types. */
1293 return( PSA_ERROR_NOT_SUPPORTED );
1294 }
1295}
1296
1297psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1298 uint8_t *data,
1299 size_t data_size,
1300 size_t *data_length )
1301{
1302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1303 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1304 psa_key_slot_t *slot;
1305
Ronald Crone907e552021-01-18 13:22:38 +01001306 /* Reject a zero-length output buffer now, since this can never be a
1307 * valid key representation. This way we know that data must be a valid
1308 * pointer and we can do things like memset(data, ..., data_size). */
1309 if( data_size == 0 )
1310 return( PSA_ERROR_BUFFER_TOO_SMALL );
1311
Ronald Cron9486f9d2020-11-26 13:36:23 +01001312 /* Set the key to empty now, so that even when there are errors, we always
1313 * set data_length to a value between 0 and data_size. On error, setting
1314 * the key to empty is a good choice because an empty key representation is
1315 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001316 *data_length = 0;
1317
Ronald Cron9486f9d2020-11-26 13:36:23 +01001318 /* Export requires the EXPORT flag. There is an exception for public keys,
1319 * which don't require any flag, but
1320 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1321 */
1322 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1323 PSA_KEY_USAGE_EXPORT, 0 );
1324 if( status != PSA_SUCCESS )
1325 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001326
Ronald Crond18b5f82020-11-25 16:46:05 +01001327 psa_key_attributes_t attributes = {
1328 .core = slot->attr
1329 };
Ronald Cron67227982020-11-26 15:16:05 +01001330 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001331 slot->key.data, slot->key.bytes,
1332 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001333
Ronald Cron9486f9d2020-11-26 13:36:23 +01001334 unlock_status = psa_unlock_key_slot( slot );
1335
1336 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1337}
1338
Ronald Cron7285cda2020-11-26 14:46:37 +01001339psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 const psa_key_attributes_t *attributes,
1341 const uint8_t *key_buffer,
1342 size_t key_buffer_size,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001346{
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001348
Ronald Crond18b5f82020-11-25 16:46:05 +01001349 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001350 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001352 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001353 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001354 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001355 key_buffer, key_buffer_size,
1356 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001357 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001358
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001360 {
John Durkop0e005192020-10-31 22:06:54 -07001361#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1362 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001363 return( mbedtls_psa_rsa_export_public_key( attributes,
1364 key_buffer,
1365 key_buffer_size,
1366 data,
1367 data_size,
1368 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001369#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001370 /* We don't know how to convert a private RSA key to public. */
1371 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001372#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1373 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001374 }
1375 else
Moran Pekera998bc62018-04-16 18:16:20 +03001376 {
John Durkop6ba40d12020-11-10 08:50:04 -08001377#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1378 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001379 return( mbedtls_psa_ecp_export_public_key( attributes,
1380 key_buffer,
1381 key_buffer_size,
1382 data,
1383 data_size,
1384 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001385#else
1386 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001387 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001388#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001390 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001391 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001392 else
1393 {
1394 /* This shouldn't happen in the reference implementation, but
1395 it is valid for a special-purpose implementation to omit
1396 support for exporting certain key types. */
1397 return( PSA_ERROR_NOT_SUPPORTED );
1398 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001399}
Ronald Crond18b5f82020-11-25 16:46:05 +01001400
Ronald Croncf56a0a2020-08-04 09:51:30 +02001401psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001402 uint8_t *data,
1403 size_t data_size,
1404 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001405{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001407 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001408 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001409
Ronald Crone907e552021-01-18 13:22:38 +01001410 /* Reject a zero-length output buffer now, since this can never be a
1411 * valid key representation. This way we know that data must be a valid
1412 * pointer and we can do things like memset(data, ..., data_size). */
1413 if( data_size == 0 )
1414 return( PSA_ERROR_BUFFER_TOO_SMALL );
1415
Darryl Greendd8fb772018-11-07 16:00:44 +00001416 /* Set the key to empty now, so that even when there are errors, we always
1417 * set data_length to a value between 0 and data_size. On error, setting
1418 * the key to empty is a good choice because an empty key representation is
1419 * unlikely to be accepted anywhere. */
1420 *data_length = 0;
1421
1422 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001423 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001424 if( status != PSA_SUCCESS )
1425 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001426
Ronald Cron9486f9d2020-11-26 13:36:23 +01001427 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1428 {
1429 status = PSA_ERROR_INVALID_ARGUMENT;
1430 goto exit;
1431 }
1432
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 psa_key_attributes_t attributes = {
1434 .core = slot->attr
1435 };
Ronald Cron67227982020-11-26 15:16:05 +01001436 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001437 &attributes, slot->key.data, slot->key.bytes,
1438 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001439
1440exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001441 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001442
Ronald Cron5c522922020-11-14 16:35:34 +01001443 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001444}
1445
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446#if defined(static_assert)
1447static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1448 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001449static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001450 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001451static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001452 "One or more key attribute flag is listed as both internal-only and external-only" );
1453#endif
1454
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001455/** Validate that a key policy is internally well-formed.
1456 *
1457 * This function only rejects invalid policies. It does not validate the
1458 * consistency of the policy with respect to other attributes of the key
1459 * such as the key type.
1460 */
1461static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001462{
1463 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001464 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001465 PSA_KEY_USAGE_ENCRYPT |
1466 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arm4a210192021-04-14 21:14:28 +02001467 PSA_KEY_USAGE_SIGN_MESSAGE |
1468 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001469 PSA_KEY_USAGE_SIGN_HASH |
1470 PSA_KEY_USAGE_VERIFY_HASH |
Manuel Pégourié-Gonnard805251b2021-05-04 09:49:59 +02001471 PSA_KEY_USAGE_VERIFY_DERIVATION |
Gilles Peskine4747d192019-04-17 15:05:45 +02001472 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1473 return( PSA_ERROR_INVALID_ARGUMENT );
1474
Gilles Peskine4747d192019-04-17 15:05:45 +02001475 return( PSA_SUCCESS );
1476}
1477
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001478/** Validate the internal consistency of key attributes.
1479 *
1480 * This function only rejects invalid attribute values. If does not
1481 * validate the consistency of the attributes with any key data that may
1482 * be involved in the creation of the key.
1483 *
1484 * Call this function early in the key creation process.
1485 *
1486 * \param[in] attributes Key attributes for the new key.
1487 * \param[out] p_drv On any return, the driver for the key, if any.
1488 * NULL for a transparent key.
1489 *
1490 */
1491static psa_status_t psa_validate_key_attributes(
1492 const psa_key_attributes_t *attributes,
1493 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001494{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001495 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001496 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001497 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001498
Ronald Cron54b90082020-10-29 15:26:43 +01001499 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001500 if( status != PSA_SUCCESS )
1501 return( status );
1502
Ronald Crond2ed4812020-07-17 16:11:30 +02001503 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001504 if( status != PSA_SUCCESS )
1505 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001506
Ronald Cron65f38a32020-10-23 17:11:13 +02001507 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1508 {
1509 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1510 return( PSA_ERROR_INVALID_ARGUMENT );
1511 }
1512 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001513 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001514 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1515 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001516 }
1517
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001518 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001519 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001520 return( status );
1521
1522 /* Refuse to create overly large keys.
1523 * Note that this doesn't trigger on import if the attributes don't
1524 * explicitly specify a size (so psa_get_key_bits returns 0), so
1525 * psa_import_key() needs its own checks. */
1526 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1527 return( PSA_ERROR_NOT_SUPPORTED );
1528
Gilles Peskine91e8c332019-08-02 19:19:39 +02001529 /* Reject invalid flags. These should not be reachable through the API. */
1530 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1531 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1532 return( PSA_ERROR_INVALID_ARGUMENT );
1533
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534 return( PSA_SUCCESS );
1535}
1536
Gilles Peskine4747d192019-04-17 15:05:45 +02001537/** Prepare a key slot to receive key material.
1538 *
1539 * This function allocates a key slot and sets its metadata.
1540 *
1541 * If this function fails, call psa_fail_key_creation().
1542 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001543 * This function is intended to be used as follows:
1544 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001545 * it with the specified attributes, and in case of a volatile key assign it
1546 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001547 * -# Populate the slot with the key material.
1548 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1549 * In case of failure at any step, stop the sequence and call
1550 * psa_fail_key_creation().
1551 *
Ronald Cron5c522922020-11-14 16:35:34 +01001552 * On success, the key slot is locked. It is the responsibility of the caller
1553 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001554 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001555 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001556 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001557 * \param[out] p_slot On success, a pointer to the prepared slot.
1558 * \param[out] p_drv On any return, the driver for the key, if any.
1559 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001560 *
1561 * \retval #PSA_SUCCESS
1562 * The key slot is ready to receive key material.
1563 * \return If this function fails, the key slot is an invalid state.
1564 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001565 */
1566static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001567 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001568 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001570 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001571{
1572 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001573 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001574 psa_key_slot_t *slot;
1575
Gilles Peskinedf179142019-07-15 22:02:14 +02001576 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001577 *p_drv = NULL;
1578
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001579 status = psa_validate_key_attributes( attributes, p_drv );
1580 if( status != PSA_SUCCESS )
1581 return( status );
1582
Ronald Cronc4d1b512020-07-31 11:26:37 +02001583 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001584 if( status != PSA_SUCCESS )
1585 return( status );
1586 slot = *p_slot;
1587
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001588 /* We're storing the declared bit-size of the key. It's up to each
1589 * creation mechanism to verify that this information is correct.
1590 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001591 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001592 * is optional (import, copy). In case of a volatile key, assign it the
1593 * volatile key identifier associated to the slot returned to contain its
1594 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001595
1596 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001597 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1598 {
1599#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1600 slot->attr.id = volatile_key_id;
1601#else
1602 slot->attr.id.key_id = volatile_key_id;
1603#endif
1604 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001605
Gilles Peskine91e8c332019-08-02 19:19:39 +02001606 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001607 * external-only flags, query `attributes`. Thanks to the check
1608 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001609 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001610 * may have set. */
1611 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001612
Gilles Peskinecbaff462019-07-12 23:46:04 +02001613#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001614 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001615 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001616 * create the key file in internal storage, create the
1617 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001618 * persistent data. This is done by starting a transaction that will
1619 * encompass these three actions.
1620 * For registering a volatile key, we just need to find an appropriate
1621 * slot number inside the SE. Since the key is designated volatile, creating
1622 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001623 /* The first thing to do is to find a slot number for the new key.
1624 * We save the slot number in persistent storage as part of the
1625 * transaction data. It will be needed to recover if the power
1626 * fails during the key creation process, to clean up on the secure
1627 * element side after restarting. Obtaining a slot number from the
1628 * secure element driver updates its persistent state, but we do not yet
1629 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001630 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001631 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001632 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001633 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001634 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001636 if( status != PSA_SUCCESS )
1637 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001638
1639 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001640 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001641 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1642 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001643 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001644 psa_crypto_transaction.key.id = slot->attr.id;
1645 status = psa_crypto_save_transaction( );
1646 if( status != PSA_SUCCESS )
1647 {
1648 (void) psa_crypto_stop_transaction( );
1649 return( status );
1650 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001651 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001652
1653 status = psa_copy_key_material_into_slot(
1654 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001655 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001656
1657 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1658 {
1659 /* Key registration only makes sense with a secure element. */
1660 return( PSA_ERROR_INVALID_ARGUMENT );
1661 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001662#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1663
Ronald Cronc4d1b512020-07-31 11:26:37 +02001664 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001665}
Gilles Peskine4747d192019-04-17 15:05:45 +02001666
1667/** Finalize the creation of a key once its key material has been set.
1668 *
1669 * This entails writing the key to persistent storage.
1670 *
1671 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001672 * See the documentation of psa_start_key_creation() for the intended use
1673 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001674 *
Ronald Cron5c522922020-11-14 16:35:34 +01001675 * If the finalization succeeds, the function unlocks the key slot (it was
1676 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1677 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001678 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001679 * \param[in,out] slot Pointer to the slot with key material.
1680 * \param[in] driver The secure element driver for the key,
1681 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001682 * \param[out] key On success, identifier of the key. Note that the
1683 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001684 *
1685 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001686 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001687 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1688 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1689 * \retval #PSA_ERROR_ALREADY_EXISTS
1690 * \retval #PSA_ERROR_DATA_INVALID
1691 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001692 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001693 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001694 * \return If this function fails, the key slot is an invalid state.
1695 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001696 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001697static psa_status_t psa_finish_key_creation(
1698 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001699 psa_se_drv_table_entry_t *driver,
1700 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001701{
1702 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001703 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001704 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001705
1706#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001707 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001708 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001709#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1710 if( driver != NULL )
1711 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001712 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001713 psa_key_slot_number_t slot_number =
1714 psa_key_slot_get_slot_number( slot ) ;
1715
Gilles Peskineb46bef22019-07-30 21:32:04 +02001716#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001717 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001718 sizeof( data.slot_number ),
1719 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001720#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001722 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001723 (uint8_t*) &data,
1724 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001725 }
1726 else
1727#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1728 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001729 /* Key material is saved in export representation in the slot, so
1730 * just pass the slot buffer for storage. */
1731 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001732 slot->key.data,
1733 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001734 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001735 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001736#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1737
Gilles Peskinecbaff462019-07-12 23:46:04 +02001738#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001739 /* Finish the transaction for a key creation. This does not
1740 * happen when registering an existing key. Detect this case
1741 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 * creation of a persistent key in a secure element requires a transaction,
1743 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001744 if( driver != NULL &&
1745 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001746 {
1747 status = psa_save_se_persistent_data( driver );
1748 if( status != PSA_SUCCESS )
1749 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001750 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001751 return( status );
1752 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001754 }
1755#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1756
Ronald Cron50972942020-11-14 11:28:25 +01001757 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001758 {
1759 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001760 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001761 if( status != PSA_SUCCESS )
1762 *key = MBEDTLS_SVC_KEY_ID_INIT;
1763 }
Ronald Cron50972942020-11-14 11:28:25 +01001764
Gilles Peskine4747d192019-04-17 15:05:45 +02001765 return( status );
1766}
1767
1768/** Abort the creation of a key.
1769 *
1770 * You may call this function after calling psa_start_key_creation(),
1771 * or after psa_finish_key_creation() fails. In other circumstances, this
1772 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001773 * See the documentation of psa_start_key_creation() for the intended use
1774 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001776 * \param[in,out] slot Pointer to the slot with key material.
1777 * \param[in] driver The secure element driver for the key,
1778 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001780static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001781 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001782{
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 (void) driver;
1784
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 if( slot == NULL )
1786 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001787
1788#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001789 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001790 * element, and the failure happened later (when saving metadata
1791 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001792 * element.
1793 * https://github.com/ARMmbed/mbed-crypto/issues/217
1794 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001795
Gilles Peskined7729582019-08-05 15:55:54 +02001796 /* Abort the ongoing transaction if any (there may not be one if
1797 * the creation process failed before starting one, or if the
1798 * key creation is a registration of a key in a secure element).
1799 * Earlier functions must already have done what it takes to undo any
1800 * partial creation. All that's left is to update the transaction data
1801 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001802 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001803#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1804
Gilles Peskine4747d192019-04-17 15:05:45 +02001805 psa_wipe_key_slot( slot );
1806}
1807
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001808/** Validate optional attributes during key creation.
1809 *
1810 * Some key attributes are optional during key creation. If they are
1811 * specified in the attributes structure, check that they are consistent
1812 * with the data in the slot.
1813 *
1814 * This function should be called near the end of key creation, after
1815 * the slot in memory is fully populated but before saving persistent data.
1816 */
1817static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001818 const psa_key_slot_t *slot,
1819 const psa_key_attributes_t *attributes )
1820{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001821 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001822 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001823 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001824 return( PSA_ERROR_INVALID_ARGUMENT );
1825 }
1826
1827 if( attributes->domain_parameters_size != 0 )
1828 {
John Durkop0e005192020-10-31 22:06:54 -07001829#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1830 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001831 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001832 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001833 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001834 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001836
Ronald Cron90857082020-11-25 14:58:33 +01001837 psa_status_t status = mbedtls_psa_rsa_load_representation(
1838 slot->attr.type,
1839 slot->key.data,
1840 slot->key.bytes,
1841 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001842 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001843 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001844
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001845 mbedtls_mpi_init( &actual );
1846 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001847 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001848 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001849 mbedtls_rsa_free( rsa );
1850 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851 if( ret != 0 )
1852 goto rsa_exit;
1853 ret = mbedtls_mpi_read_binary( &required,
1854 attributes->domain_parameters,
1855 attributes->domain_parameters_size );
1856 if( ret != 0 )
1857 goto rsa_exit;
1858 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1859 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1860 rsa_exit:
1861 mbedtls_mpi_free( &actual );
1862 mbedtls_mpi_free( &required );
1863 if( ret != 0)
1864 return( mbedtls_to_psa_error( ret ) );
1865 }
1866 else
John Durkop9814fa22020-11-04 12:28:15 -08001867#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1868 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 {
1870 return( PSA_ERROR_INVALID_ARGUMENT );
1871 }
1872 }
1873
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001874 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001876 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001877 return( PSA_ERROR_INVALID_ARGUMENT );
1878 }
1879
1880 return( PSA_SUCCESS );
1881}
1882
Gilles Peskine4747d192019-04-17 15:05:45 +02001883psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001885 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001886 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001887{
1888 psa_status_t status;
1889 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001890 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001891 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301892 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001893
Ronald Cron81709fc2020-11-14 12:10:32 +01001894 *key = MBEDTLS_SVC_KEY_ID_INIT;
1895
Gilles Peskine0f84d622019-09-12 19:03:13 +02001896 /* Reject zero-length symmetric keys (including raw data key objects).
1897 * This also rejects any key which might be encoded as an empty string,
1898 * which is never valid. */
1899 if( data_length == 0 )
1900 return( PSA_ERROR_INVALID_ARGUMENT );
1901
Archana449608b2021-09-08 15:36:05 +05301902 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Archana6ed4bda2021-08-04 10:47:15 +05301903 if( data_length > SIZE_MAX / 8 )
1904 return( PSA_ERROR_NOT_SUPPORTED );
1905
Gilles Peskinedf179142019-07-15 22:02:14 +02001906 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001907 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001908 if( status != PSA_SUCCESS )
1909 goto exit;
1910
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001911 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301912 * storage ( thus not in the case of importing a key in a secure element
1913 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1914 * buffer to hold the imported key material. */
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001915 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001916 {
Archanad8a83dc2021-06-14 10:04:16 +05301917 if( psa_key_lifetime_is_external( attributes->core.lifetime ) )
1918 {
Archana449608b2021-09-08 15:36:05 +05301919 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
1920 attributes, data, data_length, &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05301921 if( status != PSA_SUCCESS )
1922 goto exit;
1923 }
1924 status = psa_allocate_buffer_to_slot( slot, storage_size );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001925 if( status != PSA_SUCCESS )
1926 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001927 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001928
1929 bits = slot->attr.bits;
1930 status = psa_driver_wrapper_import_key( attributes,
1931 data, data_length,
1932 slot->key.data,
1933 slot->key.bytes,
1934 &slot->key.bytes, &bits );
1935 if( status != PSA_SUCCESS )
1936 goto exit;
1937
1938 if( slot->attr.bits == 0 )
1939 slot->attr.bits = (psa_key_bits_t) bits;
1940 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001941 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001942 status = PSA_ERROR_INVALID_ARGUMENT;
1943 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001944 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001945
Archana6ed4bda2021-08-04 10:47:15 +05301946 /* Enforce a size limit, and in particular ensure that the bit
1947 * size fits in its representation type.*/
1948 if( bits > PSA_MAX_KEY_BITS )
1949 {
1950 status = PSA_ERROR_NOT_SUPPORTED;
1951 goto exit;
1952 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001953 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001954 if( status != PSA_SUCCESS )
1955 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001956
Ronald Cron81709fc2020-11-14 12:10:32 +01001957 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001959 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001960 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001961
Gilles Peskine4747d192019-04-17 15:05:45 +02001962 return( status );
1963}
1964
Gilles Peskined7729582019-08-05 15:55:54 +02001965#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1966psa_status_t mbedtls_psa_register_se_key(
1967 const psa_key_attributes_t *attributes )
1968{
1969 psa_status_t status;
1970 psa_key_slot_t *slot = NULL;
1971 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001972 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001973
1974 /* Leaving attributes unspecified is not currently supported.
1975 * It could make sense to query the key type and size from the
1976 * secure element, but not all secure elements support this
1977 * and the driver HAL doesn't currently support it. */
1978 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1979 return( PSA_ERROR_NOT_SUPPORTED );
1980 if( psa_get_key_bits( attributes ) == 0 )
1981 return( PSA_ERROR_NOT_SUPPORTED );
1982
1983 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001984 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001985 if( status != PSA_SUCCESS )
1986 goto exit;
1987
Ronald Cron81709fc2020-11-14 12:10:32 +01001988 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001989
1990exit:
1991 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001992 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001993
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001995 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001996 return( status );
1997}
1998#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1999
Ronald Croncf56a0a2020-08-04 09:51:30 +02002000psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002001 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002002 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002003{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002004 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002005 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002006 psa_key_slot_t *source_slot = NULL;
2007 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002008 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002009 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302010 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011
Ronald Cron81709fc2020-11-14 12:10:32 +01002012 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2013
Archana8a180362021-07-05 02:18:48 +05302014 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01002015 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002016 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002017 goto exit;
2018
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002019 status = psa_validate_optional_attributes( source_slot,
2020 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 if( status != PSA_SUCCESS )
2022 goto exit;
2023
Archana9d17bf42021-09-10 06:22:44 +05302024 /* The target key type and number of bits have been validated by
2025 * psa_validate_optional_attributes() to be either equal to zero or
2026 * equal to the ones of the source key. So it is safe to inherit
2027 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302028 * */
Archana9d17bf42021-09-10 06:22:44 +05302029 actual_attributes.core.bits = source_slot->attr.bits;
2030 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302031
2032
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002033 status = psa_restrict_key_policy( source_slot->attr.type,
2034 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002035 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002036 if( status != PSA_SUCCESS )
2037 goto exit;
2038
Ronald Cron81709fc2020-11-14 12:10:32 +01002039 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2040 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002041 if( status != PSA_SUCCESS )
2042 goto exit;
Archana8a180362021-07-05 02:18:48 +05302043 if( PSA_KEY_LIFETIME_GET_LOCATION( target_slot->attr.lifetime ) !=
2044 PSA_KEY_LIFETIME_GET_LOCATION( source_slot->attr.lifetime ) )
Gilles Peskinef603c712019-01-19 13:40:11 +01002045 {
Archana8a180362021-07-05 02:18:48 +05302046 /*
Archana9d17bf42021-09-10 06:22:44 +05302047 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302048 * the source key would need to be exported as plaintext and re-imported
2049 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302050 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302051 * appropriate API invocations from the application, if needed.
2052 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002053 status = PSA_ERROR_NOT_SUPPORTED;
2054 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002055 }
Archana8a180362021-07-05 02:18:48 +05302056 /*
2057 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302058 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302059 * - For opaque keys this translates to an invocation of the drivers'
2060 * copy_key entry point through the dispatch layer.
2061 * */
Ronald Cron6cc66312021-04-02 12:27:47 +02002062 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2063 {
Archana8a180362021-07-05 02:18:48 +05302064 status = psa_driver_wrapper_get_key_buffer_size( &actual_attributes,
Archana449608b2021-09-08 15:36:05 +05302065 &storage_size );
Archana8a180362021-07-05 02:18:48 +05302066 if( status != PSA_SUCCESS )
2067 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302068
Archana8a180362021-07-05 02:18:48 +05302069 status = psa_allocate_buffer_to_slot( target_slot, storage_size );
2070 if( status != PSA_SUCCESS )
2071 goto exit;
Archana374fe5b2021-09-08 15:50:28 +05302072
Archana8a180362021-07-05 02:18:48 +05302073 status = psa_driver_wrapper_copy_key( &actual_attributes,
2074 source_slot->key.data,
2075 source_slot->key.bytes,
2076 target_slot->key.data,
2077 target_slot->key.bytes,
2078 &target_slot->key.bytes );
2079 if( status != PSA_SUCCESS )
2080 goto exit;
Ronald Cron6cc66312021-04-02 12:27:47 +02002081 }
Archana8a180362021-07-05 02:18:48 +05302082 else
2083 {
Archana9d17bf42021-09-10 06:22:44 +05302084 status = psa_copy_key_material_into_slot( target_slot,
2085 source_slot->key.data,
2086 source_slot->key.bytes );
Archana8a180362021-07-05 02:18:48 +05302087 if( status != PSA_SUCCESS )
2088 goto exit;
2089 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002090 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002091exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002092 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002093 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002094
Ronald Cron5c522922020-11-14 16:35:34 +01002095 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002096
Ronald Cron5c522922020-11-14 16:35:34 +01002097 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002098}
2099
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002100
2101
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002102/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002103/* Message digests */
2104/****************************************************************/
2105
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002106psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2107{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002108 /* Aborting a non-active operation is allowed */
2109 if( operation->id == 0 )
2110 return( PSA_SUCCESS );
2111
2112 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2113 operation->id = 0;
2114
2115 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002116}
2117
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002118psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002119 psa_algorithm_t alg )
2120{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002122
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002123 /* A context must be freshly initialized before it can be set up. */
2124 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002125 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002126 status = PSA_ERROR_BAD_STATE;
2127 goto exit;
2128 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002129
2130 if( !PSA_ALG_IS_HASH( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002131 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002132 status = PSA_ERROR_INVALID_ARGUMENT;
2133 goto exit;
2134 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002135
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002136 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2137 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002138 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2139
Dave Rodgman685b6a72021-06-24 11:49:14 +01002140 status = psa_driver_wrapper_hash_setup( operation, alg );
2141
2142exit:
2143 if( status != PSA_SUCCESS )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002144 psa_hash_abort( operation );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002145
2146 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002147}
2148
2149psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2150 const uint8_t *input,
2151 size_t input_length )
2152{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2154
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002155 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002156 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002157 status = PSA_ERROR_BAD_STATE;
2158 goto exit;
2159 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002160
Steven Cooremanc8288352021-03-04 14:02:19 +01002161 /* Don't require hash implementations to behave correctly on a
2162 * zero-length input, which may have an invalid pointer. */
2163 if( input_length == 0 )
2164 return( PSA_SUCCESS );
2165
Dave Rodgman685b6a72021-06-24 11:49:14 +01002166 status = psa_driver_wrapper_hash_update( operation, input, input_length );
2167
2168exit:
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002169 if( status != PSA_SUCCESS )
2170 psa_hash_abort( operation );
2171
2172 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002173}
2174
2175psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2176 uint8_t *hash,
2177 size_t hash_size,
2178 size_t *hash_length )
2179{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002180 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002181 if( operation->id == 0 )
2182 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183
Steven Cooreman1e582352021-02-18 17:24:37 +01002184 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002185 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002186 psa_hash_abort( operation );
2187 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188}
2189
Gilles Peskine2d277862018-06-18 15:41:12 +02002190psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2191 const uint8_t *hash,
2192 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002193{
Ronald Cron69a63422021-10-18 09:47:58 +02002194 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002196 psa_status_t status = psa_hash_finish(
2197 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002198 actual_hash, sizeof( actual_hash ),
2199 &actual_hash_length );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002200
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201 if( status != PSA_SUCCESS )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002202 goto exit;
2203
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002204 if( actual_hash_length != hash_length )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002205 {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002206 status = PSA_ERROR_INVALID_SIGNATURE;
2207 goto exit;
2208 }
2209
Steven Cooreman36876a02021-04-29 16:37:59 +02002210 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Dave Rodgman685b6a72021-06-24 11:49:14 +01002211 status = PSA_ERROR_INVALID_SIGNATURE;
2212
2213exit:
Gilles Peskine60aebec2021-12-13 12:33:18 +01002214 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
Dave Rodgman685b6a72021-06-24 11:49:14 +01002215 if( status != PSA_SUCCESS )
2216 psa_hash_abort(operation);
2217
2218 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219}
2220
Gilles Peskine0a749c82019-11-28 19:33:58 +01002221psa_status_t psa_hash_compute( psa_algorithm_t alg,
2222 const uint8_t *input, size_t input_length,
2223 uint8_t *hash, size_t hash_size,
2224 size_t *hash_length )
2225{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002226 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002227 if( !PSA_ALG_IS_HASH( alg ) )
2228 return( PSA_ERROR_INVALID_ARGUMENT );
2229
Steven Cooreman1e582352021-02-18 17:24:37 +01002230 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2231 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002232}
2233
2234psa_status_t psa_hash_compare( psa_algorithm_t alg,
2235 const uint8_t *input, size_t input_length,
2236 const uint8_t *hash, size_t hash_length )
2237{
Ronald Cron69a63422021-10-18 09:47:58 +02002238 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002239 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002240
2241 if( !PSA_ALG_IS_HASH( alg ) )
2242 return( PSA_ERROR_INVALID_ARGUMENT );
2243
Steven Cooreman1e582352021-02-18 17:24:37 +01002244 psa_status_t status = psa_driver_wrapper_hash_compute(
2245 alg, input, input_length,
2246 actual_hash, sizeof(actual_hash),
2247 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002248 if( status != PSA_SUCCESS )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002249 goto exit;
Steven Cooreman84d670d2021-02-18 16:22:53 +01002250 if( actual_hash_length != hash_length )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002251 {
2252 status = PSA_ERROR_INVALID_SIGNATURE;
2253 goto exit;
2254 }
Steven Cooreman36876a02021-04-29 16:37:59 +02002255 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine60aebec2021-12-13 12:33:18 +01002256 status = PSA_ERROR_INVALID_SIGNATURE;
2257
2258exit:
2259 mbedtls_platform_zeroize( actual_hash, sizeof( actual_hash ) );
2260 return( status );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002261}
2262
Gilles Peskineeb35d782019-01-22 17:56:16 +01002263psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2264 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002265{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002266 if( source_operation->id == 0 ||
2267 target_operation->id != 0 )
2268 {
2269 return( PSA_ERROR_BAD_STATE );
2270 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002271
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002272 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2273 target_operation );
2274 if( status != PSA_SUCCESS )
2275 psa_hash_abort( target_operation );
2276
2277 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002278}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002279
2280
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002281/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002282/* MAC */
2283/****************************************************************/
2284
Steven Cooremane6804192021-03-19 18:28:56 +01002285psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002286{
Steven Cooremane6804192021-03-19 18:28:56 +01002287 /* Aborting a non-active operation is allowed */
2288 if( operation->id == 0 )
2289 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002290
Steven Cooremane6804192021-03-19 18:28:56 +01002291 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002292 operation->mac_size = 0;
2293 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002294 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002295
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002296 return( status );
2297}
2298
Ronald Cron2dff3b22021-06-17 16:33:22 +02002299static psa_status_t psa_mac_finalize_alg_and_key_validation(
2300 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002301 const psa_key_attributes_t *attributes,
2302 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002303{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002304 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron79bdd822021-06-17 16:46:44 +02002305 psa_key_type_t key_type = psa_get_key_type( attributes );
2306 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002307
Ronald Cron28ea0502021-06-17 16:10:24 +02002308 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Cron79bdd822021-06-17 16:46:44 +02002309 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremane6804192021-03-19 18:28:56 +01002310
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002311 /* Validate the combination of key type and algorithm */
Ronald Cron79bdd822021-06-17 16:46:44 +02002312 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002313 if( status != PSA_SUCCESS )
Ronald Cron79bdd822021-06-17 16:46:44 +02002314 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002315
Steven Cooremand1a68f12021-05-10 11:13:41 +02002316 /* Get the output length for the algorithm and key combination */
Ronald Cron79bdd822021-06-17 16:46:44 +02002317 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002318
Ronald Cron79bdd822021-06-17 16:46:44 +02002319 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002320 {
2321 /* A very short MAC is too short for security since it can be
2322 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2323 * so we make this our minimum, even though 32 bits is still
2324 * too small for security. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002325 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002326 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002327
Ronald Cron79bdd822021-06-17 16:46:44 +02002328 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2329 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002330 {
2331 /* It's impossible to "truncate" to a larger length than the full length
2332 * of the algorithm. */
Ronald Cron79bdd822021-06-17 16:46:44 +02002333 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002334 }
2335
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002336 if( *mac_size > PSA_MAC_MAX_SIZE )
2337 {
2338 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2339 * that is disabled in the compile-time configuration. The result can
2340 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2341 * configuration into account. In this case, force a return of
2342 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2343 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2344 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2345 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2346 * systematically generated tests. */
2347 return( PSA_ERROR_NOT_SUPPORTED );
2348 }
2349
Ronald Cron79bdd822021-06-17 16:46:44 +02002350 return( PSA_SUCCESS );
Ronald Cron2dff3b22021-06-17 16:33:22 +02002351}
2352
Gilles Peskinee59236f2018-01-27 23:32:46 +01002353static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2354 mbedtls_svc_key_id_t key,
2355 psa_algorithm_t alg,
2356 int is_sign )
2357{
2358 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2359 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002360 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002361
2362 /* A context must be freshly initialized before it can be set up. */
2363 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002364 {
Dave Rodgman54648242021-06-24 11:49:45 +01002365 status = PSA_ERROR_BAD_STATE;
2366 goto exit;
2367 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002368
2369 status = psa_get_and_lock_key_slot_with_policy(
2370 key,
2371 &slot,
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002372 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002373 alg );
2374 if( status != PSA_SUCCESS )
Dave Rodgman54648242021-06-24 11:49:45 +01002375 goto exit;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002376
2377 psa_key_attributes_t attributes = {
2378 .core = slot->attr
2379 };
2380
Ronald Cron79bdd822021-06-17 16:46:44 +02002381 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2382 &operation->mac_size );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002383 if( status != PSA_SUCCESS )
2384 goto exit;
2385
2386 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002387 /* Dispatch the MAC setup call with validated input */
2388 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002389 {
Steven Cooremane6804192021-03-19 18:28:56 +01002390 status = psa_driver_wrapper_mac_sign_setup( operation,
2391 &attributes,
2392 slot->key.data,
2393 slot->key.bytes,
2394 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002395 }
2396 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002397 {
Steven Cooremane6804192021-03-19 18:28:56 +01002398 status = psa_driver_wrapper_mac_verify_setup( operation,
2399 &attributes,
2400 slot->key.data,
2401 slot->key.bytes,
2402 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002403 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002404
Gilles Peskinefbfac682018-07-08 20:51:54 +02002405exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002406 if( status != PSA_SUCCESS )
Steven Cooremane6804192021-03-19 18:28:56 +01002407 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002408
Ronald Cron5c522922020-11-14 16:35:34 +01002409 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002410
Ronald Cron5c522922020-11-14 16:35:34 +01002411 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412}
2413
Gilles Peskine89167cb2018-07-08 20:12:23 +02002414psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002415 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002416 psa_algorithm_t alg )
2417{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002418 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002419}
2420
2421psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002422 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002423 psa_algorithm_t alg )
2424{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002425 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002426}
2427
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002428psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002429 const uint8_t *input,
2430 size_t input_length )
2431{
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002432 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002433 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002434
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002435 /* Don't require hash implementations to behave correctly on a
2436 * zero-length input, which may have an invalid pointer. */
2437 if( input_length == 0 )
2438 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002439
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002440 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2441 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002442 if( status != PSA_SUCCESS )
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002443 psa_mac_abort( operation );
2444
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002445 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002446}
2447
Steven Cooremana5b860a2021-03-19 19:04:39 +01002448psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002449 uint8_t *mac,
2450 size_t mac_size,
2451 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002452{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002453 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2454 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002455
Steven Cooremana5b860a2021-03-19 19:04:39 +01002456 if( operation->id == 0 )
Dave Rodgman8036bdd2021-06-24 16:19:08 +01002457 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002458 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002459 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002460 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002461
Steven Cooreman72f736a2021-05-07 14:14:37 +02002462 if( ! operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002463 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002464 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002465 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002466 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002467
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002468 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2469 * once all the error checks are done. */
2470 if( operation->mac_size == 0 )
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 Cooreman8af5c5c2021-05-11 11:09:13 +02002475
2476 if( mac_size < operation->mac_size )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002477 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002478 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002479 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002480 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002481
Steven Cooremana5b860a2021-03-19 19:04:39 +01002482 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman72f736a2021-05-07 14:14:37 +02002483 mac, operation->mac_size,
2484 mac_length );
2485
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002486exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002487 /* In case of success, set the potential excess room in the output buffer
2488 * to an invalid value, to avoid potentially leaking a longer MAC.
2489 * In case of error, set the output length and content to a safe default,
2490 * such that in case the caller misses an error check, the output would be
2491 * an unachievable MAC.
2492 */
2493 if( status != PSA_SUCCESS )
Steven Cooreman72f736a2021-05-07 14:14:37 +02002494 {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002495 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002496 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002497 }
mohammad16036df908f2018-04-02 08:34:15 -07002498
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002499 if( mac_size > operation->mac_size )
2500 memset( &mac[operation->mac_size], '!',
2501 mac_size - operation->mac_size );
2502
Steven Cooremana5b860a2021-03-19 19:04:39 +01002503 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002504
Steven Cooremana5b860a2021-03-19 19:04:39 +01002505 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002506}
2507
Steven Cooremana5b860a2021-03-19 19:04:39 +01002508psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002509 const uint8_t *mac,
2510 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002511{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002512 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2513 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002514
Steven Cooremana5b860a2021-03-19 19:04:39 +01002515 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002516 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002517 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002518 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002519 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002520
Steven Cooreman72f736a2021-05-07 14:14:37 +02002521 if( operation->is_sign )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01002522 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002523 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002524 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002525 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002526
2527 if( operation->mac_size != mac_length )
2528 {
2529 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002530 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002531 }
2532
Steven Cooremana5b860a2021-03-19 19:04:39 +01002533 status = psa_driver_wrapper_mac_verify_finish( operation,
2534 mac, mac_length );
Steven Cooreman72f736a2021-05-07 14:14:37 +02002535
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002536exit:
Steven Cooremana5b860a2021-03-19 19:04:39 +01002537 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002538
Steven Cooremana5b860a2021-03-19 19:04:39 +01002539 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002540}
2541
Ronald Croncd989b52021-06-18 14:23:33 +02002542static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2543 psa_algorithm_t alg,
2544 const uint8_t *input,
2545 size_t input_length,
2546 uint8_t *mac,
2547 size_t mac_size,
2548 size_t *mac_length,
2549 int is_sign )
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002550{
2551 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002552 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2553 psa_key_slot_t *slot;
2554 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002555
Ronald Cron51131b52021-06-17 17:17:20 +02002556 status = psa_get_and_lock_key_slot_with_policy(
Mateusz Starzykce0e6a92021-08-17 15:24:32 +02002557 key,
2558 &slot,
2559 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
Ronald Croncd989b52021-06-18 14:23:33 +02002560 alg );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002561 if( status != PSA_SUCCESS )
2562 goto exit;
2563
Ronald Cron51131b52021-06-17 17:17:20 +02002564 psa_key_attributes_t attributes = {
2565 .core = slot->attr
2566 };
2567
2568 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2569 &operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002570 if( status != PSA_SUCCESS )
2571 goto exit;
2572
Ronald Cron51131b52021-06-17 17:17:20 +02002573 if( mac_size < operation_mac_size )
2574 {
2575 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002576 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002577 }
2578
2579 status = psa_driver_wrapper_mac_compute(
2580 &attributes,
2581 slot->key.data, slot->key.bytes,
2582 alg,
2583 input, input_length,
2584 mac, operation_mac_size, mac_length );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002585
2586exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002587 /* In case of success, set the potential excess room in the output buffer
2588 * to an invalid value, to avoid potentially leaking a longer MAC.
2589 * In case of error, set the output length and content to a safe default,
2590 * such that in case the caller misses an error check, the output would be
2591 * an unachievable MAC.
2592 */
2593 if( status != PSA_SUCCESS )
Ronald Cron51131b52021-06-17 17:17:20 +02002594 {
Ronald Cron51131b52021-06-17 17:17:20 +02002595 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002596 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002597 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002598 if( mac_size > operation_mac_size )
2599 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002600
Ronald Cron51131b52021-06-17 17:17:20 +02002601 unlock_status = psa_unlock_key_slot( slot );
2602
2603 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002604}
2605
Ronald Croncd989b52021-06-18 14:23:33 +02002606psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2607 psa_algorithm_t alg,
2608 const uint8_t *input,
2609 size_t input_length,
2610 uint8_t *mac,
2611 size_t mac_size,
2612 size_t *mac_length)
2613{
2614 return( psa_mac_compute_internal( key, alg,
2615 input, input_length,
2616 mac, mac_size, mac_length, 1 ) );
2617}
2618
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002619psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2620 psa_algorithm_t alg,
2621 const uint8_t *input,
2622 size_t input_length,
2623 const uint8_t *mac,
2624 size_t mac_length)
2625{
2626 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002627 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2628 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002629
Ronald Crona587cbc2021-06-18 14:51:29 +02002630 status = psa_mac_compute_internal( key, alg,
2631 input, input_length,
2632 actual_mac, sizeof( actual_mac ),
2633 &actual_mac_length, 0 );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002634 if( status != PSA_SUCCESS )
2635 goto exit;
2636
Ronald Crona587cbc2021-06-18 14:51:29 +02002637 if( mac_length != actual_mac_length )
2638 {
2639 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002640 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002641 }
2642 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2643 {
2644 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002645 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002646 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002647
2648exit:
Ronald Crona587cbc2021-06-18 14:51:29 +02002649 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002650
2651 return ( status );
2652}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002653
Gilles Peskinee59236f2018-01-27 23:32:46 +01002654/****************************************************************/
2655/* Asymmetric cryptography */
2656/****************************************************************/
2657
gabor-mezei-armf0486182021-05-12 11:03:09 +02002658static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002659 psa_algorithm_t alg )
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002660{
gabor-mezei-armf0486182021-05-12 11:03:09 +02002661 if( input_is_message )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002662 {
2663 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2664 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002665
Gilles Peskinef7b41372021-09-22 16:15:05 +02002666 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002667 {
2668 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2669 return( PSA_ERROR_INVALID_ARGUMENT );
2670 }
2671 }
2672 else
2673 {
Mateusz Starzyke6d3eda2021-08-26 11:46:14 +02002674 if( ! PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002675 return( PSA_ERROR_INVALID_ARGUMENT );
2676 }
2677
2678 return( PSA_SUCCESS );
2679}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002680
2681static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002682 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002683 psa_algorithm_t alg,
2684 const uint8_t * input,
2685 size_t input_length,
2686 uint8_t * signature,
2687 size_t signature_size,
2688 size_t * signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002689{
2690 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2691 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2692 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002693
2694 *signature_length = 0;
2695
gabor-mezei-armf0486182021-05-12 11:03:09 +02002696 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002697 if( status != PSA_SUCCESS )
2698 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002699
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002700 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002701 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002702 * buffer can in principle be empty since it doesn't actually have
2703 * to be a hash.) */
2704 if( signature_size == 0 )
2705 return( PSA_ERROR_BUFFER_TOO_SMALL );
2706
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002707 status = psa_get_and_lock_key_slot_with_policy(
2708 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002709 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2710 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002711 alg );
2712
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002713 if( status != PSA_SUCCESS )
2714 goto exit;
2715
2716 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2717 {
2718 status = PSA_ERROR_INVALID_ARGUMENT;
2719 goto exit;
2720 }
2721
2722 psa_key_attributes_t attributes = {
2723 .core = slot->attr
2724 };
2725
gabor-mezei-armf0486182021-05-12 11:03:09 +02002726 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002727 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002728 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002729 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002730 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002731 signature, signature_size, signature_length );
2732 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002733 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002734 {
2735
2736 status = psa_driver_wrapper_sign_hash(
2737 &attributes, slot->key.data, slot->key.bytes,
2738 alg, input, input_length,
2739 signature, signature_size, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002740 }
2741
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002742
2743exit:
2744 /* Fill the unused part of the output buffer (the whole buffer on error,
2745 * the trailing part on success) with something that isn't a valid signature
2746 * (barring an attack on the signature and deliberately-crafted input),
2747 * in case the caller doesn't check the return status properly. */
2748 if( status == PSA_SUCCESS )
2749 memset( signature + *signature_length, '!',
2750 signature_size - *signature_length );
2751 else
2752 memset( signature, '!', signature_size );
2753 /* If signature_size is 0 then we have nothing to do. We must not call
2754 * memset because signature may be NULL in this case. */
2755
2756 unlock_status = psa_unlock_key_slot( slot );
2757
2758 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2759}
2760
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002761static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002762 int input_is_message,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002763 psa_algorithm_t alg,
2764 const uint8_t * input,
2765 size_t input_length,
2766 const uint8_t * signature,
2767 size_t signature_length )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002768{
2769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2770 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2771 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002772
gabor-mezei-armf0486182021-05-12 11:03:09 +02002773 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002774 if( status != PSA_SUCCESS )
2775 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002776
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002777 status = psa_get_and_lock_key_slot_with_policy(
2778 key, &slot,
gabor-mezei-armf0486182021-05-12 11:03:09 +02002779 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2780 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002781 alg );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002782
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002783 if( status != PSA_SUCCESS )
2784 return( status );
2785
2786 psa_key_attributes_t attributes = {
2787 .core = slot->attr
2788 };
2789
gabor-mezei-armf0486182021-05-12 11:03:09 +02002790 if( input_is_message )
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002791 {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002792 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002793 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002794 alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002795 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002796 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002797 else
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002798 {
2799 status = psa_driver_wrapper_verify_hash(
2800 &attributes, slot->key.data, slot->key.bytes,
2801 alg, input, input_length,
2802 signature, signature_length );
2803 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002804
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002805 unlock_status = psa_unlock_key_slot( slot );
2806
2807 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002808
2809}
2810
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002811psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002812 const psa_key_attributes_t *attributes,
2813 const uint8_t *key_buffer,
2814 size_t key_buffer_size,
2815 psa_algorithm_t alg,
2816 const uint8_t *input,
2817 size_t input_length,
2818 uint8_t *signature,
2819 size_t signature_size,
2820 size_t *signature_length )
2821{
2822 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002823
Gilles Peskinef7b41372021-09-22 16:15:05 +02002824 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002825 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002826 size_t hash_length;
2827 uint8_t hash[PSA_HASH_MAX_SIZE];
2828
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002829 status = psa_driver_wrapper_hash_compute(
2830 PSA_ALG_SIGN_GET_HASH( alg ),
2831 input, input_length,
2832 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002833
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002834 if( status != PSA_SUCCESS )
2835 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002836
2837 return psa_driver_wrapper_sign_hash(
2838 attributes, key_buffer, key_buffer_size,
2839 alg, hash, hash_length,
2840 signature, signature_size, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002841 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002842
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002843 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002844}
2845
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002846psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2847 psa_algorithm_t alg,
2848 const uint8_t * input,
2849 size_t input_length,
2850 uint8_t * signature,
2851 size_t signature_size,
2852 size_t * signature_length )
2853{
2854 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002855 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002856 signature, signature_size, signature_length );
2857}
2858
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002859psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002860 const psa_key_attributes_t *attributes,
2861 const uint8_t *key_buffer,
2862 size_t key_buffer_size,
2863 psa_algorithm_t alg,
2864 const uint8_t *input,
2865 size_t input_length,
2866 const uint8_t *signature,
2867 size_t signature_length )
2868{
2869 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002870
Gilles Peskinef7b41372021-09-22 16:15:05 +02002871 if ( PSA_ALG_IS_SIGN_HASH( alg ) )
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002872 {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002873 size_t hash_length;
2874 uint8_t hash[PSA_HASH_MAX_SIZE];
2875
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002876 status = psa_driver_wrapper_hash_compute(
2877 PSA_ALG_SIGN_GET_HASH( alg ),
2878 input, input_length,
2879 hash, sizeof( hash ), &hash_length );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002880
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002881 if( status != PSA_SUCCESS )
2882 return status;
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002883
2884 return psa_driver_wrapper_verify_hash(
2885 attributes, key_buffer, key_buffer_size,
2886 alg, hash, hash_length,
2887 signature, signature_length );
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002888 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002889
gabor-mezei-arm474a35f2021-05-05 13:59:01 +02002890 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002891}
2892
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002893psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2894 psa_algorithm_t alg,
2895 const uint8_t * input,
2896 size_t input_length,
2897 const uint8_t * signature,
2898 size_t signature_length )
2899{
2900 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002901 key, 1, alg, input, input_length,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002902 signature, signature_length );
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002903}
2904
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002905psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002906 const psa_key_attributes_t *attributes,
2907 const uint8_t *key_buffer, size_t key_buffer_size,
2908 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2909 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002910{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002911 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002912 {
Ronald Cron4501c982021-03-19 20:09:32 +01002913 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2914 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002915 {
Ronald Cron4501c982021-03-19 20:09:32 +01002916#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2917 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2918 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002919 attributes,
2920 key_buffer, key_buffer_size,
2921 alg, hash, hash_length,
2922 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002923#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2924 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002925 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002926 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002927 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002928 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002929 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002930 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02002931 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Ronald Cron4501c982021-03-19 20:09:32 +01002932 {
2933 if( PSA_ALG_IS_ECDSA( alg ) )
2934 {
2935#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2936 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2937 return( mbedtls_psa_ecdsa_sign_hash(
2938 attributes,
2939 key_buffer, key_buffer_size,
2940 alg, hash, hash_length,
2941 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002942#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2943 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002944 }
2945 else
2946 {
2947 return( PSA_ERROR_INVALID_ARGUMENT );
2948 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002949 }
Ronald Cron4501c982021-03-19 20:09:32 +01002950
2951 (void)key_buffer;
2952 (void)key_buffer_size;
2953 (void)hash;
2954 (void)hash_length;
2955 (void)signature;
2956 (void)signature_size;
2957 (void)signature_length;
2958
2959 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002960}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002961
2962psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2963 psa_algorithm_t alg,
2964 const uint8_t *hash,
2965 size_t hash_length,
2966 uint8_t *signature,
2967 size_t signature_size,
2968 size_t *signature_length )
2969{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002970 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002971 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002972 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002973}
2974
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002975psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002976 const psa_key_attributes_t *attributes,
2977 const uint8_t *key_buffer, size_t key_buffer_size,
2978 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2979 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002980{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002981 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002982 {
Ronald Cron4501c982021-03-19 20:09:32 +01002983 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2984 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002985 {
Ronald Cron4501c982021-03-19 20:09:32 +01002986#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2987 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2988 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002989 attributes,
2990 key_buffer, key_buffer_size,
2991 alg, hash, hash_length,
2992 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002993#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2994 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002995 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002996 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002997 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002998 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002999 }
itayzafrir5c753392018-05-08 11:18:38 +03003000 }
Ronald Cron81ca97e2021-04-09 15:32:03 +02003001 else if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01003002 {
Ronald Cron4501c982021-03-19 20:09:32 +01003003 if( PSA_ALG_IS_ECDSA( alg ) )
3004 {
3005#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3006 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3007 return( mbedtls_psa_ecdsa_verify_hash(
3008 attributes,
3009 key_buffer, key_buffer_size,
3010 alg, hash, hash_length,
3011 signature, signature_length ) );
3012#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3013 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3014 }
3015 else
3016 {
3017 return( PSA_ERROR_INVALID_ARGUMENT );
3018 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003019 }
Ronald Cron4501c982021-03-19 20:09:32 +01003020
3021 (void)key_buffer;
3022 (void)key_buffer_size;
3023 (void)hash;
3024 (void)hash_length;
3025 (void)signature;
3026 (void)signature_length;
3027
3028 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003029}
3030
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003031psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3032 psa_algorithm_t alg,
3033 const uint8_t *hash,
3034 size_t hash_length,
3035 const uint8_t *signature,
3036 size_t signature_length )
3037{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003038 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003039 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003040 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003041}
3042
Ronald Croncf56a0a2020-08-04 09:51:30 +02003043psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003044 psa_algorithm_t alg,
3045 const uint8_t *input,
3046 size_t input_length,
3047 const uint8_t *salt,
3048 size_t salt_length,
3049 uint8_t *output,
3050 size_t output_size,
3051 size_t *output_length )
3052{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003053 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003054 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003055 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003056
Darryl Green5cc689a2018-07-24 15:34:10 +01003057 (void) input;
3058 (void) input_length;
3059 (void) salt;
3060 (void) output;
3061 (void) output_size;
3062
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063 *output_length = 0;
3064
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003065 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3066 return( PSA_ERROR_INVALID_ARGUMENT );
3067
Ronald Cron5c522922020-11-14 16:35:34 +01003068 status = psa_get_and_lock_transparent_key_slot_with_policy(
3069 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003070 if( status != PSA_SUCCESS )
3071 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003072 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3073 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003074 {
3075 status = PSA_ERROR_INVALID_ARGUMENT;
3076 goto exit;
3077 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003078
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003079 psa_key_attributes_t attributes = {
3080 .core = slot->attr
3081 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003082
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003083 status = psa_driver_wrapper_asymmetric_encrypt(
3084 &attributes, slot->key.data, slot->key.bytes,
3085 alg, input, input_length, salt, salt_length,
3086 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003087exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003088 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003089
Ronald Cron5c522922020-11-14 16:35:34 +01003090 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003091}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003092
Ronald Croncf56a0a2020-08-04 09:51:30 +02003093psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003094 psa_algorithm_t alg,
3095 const uint8_t *input,
3096 size_t input_length,
3097 const uint8_t *salt,
3098 size_t salt_length,
3099 uint8_t *output,
3100 size_t output_size,
3101 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003102{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003104 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003105 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003106
Darryl Green5cc689a2018-07-24 15:34:10 +01003107 (void) input;
3108 (void) input_length;
3109 (void) salt;
3110 (void) output;
3111 (void) output_size;
3112
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003113 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003115 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3116 return( PSA_ERROR_INVALID_ARGUMENT );
3117
Ronald Cron5c522922020-11-14 16:35:34 +01003118 status = psa_get_and_lock_transparent_key_slot_with_policy(
3119 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003120 if( status != PSA_SUCCESS )
3121 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003122 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003123 {
3124 status = PSA_ERROR_INVALID_ARGUMENT;
3125 goto exit;
3126 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003128 psa_key_attributes_t attributes = {
3129 .core = slot->attr
3130 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003131
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003132 status = psa_driver_wrapper_asymmetric_decrypt(
3133 &attributes, slot->key.data, slot->key.bytes,
3134 alg, input, input_length, salt, salt_length,
3135 output, output_size, output_length );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003136
3137exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003138 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003139
Ronald Cron5c522922020-11-14 16:35:34 +01003140 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003141}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003142
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003143
3144
mohammad1603503973b2018-03-12 15:59:30 +02003145/****************************************************************/
3146/* Symmetric cryptography */
3147/****************************************************************/
3148
Ronald Cronab99ac22020-10-01 16:38:28 +02003149static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3150 mbedtls_svc_key_id_t key,
3151 psa_algorithm_t alg,
3152 mbedtls_operation_t cipher_operation )
3153{
3154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3155 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003156 psa_key_slot_t *slot = NULL;
Ronald Cronab99ac22020-10-01 16:38:28 +02003157 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3158 PSA_KEY_USAGE_ENCRYPT :
3159 PSA_KEY_USAGE_DECRYPT );
3160
3161 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003162 if( operation->id != 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003163 {
Dave Rodgman54648242021-06-24 11:49:45 +01003164 status = PSA_ERROR_BAD_STATE;
3165 goto exit;
3166 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003167
Ronald Cronab99ac22020-10-01 16:38:28 +02003168 if( ! PSA_ALG_IS_CIPHER( alg ) )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003169 {
Dave Rodgman54648242021-06-24 11:49:45 +01003170 status = PSA_ERROR_INVALID_ARGUMENT;
3171 goto exit;
3172 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003173
Ronald Cronab99ac22020-10-01 16:38:28 +02003174 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3175 if( status != PSA_SUCCESS )
3176 goto exit;
3177
Ronald Cron49fafa92021-03-10 08:34:23 +01003178 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003179 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003180 * so we only set it (in the driver wrapper) after resources have been
3181 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003182 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003183 if( alg == PSA_ALG_ECB_NO_PADDING )
3184 operation->iv_required = 0;
3185 else
3186 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003187 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003188
Ronald Crona4af55f2020-12-14 14:36:06 +01003189 psa_key_attributes_t attributes = {
3190 .core = slot->attr
3191 };
3192
Ronald Cronab99ac22020-10-01 16:38:28 +02003193 /* Try doing the operation through a driver before using software fallback. */
3194 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003195 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3196 &attributes,
3197 slot->key.data,
3198 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003199 alg );
3200 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003201 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3202 &attributes,
3203 slot->key.data,
3204 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003205 alg );
3206
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003207exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003208 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003209 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003210
Ronald Cron5c522922020-11-14 16:35:34 +01003211 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003212
Ronald Cron5c522922020-11-14 16:35:34 +01003213 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003214}
3215
Gilles Peskinefe119512018-07-08 21:39:34 +02003216psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003217 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003218 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003219{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003220 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003221}
3222
Gilles Peskinefe119512018-07-08 21:39:34 +02003223psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003224 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003225 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003226{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003227 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003228}
3229
Gilles Peskinefe119512018-07-08 21:39:34 +02003230psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003231 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003232 size_t iv_size,
3233 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003234{
Ronald Cron6d051732020-10-01 14:10:20 +02003235 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02003236 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3237 size_t default_iv_length;
Ronald Cron5618a392021-03-26 09:52:26 +01003238
Ronald Cron49fafa92021-03-10 08:34:23 +01003239 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003240 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003241 status = PSA_ERROR_BAD_STATE;
3242 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003243 }
3244
Steven Cooreman7df02922020-09-09 15:28:49 +02003245 if( operation->iv_set || ! operation->iv_required )
3246 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003247 status = PSA_ERROR_BAD_STATE;
3248 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003249 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003250
Ronald Cron2fb90522021-07-05 12:31:44 +02003251 default_iv_length = operation->default_iv_length;
3252 if( iv_size < default_iv_length )
Ronald Cron5618a392021-03-26 09:52:26 +01003253 {
3254 status = PSA_ERROR_BUFFER_TOO_SMALL;
3255 goto exit;
3256 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003257
Ronald Cron2fb90522021-07-05 12:31:44 +02003258 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
3259 {
3260 status = PSA_ERROR_GENERIC_ERROR;
3261 goto exit;
3262 }
3263
3264 status = psa_generate_random( local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003265 if( status != PSA_SUCCESS )
3266 goto exit;
3267
3268 status = psa_driver_wrapper_cipher_set_iv( operation,
Ronald Cron2fb90522021-07-05 12:31:44 +02003269 local_iv, default_iv_length );
Ronald Cron5618a392021-03-26 09:52:26 +01003270
3271exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003272 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003273 {
Ronald Cron2fb90522021-07-05 12:31:44 +02003274 memcpy( iv, local_iv, default_iv_length );
3275 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003276 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003277 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003278 else
Ronald Cron2fb90522021-07-05 12:31:44 +02003279 {
3280 *iv_length = 0;
Moran Peker395db872018-05-31 14:07:14 +03003281 psa_cipher_abort( operation );
Ronald Cron2fb90522021-07-05 12:31:44 +02003282 }
Ronald Cron6d051732020-10-01 14:10:20 +02003283
itayzafrir534bd7c2018-08-02 13:56:32 +03003284 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003285}
3286
Gilles Peskinefe119512018-07-08 21:39:34 +02003287psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003288 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003289 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003290{
Ronald Cron6d051732020-10-01 14:10:20 +02003291 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003292
Ronald Cron49fafa92021-03-10 08:34:23 +01003293 if( operation->id == 0 )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003294 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003295 status = PSA_ERROR_BAD_STATE;
3296 goto exit;
3297 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003298
Steven Cooreman7df02922020-09-09 15:28:49 +02003299 if( operation->iv_set || ! operation->iv_required )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003300 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003301 status = PSA_ERROR_BAD_STATE;
3302 goto exit;
3303 }
Ronald Crona0d68172021-03-26 10:15:08 +01003304
3305 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
Dave Rodgmanb5dd7c72021-06-24 16:17:43 +01003306 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003307 status = PSA_ERROR_INVALID_ARGUMENT;
3308 goto exit;
3309 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003310
Ronald Crondd24c9b2020-12-15 14:10:01 +01003311 status = psa_driver_wrapper_cipher_set_iv( operation,
3312 iv,
3313 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003314
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003315exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003316 if( status == PSA_SUCCESS )
3317 operation->iv_set = 1;
3318 else
mohammad1603503973b2018-03-12 15:59:30 +02003319 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003320 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003321}
3322
Gilles Peskinee553c652018-06-04 16:22:46 +02003323psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3324 const uint8_t *input,
3325 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003326 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003327 size_t output_size,
3328 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003329{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003331
Ronald Cron49fafa92021-03-10 08:34:23 +01003332 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003333 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003334 status = PSA_ERROR_BAD_STATE;
3335 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003336 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003337
Steven Cooreman7df02922020-09-09 15:28:49 +02003338 if( operation->iv_required && ! operation->iv_set )
3339 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003340 status = PSA_ERROR_BAD_STATE;
3341 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003342 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003343
Ronald Crondd24c9b2020-12-15 14:10:01 +01003344 status = psa_driver_wrapper_cipher_update( operation,
3345 input,
3346 input_length,
3347 output,
3348 output_size,
3349 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003350
3351exit:
itayzafrir534bd7c2018-08-02 13:56:32 +03003352 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003353 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003354
itayzafrir534bd7c2018-08-02 13:56:32 +03003355 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003356}
3357
Gilles Peskinee553c652018-06-04 16:22:46 +02003358psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3359 uint8_t *output,
3360 size_t output_size,
3361 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003362{
David Saadab4ecc272019-02-14 13:48:10 +02003363 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003364
Ronald Cron49fafa92021-03-10 08:34:23 +01003365 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003366 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003367 status = PSA_ERROR_BAD_STATE;
3368 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003369 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003370
Steven Cooreman7df02922020-09-09 15:28:49 +02003371 if( operation->iv_required && ! operation->iv_set )
3372 {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003373 status = PSA_ERROR_BAD_STATE;
3374 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003375 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003376
Ronald Crondd24c9b2020-12-15 14:10:01 +01003377 status = psa_driver_wrapper_cipher_finish( operation,
3378 output,
3379 output_size,
3380 output_length );
Dave Rodgman38e62ae2021-06-23 11:38:39 +01003381
3382exit:
Steven Cooremanef8575e2020-09-11 11:44:50 +02003383 if( status == PSA_SUCCESS )
3384 return( psa_cipher_abort( operation ) );
3385 else
3386 {
3387 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003388 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003389
Steven Cooremanef8575e2020-09-11 11:44:50 +02003390 return( status );
3391 }
mohammad1603503973b2018-03-12 15:59:30 +02003392}
3393
Gilles Peskinee553c652018-06-04 16:22:46 +02003394psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3395{
Ronald Cron49fafa92021-03-10 08:34:23 +01003396 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003397 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003398 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003399 * in use. It's ok to call abort on such an object, and there's
3400 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003401 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003402 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003403
Ronald Crondd24c9b2020-12-15 14:10:01 +01003404 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003405
Ronald Cron49fafa92021-03-10 08:34:23 +01003406 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003407 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003408 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003409
Moran Peker395db872018-05-31 14:07:14 +03003410 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003411}
3412
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003413psa_status_t psa_cipher_encrypt( mbedtls_svc_key_id_t key,
3414 psa_algorithm_t alg,
3415 const uint8_t *input,
3416 size_t input_length,
3417 uint8_t *output,
3418 size_t output_size,
3419 size_t *output_length )
3420{
3421 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003422 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003423 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02003424 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3425 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003426
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003427 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003428 {
3429 status = PSA_ERROR_INVALID_ARGUMENT;
3430 goto exit;
3431 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003432
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003433 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3434 PSA_KEY_USAGE_ENCRYPT,
3435 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003436 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003437 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003438
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003439 psa_key_attributes_t attributes = {
3440 .core = slot->attr
3441 };
3442
Ronald Cronc6e6f502021-07-09 18:44:58 +02003443 default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
3444 if( default_iv_length > PSA_CIPHER_IV_MAX_SIZE )
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003445 {
Ronald Cronc6e6f502021-07-09 18:44:58 +02003446 status = PSA_ERROR_GENERIC_ERROR;
3447 goto exit;
3448 }
3449
3450 if( default_iv_length > 0 )
3451 {
3452 if( output_size < default_iv_length )
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003453 {
3454 status = PSA_ERROR_BUFFER_TOO_SMALL;
3455 goto exit;
3456 }
3457
Ronald Cronc6e6f502021-07-09 18:44:58 +02003458 status = psa_generate_random( local_iv, default_iv_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003459 if( status != PSA_SUCCESS )
3460 goto exit;
3461 }
3462
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003463 status = psa_driver_wrapper_cipher_encrypt(
3464 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02003465 alg, local_iv, default_iv_length, input, input_length,
3466 output + default_iv_length, output_size - default_iv_length,
3467 output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003468
3469exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003470 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003471 if( status == PSA_SUCCESS )
3472 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003473
Ronald Cron9b674282021-07-09 09:19:35 +02003474 if( status == PSA_SUCCESS )
Ronald Cronc6e6f502021-07-09 18:44:58 +02003475 {
3476 if( default_iv_length > 0 )
3477 memcpy( output, local_iv, default_iv_length );
3478 *output_length += default_iv_length;
3479 }
Ronald Cron9b674282021-07-09 09:19:35 +02003480 else
Ronald Cron23919522021-07-08 19:00:07 +02003481 *output_length = 0;
3482
3483 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003484}
3485
3486psa_status_t psa_cipher_decrypt( mbedtls_svc_key_id_t key,
3487 psa_algorithm_t alg,
3488 const uint8_t *input,
3489 size_t input_length,
3490 uint8_t *output,
3491 size_t output_size,
3492 size_t *output_length )
3493{
3494 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003495 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02003496 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02003497
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003498 if( ! PSA_ALG_IS_CIPHER( alg ) )
Ronald Cron23919522021-07-08 19:00:07 +02003499 {
3500 status = PSA_ERROR_INVALID_ARGUMENT;
3501 goto exit;
3502 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003503
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003504 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3505 PSA_KEY_USAGE_DECRYPT,
3506 alg );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003507 if( status != PSA_SUCCESS )
Ronald Cron23919522021-07-08 19:00:07 +02003508 goto exit;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003509
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003510 psa_key_attributes_t attributes = {
3511 .core = slot->attr
3512 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003513
Mateusz Starzyk594215b2021-10-14 12:23:06 +02003514 if( alg == PSA_ALG_CCM_STAR_NO_TAG && input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) )
3515 {
3516 status = PSA_ERROR_INVALID_ARGUMENT;
3517 goto exit;
3518 }
3519 else if ( input_length < PSA_CIPHER_IV_LENGTH( slot->attr.type, alg ) )
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003520 {
3521 status = PSA_ERROR_INVALID_ARGUMENT;
3522 goto exit;
3523 }
3524
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003525 status = psa_driver_wrapper_cipher_decrypt(
3526 &attributes, slot->key.data, slot->key.bytes,
3527 alg, input, input_length,
3528 output, output_size, output_length );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003529
gabor-mezei-arm258ae072021-06-25 15:25:38 +02003530exit:
gabor-mezei-arma9449a02021-03-25 11:17:10 +01003531 unlock_status = psa_unlock_key_slot( slot );
Ronald Cron23919522021-07-08 19:00:07 +02003532 if( status == PSA_SUCCESS )
3533 status = unlock_status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003534
Ronald Cron23919522021-07-08 19:00:07 +02003535 if( status != PSA_SUCCESS )
3536 *output_length = 0;
3537
3538 return( status );
gabor-mezei-armba0fa752021-03-01 15:04:24 +01003539}
3540
3541
mohammad16035955c982018-04-26 00:53:03 +03003542/****************************************************************/
3543/* AEAD */
3544/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003545
Paul Elliottbaff51c2021-09-28 17:44:45 +01003546/* Helper function to get the base algorithm from its variants. */
3547static psa_algorithm_t psa_aead_get_base_algorithm( psa_algorithm_t alg )
3548{
3549 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG( alg );
3550}
3551
3552/* Helper function to perform common nonce length checks. */
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003553static psa_status_t psa_aead_check_nonce_length( psa_algorithm_t alg,
3554 size_t nonce_length )
3555{
Paul Elliottbaff51c2021-09-28 17:44:45 +01003556 psa_algorithm_t base_alg = psa_aead_get_base_algorithm( alg );
3557
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003558 switch(base_alg)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003559 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003560#if defined(PSA_WANT_ALG_GCM)
3561 case PSA_ALG_GCM:
3562 /* Not checking max nonce size here as GCM spec allows almost
3563 * arbitrarily large nonces. Please note that we do not generally
3564 * recommend the usage of nonces of greater length than
3565 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
3566 * size, which can then lead to collisions if you encrypt a very
3567 * large number of messages.*/
3568 if( nonce_length != 0 )
3569 return( PSA_SUCCESS );
3570 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003571#endif /* PSA_WANT_ALG_GCM */
3572#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003573 case PSA_ALG_CCM:
3574 if( nonce_length >= 7 && nonce_length <= 13 )
3575 return( PSA_SUCCESS );
3576 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003577#endif /* PSA_WANT_ALG_CCM */
3578#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003579 case PSA_ALG_CHACHA20_POLY1305:
3580 if( nonce_length == 12 )
3581 return( PSA_SUCCESS );
Bence Szépkúti6d48e202021-11-15 20:04:15 +01003582 else if( nonce_length == 8 )
3583 return( PSA_ERROR_NOT_SUPPORTED );
3584 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003585#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003586 default:
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003587 return( PSA_ERROR_NOT_SUPPORTED );
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003588 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003589
Bence Szépkúti357b78e2021-11-09 13:17:17 +01003590 return( PSA_ERROR_INVALID_ARGUMENT );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003591}
3592
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01003593static psa_status_t psa_aead_check_algorithm( psa_algorithm_t alg )
3594{
Bence Szépkúti08f34652021-12-08 21:07:13 +01003595 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3596 return( PSA_ERROR_INVALID_ARGUMENT );
3597
3598 return( PSA_SUCCESS );
3599}
3600
Ronald Croncf56a0a2020-08-04 09:51:30 +02003601psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003602 psa_algorithm_t alg,
3603 const uint8_t *nonce,
3604 size_t nonce_length,
3605 const uint8_t *additional_data,
3606 size_t additional_data_length,
3607 const uint8_t *plaintext,
3608 size_t plaintext_length,
3609 uint8_t *ciphertext,
3610 size_t ciphertext_size,
3611 size_t *ciphertext_length )
3612{
Ronald Cron215633c2021-03-16 17:15:37 +01003613 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3614 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003615
mohammad1603f08a5502018-06-03 15:05:47 +03003616 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003617
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003618 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003619 if( status != PSA_SUCCESS )
3620 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003621
Ronald Cron9a986162021-03-26 12:40:07 +01003622 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003623 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003624 if( status != PSA_SUCCESS )
3625 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003626
Ronald Cron215633c2021-03-16 17:15:37 +01003627 psa_key_attributes_t attributes = {
3628 .core = slot->attr
3629 };
mohammad16035955c982018-04-26 00:53:03 +03003630
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003631 status = psa_aead_check_nonce_length( alg, nonce_length );
3632 if( status != PSA_SUCCESS )
3633 goto exit;
3634
Ronald Cronde822812021-03-17 16:08:20 +01003635 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003636 &attributes, slot->key.data, slot->key.bytes,
3637 alg,
3638 nonce, nonce_length,
3639 additional_data, additional_data_length,
3640 plaintext, plaintext_length,
3641 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003642
Gilles Peskineedf9a652018-08-17 18:11:56 +02003643 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3644 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003645
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003646exit:
Ronald Cron9f310172021-03-16 16:36:37 +01003647 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003648
mohammad16035955c982018-04-26 00:53:03 +03003649 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003650}
3651
Ronald Croncf56a0a2020-08-04 09:51:30 +02003652psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003653 psa_algorithm_t alg,
3654 const uint8_t *nonce,
3655 size_t nonce_length,
3656 const uint8_t *additional_data,
3657 size_t additional_data_length,
3658 const uint8_t *ciphertext,
3659 size_t ciphertext_length,
3660 uint8_t *plaintext,
3661 size_t plaintext_size,
3662 size_t *plaintext_length )
3663{
Ronald Cron215633c2021-03-16 17:15:37 +01003664 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3665 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003666
Gilles Peskineee652a32018-06-01 19:23:52 +02003667 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003668
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003669 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003670 if( status != PSA_SUCCESS )
3671 return( status );
Steven Cooremanea7ab132021-03-17 16:28:00 +01003672
Ronald Cron9a986162021-03-26 12:40:07 +01003673 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003674 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003675 if( status != PSA_SUCCESS )
3676 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003677
Ronald Cron215633c2021-03-16 17:15:37 +01003678 psa_key_attributes_t attributes = {
3679 .core = slot->attr
3680 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003681
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003682 status = psa_aead_check_nonce_length( alg, nonce_length );
3683 if( status != PSA_SUCCESS )
3684 goto exit;
3685
Ronald Cronde822812021-03-17 16:08:20 +01003686 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003687 &attributes, slot->key.data, slot->key.bytes,
3688 alg,
3689 nonce, nonce_length,
3690 additional_data, additional_data_length,
3691 ciphertext, ciphertext_length,
3692 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003693
Gilles Peskineedf9a652018-08-17 18:11:56 +02003694 if( status != PSA_SUCCESS && plaintext_size != 0 )
3695 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003696
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003697exit:
Ronald Cron215633c2021-03-16 17:15:37 +01003698 psa_unlock_key_slot( slot );
3699
Gilles Peskineedf9a652018-08-17 18:11:56 +02003700 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003701}
3702
Andrzej Kurekf8816012021-12-19 17:00:12 +01003703static psa_status_t psa_validate_tag_length( psa_aead_operation_t *operation,
3704 psa_algorithm_t alg ) {
3705 uint8_t tag_len = 0;
3706 if( psa_driver_get_tag_len( operation, &tag_len ) != PSA_SUCCESS )
3707 {
3708 return( PSA_ERROR_INVALID_ARGUMENT );
3709 }
3710
3711 switch( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg, 0 ) )
3712 {
3713#if defined(MBEDTLS_PSA_BUILTIN_ALG_CCM)
3714 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 0 ):
3715 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
3716 if( tag_len < 4 || tag_len > 16 || tag_len % 2 )
3717 return( PSA_ERROR_INVALID_ARGUMENT );
3718 break;
3719#endif /* MBEDTLS_PSA_BUILTIN_ALG_CCM */
3720
3721#if defined(MBEDTLS_PSA_BUILTIN_ALG_GCM)
3722 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_GCM, 0 ):
3723 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
3724 if( tag_len != 4 && tag_len != 8 && ( tag_len < 12 || tag_len > 16 ) )
3725 return( PSA_ERROR_INVALID_ARGUMENT );
3726 break;
3727#endif /* MBEDTLS_PSA_BUILTIN_ALG_GCM */
3728
3729#if defined(MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305)
3730 case PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CHACHA20_POLY1305, 0 ):
3731 /* We only support the default tag length. */
3732 if( tag_len != 16 )
3733 return( PSA_ERROR_INVALID_ARGUMENT );
3734 break;
3735#endif /* MBEDTLS_PSA_BUILTIN_ALG_CHACHA20_POLY1305 */
3736
3737 default:
3738 (void) tag_len;
3739 return( PSA_ERROR_NOT_SUPPORTED );
3740 }
3741 return( PSA_SUCCESS );
3742}
3743
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003744/* Set the key for a multipart authenticated operation. */
3745static psa_status_t psa_aead_setup( psa_aead_operation_t *operation,
Paul Elliottd9343f22021-08-23 18:59:49 +01003746 int is_encrypt,
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003747 mbedtls_svc_key_id_t key,
3748 psa_algorithm_t alg )
Paul Elliottc2b71442021-06-24 18:17:52 +01003749{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3751 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3752 psa_key_slot_t *slot = NULL;
3753 psa_key_usage_t key_usage = 0;
3754
Bence Szépkúti39fb9d12022-01-13 14:33:45 +01003755 status = psa_aead_check_algorithm( alg );
Bence Szépkúti08f34652021-12-08 21:07:13 +01003756 if( status != PSA_SUCCESS )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003757 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003758
3759 if( operation->id != 0 )
3760 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003761 status = PSA_ERROR_BAD_STATE;
3762 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003763 }
3764
3765 if( operation->nonce_set || operation->lengths_set ||
3766 operation->ad_started || operation->body_started )
3767 {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003768 status = PSA_ERROR_BAD_STATE;
3769 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01003770 }
3771
Paul Elliottd9343f22021-08-23 18:59:49 +01003772 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003773 key_usage = PSA_KEY_USAGE_ENCRYPT;
3774 else
3775 key_usage = PSA_KEY_USAGE_DECRYPT;
3776
3777 status = psa_get_and_lock_key_slot_with_policy( key, &slot, key_usage,
3778 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003779 if( status != PSA_SUCCESS )
3780 goto exit;
3781
3782 psa_key_attributes_t attributes = {
3783 .core = slot->attr
3784 };
3785
Paul Elliottd9343f22021-08-23 18:59:49 +01003786 if( is_encrypt )
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003787 status = psa_driver_wrapper_aead_encrypt_setup( operation,
3788 &attributes,
3789 slot->key.data,
3790 slot->key.bytes,
3791 alg );
3792 else
3793 status = psa_driver_wrapper_aead_decrypt_setup( operation,
3794 &attributes,
3795 slot->key.data,
3796 slot->key.bytes,
3797 alg );
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003798 if( status != PSA_SUCCESS )
3799 goto exit;
3800
Andrzej Kurekf8816012021-12-19 17:00:12 +01003801 if( ( status = psa_validate_tag_length( operation, alg ) ) != PSA_SUCCESS )
3802 goto exit;
3803
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003804 operation->key_type = psa_get_key_type( &attributes );
3805
3806exit:
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003807 unlock_status = psa_unlock_key_slot( slot );
3808
3809 if( status == PSA_SUCCESS )
3810 {
3811 status = unlock_status;
3812 operation->alg = psa_aead_get_base_algorithm( alg );
Paul Elliottd9343f22021-08-23 18:59:49 +01003813 operation->is_encrypt = is_encrypt;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01003814 }
3815 else
3816 psa_aead_abort( operation );
3817
3818 return( status );
Paul Elliottc2b71442021-06-24 18:17:52 +01003819}
3820
Paul Elliott302ff6b2021-04-20 18:10:30 +01003821/* Set the key for a multipart authenticated encryption operation. */
3822psa_status_t psa_aead_encrypt_setup( psa_aead_operation_t *operation,
3823 mbedtls_svc_key_id_t key,
3824 psa_algorithm_t alg )
3825{
Paul Elliottd9343f22021-08-23 18:59:49 +01003826 return( psa_aead_setup( operation, 1, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003827}
3828
3829/* Set the key for a multipart authenticated decryption operation. */
3830psa_status_t psa_aead_decrypt_setup( psa_aead_operation_t *operation,
3831 mbedtls_svc_key_id_t key,
3832 psa_algorithm_t alg )
3833{
Paul Elliottd9343f22021-08-23 18:59:49 +01003834 return( psa_aead_setup( operation, 0, key, alg ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003835}
3836
3837/* Generate a random nonce / IV for multipart AEAD operation */
3838psa_status_t psa_aead_generate_nonce( psa_aead_operation_t *operation,
3839 uint8_t *nonce,
3840 size_t nonce_size,
3841 size_t *nonce_length )
3842{
3843 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01003844 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Paul Elliottb91da712021-05-20 14:43:47 +01003845 size_t required_nonce_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003846
Paul Elliott8eb9daf2021-06-04 16:42:21 +01003847 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003848
Paul Elliottcee785c2021-05-20 14:29:20 +01003849 if( operation->id == 0 )
3850 {
3851 status = PSA_ERROR_BAD_STATE;
3852 goto exit;
3853 }
3854
Paul Elliottdaf5c892021-08-25 16:24:58 +01003855 if( operation->nonce_set || !operation->is_encrypt )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003856 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003857 status = PSA_ERROR_BAD_STATE;
3858 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003859 }
3860
Paul Elliotte193ea82021-10-01 13:00:16 +01003861 /* For CCM, this size may not be correct according to the PSA
3862 * specification. The PSA Crypto 1.0.1 specification states:
3863 *
3864 * CCM encodes the plaintext length pLen in L octets, with L the smallest
3865 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
3866 *
3867 * However this restriction that L has to be the smallest integer is not
3868 * applied in practice, and it is not implementable here since the
3869 * plaintext length may or may not be known at this time. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01003870 required_nonce_size = PSA_AEAD_NONCE_LENGTH( operation->key_type,
Paul Elliott3242f6c2021-08-25 16:33:47 +01003871 operation->alg );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003872 if( nonce_size < required_nonce_size )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003873 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003874 status = PSA_ERROR_BUFFER_TOO_SMALL;
3875 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003876 }
3877
Ronald Croncae59092021-11-26 18:53:58 +01003878 status = psa_generate_random( local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003879 if( status != PSA_SUCCESS )
Paul Elliott39dc6b82021-05-11 19:16:09 +01003880 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003881
Ronald Croncae59092021-11-26 18:53:58 +01003882 status = psa_aead_set_nonce( operation, local_nonce, required_nonce_size );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003883
Paul Elliott39dc6b82021-05-11 19:16:09 +01003884exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003885 if( status == PSA_SUCCESS )
Ronald Croncae59092021-11-26 18:53:58 +01003886 {
3887 memcpy( nonce, local_nonce, required_nonce_size );
Paul Elliott39dc6b82021-05-11 19:16:09 +01003888 *nonce_length = required_nonce_size;
Ronald Croncae59092021-11-26 18:53:58 +01003889 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01003890 else
3891 psa_aead_abort( operation );
3892
3893 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003894}
3895
3896/* Set the nonce for a multipart authenticated encryption or decryption
3897 operation.*/
3898psa_status_t psa_aead_set_nonce( psa_aead_operation_t *operation,
3899 const uint8_t *nonce,
3900 size_t nonce_length )
3901{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003902 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3903
Paul Elliottcee785c2021-05-20 14:29:20 +01003904 if( operation->id == 0 )
3905 {
3906 status = PSA_ERROR_BAD_STATE;
3907 goto exit;
3908 }
3909
Paul Elliott3d7d52c2021-09-01 10:33:14 +01003910 if( operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003911 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003912 status = PSA_ERROR_BAD_STATE;
3913 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003914 }
3915
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003916 status = psa_aead_check_nonce_length( operation->alg, nonce_length );
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003917 if( status != PSA_SUCCESS )
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003918 {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01003919 status = PSA_ERROR_INVALID_ARGUMENT;
3920 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01003921 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01003922
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003923 status = psa_driver_wrapper_aead_set_nonce( operation, nonce,
3924 nonce_length );
3925
Paul Elliott39dc6b82021-05-11 19:16:09 +01003926exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003927 if( status == PSA_SUCCESS )
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003928 operation->nonce_set = 1;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003929 else
3930 psa_aead_abort( operation );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003931
3932 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01003933}
3934
3935/* Declare the lengths of the message and additional data for multipart AEAD. */
3936psa_status_t psa_aead_set_lengths( psa_aead_operation_t *operation,
3937 size_t ad_length,
3938 size_t plaintext_length )
3939{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003940 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3941
Paul Elliottcee785c2021-05-20 14:29:20 +01003942 if( operation->id == 0 )
3943 {
3944 status = PSA_ERROR_BAD_STATE;
3945 goto exit;
3946 }
3947
Paul Elliott6eb95982021-05-21 17:41:41 +01003948 if( operation->lengths_set || operation->ad_started ||
Paul Elliott7f429b72021-06-24 18:08:54 +01003949 operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01003950 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01003951 status = PSA_ERROR_BAD_STATE;
3952 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01003953 }
3954
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003955 switch(operation->alg)
Paul Elliott325d3742021-09-27 17:56:28 +01003956 {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003957#if defined(PSA_WANT_ALG_GCM)
3958 case PSA_ALG_GCM:
3959 /* Lengths can only be too large for GCM if size_t is bigger than 32
3960 * bits. Without the guard this code will generate warnings on 32bit
3961 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01003962#if SIZE_MAX > UINT32_MAX
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003963 if( (( uint64_t ) ad_length ) >> 61 != 0 ||
3964 (( uint64_t ) plaintext_length ) > 0xFFFFFFFE0ull )
3965 {
3966 status = PSA_ERROR_INVALID_ARGUMENT;
3967 goto exit;
3968 }
Paul Elliott325d3742021-09-27 17:56:28 +01003969#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003970 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003971#endif /* PSA_WANT_ALG_GCM */
3972#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003973 case PSA_ALG_CCM:
3974 if( ad_length > 0xFF00 )
3975 {
3976 status = PSA_ERROR_INVALID_ARGUMENT;
3977 goto exit;
3978 }
3979 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003980#endif /* PSA_WANT_ALG_CCM */
3981#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003982 case PSA_ALG_CHACHA20_POLY1305:
3983 /* No length restrictions for ChaChaPoly. */
3984 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01003985#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02003986 default:
3987 break;
3988 }
Paul Elliott325d3742021-09-27 17:56:28 +01003989
Paul Elliottcbbde5f2021-05-10 18:19:46 +01003990 status = psa_driver_wrapper_aead_set_lengths( operation, ad_length,
3991 plaintext_length );
3992
Paul Elliott39dc6b82021-05-11 19:16:09 +01003993exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01003994 if( status == PSA_SUCCESS )
Paul Elliottee4ffe02021-05-20 17:25:06 +01003995 {
3996 operation->ad_remaining = ad_length;
3997 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01003998 operation->lengths_set = 1;
Paul Elliottee4ffe02021-05-20 17:25:06 +01003999 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004000 else
4001 psa_aead_abort( operation );
4002
4003 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004004}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004005
4006/* Pass additional data to an active multipart AEAD operation. */
Paul Elliott302ff6b2021-04-20 18:10:30 +01004007psa_status_t psa_aead_update_ad( psa_aead_operation_t *operation,
4008 const uint8_t *input,
4009 size_t input_length )
4010{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004011 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4012
Paul Elliottcee785c2021-05-20 14:29:20 +01004013 if( operation->id == 0 )
4014 {
4015 status = PSA_ERROR_BAD_STATE;
4016 goto exit;
4017 }
4018
Paul Elliott6eb95982021-05-21 17:41:41 +01004019 if( !operation->nonce_set || operation->body_started )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004020 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004021 status = PSA_ERROR_BAD_STATE;
4022 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004023 }
4024
Paul Elliottee4ffe02021-05-20 17:25:06 +01004025 if( operation->lengths_set )
4026 {
Paul Elliott6eb95982021-05-21 17:41:41 +01004027 if( operation->ad_remaining < input_length )
Paul Elliottee4ffe02021-05-20 17:25:06 +01004028 {
4029 status = PSA_ERROR_INVALID_ARGUMENT;
4030 goto exit;
4031 }
4032
4033 operation->ad_remaining -= input_length;
4034 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004035#if defined(PSA_WANT_ALG_CCM)
4036 else if( operation->alg == PSA_ALG_CCM )
4037 {
4038 status = PSA_ERROR_BAD_STATE;
4039 goto exit;
4040 }
4041#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004042
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004043 status = psa_driver_wrapper_aead_update_ad( operation, input,
4044 input_length );
4045
Paul Elliott39dc6b82021-05-11 19:16:09 +01004046exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004047 if( status == PSA_SUCCESS )
4048 operation->ad_started = 1;
4049 else
4050 psa_aead_abort( operation );
4051
4052 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004053}
4054
4055/* Encrypt or decrypt a message fragment in an active multipart AEAD
4056 operation.*/
4057psa_status_t psa_aead_update( psa_aead_operation_t *operation,
4058 const uint8_t *input,
4059 size_t input_length,
4060 uint8_t *output,
4061 size_t output_size,
4062 size_t *output_length )
4063{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004065
4066 *output_length = 0;
4067
Paul Elliottcee785c2021-05-20 14:29:20 +01004068 if( operation->id == 0 )
4069 {
4070 status = PSA_ERROR_BAD_STATE;
4071 goto exit;
4072 }
4073
Paul Elliott6eb95982021-05-21 17:41:41 +01004074 if( !operation->nonce_set )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004075 {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004076 status = PSA_ERROR_BAD_STATE;
4077 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004078 }
4079
Paul Elliottee4ffe02021-05-20 17:25:06 +01004080 if( operation->lengths_set )
4081 {
4082 /* Additional data length was supplied, but not all the additional
4083 data was supplied.*/
4084 if( operation->ad_remaining != 0 )
4085 {
4086 status = PSA_ERROR_INVALID_ARGUMENT;
4087 goto exit;
4088 }
4089
4090 /* Too much data provided. */
4091 if( operation->body_remaining < input_length )
4092 {
4093 status = PSA_ERROR_INVALID_ARGUMENT;
4094 goto exit;
4095 }
4096
4097 operation->body_remaining -= input_length;
4098 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004099#if defined(PSA_WANT_ALG_CCM)
4100 else if( operation->alg == PSA_ALG_CCM )
4101 {
4102 status = PSA_ERROR_BAD_STATE;
4103 goto exit;
4104 }
4105#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004106
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004107 status = psa_driver_wrapper_aead_update( operation, input, input_length,
4108 output, output_size,
4109 output_length );
4110
Paul Elliott39dc6b82021-05-11 19:16:09 +01004111exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004112 if( status == PSA_SUCCESS )
4113 operation->body_started = 1;
4114 else
4115 psa_aead_abort( operation );
4116
4117 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004118}
4119
Paul Elliott69bf5fc2021-09-19 18:26:37 +01004120static psa_status_t psa_aead_final_checks( const psa_aead_operation_t *operation )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004121{
Paul Elliott7f429b72021-06-24 18:08:54 +01004122 if( operation->id == 0 || !operation->nonce_set )
Paul Elliottad53dcc2021-06-23 08:50:14 +01004123 return( PSA_ERROR_BAD_STATE );
4124
Paul Elliotta5614442021-07-14 14:54:11 +01004125 if( operation->lengths_set && ( operation->ad_remaining != 0 ||
Paul Elliottad53dcc2021-06-23 08:50:14 +01004126 operation->body_remaining != 0 ) )
4127 return( PSA_ERROR_INVALID_ARGUMENT );
4128
4129 return( PSA_SUCCESS );
4130}
4131
Paul Elliott302ff6b2021-04-20 18:10:30 +01004132/* Finish encrypting a message in a multipart AEAD operation. */
4133psa_status_t psa_aead_finish( psa_aead_operation_t *operation,
4134 uint8_t *ciphertext,
4135 size_t ciphertext_size,
4136 size_t *ciphertext_length,
4137 uint8_t *tag,
4138 size_t tag_size,
4139 size_t *tag_length )
4140{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4142
Paul Elliott302ff6b2021-04-20 18:10:30 +01004143 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004144 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004145
Paul Elliott814fffb2021-08-16 18:20:36 +01004146 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004147 if( status != PSA_SUCCESS )
4148 goto exit;
4149
Paul Elliott7f429b72021-06-24 18:08:54 +01004150 if( !operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004151 {
4152 status = PSA_ERROR_BAD_STATE;
4153 goto exit;
4154 }
4155
Paul Elliott39dc6b82021-05-11 19:16:09 +01004156 status = psa_driver_wrapper_aead_finish( operation, ciphertext,
4157 ciphertext_size,
4158 ciphertext_length,
4159 tag, tag_size, tag_length );
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004160
Paul Elliott39dc6b82021-05-11 19:16:09 +01004161exit:
Paul Elliottf47b0952021-05-21 18:02:33 +01004162 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004163 * the zero tag size, make sure the tag is set to something implausible.
4164 * Even if the operation succeeds, make sure we clear the rest of the
4165 * buffer to prevent potential leakage of anything previously placed in
4166 * the same buffer.*/
Paul Elliott90fdc112021-09-22 17:15:48 +01004167 if( tag != NULL )
Paul Elliottec95cc92021-09-19 22:33:09 +01004168 {
4169 if( status != PSA_SUCCESS )
4170 memset( tag, '!', tag_size );
4171 else if( *tag_length < tag_size )
4172 memset( tag + *tag_length, '!', ( tag_size - *tag_length ) );
4173 }
Paul Elliottf47b0952021-05-21 18:02:33 +01004174
Paul Elliott39dc6b82021-05-11 19:16:09 +01004175 psa_aead_abort( operation );
4176
4177 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004178}
4179
4180/* Finish authenticating and decrypting a message in a multipart AEAD
4181 operation.*/
4182psa_status_t psa_aead_verify( psa_aead_operation_t *operation,
4183 uint8_t *plaintext,
4184 size_t plaintext_size,
4185 size_t *plaintext_length,
4186 const uint8_t *tag,
4187 size_t tag_length )
4188{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4190
Paul Elliott302ff6b2021-04-20 18:10:30 +01004191 *plaintext_length = 0;
4192
Paul Elliott814fffb2021-08-16 18:20:36 +01004193 status = psa_aead_final_checks( operation );
Paul Elliottad53dcc2021-06-23 08:50:14 +01004194 if( status != PSA_SUCCESS )
4195 goto exit;
4196
Paul Elliott7f429b72021-06-24 18:08:54 +01004197 if( operation->is_encrypt )
Paul Elliottcee785c2021-05-20 14:29:20 +01004198 {
4199 status = PSA_ERROR_BAD_STATE;
4200 goto exit;
4201 }
4202
Paul Elliott39dc6b82021-05-11 19:16:09 +01004203 status = psa_driver_wrapper_aead_verify( operation, plaintext,
4204 plaintext_size,
4205 plaintext_length,
4206 tag, tag_length );
4207
4208exit:
Paul Elliott39dc6b82021-05-11 19:16:09 +01004209 psa_aead_abort( operation );
4210
4211 return( status );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004212}
4213
4214/* Abort an AEAD operation. */
Paul Elliottbbe90b52021-05-11 22:22:42 +01004215psa_status_t psa_aead_abort( psa_aead_operation_t *operation )
Paul Elliott302ff6b2021-04-20 18:10:30 +01004216{
4217 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4218
4219 if( operation->id == 0 )
4220 {
4221 /* The object has (apparently) been initialized but it is not (yet)
4222 * in use. It's ok to call abort on such an object, and there's
4223 * nothing to do. */
4224 return( PSA_SUCCESS );
4225 }
4226
4227 status = psa_driver_wrapper_aead_abort( operation );
4228
Paul Elliott70618b22021-09-22 17:12:16 +01004229 memset( operation, 0, sizeof( *operation ) );
Paul Elliott302ff6b2021-04-20 18:10:30 +01004230
4231 return( status );
4232}
4233
Gilles Peskinee59236f2018-01-27 23:32:46 +01004234/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004235/* Generators */
4236/****************************************************************/
4237
John Durkop07cc04a2020-11-16 22:08:34 -08004238#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4239 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4240 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4241#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02004242#endif /* At least one builtin KDF */
4243
4244#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4245 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4246 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4247static psa_status_t psa_key_derivation_start_hmac(
4248 psa_mac_operation_t *operation,
4249 psa_algorithm_t hash_alg,
4250 const uint8_t *hmac_key,
4251 size_t hmac_key_length )
4252{
4253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4254 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
4255 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
4256 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
4257 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
4258
Steven Cooreman72f736a2021-05-07 14:14:37 +02004259 operation->is_sign = 1;
4260 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
4261
Steven Cooreman094a77e2021-05-06 17:58:36 +02004262 status = psa_driver_wrapper_mac_sign_setup( operation,
4263 &attributes,
4264 hmac_key, hmac_key_length,
4265 PSA_ALG_HMAC( hash_alg ) );
4266
4267 psa_reset_key_attributes( &attributes );
4268 return( status );
4269}
4270#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004271
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004272#define HKDF_STATE_INIT 0 /* no input yet */
4273#define HKDF_STATE_STARTED 1 /* got salt */
4274#define HKDF_STATE_KEYED 2 /* got key */
4275#define HKDF_STATE_OUTPUT 3 /* output started */
4276
Gilles Peskinecbe66502019-05-16 16:59:18 +02004277static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004278 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004279{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004280 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4281 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004282 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004283 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004284}
4285
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004286psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004287{
4288 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004289 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004290 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004291 {
4292 /* The object has (apparently) been initialized but it is not
4293 * in use. It's ok to call abort on such an object, and there's
4294 * nothing to do. */
4295 }
4296 else
John Durkopd0321952020-10-29 21:37:36 -07004297#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004298 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004299 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004300 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004301 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004302 }
John Durkop07cc04a2020-11-16 22:08:34 -08004303 else
4304#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4305#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4306 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4307 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004308 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004309 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004310 {
Steven Cooremana6df6042021-04-29 19:32:25 +02004311 if( operation->ctx.tls12_prf.secret != NULL )
4312 {
4313 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
4314 operation->ctx.tls12_prf.secret_length );
4315 mbedtls_free( operation->ctx.tls12_prf.secret );
4316 }
4317
Janos Follath6a1d2622019-06-11 10:37:28 +01004318 if( operation->ctx.tls12_prf.seed != NULL )
4319 {
4320 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4321 operation->ctx.tls12_prf.seed_length );
4322 mbedtls_free( operation->ctx.tls12_prf.seed );
4323 }
4324
4325 if( operation->ctx.tls12_prf.label != NULL )
4326 {
4327 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4328 operation->ctx.tls12_prf.label_length );
4329 mbedtls_free( operation->ctx.tls12_prf.label );
4330 }
4331
Przemek Stekiele3ee2212022-04-07 14:29:56 +02004332 if( operation->ctx.tls12_prf.other_secret != NULL )
4333 {
4334 mbedtls_platform_zeroize( operation->ctx.tls12_prf.other_secret,
4335 operation->ctx.tls12_prf.other_secret_length );
4336 mbedtls_free( operation->ctx.tls12_prf.other_secret );
4337 }
4338
Steven Cooremana6df6042021-04-29 19:32:25 +02004339 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004340
4341 /* We leave the fields Ai and output_block to be erased safely by the
4342 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004343 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004344 else
John Durkop07cc04a2020-11-16 22:08:34 -08004345#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4346 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004347 {
4348 status = PSA_ERROR_BAD_STATE;
4349 }
Janos Follath083036a2019-06-11 10:22:26 +01004350 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004351 return( status );
4352}
4353
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004354psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004355 size_t *capacity)
4356{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004357 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004358 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004359 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004360 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004361 }
4362
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004363 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004364 return( PSA_SUCCESS );
4365}
4366
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004367psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004368 size_t capacity )
4369{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004370 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004371 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004372 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004373 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004374 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004375 return( PSA_SUCCESS );
4376}
4377
John Durkopd0321952020-10-29 21:37:36 -07004378#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004379/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004380 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004381static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004382 psa_algorithm_t hash_alg,
4383 uint8_t *output,
4384 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004385{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004386 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004387 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004388 psa_status_t status;
4389
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004390 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4391 return( PSA_ERROR_BAD_STATE );
4392 hkdf->state = HKDF_STATE_OUTPUT;
4393
Gilles Peskinebef7f142018-07-12 17:22:21 +02004394 while( output_length != 0 )
4395 {
4396 /* Copy what remains of the current block */
4397 uint8_t n = hash_length - hkdf->offset_in_block;
4398 if( n > output_length )
4399 n = (uint8_t) output_length;
4400 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4401 output += n;
4402 output_length -= n;
4403 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004404 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004405 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004406 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004407 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004408 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004409 * object was corrupted or if this function is called directly
4410 * inside the library. */
4411 if( hkdf->block_number == 0xff )
4412 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004413
4414 /* We need a new block */
4415 ++hkdf->block_number;
4416 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004417
Steven Cooreman094a77e2021-05-06 17:58:36 +02004418 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4419 hash_alg,
4420 hkdf->prk,
4421 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004422 if( status != PSA_SUCCESS )
4423 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004424
Gilles Peskinebef7f142018-07-12 17:22:21 +02004425 if( hkdf->block_number != 1 )
4426 {
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004427 status = psa_mac_update( &hkdf->hmac,
4428 hkdf->output_block,
4429 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004430 if( status != PSA_SUCCESS )
4431 return( status );
4432 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004433 status = psa_mac_update( &hkdf->hmac,
4434 hkdf->info,
4435 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004436 if( status != PSA_SUCCESS )
4437 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004438 status = psa_mac_update( &hkdf->hmac,
4439 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004440 if( status != PSA_SUCCESS )
4441 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02004442 status = psa_mac_sign_finish( &hkdf->hmac,
4443 hkdf->output_block,
4444 sizeof( hkdf->output_block ),
4445 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004446 if( status != PSA_SUCCESS )
4447 return( status );
4448 }
4449
4450 return( PSA_SUCCESS );
4451}
John Durkop07cc04a2020-11-16 22:08:34 -08004452#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004453
John Durkop07cc04a2020-11-16 22:08:34 -08004454#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4455 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004456static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4457 psa_tls12_prf_key_derivation_t *tls12_prf,
4458 psa_algorithm_t alg )
4459{
4460 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004461 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremana6df6042021-04-29 19:32:25 +02004462 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4463 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004464 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004465
Janos Follath7742fee2019-06-17 12:58:10 +01004466 /* We can't be wanting more output after block 0xff, otherwise
4467 * the capacity check in psa_key_derivation_output_bytes() would have
4468 * prevented this call. It could happen only if the operation
4469 * object was corrupted or if this function is called directly
4470 * inside the library. */
4471 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004472 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004473
4474 /* We need a new block */
4475 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004476 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004477
4478 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4479 *
4480 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4481 *
4482 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4483 * HMAC_hash(secret, A(2) + seed) +
4484 * HMAC_hash(secret, A(3) + seed) + ...
4485 *
4486 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004487 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004488 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004489 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004490 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004491 * is currently extracted as `output_block` and where i is
4492 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004493 */
4494
Steven Cooreman094a77e2021-05-06 17:58:36 +02004495 status = psa_key_derivation_start_hmac( &hmac,
4496 hash_alg,
4497 tls12_prf->secret,
4498 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004499 if( status != PSA_SUCCESS )
4500 goto cleanup;
4501
4502 /* Calculate A(i) where i = tls12_prf->block_number. */
4503 if( tls12_prf->block_number == 1 )
4504 {
4505 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4506 * the variable seed and in this instance means it in the context of the
4507 * P_hash function, where seed = label + seed.) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004508 status = psa_mac_update( &hmac,
4509 tls12_prf->label,
4510 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004511 if( status != PSA_SUCCESS )
4512 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004513 status = psa_mac_update( &hmac,
4514 tls12_prf->seed,
4515 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004516 if( status != PSA_SUCCESS )
4517 goto cleanup;
4518 }
4519 else
4520 {
4521 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooremana6df6042021-04-29 19:32:25 +02004522 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004523 if( status != PSA_SUCCESS )
4524 goto cleanup;
4525 }
4526
Steven Cooremana6df6042021-04-29 19:32:25 +02004527 status = psa_mac_sign_finish( &hmac,
4528 tls12_prf->Ai, hash_length,
4529 &hmac_output_length );
4530 if( hmac_output_length != hash_length )
4531 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01004532 if( status != PSA_SUCCESS )
4533 goto cleanup;
4534
4535 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman094a77e2021-05-06 17:58:36 +02004536 status = psa_key_derivation_start_hmac( &hmac,
4537 hash_alg,
4538 tls12_prf->secret,
4539 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004540 if( status != PSA_SUCCESS )
4541 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004542 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004543 if( status != PSA_SUCCESS )
4544 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004545 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004546 if( status != PSA_SUCCESS )
4547 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004548 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004549 if( status != PSA_SUCCESS )
4550 goto cleanup;
Steven Cooremana6df6042021-04-29 19:32:25 +02004551 status = psa_mac_sign_finish( &hmac,
4552 tls12_prf->output_block, hash_length,
4553 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01004554 if( status != PSA_SUCCESS )
4555 goto cleanup;
4556
Janos Follath7742fee2019-06-17 12:58:10 +01004557
4558cleanup:
Steven Cooremana6df6042021-04-29 19:32:25 +02004559 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01004560 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4561 status = cleanup_status;
4562
4563 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004564}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004565
Janos Follath844eb0e2019-06-19 12:10:49 +01004566static psa_status_t psa_key_derivation_tls12_prf_read(
4567 psa_tls12_prf_key_derivation_t *tls12_prf,
4568 psa_algorithm_t alg,
4569 uint8_t *output,
4570 size_t output_length )
4571{
4572 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004573 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004574 psa_status_t status;
4575 uint8_t offset, length;
4576
Gilles Peskineb1edaec2021-06-11 22:41:46 +02004577 switch( tls12_prf->state )
4578 {
4579 case PSA_TLS12_PRF_STATE_LABEL_SET:
4580 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4581 break;
4582 case PSA_TLS12_PRF_STATE_OUTPUT:
4583 break;
4584 default:
4585 return( PSA_ERROR_BAD_STATE );
4586 }
4587
Janos Follath844eb0e2019-06-19 12:10:49 +01004588 while( output_length != 0 )
4589 {
4590 /* Check if we have fully processed the current block. */
4591 if( tls12_prf->left_in_block == 0 )
4592 {
4593 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
4594 alg );
4595 if( status != PSA_SUCCESS )
4596 return( status );
4597
4598 continue;
4599 }
4600
4601 if( tls12_prf->left_in_block > output_length )
4602 length = (uint8_t) output_length;
4603 else
4604 length = tls12_prf->left_in_block;
4605
4606 offset = hash_length - tls12_prf->left_in_block;
4607 memcpy( output, tls12_prf->output_block + offset, length );
4608 output += length;
4609 output_length -= length;
4610 tls12_prf->left_in_block -= length;
4611 }
4612
4613 return( PSA_SUCCESS );
4614}
John Durkop07cc04a2020-11-16 22:08:34 -08004615#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4616 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004617
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004618psa_status_t psa_key_derivation_output_bytes(
4619 psa_key_derivation_operation_t *operation,
4620 uint8_t *output,
4621 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004622{
4623 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004624 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004625
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004626 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004627 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004628 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004629 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004630 }
4631
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004632 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004633 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004634 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004635 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004636 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004637 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004638 goto exit;
4639 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004640 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004641 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004642 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004643 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004644 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4645 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004646 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004647 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02004648 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004649 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004650 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004651
John Durkopd0321952020-10-29 21:37:36 -07004652#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004653 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004654 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004655 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004656 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004657 output, output_length );
4658 }
Janos Follathadbec812019-06-14 11:05:39 +01004659 else
John Durkop07cc04a2020-11-16 22:08:34 -08004660#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4661#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4662 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01004663 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08004664 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004665 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004666 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooremana6df6042021-04-29 19:32:25 +02004667 kdf_alg, output,
4668 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004669 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004670 else
John Durkop07cc04a2020-11-16 22:08:34 -08004671#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4672 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004673 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004674 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004675 return( PSA_ERROR_BAD_STATE );
4676 }
4677
4678exit:
4679 if( status != PSA_SUCCESS )
4680 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004681 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004682 * This allows us to differentiate between exhausted operations and
4683 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4684 * operations. */
4685 psa_algorithm_t alg = operation->alg;
4686 psa_key_derivation_abort( operation );
4687 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004688 memset( output, '!', output_length );
4689 }
4690 return( status );
4691}
4692
David Brown7807bf72021-02-09 16:28:23 -07004693#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004694static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4695{
4696 if( data_size >= 8 )
4697 mbedtls_des_key_set_parity( data );
4698 if( data_size >= 16 )
4699 mbedtls_des_key_set_parity( data + 8 );
4700 if( data_size >= 24 )
4701 mbedtls_des_key_set_parity( data + 16 );
4702}
David Brown7807bf72021-02-09 16:28:23 -07004703#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004704
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004705/*
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +01004706* ECC keys on a Weierstrass elliptic curve require the generation
4707* of a private key which is an integer
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004708* in the range [1, N - 1], where N is the boundary of the private key domain:
4709* N is the prime p for Diffie-Hellman, or the order of the
4710* curve’s base point for ECC.
4711*
4712* Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
4713* This function generates the private key using the following process:
4714*
4715* 1. Draw a byte string of length ceiling(m/8) bytes.
4716* 2. If m is not a multiple of 8, set the most significant
4717* (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
4718* 3. Convert the string to integer k by decoding it as a big-endian byte string.
4719* 4. If k > N - 2, discard the result and return to step 1.
4720* 5. Output k + 1 as the private key.
4721*
4722* This method allows compliance to NIST standards, specifically the methods titled
4723* Key-Pair Generation by Testing Candidates in the following publications:
4724* - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
4725* Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
4726* Diffie-Hellman keys.
4727*
4728* - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
4729* Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004730*
4731* Note: Function allocates memory for *data buffer, so given *data should be
4732* always NULL.
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004733*/
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004734#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4735 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4736 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4737 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4738 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004739static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004740 psa_key_slot_t *slot,
4741 size_t bits,
4742 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004743 uint8_t **data
4744 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004745{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004746 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004747 mbedtls_mpi k;
4748 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004749 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004751
4752 mbedtls_mpi_init( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004753 mbedtls_mpi_init( &diff_N_2 );
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004754
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004755 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
4756 slot->attr.type );
4757 mbedtls_ecp_group_id grp_id =
4758 mbedtls_ecc_group_of_psa( curve, bits, 0 );
4759
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004760 if( grp_id == MBEDTLS_ECP_DP_NONE )
4761 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004762 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01004763 goto cleanup;
4764 }
4765
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004766 mbedtls_ecp_group ecp_group;
Przemyslaw Stekiel65348162021-11-18 11:57:07 +01004767 mbedtls_ecp_group_init( &ecp_group );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004768
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004769 MBEDTLS_MPI_CHK( mbedtls_ecp_group_load( &ecp_group, grp_id ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004770
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004771 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004772 /* Let m be the bit size of N. */
4773 size_t m = ecp_group.nbits;
4774
4775 size_t m_bytes = PSA_BITS_TO_BYTES( m );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004776
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004777 /* Calculate N - 2 - it will be needed later. */
4778 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &diff_N_2, &ecp_group.N, 2 ) );
4779
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004780 /* Note: This function is always called with *data == NULL and it
4781 * allocates memory for the data buffer. */
4782 *data = mbedtls_calloc( 1, m_bytes );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004783 if( *data == NULL )
4784 {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004785 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004786 goto cleanup;
4787 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004788
Przemek Stekielc85f0912022-03-08 11:37:54 +01004789 while( key_out_of_range )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004790 {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004791 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004792 if( ( status = psa_key_derivation_output_bytes( operation, *data, m_bytes ) ) != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004793 goto cleanup;
4794
4795 /* 2. If m is not a multiple of 8 */
Przemek Stekielc85f0912022-03-08 11:37:54 +01004796 if( m % 8 != 0 )
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004797 {
4798 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004799 * (8 * ceiling(m/8) - m) bits of the first byte in
4800 * the string to zero.
4801 */
4802 uint8_t clear_bit_mask = ( 1 << ( m % 8 ) ) - 1;
4803 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004804 }
4805
4806 /* 3. Convert the string to integer k by decoding it as a
4807 * big-endian byte string.
4808 */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004809 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &k, *data, m_bytes ) );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004810
4811 /* 4. If k > N - 2, discard the result and return to step 1.
4812 * Result of comparison is returned. When it indicates error
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004813 * then this function is called again.
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004814 */
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004815 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( &diff_N_2, &k, &key_out_of_range ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004816 }
4817
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004818 /* 5. Output k + 1 as the private key. */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004819 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &k, &k, 1 ) );
4820 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &k, *data, m_bytes ) );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004821cleanup:
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004822 if( ret != 0 )
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004823 status = mbedtls_to_psa_error( ret );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004824 if( status != PSA_SUCCESS ) {
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004825 mbedtls_free( *data );
4826 *data = NULL;
4827 }
4828 mbedtls_mpi_free( &k );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004829 mbedtls_mpi_free( &diff_N_2 );
Przemyslaw Stekieldc8d7d92021-12-02 09:15:20 +01004830 return( status );
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004831}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004832
4833/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
4834 * is determined by the curve, and sets the mandatory bits accordingly. That is:
4835 *
4836 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
4837 * draw a 32-byte string and process it as specified in
4838 * Elliptic Curves for Security [RFC7748] §5.
4839 *
4840 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
4841 * draw a 56-byte string and process it as specified in [RFC7748] §5.
4842 *
4843 * Note: Function allocates memory for *data buffer, so given *data should be
4844 * always NULL.
4845 */
4846
4847static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
4848 size_t bits,
4849 psa_key_derivation_operation_t *operation,
4850 uint8_t **data
4851 )
4852{
4853 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004855
4856 switch( bits )
4857 {
4858 case 255:
4859 output_length = 32;
4860 break;
4861 case 448:
4862 output_length = 56;
4863 break;
4864 default:
4865 return( PSA_ERROR_INVALID_ARGUMENT );
4866 break;
4867 }
4868
4869 *data = mbedtls_calloc( 1, output_length );
4870
4871 if( *data == NULL )
4872 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4873
4874 status = psa_key_derivation_output_bytes( operation, *data, output_length );
4875
4876 if( status != PSA_SUCCESS )
4877 return status;
4878
4879 switch( bits )
4880 {
4881 case 255:
4882 (*data)[0] &= 248;
4883 (*data)[31] &= 127;
4884 (*data)[31] |= 64;
4885 break;
4886 case 448:
4887 (*data)[0] &= 252;
4888 (*data)[55] |= 128;
4889 break;
4890 default:
Przemek Stekiela81aed22022-03-01 15:13:30 +01004891 return( PSA_ERROR_CORRUPTION_DETECTED );
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004892 break;
4893 }
4894
4895 return status;
4896}
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004897#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4898 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4899 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4900 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4901 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01004902
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004903static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004904 psa_key_slot_t *slot,
4905 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004906 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004907{
4908 uint8_t *data = NULL;
4909 size_t bytes = PSA_BITS_TO_BYTES( bits );
Archanad8a83dc2021-06-14 10:04:16 +05304910 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01004911 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004912
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004913 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004914 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004915
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004916#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
4917 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
4918 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4919 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
4920 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Przemek Stekielc85f0912022-03-08 11:37:54 +01004921 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004922 {
Przemyslaw Stekiel92481592022-01-04 10:09:46 +01004923 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type );
Przemek Stekielc85f0912022-03-08 11:37:54 +01004924 if( PSA_ECC_FAMILY_IS_WEIERSTRASS( curve ) )
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004925 {
4926 /* Weierstrass elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004927 status = psa_generate_derived_ecc_key_weierstrass_helper( slot, bits, operation, &data );
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01004928 if( status != PSA_SUCCESS )
4929 goto exit;
Przemyslaw Stekiel50fcc532021-11-26 10:54:52 +01004930 }
4931 else
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004932 {
4933 /* Montgomery elliptic curve */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004934 status = psa_generate_derived_ecc_key_montgomery_helper( bits, operation, &data );
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004935 if( status != PSA_SUCCESS )
4936 goto exit;
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01004937 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004938 } else
Przemek Stekiel7fc07512022-03-04 14:41:11 +01004939#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
4940 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
4941 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4942 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
4943 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004944 if( key_type_is_raw_bytes( slot->attr.type ) )
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01004945 {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004946 if( bits % 8 != 0 )
4947 return( PSA_ERROR_INVALID_ARGUMENT );
4948 data = mbedtls_calloc( 1, bytes );
4949 if( data == NULL )
4950 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4951
4952 status = psa_key_derivation_output_bytes( operation, data, bytes );
4953 if( status != PSA_SUCCESS )
4954 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004955#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004956 if( slot->attr.type == PSA_KEY_TYPE_DES )
4957 psa_des_set_key_parity( data, bytes );
Przemek Stekielf110dc02022-03-01 14:48:05 +01004958#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01004959 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01004960 else
Przemek Stekieldcab6cc2022-03-01 14:22:29 +01004961 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Crondd04d422020-11-28 15:14:42 +01004962
Ronald Cronbf33c932020-11-28 18:06:53 +01004963 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004964 psa_key_attributes_t attributes = {
4965 .core = slot->attr
4966 };
4967
Archanad8a83dc2021-06-14 10:04:16 +05304968 if( psa_key_lifetime_is_external( attributes.core.lifetime ) )
4969 {
Archana449608b2021-09-08 15:36:05 +05304970 status = psa_driver_wrapper_get_key_buffer_size( &attributes,
4971 &storage_size );
Archanad8a83dc2021-06-14 10:04:16 +05304972 if( status != PSA_SUCCESS )
4973 goto exit;
4974 }
4975 status = psa_allocate_buffer_to_slot( slot, storage_size );
4976 if( status != PSA_SUCCESS )
4977 goto exit;
4978
Ronald Cronbf33c932020-11-28 18:06:53 +01004979 status = psa_driver_wrapper_import_key( &attributes,
4980 data, bytes,
4981 slot->key.data,
4982 slot->key.bytes,
4983 &slot->key.bytes, &bits );
4984 if( bits != slot->attr.bits )
4985 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004986
4987exit:
4988 mbedtls_free( data );
4989 return( status );
4990}
4991
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004992psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004993 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004994 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004995{
4996 psa_status_t status;
4997 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004998 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004999
Ronald Cron81709fc2020-11-14 12:10:32 +01005000 *key = MBEDTLS_SVC_KEY_ID_INIT;
5001
Gilles Peskine0f84d622019-09-12 19:03:13 +02005002 /* Reject any attempt to create a zero-length key so that we don't
5003 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5004 if( psa_get_key_bits( attributes ) == 0 )
5005 return( PSA_ERROR_INVALID_ARGUMENT );
5006
Dave Rodgmand69da6c2021-11-16 10:32:48 +00005007 if( operation->alg == PSA_ALG_NONE )
5008 return( PSA_ERROR_BAD_STATE );
5009
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005010 if( ! operation->can_output_key )
5011 return( PSA_ERROR_NOT_PERMITTED );
5012
Ronald Cron81709fc2020-11-14 12:10:32 +01005013 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5014 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005015#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5016 if( driver != NULL )
5017 {
5018 /* Deriving a key in a secure element is not implemented yet. */
5019 status = PSA_ERROR_NOT_SUPPORTED;
5020 }
5021#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005022 if( status == PSA_SUCCESS )
5023 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005024 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005025 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005026 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005027 }
5028 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005029 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005030 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005031 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005032
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005033 return( status );
5034}
5035
Gilles Peskineeab56e42018-07-12 17:12:33 +02005036
5037
5038/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005039/* Key derivation */
5040/****************************************************************/
5041
Steven Cooreman932ffb72021-02-15 12:14:32 +01005042#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005043static int is_kdf_alg_supported( psa_algorithm_t kdf_alg )
5044{
5045#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
5046 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5047 return( 1 );
5048#endif
5049#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5050 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5051 return( 1 );
5052#endif
5053#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5054 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5055 return( 1 );
5056#endif
5057 return( 0 );
5058}
5059
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005060static psa_status_t psa_hash_try_support( psa_algorithm_t alg )
5061{
5062 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
5063 psa_status_t status = psa_hash_setup( &operation, alg );
5064 psa_hash_abort( &operation );
5065 return( status );
5066}
5067
Gilles Peskine969c5d62019-01-16 15:53:06 +01005068static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005069 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005070 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005071{
Janos Follath5fe19732019-06-20 15:09:30 +01005072 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5073 * initialisers for this union leave some bytes unspecified.) */
5074 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5075
Gilles Peskine969c5d62019-01-16 15:53:06 +01005076 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005077 if( ! is_kdf_alg_supported( kdf_alg ) )
5078 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop07cc04a2020-11-16 22:08:34 -08005079
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005080 /* All currently supported key derivation algorithms are based on a
5081 * hash algorithm. */
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005082 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
5083 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
5084 if( hash_size == 0 )
5085 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005086
5087 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
5088 * we might fail later, which is somewhat unfriendly and potentially
5089 * risk-prone. */
5090 psa_status_t status = psa_hash_try_support( hash_alg );
5091 if( status != PSA_SUCCESS )
5092 return( status );
5093
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005094 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5095 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
5096 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005097 {
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005098 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005099 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02005100
Gilles Peskine9efde4f2021-04-29 21:10:00 +02005101 operation->capacity = 255 * hash_size;
5102 return( PSA_SUCCESS );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005103}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005104
5105static psa_status_t psa_key_agreement_try_support( psa_algorithm_t alg )
5106{
5107#if defined(PSA_WANT_ALG_ECDH)
5108 if( alg == PSA_ALG_ECDH )
5109 return( PSA_SUCCESS );
5110#endif
5111 (void) alg;
5112 return( PSA_ERROR_NOT_SUPPORTED );
5113}
John Durkop07cc04a2020-11-16 22:08:34 -08005114#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005115
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005116psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005117 psa_algorithm_t alg )
5118{
5119 psa_status_t status;
5120
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005121 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005122 return( PSA_ERROR_BAD_STATE );
5123
Gilles Peskine6843c292019-01-18 16:44:49 +01005124 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5125 return( PSA_ERROR_INVALID_ARGUMENT );
5126 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005127 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005128#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005129 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine0c3a0712021-04-29 21:34:33 +02005130 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( alg );
5131 status = psa_key_agreement_try_support( ka_alg );
5132 if( status != PSA_SUCCESS )
5133 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005134 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005135#else
5136 return( PSA_ERROR_NOT_SUPPORTED );
5137#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005138 }
5139 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5140 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01005141#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005142 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01005143#else
5144 return( PSA_ERROR_NOT_SUPPORTED );
5145#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005146 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005147 else
5148 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005149
5150 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005151 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005152 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005153}
5154
John Durkopd0321952020-10-29 21:37:36 -07005155#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005156static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005157 psa_algorithm_t hash_alg,
5158 psa_key_derivation_step_t step,
5159 const uint8_t *data,
5160 size_t data_length )
5161{
5162 psa_status_t status;
5163 switch( step )
5164 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005165 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005166 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005167 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005168 else
5169 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005170 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5171 hash_alg,
5172 data, data_length );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005173 if( status != PSA_SUCCESS )
5174 return( status );
5175 hkdf->state = HKDF_STATE_STARTED;
5176 return( PSA_SUCCESS );
5177 }
Gilles Peskine03410b52019-05-16 16:05:19 +02005178 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005179 /* If no salt was provided, use an empty salt. */
5180 if( hkdf->state == HKDF_STATE_INIT )
5181 {
Steven Cooreman094a77e2021-05-06 17:58:36 +02005182 status = psa_key_derivation_start_hmac( &hkdf->hmac,
5183 hash_alg,
5184 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005185 if( status != PSA_SUCCESS )
5186 return( status );
5187 hkdf->state = HKDF_STATE_STARTED;
5188 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005189 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005190 return( PSA_ERROR_BAD_STATE );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005191 status = psa_mac_update( &hkdf->hmac,
5192 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005193 if( status != PSA_SUCCESS )
5194 return( status );
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005195 status = psa_mac_sign_finish( &hkdf->hmac,
5196 hkdf->prk,
5197 sizeof( hkdf->prk ),
5198 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005199 if( status != PSA_SUCCESS )
5200 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005201 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005202 hkdf->block_number = 0;
5203 hkdf->state = HKDF_STATE_KEYED;
5204 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005205 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005206 if( hkdf->state == HKDF_STATE_OUTPUT )
5207 return( PSA_ERROR_BAD_STATE );
5208 if( hkdf->info_set )
5209 return( PSA_ERROR_BAD_STATE );
5210 hkdf->info_length = data_length;
5211 if( data_length != 0 )
5212 {
5213 hkdf->info = mbedtls_calloc( 1, data_length );
5214 if( hkdf->info == NULL )
5215 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5216 memcpy( hkdf->info, data, data_length );
5217 }
5218 hkdf->info_set = 1;
5219 return( PSA_SUCCESS );
5220 default:
5221 return( PSA_ERROR_INVALID_ARGUMENT );
5222 }
5223}
John Durkop07cc04a2020-11-16 22:08:34 -08005224#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005225
John Durkop07cc04a2020-11-16 22:08:34 -08005226#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5227 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005228static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5229 const uint8_t *data,
5230 size_t data_length )
5231{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005232 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005233 return( PSA_ERROR_BAD_STATE );
5234
Janos Follathd6dce9f2019-07-04 09:11:38 +01005235 if( data_length != 0 )
5236 {
5237 prf->seed = mbedtls_calloc( 1, data_length );
5238 if( prf->seed == NULL )
5239 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005240
Janos Follathd6dce9f2019-07-04 09:11:38 +01005241 memcpy( prf->seed, data, data_length );
5242 prf->seed_length = data_length;
5243 }
Janos Follathf08e2652019-06-13 09:05:41 +01005244
Gilles Peskine43f958b2020-12-13 14:55:14 +01005245 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005246
5247 return( PSA_SUCCESS );
5248}
5249
Janos Follath81550542019-06-13 14:26:34 +01005250static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01005251 const uint8_t *data,
5252 size_t data_length )
5253{
Przemek Stekield7a28642022-04-07 14:58:33 +02005254 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
5255 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET )
Janos Follath81550542019-06-13 14:26:34 +01005256 return( PSA_ERROR_BAD_STATE );
5257
Steven Cooremana6df6042021-04-29 19:32:25 +02005258 if( data_length != 0 )
5259 {
5260 prf->secret = mbedtls_calloc( 1, data_length );
5261 if( prf->secret == NULL )
5262 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5263
5264 memcpy( prf->secret, data, data_length );
5265 prf->secret_length = data_length;
5266 }
Janos Follath81550542019-06-13 14:26:34 +01005267
Gilles Peskine43f958b2020-12-13 14:55:14 +01005268 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005269
5270 return( PSA_SUCCESS );
5271}
5272
Janos Follath63028dd2019-06-13 09:15:47 +01005273static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5274 const uint8_t *data,
5275 size_t data_length )
5276{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005277 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005278 return( PSA_ERROR_BAD_STATE );
5279
Janos Follathd6dce9f2019-07-04 09:11:38 +01005280 if( data_length != 0 )
5281 {
5282 prf->label = mbedtls_calloc( 1, data_length );
5283 if( prf->label == NULL )
5284 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005285
Janos Follathd6dce9f2019-07-04 09:11:38 +01005286 memcpy( prf->label, data, data_length );
5287 prf->label_length = data_length;
5288 }
Janos Follath63028dd2019-06-13 09:15:47 +01005289
Gilles Peskine43f958b2020-12-13 14:55:14 +01005290 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005291
5292 return( PSA_SUCCESS );
5293}
5294
Janos Follathb03233e2019-06-11 15:30:30 +01005295static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005296 psa_key_derivation_step_t step,
5297 const uint8_t *data,
5298 size_t data_length )
5299{
Janos Follathb03233e2019-06-11 15:30:30 +01005300 switch( step )
5301 {
Janos Follathf08e2652019-06-13 09:05:41 +01005302 case PSA_KEY_DERIVATION_INPUT_SEED:
5303 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005304 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooremana6df6042021-04-29 19:32:25 +02005305 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005306 case PSA_KEY_DERIVATION_INPUT_LABEL:
5307 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005308 default:
5309 return( PSA_ERROR_INVALID_ARGUMENT );
5310 }
5311}
John Durkop07cc04a2020-11-16 22:08:34 -08005312#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5313 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5314
5315#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5316static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5317 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08005318 const uint8_t *data,
5319 size_t data_length )
5320{
5321 psa_status_t status;
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005322 const size_t pms_len = ( prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
5323 4 + data_length + prf->other_secret_length :
5324 4 + 2 * data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005325
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005326 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005327 return( PSA_ERROR_INVALID_ARGUMENT );
5328
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005329 uint8_t *pms = mbedtls_calloc( 1, pms_len );
Przemek Stekiel937b90f2022-04-20 08:33:13 +02005330 if( pms == NULL )
5331 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005332 uint8_t *cur = pms;
5333
5334 /* pure-PSK:
5335 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08005336 *
5337 * The premaster secret is formed as follows: if the PSK is N octets
5338 * long, concatenate a uint16 with the value N, N zero octets, a second
5339 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005340 *
5341 * mixed-PSK:
5342 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
5343 * follows: concatenate a uint16 with the length of the other secret,
5344 * the other secret itself, uint16 with the length of PSK, and the
5345 * PSK itself.
5346 * For details please check:
5347 * - RFC 4279, Section 4 for the definition of RSA-PSK,
5348 * - RFC 4279, Section 3 for the definition of DHE-PSK,
5349 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08005350 */
5351
Przemek Stekiel4e47a912022-04-21 11:40:18 +02005352 if( prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET )
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005353 {
5354 *cur++ = MBEDTLS_BYTE_1( prf->other_secret_length );
5355 *cur++ = MBEDTLS_BYTE_0( prf->other_secret_length );
Przemek Stekiel4e47a912022-04-21 11:40:18 +02005356 if( prf->other_secret_length != 0 )
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02005357 {
5358 memcpy( cur, prf->other_secret, prf->other_secret_length );
Przemek Stekiel03faf5d22022-04-20 08:37:43 +02005359 mbedtls_platform_zeroize( prf->other_secret, prf->other_secret_length );
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02005360 cur += prf->other_secret_length;
5361 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005362 }
5363 else
5364 {
5365 *cur++ = MBEDTLS_BYTE_1( data_length );
5366 *cur++ = MBEDTLS_BYTE_0( data_length );
5367 memset( cur, 0, data_length );
5368 cur += data_length;
5369 }
5370
Joe Subbiani5ecac212021-06-24 13:00:03 +01005371 *cur++ = MBEDTLS_BYTE_1( data_length );
5372 *cur++ = MBEDTLS_BYTE_0( data_length );
John Durkop07cc04a2020-11-16 22:08:34 -08005373 memcpy( cur, data, data_length );
5374 cur += data_length;
5375
Steven Cooremana6df6042021-04-29 19:32:25 +02005376 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005377
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02005378 mbedtls_platform_zeroize( pms, pms_len );
5379 mbedtls_free( pms );
John Durkop07cc04a2020-11-16 22:08:34 -08005380 return( status );
5381}
Janos Follath6660f0e2019-06-17 08:44:03 +01005382
Przemek Stekiele47201b2022-04-19 13:53:28 +02005383static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
5384 psa_tls12_prf_key_derivation_t *prf,
5385 const uint8_t *data,
5386 size_t data_length )
5387{
5388 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
5389 return( PSA_ERROR_BAD_STATE );
5390
5391 if( data_length != 0 )
5392 {
5393 prf->other_secret = mbedtls_calloc( 1, data_length );
5394 if( prf->other_secret == NULL )
5395 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5396
5397 memcpy( prf->other_secret, data, data_length );
5398 prf->other_secret_length = data_length;
5399 }
5400 else
5401 {
5402 prf->other_secret_length = 0;
5403 }
5404
5405 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
5406
5407 return( PSA_SUCCESS );
5408}
5409
Janos Follath6660f0e2019-06-17 08:44:03 +01005410static psa_status_t psa_tls12_prf_psk_to_ms_input(
5411 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005412 psa_key_derivation_step_t step,
5413 const uint8_t *data,
5414 size_t data_length )
5415{
Przemek Stekiele47201b2022-04-19 13:53:28 +02005416 switch( step )
Janos Follath0c1ed842019-06-28 13:35:36 +01005417 {
Przemek Stekiele47201b2022-04-19 13:53:28 +02005418 case PSA_KEY_DERIVATION_INPUT_SECRET:
5419 return( psa_tls12_prf_psk_to_ms_set_key( prf,
5420 data, data_length ) );
5421 break;
5422 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
5423 return( psa_tls12_prf_psk_to_ms_set_other_key( prf,
5424 data,
5425 data_length ) );
5426 break;
5427 default:
5428 return( psa_tls12_prf_input( prf, step, data, data_length ) );
5429 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01005430
Przemek Stekiele47201b2022-04-19 13:53:28 +02005431 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005432}
John Durkop07cc04a2020-11-16 22:08:34 -08005433#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005434
Gilles Peskineb8965192019-09-24 16:21:10 +02005435/** Check whether the given key type is acceptable for the given
5436 * input step of a key derivation.
5437 *
5438 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5439 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5440 * Both secret and non-secret inputs can alternatively have the type
5441 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5442 * that the input was passed as a buffer rather than via a key object.
5443 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005444static int psa_key_derivation_check_input_type(
5445 psa_key_derivation_step_t step,
5446 psa_key_type_t key_type )
5447{
5448 switch( step )
5449 {
5450 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005451 if( key_type == PSA_KEY_TYPE_DERIVE )
5452 return( PSA_SUCCESS );
5453 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005454 return( PSA_SUCCESS );
5455 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02005456 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
5457 if( key_type == PSA_KEY_TYPE_DERIVE )
5458 return( PSA_SUCCESS );
5459 if( key_type == PSA_KEY_TYPE_NONE )
5460 return( PSA_SUCCESS );
5461 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02005462 case PSA_KEY_DERIVATION_INPUT_LABEL:
5463 case PSA_KEY_DERIVATION_INPUT_SALT:
5464 case PSA_KEY_DERIVATION_INPUT_INFO:
5465 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005466 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5467 return( PSA_SUCCESS );
5468 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005469 return( PSA_SUCCESS );
5470 break;
5471 }
5472 return( PSA_ERROR_INVALID_ARGUMENT );
5473}
5474
Janos Follathb80a94e2019-06-12 15:54:46 +01005475static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005476 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005477 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005478 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005479 const uint8_t *data,
5480 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005481{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005482 psa_status_t status;
5483 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5484
5485 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005486 if( status != PSA_SUCCESS )
5487 goto exit;
5488
John Durkopd0321952020-10-29 21:37:36 -07005489#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005490 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005491 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005492 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005493 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005494 step, data, data_length );
5495 }
John Durkop07cc04a2020-11-16 22:08:34 -08005496 else
5497#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5498#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5499 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005500 {
Janos Follathb03233e2019-06-11 15:30:30 +01005501 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01005502 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005503 }
John Durkop07cc04a2020-11-16 22:08:34 -08005504 else
5505#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5506#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5507 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005508 {
5509 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01005510 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005511 }
5512 else
John Durkop07cc04a2020-11-16 22:08:34 -08005513#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005514 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005515 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005516 (void) data;
5517 (void) data_length;
5518 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005519 return( PSA_ERROR_BAD_STATE );
5520 }
5521
Gilles Peskine224b0d62019-09-23 18:13:17 +02005522exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005523 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005524 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005525 return( status );
5526}
5527
Janos Follath51f4a0f2019-06-14 11:35:55 +01005528psa_status_t psa_key_derivation_input_bytes(
5529 psa_key_derivation_operation_t *operation,
5530 psa_key_derivation_step_t step,
5531 const uint8_t *data,
5532 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005533{
Gilles Peskineb8965192019-09-24 16:21:10 +02005534 return( psa_key_derivation_input_internal( operation, step,
5535 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005536 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005537}
5538
Janos Follath51f4a0f2019-06-14 11:35:55 +01005539psa_status_t psa_key_derivation_input_key(
5540 psa_key_derivation_operation_t *operation,
5541 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005542 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005543{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005545 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005546 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005547
Ronald Cron5c522922020-11-14 16:35:34 +01005548 status = psa_get_and_lock_transparent_key_slot_with_policy(
5549 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005550 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005551 {
5552 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005553 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005554 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005555
5556 /* Passing a key object as a SECRET input unlocks the permission
5557 * to output to a key object. */
5558 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5559 operation->can_output_key = 1;
5560
Ronald Cronf95a2b12020-10-22 15:24:49 +02005561 status = psa_key_derivation_input_internal( operation,
5562 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005563 slot->key.data,
5564 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005565
Ronald Cron5c522922020-11-14 16:35:34 +01005566 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005567
Ronald Cron5c522922020-11-14 16:35:34 +01005568 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005569}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005570
5571
5572
5573/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005574/* Key agreement */
5575/****************************************************************/
5576
John Durkop6ba40d12020-11-10 08:50:04 -08005577#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005578static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5579 size_t peer_key_length,
5580 const mbedtls_ecp_keypair *our_key,
5581 uint8_t *shared_secret,
5582 size_t shared_secret_size,
5583 size_t *shared_secret_length )
5584{
Steven Cooremand4867872020-08-05 16:31:39 +02005585 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005586 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005587 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005588 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005589 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005590 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005591
Ronald Cron90857082020-11-25 14:58:33 +01005592 status = mbedtls_psa_ecp_load_representation(
5593 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005594 bits,
Ronald Cron90857082020-11-25 14:58:33 +01005595 peer_key,
5596 peer_key_length,
5597 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005598 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005599 goto exit;
5600
Jaeden Amero97271b32019-01-10 19:38:51 +00005601 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005602 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005603 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005604 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005605 status = mbedtls_to_psa_error(
5606 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5607 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005608 goto exit;
5609
Jaeden Amero97271b32019-01-10 19:38:51 +00005610 status = mbedtls_to_psa_error(
5611 mbedtls_ecdh_calc_secret( &ecdh,
5612 shared_secret_length,
5613 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005614 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005615 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005616 if( status != PSA_SUCCESS )
5617 goto exit;
5618 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5619 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005620
5621exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005622 if( status != PSA_SUCCESS )
5623 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005624 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005625 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005626 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005627
Jaeden Amero97271b32019-01-10 19:38:51 +00005628 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005629}
John Durkop6ba40d12020-11-10 08:50:04 -08005630#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005631
Gilles Peskine01d718c2018-09-18 12:01:02 +02005632#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5633
Gilles Peskine0216fe12019-04-11 21:23:21 +02005634static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5635 psa_key_slot_t *private_key,
5636 const uint8_t *peer_key,
5637 size_t peer_key_length,
5638 uint8_t *shared_secret,
5639 size_t shared_secret_size,
5640 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005641{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005642 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005643 {
John Durkop6ba40d12020-11-10 08:50:04 -08005644#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005645 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005646 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005647 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005648 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005649 psa_status_t status = mbedtls_psa_ecp_load_representation(
5650 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01005651 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01005652 private_key->key.data,
5653 private_key->key.bytes,
5654 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005655 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005656 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005657 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005658 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005659 shared_secret, shared_secret_size,
5660 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005661 mbedtls_ecp_keypair_free( ecp );
5662 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005663 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005664#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005665 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005666 (void) private_key;
5667 (void) peer_key;
5668 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005669 (void) shared_secret;
5670 (void) shared_secret_size;
5671 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005672 return( PSA_ERROR_NOT_SUPPORTED );
5673 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005674}
5675
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005676/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005677 * to potentially free embedded data structures and wipe confidential data.
5678 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005679static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005680 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005681 psa_key_slot_t *private_key,
5682 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005683 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005684{
5685 psa_status_t status;
5686 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5687 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005688 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005689
5690 /* Step 1: run the secret agreement algorithm to generate the shared
5691 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005692 status = psa_key_agreement_raw_internal( ka_alg,
5693 private_key,
5694 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005695 shared_secret,
5696 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005697 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005698 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005699 goto exit;
5700
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005701 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005702 * the shared secret. A shared secret is permitted wherever a key
5703 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005704 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005705 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005706 shared_secret,
5707 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005708exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005709 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005710 return( status );
5711}
5712
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005713psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005714 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005715 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005716 const uint8_t *peer_key,
5717 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005718{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005719 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005720 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005721 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005722
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005723 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005724 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005725 status = psa_get_and_lock_transparent_key_slot_with_policy(
5726 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005727 if( status != PSA_SUCCESS )
5728 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005729 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005730 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005731 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005732 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005734 else
5735 {
5736 /* If a private key has been added as SECRET, we allow the derived
5737 * key material to be used as a key in PSA Crypto. */
5738 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5739 operation->can_output_key = 1;
5740 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005741
Ronald Cron5c522922020-11-14 16:35:34 +01005742 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005743
Ronald Cron5c522922020-11-14 16:35:34 +01005744 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005745}
5746
Gilles Peskinebe697d82019-05-16 18:00:41 +02005747psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005748 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005749 const uint8_t *peer_key,
5750 size_t peer_key_length,
5751 uint8_t *output,
5752 size_t output_size,
5753 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005754{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005756 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005757 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005758
5759 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5760 {
5761 status = PSA_ERROR_INVALID_ARGUMENT;
5762 goto exit;
5763 }
Ronald Cron5c522922020-11-14 16:35:34 +01005764 status = psa_get_and_lock_transparent_key_slot_with_policy(
5765 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005766 if( status != PSA_SUCCESS )
5767 goto exit;
5768
5769 status = psa_key_agreement_raw_internal( alg, slot,
5770 peer_key, peer_key_length,
5771 output, output_size,
5772 output_length );
5773
5774exit:
5775 if( status != PSA_SUCCESS )
5776 {
5777 /* If an error happens and is not handled properly, the output
5778 * may be used as a key to protect sensitive data. Arrange for such
5779 * a key to be random, which is likely to result in decryption or
5780 * verification errors. This is better than filling the buffer with
5781 * some constant data such as zeros, which would result in the data
5782 * being protected with a reproducible, easily knowable key.
5783 */
5784 psa_generate_random( output, output_size );
5785 *output_length = output_size;
5786 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005787
Ronald Cron5c522922020-11-14 16:35:34 +01005788 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005789
Ronald Cron5c522922020-11-14 16:35:34 +01005790 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005791}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005792
5793
Gilles Peskine30524eb2020-11-13 17:02:26 +01005794
Gilles Peskine86a440b2018-11-12 18:39:40 +01005795/****************************************************************/
5796/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005797/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005798
Gilles Peskine30524eb2020-11-13 17:02:26 +01005799/** Initialize the PSA random generator.
5800 */
5801static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5802{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005803#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5804 memset( rng, 0, sizeof( *rng ) );
5805#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5806
Gilles Peskine30524eb2020-11-13 17:02:26 +01005807 /* Set default configuration if
5808 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5809 if( rng->entropy_init == NULL )
5810 rng->entropy_init = mbedtls_entropy_init;
5811 if( rng->entropy_free == NULL )
5812 rng->entropy_free = mbedtls_entropy_free;
5813
5814 rng->entropy_init( &rng->entropy );
5815#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5816 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5817 /* The PSA entropy injection feature depends on using NV seed as an entropy
5818 * source. Add NV seed as an entropy source for PSA entropy injection. */
5819 mbedtls_entropy_add_source( &rng->entropy,
5820 mbedtls_nv_seed_poll, NULL,
5821 MBEDTLS_ENTROPY_BLOCK_SIZE,
5822 MBEDTLS_ENTROPY_SOURCE_STRONG );
5823#endif
5824
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005825 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005826#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005827}
5828
5829/** Deinitialize the PSA random generator.
5830 */
5831static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5832{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005833#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5834 memset( rng, 0, sizeof( *rng ) );
5835#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005836 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005837 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005838#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005839}
5840
5841/** Seed the PSA random generator.
5842 */
5843static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5844{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005845#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5846 /* Do nothing: the external RNG seeds itself. */
5847 (void) rng;
5848 return( PSA_SUCCESS );
5849#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005850 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005851 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5852 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005853 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005854#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005855}
5856
Gilles Peskinee59236f2018-01-27 23:32:46 +01005857psa_status_t psa_generate_random( uint8_t *output,
5858 size_t output_size )
5859{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005860 GUARD_MODULE_INITIALIZED;
5861
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005862#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5863
5864 size_t output_length = 0;
5865 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5866 output, output_size,
5867 &output_length );
5868 if( status != PSA_SUCCESS )
5869 return( status );
5870 /* Breaking up a request into smaller chunks is currently not supported
5871 * for the extrernal RNG interface. */
5872 if( output_length != output_size )
5873 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5874 return( PSA_SUCCESS );
5875
5876#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5877
Gilles Peskine71ddab92021-01-04 21:01:07 +01005878 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005879 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005880 size_t request_size =
5881 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5882 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5883 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005884 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5885 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005886 if( ret != 0 )
5887 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005888 output_size -= request_size;
5889 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005890 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005891 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005892#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005893}
5894
Gilles Peskine8814fc42020-12-14 15:33:44 +01005895/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005896 *
5897 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5898 * `psa_generate_random(...)`. The state parameter is ignored since the
5899 * PSA API doesn't support passing an explicit state.
5900 *
5901 * In the non-external case, psa_generate_random() calls an
5902 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5903 * and semantics as mbedtls_psa_get_random(). As an optimization,
5904 * instead of doing this back-and-forth between the PSA API and the
5905 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5906 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005907 */
5908#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5909int mbedtls_psa_get_random( void *p_rng,
5910 unsigned char *output,
5911 size_t output_size )
5912{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005913 /* This function takes a pointer to the RNG state because that's what
5914 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5915 * its own state internally and doesn't let the caller access that state.
5916 * So we just ignore the state parameter, and in practice we'll pass
5917 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005918 (void) p_rng;
5919 psa_status_t status = psa_generate_random( output, output_size );
5920 if( status == PSA_SUCCESS )
5921 return( 0 );
5922 else
5923 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5924}
5925#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5926
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005927#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Chris Jonesea0a8652021-03-09 19:11:19 +00005928#include "entropy_poll.h"
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005929
Gilles Peskine7228da22019-07-15 11:06:15 +02005930psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005931 size_t seed_size )
5932{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005933 if( global_data.initialized )
5934 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005935
5936 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5937 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5938 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5939 return( PSA_ERROR_INVALID_ARGUMENT );
5940
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005941 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005942}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005943#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005944
Ronald Cron3772afe2021-02-08 16:10:05 +01005945/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005946 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005947 * \param type The key type
5948 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005949 *
5950 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005951 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005952 * \retval #PSA_ERROR_INVALID_ARGUMENT
5953 * The size in bits of the key is not valid.
5954 * \retval #PSA_ERROR_NOT_SUPPORTED
5955 * The type and/or the size in bits of the key or the combination of
5956 * the two is not supported.
5957 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005958static psa_status_t psa_validate_key_type_and_size_for_key_generation(
5959 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005960{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005962
Gilles Peskinee59236f2018-01-27 23:32:46 +01005963 if( key_type_is_raw_bytes( type ) )
5964 {
Archana4d7ae1d2021-07-07 02:50:22 +05305965 status = psa_validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005966 if( status != PSA_SUCCESS )
5967 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005968 }
5969 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005970#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005971 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5972 {
5973 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
5974 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005975
Ronald Cron01b2aba2020-10-05 09:42:02 +02005976 /* Accept only byte-aligned keys, for the same reasons as
5977 * in psa_import_rsa_key(). */
5978 if( bits % 8 != 0 )
5979 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005980 }
5981 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005982#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005983
Ronald Cron5c4d3862020-12-07 11:07:24 +01005984#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005985 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
5986 {
Ronald Crond81ab562021-02-16 09:01:16 +01005987 /* To avoid empty block, return successfully here. */
5988 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02005989 }
5990 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005991#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005992 {
5993 return( PSA_ERROR_NOT_SUPPORTED );
5994 }
5995
5996 return( PSA_SUCCESS );
5997}
5998
Ronald Cron55ed0592020-10-05 10:30:40 +02005999psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006000 const psa_key_attributes_t *attributes,
6001 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006002{
6003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006004 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02006005
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006006 if( ( attributes->domain_parameters == NULL ) &&
6007 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02006008 return( PSA_ERROR_INVALID_ARGUMENT );
6009
Ronald Cron01b2aba2020-10-05 09:42:02 +02006010 if( key_type_is_raw_bytes( type ) )
6011 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006012 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006013 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006014 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006015
David Brown12ca5032021-02-11 11:02:00 -07006016#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01006017 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006018 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07006019#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006020 }
6021 else
6022
Jaeden Amero424fa932021-05-14 08:34:32 +01006023#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
6024 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006025 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006026 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01006027 return( mbedtls_psa_rsa_generate_key( attributes,
6028 key_buffer,
6029 key_buffer_size,
6030 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006031 }
6032 else
Jaeden Amero424fa932021-05-14 08:34:32 +01006033#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
6034 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006035
John Durkop9814fa22020-11-04 12:28:15 -08006036#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006037 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006038 {
Ronald Cron7023db52020-11-20 18:17:42 +01006039 return( mbedtls_psa_ecp_generate_key( attributes,
6040 key_buffer,
6041 key_buffer_size,
6042 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006043 }
6044 else
John Durkop9814fa22020-11-04 12:28:15 -08006045#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006046 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02006047 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006048 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006049 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006050
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006051 return( PSA_SUCCESS );
6052}
Darryl Green0c6575a2018-11-07 16:05:30 +00006053
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006054psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006055 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006056{
6057 psa_status_t status;
6058 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006059 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02006060 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02006061
Ronald Cron81709fc2020-11-14 12:10:32 +01006062 *key = MBEDTLS_SVC_KEY_ID_INIT;
6063
Gilles Peskine0f84d622019-09-12 19:03:13 +02006064 /* Reject any attempt to create a zero-length key so that we don't
6065 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6066 if( psa_get_key_bits( attributes ) == 0 )
6067 return( PSA_ERROR_INVALID_ARGUMENT );
6068
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02006069 /* Reject any attempt to create a public key. */
6070 if( PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type) )
6071 return( PSA_ERROR_INVALID_ARGUMENT );
6072
Ronald Cron81709fc2020-11-14 12:10:32 +01006073 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6074 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006075 if( status != PSA_SUCCESS )
6076 goto exit;
6077
Ronald Cron977c2472020-10-13 08:32:21 +02006078 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05306079 * storage ( thus not in the case of generating a key in a secure element
6080 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
6081 * buffer to hold the generated key material. */
Ronald Cron977c2472020-10-13 08:32:21 +02006082 if( slot->key.data == NULL )
6083 {
6084 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
6085 PSA_KEY_LOCATION_LOCAL_STORAGE )
6086 {
Ronald Cron3772afe2021-02-08 16:10:05 +01006087 status = psa_validate_key_type_and_size_for_key_generation(
6088 attributes->core.type, attributes->core.bits );
6089 if( status != PSA_SUCCESS )
6090 goto exit;
6091
6092 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
6093 attributes->core.type,
6094 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02006095 }
6096 else
6097 {
6098 status = psa_driver_wrapper_get_key_buffer_size(
6099 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01006100 if( status != PSA_SUCCESS )
6101 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02006102 }
Ronald Cron977c2472020-10-13 08:32:21 +02006103
6104 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
6105 if( status != PSA_SUCCESS )
6106 goto exit;
6107 }
6108
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006109 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02006110 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02006111
Ronald Cron2b56bc82020-10-05 10:02:26 +02006112 if( status != PSA_SUCCESS )
6113 psa_remove_key_data_from_memory( slot );
6114
Gilles Peskine11792082019-08-06 18:36:36 +02006115exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006116 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006117 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006118 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006119 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006120
Darryl Green0c6575a2018-11-07 16:05:30 +00006121 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006122}
6123
Gilles Peskinee59236f2018-01-27 23:32:46 +01006124/****************************************************************/
6125/* Module setup */
6126/****************************************************************/
6127
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006128#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006129psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6130 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6131 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6132{
6133 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6134 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006135 global_data.rng.entropy_init = entropy_init;
6136 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006137 return( PSA_SUCCESS );
6138}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006139#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006140
Gilles Peskinee59236f2018-01-27 23:32:46 +01006141void mbedtls_psa_crypto_free( void )
6142{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006143 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006144 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6145 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006146 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006147 }
6148 /* Wipe all remaining data, including configuration.
6149 * In particular, this sets all state indicator to the value
6150 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006151 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Ronald Cron9ba76912021-04-10 16:57:30 +02006152
6153 /* Terminate drivers */
6154 psa_driver_wrapper_free( );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006155}
6156
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006157#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6158/** Recover a transaction that was interrupted by a power failure.
6159 *
6160 * This function is called during initialization, before psa_crypto_init()
6161 * returns. If this function returns a failure status, the initialization
6162 * fails.
6163 */
6164static psa_status_t psa_crypto_recover_transaction(
6165 const psa_crypto_transaction_t *transaction )
6166{
6167 switch( transaction->unknown.type )
6168 {
6169 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6170 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006171 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006172 * is implemented.
6173 * https://github.com/ARMmbed/mbed-crypto/issues/218
6174 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006175 default:
6176 /* We found an unsupported transaction in the storage.
6177 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006178 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006179 }
6180}
6181#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6182
Gilles Peskinee59236f2018-01-27 23:32:46 +01006183psa_status_t psa_crypto_init( void )
6184{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006185 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006186
Gilles Peskinec6b69072018-11-20 21:42:52 +01006187 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006188 if( global_data.initialized != 0 )
6189 return( PSA_SUCCESS );
6190
Gilles Peskine30524eb2020-11-13 17:02:26 +01006191 /* Initialize and seed the random generator. */
6192 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006193 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006194 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006195 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006196 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006197 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006198
Gilles Peskine66fb1262018-12-10 16:29:04 +01006199 status = psa_initialize_key_slots( );
6200 if( status != PSA_SUCCESS )
6201 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006202
Ronald Cron9ba76912021-04-10 16:57:30 +02006203 /* Init drivers */
6204 status = psa_driver_wrapper_init( );
Gilles Peskined9348f22019-10-01 15:22:29 +02006205 if( status != PSA_SUCCESS )
6206 goto exit;
Gilles Peskined9348f22019-10-01 15:22:29 +02006207
Gilles Peskine4b734222019-07-24 15:56:31 +02006208#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006209 status = psa_crypto_load_transaction( );
6210 if( status == PSA_SUCCESS )
6211 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006212 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6213 if( status != PSA_SUCCESS )
6214 goto exit;
6215 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006216 }
6217 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6218 {
6219 /* There's no transaction to complete. It's all good. */
6220 status = PSA_SUCCESS;
6221 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006222#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006223
Gilles Peskinec6b69072018-11-20 21:42:52 +01006224 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006225 global_data.initialized = 1;
6226
6227exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006228 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006229 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006230 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006231}
6232
6233#endif /* MBEDTLS_PSA_CRYPTO_C */