blob: 775923af51b54f4cff85a819bf86bb274321d469 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Ronald Crond6d28882020-12-14 14:56:02 +010032#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010033#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010034#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020035#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010036#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010037#include "psa_crypto_hash.h"
Steven Cooreman32d56942021-03-19 17:39:17 +010038#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010039#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010040#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020041#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020042#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020043#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010044#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010045/* Include internal declarations that are useful for implementing persistently
46 * stored keys. */
47#include "psa_crypto_storage.h"
48
Gilles Peskineb2b64d32020-12-14 16:43:58 +010049#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010050
Gilles Peskineb46bef22019-07-30 21:32:04 +020051#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#include <stdlib.h>
53#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010054#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020055#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010056#define mbedtls_calloc calloc
57#define mbedtls_free free
58#endif
59
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010060#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020062#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000063#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020064#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/blowfish.h"
66#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020067#include "mbedtls/chacha20.h"
68#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/cipher.h"
70#include "mbedtls/ccm.h"
71#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020073#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010074#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010075#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010076#include "mbedtls/error.h"
77#include "mbedtls/gcm.h"
78#include "mbedtls/md2.h"
79#include "mbedtls/md4.h"
80#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010081#include "mbedtls/md.h"
82#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010083#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010085#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000086#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010087#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010088#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010089#include "mbedtls/sha1.h"
90#include "mbedtls/sha256.h"
91#include "mbedtls/sha512.h"
92#include "mbedtls/xtea.h"
93
Gilles Peskine996deb12018-08-01 15:45:45 +020094#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
95
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010096/****************************************************************/
97/* Global data, support functions and library management */
98/****************************************************************/
99
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200100static int key_type_is_raw_bytes( psa_key_type_t type )
101{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200102 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200103}
104
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100105/* Values for psa_global_data_t::rng_state */
106#define RNG_NOT_INITIALIZED 0
107#define RNG_INITIALIZED 1
108#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100109
Gilles Peskine2d277862018-06-18 15:41:12 +0200110typedef struct
111{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100112 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100113 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100114 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100115} psa_global_data_t;
116
117static psa_global_data_t global_data;
118
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100119#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
120mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
121 &global_data.rng.drbg;
122#endif
123
itayzafrir0adf0fc2018-09-06 16:24:41 +0300124#define GUARD_MODULE_INITIALIZED \
125 if( global_data.initialized == 0 ) \
126 return( PSA_ERROR_BAD_STATE );
127
Steven Cooreman01164162020-07-20 15:31:37 +0200128psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100129{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100130 /* Mbed TLS error codes can combine a high-level error code and a
131 * low-level error code. The low-level error usually reflects the
132 * root cause better, so dispatch on that preferably. */
133 int low_level_ret = - ( -ret & 0x007f );
134 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100135 {
136 case 0:
137 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100138
139 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
140 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
141 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
142 return( PSA_ERROR_NOT_SUPPORTED );
143 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
144 return( PSA_ERROR_HARDWARE_FAILURE );
145
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200146 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
147 return( PSA_ERROR_HARDWARE_FAILURE );
148
Gilles Peskine9a944802018-06-21 09:35:35 +0200149 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
150 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
151 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
152 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
153 case MBEDTLS_ERR_ASN1_INVALID_DATA:
154 return( PSA_ERROR_INVALID_ARGUMENT );
155 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
156 return( PSA_ERROR_INSUFFICIENT_MEMORY );
157 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
158 return( PSA_ERROR_BUFFER_TOO_SMALL );
159
Jaeden Amero93e21112019-02-20 13:57:28 +0000160#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000161 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000162#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
163 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
164#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100165 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
166 return( PSA_ERROR_NOT_SUPPORTED );
167 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
168 return( PSA_ERROR_HARDWARE_FAILURE );
169
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000171 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
173 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
174#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
176 return( PSA_ERROR_NOT_SUPPORTED );
177 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
178 return( PSA_ERROR_HARDWARE_FAILURE );
179
180 case MBEDTLS_ERR_CCM_BAD_INPUT:
181 return( PSA_ERROR_INVALID_ARGUMENT );
182 case MBEDTLS_ERR_CCM_AUTH_FAILED:
183 return( PSA_ERROR_INVALID_SIGNATURE );
184 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
185 return( PSA_ERROR_HARDWARE_FAILURE );
186
Gilles Peskine26869f22019-05-06 15:25:00 +0200187 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
188 return( PSA_ERROR_INVALID_ARGUMENT );
189
190 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
191 return( PSA_ERROR_BAD_STATE );
192 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
193 return( PSA_ERROR_INVALID_SIGNATURE );
194
Gilles Peskinea5905292018-02-07 20:59:33 +0100195 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
196 return( PSA_ERROR_NOT_SUPPORTED );
197 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
198 return( PSA_ERROR_INVALID_ARGUMENT );
199 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
200 return( PSA_ERROR_INSUFFICIENT_MEMORY );
201 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
202 return( PSA_ERROR_INVALID_PADDING );
203 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200204 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100205 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
206 return( PSA_ERROR_INVALID_SIGNATURE );
207 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200208 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100209 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
210 return( PSA_ERROR_HARDWARE_FAILURE );
211
212 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
213 return( PSA_ERROR_HARDWARE_FAILURE );
214
Gilles Peskine82e57d12020-11-13 21:31:17 +0100215#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
216 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100217 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
218 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100219 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
220 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
221 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
222 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
223 return( PSA_ERROR_NOT_SUPPORTED );
224 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
225 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100226#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100227
228 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
229 return( PSA_ERROR_NOT_SUPPORTED );
230 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
231 return( PSA_ERROR_HARDWARE_FAILURE );
232
Gilles Peskinee59236f2018-01-27 23:32:46 +0100233 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
234 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
235 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
236 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100237
238 case MBEDTLS_ERR_GCM_AUTH_FAILED:
239 return( PSA_ERROR_INVALID_SIGNATURE );
240 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200241 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100242 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
243 return( PSA_ERROR_HARDWARE_FAILURE );
244
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
246 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100247 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
248 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100249 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
250 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
251 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
252 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
253 return( PSA_ERROR_NOT_SUPPORTED );
254 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
255 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
256#endif
257
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200258 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
259 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
260 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
261 return( PSA_ERROR_HARDWARE_FAILURE );
262
Gilles Peskinea5905292018-02-07 20:59:33 +0100263 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
264 return( PSA_ERROR_NOT_SUPPORTED );
265 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
266 return( PSA_ERROR_INVALID_ARGUMENT );
267 case MBEDTLS_ERR_MD_ALLOC_FAILED:
268 return( PSA_ERROR_INSUFFICIENT_MEMORY );
269 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
270 return( PSA_ERROR_STORAGE_FAILURE );
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200271 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
272 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100273
Gilles Peskinef76aa772018-10-29 19:24:33 +0100274 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
275 return( PSA_ERROR_STORAGE_FAILURE );
276 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
277 return( PSA_ERROR_INVALID_ARGUMENT );
278 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
279 return( PSA_ERROR_INVALID_ARGUMENT );
280 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
281 return( PSA_ERROR_BUFFER_TOO_SMALL );
282 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
283 return( PSA_ERROR_INVALID_ARGUMENT );
284 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
285 return( PSA_ERROR_INVALID_ARGUMENT );
286 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
289 return( PSA_ERROR_INSUFFICIENT_MEMORY );
290
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100291 case MBEDTLS_ERR_PK_ALLOC_FAILED:
292 return( PSA_ERROR_INSUFFICIENT_MEMORY );
293 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
294 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
295 return( PSA_ERROR_INVALID_ARGUMENT );
296 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100297 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100298 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
299 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
300 return( PSA_ERROR_INVALID_ARGUMENT );
301 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
302 return( PSA_ERROR_NOT_SUPPORTED );
303 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
304 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
305 return( PSA_ERROR_NOT_PERMITTED );
306 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
307 return( PSA_ERROR_INVALID_ARGUMENT );
308 case MBEDTLS_ERR_PK_INVALID_ALG:
309 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
310 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
311 return( PSA_ERROR_NOT_SUPPORTED );
312 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
313 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100314 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
315 return( PSA_ERROR_HARDWARE_FAILURE );
316
Gilles Peskineff2d2002019-05-06 15:26:23 +0200317 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
318 return( PSA_ERROR_HARDWARE_FAILURE );
319 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
320 return( PSA_ERROR_NOT_SUPPORTED );
321
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200322 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
323 return( PSA_ERROR_HARDWARE_FAILURE );
324
Gilles Peskinea5905292018-02-07 20:59:33 +0100325 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
326 return( PSA_ERROR_INVALID_ARGUMENT );
327 case MBEDTLS_ERR_RSA_INVALID_PADDING:
328 return( PSA_ERROR_INVALID_PADDING );
329 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
330 return( PSA_ERROR_HARDWARE_FAILURE );
331 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
332 return( PSA_ERROR_INVALID_ARGUMENT );
333 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
334 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200335 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100336 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
337 return( PSA_ERROR_INVALID_SIGNATURE );
338 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
339 return( PSA_ERROR_BUFFER_TOO_SMALL );
340 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100341 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100342 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
343 return( PSA_ERROR_NOT_SUPPORTED );
344 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
345 return( PSA_ERROR_HARDWARE_FAILURE );
346
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200347 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
348 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
349 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
350 return( PSA_ERROR_HARDWARE_FAILURE );
351
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
353 return( PSA_ERROR_INVALID_ARGUMENT );
354 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
355 return( PSA_ERROR_HARDWARE_FAILURE );
356
itayzafrir5c753392018-05-08 11:18:38 +0300357 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300358 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300359 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300360 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
361 return( PSA_ERROR_BUFFER_TOO_SMALL );
362 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
363 return( PSA_ERROR_NOT_SUPPORTED );
364 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
365 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
366 return( PSA_ERROR_INVALID_SIGNATURE );
367 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
368 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100369 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
370 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
372 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100373
Janos Follatha13b9052019-11-22 12:48:59 +0000374 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
375 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300376
Gilles Peskinee59236f2018-01-27 23:32:46 +0100377 default:
David Saadab4ecc272019-02-14 13:48:10 +0200378 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100379 }
380}
381
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200382
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200383
384
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100385/****************************************************************/
386/* Key management */
387/****************************************************************/
388
Gilles Peskine73167e12019-07-12 23:44:37 +0200389#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
390static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
391{
Gilles Peskine8e338702019-07-30 20:06:31 +0200392 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200393}
394#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
395
John Durkop07cc04a2020-11-16 22:08:34 -0800396/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
397 * current test driver in key_management.c is using this function
398 * when accelerators are used for ECC key pair and public key.
399 * Once that dependency is resolved these guards can be removed.
400 */
John Durkop9814fa22020-11-04 12:28:15 -0800401#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800402 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
403 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
404 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100405mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100406 size_t bits,
407 int bits_is_sloppy )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200408{
409 switch( curve )
410 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100411 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100412 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100413 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100414#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100415 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100416 return( MBEDTLS_ECP_DP_SECP192R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100417#endif
418#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100419 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100420 return( MBEDTLS_ECP_DP_SECP224R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100421#endif
422#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100423 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100424 return( MBEDTLS_ECP_DP_SECP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100425#endif
426#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100427 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100428 return( MBEDTLS_ECP_DP_SECP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100429#endif
430#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100431 case 521:
Gilles Peskine228abc52019-12-03 17:24:19 +0100432 return( MBEDTLS_ECP_DP_SECP521R1 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100433 case 528:
434 if( bits_is_sloppy )
435 return( MBEDTLS_ECP_DP_SECP521R1 );
436 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100437#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100438 }
439 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100440
Paul Elliott8ff510a2020-06-02 17:19:28 +0100441 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100442 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100443 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100444#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100445 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100446 return( MBEDTLS_ECP_DP_BP256R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100447#endif
448#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100449 case 384:
Gilles Peskine228abc52019-12-03 17:24:19 +0100450 return( MBEDTLS_ECP_DP_BP384R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100451#endif
452#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100453 case 512:
Gilles Peskine228abc52019-12-03 17:24:19 +0100454 return( MBEDTLS_ECP_DP_BP512R1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100455#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100456 }
457 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100458
Paul Elliott8ff510a2020-06-02 17:19:28 +0100459 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100460 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100461 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100462#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100463 case 255:
Gilles Peskine228abc52019-12-03 17:24:19 +0100464 return( MBEDTLS_ECP_DP_CURVE25519 );
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100465 case 256:
466 if( bits_is_sloppy )
467 return( MBEDTLS_ECP_DP_CURVE25519 );
468 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100469#endif
470#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100471 case 448:
Gilles Peskine228abc52019-12-03 17:24:19 +0100472 return( MBEDTLS_ECP_DP_CURVE448 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100473#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100474 }
475 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100476
Paul Elliott8ff510a2020-06-02 17:19:28 +0100477 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100478 switch( bits )
Gilles Peskine228abc52019-12-03 17:24:19 +0100479 {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100480#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100481 case 192:
Gilles Peskine228abc52019-12-03 17:24:19 +0100482 return( MBEDTLS_ECP_DP_SECP192K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100483#endif
484#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100485 case 224:
Gilles Peskine228abc52019-12-03 17:24:19 +0100486 return( MBEDTLS_ECP_DP_SECP224K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100487#endif
488#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100489 case 256:
Gilles Peskine228abc52019-12-03 17:24:19 +0100490 return( MBEDTLS_ECP_DP_SECP256K1 );
Gilles Peskinea1684f42021-03-23 13:12:34 +0100491#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100492 }
493 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200494 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100495
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100496 (void) bits_is_sloppy;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100497 return( MBEDTLS_ECP_DP_NONE );
Gilles Peskine12313cd2018-06-20 00:20:32 +0200498}
John Durkop9814fa22020-11-04 12:28:15 -0800499#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800500 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
501 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
502 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200503
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200504static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
505 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200506{
507 /* Check that the bit size is acceptable for the key type */
508 switch( type )
509 {
510 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200511 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200512 case PSA_KEY_TYPE_DERIVE:
513 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100514#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200515 case PSA_KEY_TYPE_AES:
516 if( bits != 128 && bits != 192 && bits != 256 )
517 return( PSA_ERROR_INVALID_ARGUMENT );
518 break;
519#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100520#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200521 case PSA_KEY_TYPE_CAMELLIA:
522 if( bits != 128 && bits != 192 && bits != 256 )
523 return( PSA_ERROR_INVALID_ARGUMENT );
524 break;
525#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100526#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200527 case PSA_KEY_TYPE_DES:
528 if( bits != 64 && bits != 128 && bits != 192 )
529 return( PSA_ERROR_INVALID_ARGUMENT );
530 break;
531#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100532#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200533 case PSA_KEY_TYPE_ARC4:
534 if( bits < 8 || bits > 2048 )
535 return( PSA_ERROR_INVALID_ARGUMENT );
536 break;
537#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100538#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200539 case PSA_KEY_TYPE_CHACHA20:
540 if( bits != 256 )
541 return( PSA_ERROR_INVALID_ARGUMENT );
542 break;
543#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200544 default:
545 return( PSA_ERROR_NOT_SUPPORTED );
546 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200547 if( bits % 8 != 0 )
548 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200549
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200550 return( PSA_SUCCESS );
551}
552
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100553/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100554 *
Steven Cooremancd640932021-03-08 12:00:27 +0100555 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
556 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100557 *
558 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100559 * \param[in] key_type The key type of the key to be used with the
560 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100561 *
562 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100563 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100564 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100565 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100566 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100567MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100568 psa_algorithm_t algorithm,
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100569 psa_key_type_t key_type )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100570{
Steven Cooremancd640932021-03-08 12:00:27 +0100571 if( PSA_ALG_IS_HMAC( algorithm ) )
572 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100573 if( key_type == PSA_KEY_TYPE_HMAC )
574 return( PSA_SUCCESS );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100575 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100576
577 if( PSA_ALG_IS_BLOCK_CIPHER_MAC( algorithm ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100578 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100579 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
580 * key. */
581 if( ( key_type & PSA_KEY_TYPE_CATEGORY_MASK ) ==
582 PSA_KEY_TYPE_CATEGORY_SYMMETRIC )
583 {
584 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
585 * the block length (larger than 1) for block ciphers. */
586 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type ) > 1 )
587 return( PSA_SUCCESS );
588 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100589 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100590
591 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100592}
593
Steven Cooreman7609b1f2021-04-06 16:45:06 +0200594psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
595 size_t buffer_length )
Steven Cooreman75b74362020-07-28 14:30:13 +0200596{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100597 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200598 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200599
Ronald Cronea0f8a62020-11-25 17:52:23 +0100600 slot->key.data = mbedtls_calloc( 1, buffer_length );
601 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200602 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200603
Ronald Cronea0f8a62020-11-25 17:52:23 +0100604 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200605 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200606}
607
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200608psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
609 const uint8_t* data,
610 size_t data_length )
611{
612 psa_status_t status = psa_allocate_buffer_to_slot( slot,
613 data_length );
614 if( status != PSA_SUCCESS )
615 return( status );
616
Ronald Cronea0f8a62020-11-25 17:52:23 +0100617 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200618 return( PSA_SUCCESS );
619}
620
Ronald Crona0fe59f2020-11-29 11:14:53 +0100621psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100622 const psa_key_attributes_t *attributes,
623 const uint8_t *data, size_t data_length,
624 uint8_t *key_buffer, size_t key_buffer_size,
625 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100626{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
628 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100629
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200630 /* zero-length keys are never supported. */
631 if( data_length == 0 )
632 return( PSA_ERROR_NOT_SUPPORTED );
633
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100634 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100635 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100636 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200637
Steven Cooreman75b74362020-07-28 14:30:13 +0200638 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
639 if( data_length > SIZE_MAX / 8 )
640 return( PSA_ERROR_NOT_SUPPORTED );
641
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200642 /* Enforce a size limit, and in particular ensure that the bit
643 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100644 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200645 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200646
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100647 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200648 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200649 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200650
Ronald Crondd04d422020-11-28 15:14:42 +0100651 /* Copy the key material. */
652 memcpy( key_buffer, data, data_length );
653 *key_buffer_length = data_length;
654 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200655
Steven Cooreman40120f62020-10-29 11:42:22 +0100656 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100657 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100658 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200659 {
John Durkop9814fa22020-11-04 12:28:15 -0800660#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
661 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100662 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200663 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100664 return( mbedtls_psa_ecp_import_key( attributes,
665 data, data_length,
666 key_buffer, key_buffer_size,
667 key_buffer_length,
668 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100669 }
John Durkop9814fa22020-11-04 12:28:15 -0800670#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
671 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700672#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
673 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100674 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200675 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100676 return( mbedtls_psa_rsa_import_key( attributes,
677 data, data_length,
678 key_buffer, key_buffer_size,
679 key_buffer_length,
680 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200681 }
John Durkop9814fa22020-11-04 12:28:15 -0800682#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
683 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100684 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100685
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100686 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100687}
688
Gilles Peskinef603c712019-01-19 13:40:11 +0100689/** Calculate the intersection of two algorithm usage policies.
690 *
691 * Return 0 (which allows no operation) on incompatibility.
692 */
693static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100694 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100695 psa_algorithm_t alg1,
696 psa_algorithm_t alg2 )
697{
Gilles Peskine549ea862019-05-22 11:45:59 +0200698 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100699 if( alg1 == alg2 )
700 return( alg1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100701 /* If the policies are from the same hash-and-sign family, check
702 * if one is a wildcard. If so the other has the specific algorithm. */
703 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
704 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
705 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
Gilles Peskinef603c712019-01-19 13:40:11 +0100706 {
Steven Cooreman03488022021-02-18 12:07:20 +0100707 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
708 return( alg2 );
709 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
710 return( alg1 );
711 }
712 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100713 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100714 * restrictive tag length. */
715 if( PSA_ALG_IS_AEAD( alg1 ) && PSA_ALG_IS_AEAD( alg2 ) &&
716 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg1, 0 ) ==
717 PSA_ALG_AEAD_WITH_SHORTENED_TAG( alg2, 0 ) ) )
718 {
719 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg1 );
720 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH( alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100721 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100722
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100723 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100724 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
725 ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100726 {
Steven Cooremancd640932021-03-08 12:00:27 +0100727 return( PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
728 alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100729 }
730 /* If only one is a wildcard, return specific algorithm if compatible. */
Steven Cooremand927ed72021-02-22 19:59:35 +0100731 if( ( ( alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100732 ( alg1_len <= alg2_len ) )
733 {
734 return( alg2 );
735 }
Steven Cooremand927ed72021-02-22 19:59:35 +0100736 if( ( ( alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
Steven Cooreman03488022021-02-18 12:07:20 +0100737 ( alg2_len <= alg1_len ) )
738 {
739 return( alg1 );
740 }
741 }
742 /* If the policies are from the same MAC family, check whether one
743 * of them is a minimum-MAC-length policy. Calculate the most
744 * restrictive tag length. */
745 if( PSA_ALG_IS_MAC( alg1 ) && PSA_ALG_IS_MAC( alg2 ) &&
746 ( PSA_ALG_FULL_LENGTH_MAC( alg1 ) ==
747 PSA_ALG_FULL_LENGTH_MAC( alg2 ) ) )
748 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100749 /* Validate the combination of key type and algorithm. Since the base
750 * algorithm of alg1 and alg2 are the same, we only need this once. */
751 if( PSA_SUCCESS != psa_mac_key_can_do( alg1, key_type ) )
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100752 return( 0 );
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100753
Steven Cooreman31a876d2021-03-03 20:47:40 +0100754 /* Get the (exact or at-least) output lengths for both sides of the
755 * requested intersection. None of the currently supported algorithms
756 * have an output length dependent on the actual key size, so setting it
757 * to a bogus value of 0 is currently OK.
758 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 * Note that for at-least-this-length wildcard algorithms, the output
760 * length is set to the shortest allowed length, which allows us to
761 * calculate the most restrictive tag length for the intersection. */
762 size_t alg1_len = PSA_MAC_LENGTH( key_type, 0, alg1 );
763 size_t alg2_len = PSA_MAC_LENGTH( key_type, 0, alg2 );
Steven Cooremancd640932021-03-08 12:00:27 +0100764 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100765
Steven Cooremana1d83222021-02-25 10:20:29 +0100766 /* If both are wildcards, return most restrictive wildcard */
Steven Cooremand927ed72021-02-22 19:59:35 +0100767 if( ( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) &&
768 ( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100769 {
Steven Cooremancd640932021-03-08 12:00:27 +0100770 return( PSA_ALG_AT_LEAST_THIS_LENGTH_MAC( alg1, restricted_len ) );
Steven Cooreman03488022021-02-18 12:07:20 +0100771 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100772
773 /* If only one is an at-least-this-length policy, the intersection would
774 * be the other (fixed-length) policy as long as said fixed length is
775 * equal to or larger than the shortest allowed length. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100776 if( ( alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100777 {
Steven Cooremancd640932021-03-08 12:00:27 +0100778 return( ( alg1_len <= alg2_len ) ? alg2 : 0 );
Steven Cooreman03488022021-02-18 12:07:20 +0100779 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100780 if( ( alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
Steven Cooreman03488022021-02-18 12:07:20 +0100781 {
Steven Cooremancd640932021-03-08 12:00:27 +0100782 return( ( alg2_len <= alg1_len ) ? alg1 : 0 );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100783 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100784
Steven Cooremancd640932021-03-08 12:00:27 +0100785 /* If none of them are wildcards, check whether they define the same tag
786 * length. This is still possible here when one is default-length and
787 * the other specific-length. Ensure to always return the
788 * specific-length version for the intersection. */
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100789 if( alg1_len == alg2_len )
790 return( PSA_ALG_TRUNCATED_MAC( alg1, alg1_len ) );
Gilles Peskinef603c712019-01-19 13:40:11 +0100791 }
792 /* If the policies are incompatible, allow nothing. */
793 return( 0 );
794}
795
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100796static int psa_key_algorithm_permits( psa_key_type_t key_type,
797 psa_algorithm_t policy_alg,
Gilles Peskined6f371b2019-05-10 19:33:38 +0200798 psa_algorithm_t requested_alg )
799{
Gilles Peskine549ea862019-05-22 11:45:59 +0200800 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200801 if( requested_alg == policy_alg )
802 return( 1 );
Steven Cooreman03488022021-02-18 12:07:20 +0100803 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
804 * and requested_alg is the same hash-and-sign family with any hash,
805 * then requested_alg is compliant with policy_alg. */
806 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
807 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
Gilles Peskined6f371b2019-05-10 19:33:38 +0200808 {
Steven Cooreman03488022021-02-18 12:07:20 +0100809 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
810 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
811 }
812 /* If policy_alg is a wildcard AEAD algorithm of the same base as
813 * the requested algorithm, check the requested tag length to be
814 * equal-length or longer than the wildcard-specified length. */
815 if( PSA_ALG_IS_AEAD( policy_alg ) &&
816 PSA_ALG_IS_AEAD( requested_alg ) &&
817 ( PSA_ALG_AEAD_WITH_SHORTENED_TAG( policy_alg, 0 ) ==
818 PSA_ALG_AEAD_WITH_SHORTENED_TAG( requested_alg, 0 ) ) &&
Steven Cooremand927ed72021-02-22 19:59:35 +0100819 ( ( policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG ) != 0 ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100820 {
821 return( PSA_ALG_AEAD_GET_TAG_LENGTH( policy_alg ) <=
822 PSA_ALG_AEAD_GET_TAG_LENGTH( requested_alg ) );
823 }
Steven Cooremancd640932021-03-08 12:00:27 +0100824 /* If policy_alg is a MAC algorithm of the same base as the requested
825 * algorithm, check whether their MAC lengths are compatible. */
Steven Cooreman03488022021-02-18 12:07:20 +0100826 if( PSA_ALG_IS_MAC( policy_alg ) &&
827 PSA_ALG_IS_MAC( requested_alg ) &&
828 ( PSA_ALG_FULL_LENGTH_MAC( policy_alg ) ==
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100829 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) ) )
Steven Cooreman03488022021-02-18 12:07:20 +0100830 {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100831 /* Validate the combination of key type and algorithm. Since the policy
832 * and requested algorithms are the same, we only need this once. */
833 if( PSA_SUCCESS != psa_mac_key_can_do( policy_alg, key_type ) )
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100834 return( 0 );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100835
Steven Cooreman31a876d2021-03-03 20:47:40 +0100836 /* Get both the requested output length for the algorithm which is to be
837 * verified, and the default output length for the base algorithm.
838 * Note that none of the currently supported algorithms have an output
839 * length dependent on actual key size, so setting it to a bogus value
840 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100841 size_t requested_output_length = PSA_MAC_LENGTH(
842 key_type, 0, requested_alg );
843 size_t default_output_length = PSA_MAC_LENGTH(
844 key_type, 0,
845 PSA_ALG_FULL_LENGTH_MAC( requested_alg ) );
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100846
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100847 /* If the policy is default-length, only allow an algorithm with
848 * a declared exact-length matching the default. */
849 if( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == 0 )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100850 return( requested_output_length == default_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100851
852 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100853 * length exactly matches the default length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100854 if( PSA_MAC_TRUNCATED_LENGTH( requested_alg ) == 0 &&
855 PSA_MAC_TRUNCATED_LENGTH( policy_alg ) == default_output_length )
856 {
857 return( 1 );
858 }
859
Steven Cooremancd640932021-03-08 12:00:27 +0100860 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
861 * check for the requested MAC length to be equal to or longer than the
862 * minimum allowed length. */
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100863 if( ( policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG ) != 0 )
864 {
865 return( PSA_MAC_TRUNCATED_LENGTH( policy_alg ) <=
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100866 requested_output_length );
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100867 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200868 }
Steven Cooremance48e852020-10-05 16:02:45 +0200869 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200870 * a key derivation with that key agreement should also be allowed. This
871 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200872 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
873 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
874 {
875 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
876 policy_alg );
877 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100878 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200879 return( 0 );
880}
881
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100882/** Test whether a policy permits an algorithm.
883 *
884 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100885 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100886 * \note This function requires providing the key type for which the policy is
887 * being validated, since some algorithm policy definitions (e.g. MAC)
888 * have different properties depending on what kind of cipher it is
889 * combined with.
890 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100891 * \retval PSA_SUCCESS When \p alg is a specific algorithm
892 * allowed by the \p policy.
893 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
894 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
895 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100896 */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100897static psa_status_t psa_key_policy_permits( const psa_key_policy_t *policy,
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100898 psa_key_type_t key_type,
Steven Cooreman7e39f052021-02-23 14:18:32 +0100899 psa_algorithm_t alg )
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100900{
Steven Cooremand788fab2021-02-25 11:29:17 +0100901 /* '0' is not a valid algorithm */
902 if( alg == 0 )
903 return( PSA_ERROR_INVALID_ARGUMENT );
904
Steven Cooreman7e39f052021-02-23 14:18:32 +0100905 /* A requested algorithm cannot be a wildcard. */
906 if( PSA_ALG_IS_WILDCARD( alg ) )
907 return( PSA_ERROR_INVALID_ARGUMENT );
908
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100909 if( psa_key_algorithm_permits( key_type, policy->alg, alg ) ||
910 psa_key_algorithm_permits( key_type, policy->alg2, alg ) )
Steven Cooreman7e39f052021-02-23 14:18:32 +0100911 return( PSA_SUCCESS );
912 else
913 return( PSA_ERROR_NOT_PERMITTED );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100914}
915
Gilles Peskinef603c712019-01-19 13:40:11 +0100916/** Restrict a key policy based on a constraint.
917 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100918 * \note This function requires providing the key type for which the policy is
919 * being restricted, since some algorithm policy definitions (e.g. MAC)
920 * have different properties depending on what kind of cipher it is
921 * combined with.
922 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100923 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100924 * \param[in,out] policy The policy to restrict.
925 * \param[in] constraint The policy constraint to apply.
926 *
927 * \retval #PSA_SUCCESS
928 * \c *policy contains the intersection of the original value of
929 * \c *policy and \c *constraint.
930 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100931 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100932 * \c *policy is unchanged.
933 */
934static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100935 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100936 psa_key_policy_t *policy,
937 const psa_key_policy_t *constraint )
938{
939 psa_algorithm_t intersection_alg =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100940 psa_key_policy_algorithm_intersection( key_type, policy->alg,
941 constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200942 psa_algorithm_t intersection_alg2 =
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100943 psa_key_policy_algorithm_intersection( key_type, policy->alg2,
944 constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100945 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
946 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200947 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
948 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100949 policy->usage &= constraint->usage;
950 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200951 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100952 return( PSA_SUCCESS );
953}
954
Ronald Cron5c522922020-11-14 16:35:34 +0100955/** Get the description of a key given its identifier and policy constraints
956 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200957 *
Ronald Cron5c522922020-11-14 16:35:34 +0100958 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +0100959 * nonzero, the key must allow operations with this algorithm. If \p alg is
960 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +0100961 *
Ronald Cron5c522922020-11-14 16:35:34 +0100962 * In case of a persistent key, the function loads the description of the key
963 * into a key slot if not already done.
964 *
965 * On success, the returned key slot is locked. It is the responsibility of
966 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200967 */
Ronald Cron5c522922020-11-14 16:35:34 +0100968static psa_status_t psa_get_and_lock_key_slot_with_policy(
969 mbedtls_svc_key_id_t key,
970 psa_key_slot_t **p_slot,
971 psa_key_usage_t usage,
972 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100973{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200974 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
975 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100976
Ronald Cron5c522922020-11-14 16:35:34 +0100977 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100978 if( status != PSA_SUCCESS )
979 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200980 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100981
982 /* Enforce that usage policy for the key slot contains all the flags
983 * required by the usage parameter. There is one exception: public
984 * keys can always be exported, so we treat public key objects as
985 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200986 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100987 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200988
Gilles Peskine8e338702019-07-30 20:06:31 +0200989 if( ( slot->attr.policy.usage & usage ) != usage )
Steven Cooreman328f11c2021-03-02 11:44:51 +0100990 {
991 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200992 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100993 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100994
995 /* Enforce that the usage policy permits the requested algortihm. */
Steven Cooreman7e39f052021-02-23 14:18:32 +0100996 if( alg != 0 )
997 {
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100998 status = psa_key_policy_permits( &slot->attr.policy,
999 slot->attr.type,
1000 alg );
Steven Cooreman7e39f052021-02-23 14:18:32 +01001001 if( status != PSA_SUCCESS )
1002 goto error;
1003 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001004
Darryl Green06fd18d2018-07-16 11:21:11 +01001005 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001006
1007error:
1008 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001009 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001010
1011 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001012}
Darryl Green940d72c2018-07-13 13:18:51 +01001013
Ronald Cron5c522922020-11-14 16:35:34 +01001014/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001015 *
1016 * A transparent key is a key for which the key material is directly
1017 * available, as opposed to a key in a secure element.
1018 *
Ronald Cron5c522922020-11-14 16:35:34 +01001019 * This is a temporary function to use instead of
1020 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1021 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001022 *
Ronald Cron5c522922020-11-14 16:35:34 +01001023 * On success, the returned key slot is locked. It is the responsibility of the
1024 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001025 */
1026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001027static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1028 mbedtls_svc_key_id_t key,
1029 psa_key_slot_t **p_slot,
1030 psa_key_usage_t usage,
1031 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001032{
Ronald Cron5c522922020-11-14 16:35:34 +01001033 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1034 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001035 if( status != PSA_SUCCESS )
1036 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001037
Gilles Peskineadad8132019-07-25 11:31:23 +02001038 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001039 {
Ronald Cron5c522922020-11-14 16:35:34 +01001040 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001041 *p_slot = NULL;
1042 return( PSA_ERROR_NOT_SUPPORTED );
1043 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001044
Gilles Peskine28f8f302019-07-24 13:30:31 +02001045 return( PSA_SUCCESS );
1046}
1047#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1048/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001049#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1050 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001051#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1052
Steven Cooreman7ddee7f2021-04-07 18:08:30 +02001053psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001054{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001055 /* Data pointer will always be either a valid pointer or NULL in an
1056 * initialized slot, so we can just free it. */
1057 if( slot->key.data != NULL )
1058 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1059
1060 mbedtls_free( slot->key.data );
1061 slot->key.data = NULL;
1062 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001063
1064 return( PSA_SUCCESS );
1065}
1066
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001067/** Completely wipe a slot in memory, including its policy.
1068 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001069psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001070{
1071 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001072
1073 /*
1074 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001075 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001076 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1077 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001078 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001079 */
Ronald Cron5c522922020-11-14 16:35:34 +01001080 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001081 {
1082#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001083 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001084#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001085 status = PSA_ERROR_CORRUPTION_DETECTED;
1086 }
1087
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001088 /* Multipart operations may still be using the key. This is safe
1089 * because all multipart operation objects are independent from
1090 * the key slot: if they need to access the key after the setup
1091 * phase, they have a copy of the key. Note that this means that
1092 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001093 /* At this point, key material and other type-specific content has
1094 * been wiped. Clear remaining metadata. We can call memset and not
1095 * zeroize because the metadata is not particularly sensitive. */
1096 memset( slot, 0, sizeof( *slot ) );
1097 return( status );
1098}
1099
Ronald Croncf56a0a2020-08-04 09:51:30 +02001100psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001101{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001102 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001103 psa_status_t status; /* status of the last operation */
1104 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001105#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1106 psa_se_drv_table_entry_t *driver;
1107#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001108
Ronald Croncf56a0a2020-08-04 09:51:30 +02001109 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001110 return( PSA_SUCCESS );
1111
Ronald Cronf2911112020-10-29 17:51:10 +01001112 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001113 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001114 * key, this will load the key description from persistent memory if not
1115 * done yet. We cannot avoid this loading as without it we don't know if
1116 * the key is operated by an SE or not and this information is needed by
1117 * the current implementation.
1118 */
Ronald Cron5c522922020-11-14 16:35:34 +01001119 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001120 if( status != PSA_SUCCESS )
1121 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001122
Ronald Cronf2911112020-10-29 17:51:10 +01001123 /*
1124 * If the key slot containing the key description is under access by the
1125 * library (apart from the present access), the key cannot be destroyed
1126 * yet. For the time being, just return in error. Eventually (to be
1127 * implemented), the key should be destroyed when all accesses have
1128 * stopped.
1129 */
Ronald Cron5c522922020-11-14 16:35:34 +01001130 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001131 {
Ronald Cron5c522922020-11-14 16:35:34 +01001132 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001133 return( PSA_ERROR_GENERIC_ERROR );
1134 }
1135
Gilles Peskine354f7672019-07-12 23:46:38 +02001136#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001137 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001138 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001139 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001140 /* For a key in a secure element, we need to do three things:
1141 * remove the key file in internal storage, destroy the
1142 * key inside the secure element, and update the driver's
1143 * persistent data. Start a transaction that will encompass these
1144 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001145 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001146 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001147 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001148 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001149 status = psa_crypto_save_transaction( );
1150 if( status != PSA_SUCCESS )
1151 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001152 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001153 /* We should still try to destroy the key in the secure
1154 * element and the key metadata in storage. This is especially
1155 * important if the error is that the storage is full.
1156 * But how to do it exactly without risking an inconsistent
1157 * state after a reset?
1158 * https://github.com/ARMmbed/mbed-crypto/issues/215
1159 */
1160 overall_status = status;
1161 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001162 }
1163
Ronald Cronea0f8a62020-11-25 17:52:23 +01001164 status = psa_destroy_se_key( driver,
1165 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001166 if( overall_status == PSA_SUCCESS )
1167 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001168 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001169#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1170
Darryl Greend49a4992018-06-18 17:27:26 +01001171#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001172 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001173 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001174 status = psa_destroy_persistent_key( slot->attr.id );
1175 if( overall_status == PSA_SUCCESS )
1176 overall_status = status;
1177
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001178 /* TODO: other slots may have a copy of the same key. We should
1179 * invalidate them.
1180 * https://github.com/ARMmbed/mbed-crypto/issues/214
1181 */
Darryl Greend49a4992018-06-18 17:27:26 +01001182 }
1183#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001184
Gilles Peskinefc762652019-07-22 19:30:34 +02001185#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1186 if( driver != NULL )
1187 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001188 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001189 if( overall_status == PSA_SUCCESS )
1190 overall_status = status;
1191 status = psa_crypto_stop_transaction( );
1192 if( overall_status == PSA_SUCCESS )
1193 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001194 }
1195#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1196
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001197#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1198exit:
1199#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001200 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001201 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1202 if( overall_status == PSA_SUCCESS )
1203 overall_status = status;
1204 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001205}
1206
John Durkop07cc04a2020-11-16 22:08:34 -08001207#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001208 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001209static psa_status_t psa_get_rsa_public_exponent(
1210 const mbedtls_rsa_context *rsa,
1211 psa_key_attributes_t *attributes )
1212{
1213 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001214 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001215 uint8_t *buffer = NULL;
1216 size_t buflen;
1217 mbedtls_mpi_init( &mpi );
1218
1219 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1220 if( ret != 0 )
1221 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001222 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1223 {
1224 /* It's the default value, which is reported as an empty string,
1225 * so there's nothing to do. */
1226 goto exit;
1227 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001228
1229 buflen = mbedtls_mpi_size( &mpi );
1230 buffer = mbedtls_calloc( 1, buflen );
1231 if( buffer == NULL )
1232 {
1233 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1234 goto exit;
1235 }
1236 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1237 if( ret != 0 )
1238 goto exit;
1239 attributes->domain_parameters = buffer;
1240 attributes->domain_parameters_size = buflen;
1241
1242exit:
1243 mbedtls_mpi_free( &mpi );
1244 if( ret != 0 )
1245 mbedtls_free( buffer );
1246 return( mbedtls_to_psa_error( ret ) );
1247}
John Durkop07cc04a2020-11-16 22:08:34 -08001248#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001249 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001250
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001251/** Retrieve all the publicly-accessible attributes of a key.
1252 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001253psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001254 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001255{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001257 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001258 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001259
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001260 psa_reset_key_attributes( attributes );
1261
Ronald Cron5c522922020-11-14 16:35:34 +01001262 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001263 if( status != PSA_SUCCESS )
1264 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001265
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001266 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001267 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1268 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1269
1270#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1271 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001272 psa_set_key_slot_number( attributes,
1273 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001275
Gilles Peskine8e338702019-07-30 20:06:31 +02001276 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001277 {
John Durkop07cc04a2020-11-16 22:08:34 -08001278#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001279 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001280 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001281 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001282#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001283 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001284 * is not yet implemented.
1285 * https://github.com/ARMmbed/mbed-crypto/issues/216
1286 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001287 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001288 break;
1289#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001290 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001291 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001292
Ronald Cron90857082020-11-25 14:58:33 +01001293 status = mbedtls_psa_rsa_load_representation(
1294 slot->attr.type,
1295 slot->key.data,
1296 slot->key.bytes,
1297 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001298 if( status != PSA_SUCCESS )
1299 break;
1300
Steven Cooremana2371e52020-07-28 14:30:39 +02001301 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001302 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001303 mbedtls_rsa_free( rsa );
1304 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001305 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001306 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001307#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001308 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001309 default:
1310 /* Nothing else to do. */
1311 break;
1312 }
1313
1314 if( status != PSA_SUCCESS )
1315 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001316
Ronald Cron5c522922020-11-14 16:35:34 +01001317 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001318
Ronald Cron5c522922020-11-14 16:35:34 +01001319 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001320}
1321
Gilles Peskinec8000c02019-08-02 20:15:51 +02001322#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1323psa_status_t psa_get_key_slot_number(
1324 const psa_key_attributes_t *attributes,
1325 psa_key_slot_number_t *slot_number )
1326{
1327 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1328 {
1329 *slot_number = attributes->slot_number;
1330 return( PSA_SUCCESS );
1331 }
1332 else
1333 return( PSA_ERROR_INVALID_ARGUMENT );
1334}
1335#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1336
Ronald Crond18b5f82020-11-25 16:46:05 +01001337static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1338 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001339 uint8_t *data,
1340 size_t data_size,
1341 size_t *data_length )
1342{
Ronald Crond18b5f82020-11-25 16:46:05 +01001343 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001344 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001345 memcpy( data, key_buffer, key_buffer_size );
1346 memset( data + key_buffer_size, 0,
1347 data_size - key_buffer_size );
1348 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001349 return( PSA_SUCCESS );
1350}
1351
Ronald Cron7285cda2020-11-26 14:46:37 +01001352psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 const psa_key_attributes_t *attributes,
1354 const uint8_t *key_buffer, size_t key_buffer_size,
1355 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001356{
Ronald Crond18b5f82020-11-25 16:46:05 +01001357 psa_key_type_t type = attributes->core.type;
1358
Ronald Crond18b5f82020-11-25 16:46:05 +01001359 if( key_type_is_raw_bytes( type ) ||
1360 PSA_KEY_TYPE_IS_RSA( type ) ||
1361 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001362 {
1363 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001364 key_buffer, key_buffer_size,
1365 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001366 }
1367 else
1368 {
1369 /* This shouldn't happen in the reference implementation, but
1370 it is valid for a special-purpose implementation to omit
1371 support for exporting certain key types. */
1372 return( PSA_ERROR_NOT_SUPPORTED );
1373 }
1374}
1375
1376psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1377 uint8_t *data,
1378 size_t data_size,
1379 size_t *data_length )
1380{
1381 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1382 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1383 psa_key_slot_t *slot;
1384
Ronald Crone907e552021-01-18 13:22:38 +01001385 /* Reject a zero-length output buffer now, since this can never be a
1386 * valid key representation. This way we know that data must be a valid
1387 * pointer and we can do things like memset(data, ..., data_size). */
1388 if( data_size == 0 )
1389 return( PSA_ERROR_BUFFER_TOO_SMALL );
1390
Ronald Cron9486f9d2020-11-26 13:36:23 +01001391 /* Set the key to empty now, so that even when there are errors, we always
1392 * set data_length to a value between 0 and data_size. On error, setting
1393 * the key to empty is a good choice because an empty key representation is
1394 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001395 *data_length = 0;
1396
Ronald Cron9486f9d2020-11-26 13:36:23 +01001397 /* Export requires the EXPORT flag. There is an exception for public keys,
1398 * which don't require any flag, but
1399 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1400 */
1401 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1402 PSA_KEY_USAGE_EXPORT, 0 );
1403 if( status != PSA_SUCCESS )
1404 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001405
Ronald Crond18b5f82020-11-25 16:46:05 +01001406 psa_key_attributes_t attributes = {
1407 .core = slot->attr
1408 };
Ronald Cron67227982020-11-26 15:16:05 +01001409 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001410 slot->key.data, slot->key.bytes,
1411 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001412
Ronald Cron9486f9d2020-11-26 13:36:23 +01001413 unlock_status = psa_unlock_key_slot( slot );
1414
1415 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1416}
1417
Ronald Cron7285cda2020-11-26 14:46:37 +01001418psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001419 const psa_key_attributes_t *attributes,
1420 const uint8_t *key_buffer,
1421 size_t key_buffer_size,
1422 uint8_t *data,
1423 size_t data_size,
1424 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001425{
Ronald Crond18b5f82020-11-25 16:46:05 +01001426 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001427
Ronald Crond18b5f82020-11-25 16:46:05 +01001428 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001429 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001430 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001431 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001432 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001434 key_buffer, key_buffer_size,
1435 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001436 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001437
Ronald Crond18b5f82020-11-25 16:46:05 +01001438 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001439 {
John Durkop0e005192020-10-31 22:06:54 -07001440#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1441 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001442 return( mbedtls_psa_rsa_export_public_key( attributes,
1443 key_buffer,
1444 key_buffer_size,
1445 data,
1446 data_size,
1447 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001448#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001449 /* We don't know how to convert a private RSA key to public. */
1450 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001451#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1452 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001453 }
1454 else
Moran Pekera998bc62018-04-16 18:16:20 +03001455 {
John Durkop6ba40d12020-11-10 08:50:04 -08001456#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1457 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001458 return( mbedtls_psa_ecp_export_public_key( attributes,
1459 key_buffer,
1460 key_buffer_size,
1461 data,
1462 data_size,
1463 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001464#else
1465 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001466 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001467#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1468 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001469 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001470 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001471 else
1472 {
1473 /* This shouldn't happen in the reference implementation, but
1474 it is valid for a special-purpose implementation to omit
1475 support for exporting certain key types. */
1476 return( PSA_ERROR_NOT_SUPPORTED );
1477 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001478}
Ronald Crond18b5f82020-11-25 16:46:05 +01001479
Ronald Croncf56a0a2020-08-04 09:51:30 +02001480psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001481 uint8_t *data,
1482 size_t data_size,
1483 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001484{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001486 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001487 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001488
Ronald Crone907e552021-01-18 13:22:38 +01001489 /* Reject a zero-length output buffer now, since this can never be a
1490 * valid key representation. This way we know that data must be a valid
1491 * pointer and we can do things like memset(data, ..., data_size). */
1492 if( data_size == 0 )
1493 return( PSA_ERROR_BUFFER_TOO_SMALL );
1494
Darryl Greendd8fb772018-11-07 16:00:44 +00001495 /* Set the key to empty now, so that even when there are errors, we always
1496 * set data_length to a value between 0 and data_size. On error, setting
1497 * the key to empty is a good choice because an empty key representation is
1498 * unlikely to be accepted anywhere. */
1499 *data_length = 0;
1500
1501 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001502 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001503 if( status != PSA_SUCCESS )
1504 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001505
Ronald Cron9486f9d2020-11-26 13:36:23 +01001506 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1507 {
1508 status = PSA_ERROR_INVALID_ARGUMENT;
1509 goto exit;
1510 }
1511
Ronald Crond18b5f82020-11-25 16:46:05 +01001512 psa_key_attributes_t attributes = {
1513 .core = slot->attr
1514 };
Ronald Cron67227982020-11-26 15:16:05 +01001515 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001516 &attributes, slot->key.data, slot->key.bytes,
1517 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001518
1519exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001520 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001521
Ronald Cron5c522922020-11-14 16:35:34 +01001522 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001523}
1524
Gilles Peskine91e8c332019-08-02 19:19:39 +02001525#if defined(static_assert)
1526static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1527 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001528static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001529 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001530static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001531 "One or more key attribute flag is listed as both internal-only and external-only" );
1532#endif
1533
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001534/** Validate that a key policy is internally well-formed.
1535 *
1536 * This function only rejects invalid policies. It does not validate the
1537 * consistency of the policy with respect to other attributes of the key
1538 * such as the key type.
1539 */
1540static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001541{
1542 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001543 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001544 PSA_KEY_USAGE_ENCRYPT |
1545 PSA_KEY_USAGE_DECRYPT |
gabor-mezei-arme8efa392021-04-14 21:14:28 +02001546 PSA_KEY_USAGE_SIGN_MESSAGE |
1547 PSA_KEY_USAGE_VERIFY_MESSAGE |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001548 PSA_KEY_USAGE_SIGN_HASH |
1549 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001550 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1551 return( PSA_ERROR_INVALID_ARGUMENT );
1552
Gilles Peskine4747d192019-04-17 15:05:45 +02001553 return( PSA_SUCCESS );
1554}
1555
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001556/** Validate the internal consistency of key attributes.
1557 *
1558 * This function only rejects invalid attribute values. If does not
1559 * validate the consistency of the attributes with any key data that may
1560 * be involved in the creation of the key.
1561 *
1562 * Call this function early in the key creation process.
1563 *
1564 * \param[in] attributes Key attributes for the new key.
1565 * \param[out] p_drv On any return, the driver for the key, if any.
1566 * NULL for a transparent key.
1567 *
1568 */
1569static psa_status_t psa_validate_key_attributes(
1570 const psa_key_attributes_t *attributes,
1571 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001572{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001573 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001574 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001575 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001576
Ronald Cron54b90082020-10-29 15:26:43 +01001577 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001578 if( status != PSA_SUCCESS )
1579 return( status );
1580
Ronald Crond2ed4812020-07-17 16:11:30 +02001581 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001582 if( status != PSA_SUCCESS )
1583 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001584
Ronald Cron65f38a32020-10-23 17:11:13 +02001585 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1586 {
1587 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1588 return( PSA_ERROR_INVALID_ARGUMENT );
1589 }
1590 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001591 {
Ronald Cron77e412c2021-03-31 17:36:31 +02001592 if( !psa_is_valid_key_id( psa_get_key_id( attributes ), 0 ) )
1593 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Crond2ed4812020-07-17 16:11:30 +02001594 }
1595
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001596 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001597 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001598 return( status );
1599
1600 /* Refuse to create overly large keys.
1601 * Note that this doesn't trigger on import if the attributes don't
1602 * explicitly specify a size (so psa_get_key_bits returns 0), so
1603 * psa_import_key() needs its own checks. */
1604 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1605 return( PSA_ERROR_NOT_SUPPORTED );
1606
Gilles Peskine91e8c332019-08-02 19:19:39 +02001607 /* Reject invalid flags. These should not be reachable through the API. */
1608 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1609 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1610 return( PSA_ERROR_INVALID_ARGUMENT );
1611
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001612 return( PSA_SUCCESS );
1613}
1614
Gilles Peskine4747d192019-04-17 15:05:45 +02001615/** Prepare a key slot to receive key material.
1616 *
1617 * This function allocates a key slot and sets its metadata.
1618 *
1619 * If this function fails, call psa_fail_key_creation().
1620 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001621 * This function is intended to be used as follows:
1622 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001623 * it with the specified attributes, and in case of a volatile key assign it
1624 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001625 * -# Populate the slot with the key material.
1626 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1627 * In case of failure at any step, stop the sequence and call
1628 * psa_fail_key_creation().
1629 *
Ronald Cron5c522922020-11-14 16:35:34 +01001630 * On success, the key slot is locked. It is the responsibility of the caller
1631 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001632 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001633 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001634 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001635 * \param[out] p_slot On success, a pointer to the prepared slot.
1636 * \param[out] p_drv On any return, the driver for the key, if any.
1637 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001638 *
1639 * \retval #PSA_SUCCESS
1640 * The key slot is ready to receive key material.
1641 * \return If this function fails, the key slot is an invalid state.
1642 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001643 */
1644static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001645 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001646 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001647 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001648 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001649{
1650 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001651 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001652 psa_key_slot_t *slot;
1653
Gilles Peskinedf179142019-07-15 22:02:14 +02001654 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 *p_drv = NULL;
1656
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001657 status = psa_validate_key_attributes( attributes, p_drv );
1658 if( status != PSA_SUCCESS )
1659 return( status );
1660
Ronald Cronc4d1b512020-07-31 11:26:37 +02001661 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001662 if( status != PSA_SUCCESS )
1663 return( status );
1664 slot = *p_slot;
1665
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001666 /* We're storing the declared bit-size of the key. It's up to each
1667 * creation mechanism to verify that this information is correct.
1668 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001669 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001670 * is optional (import, copy). In case of a volatile key, assign it the
1671 * volatile key identifier associated to the slot returned to contain its
1672 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001673
1674 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001675 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1676 {
1677#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1678 slot->attr.id = volatile_key_id;
1679#else
1680 slot->attr.id.key_id = volatile_key_id;
1681#endif
1682 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001683
Gilles Peskine91e8c332019-08-02 19:19:39 +02001684 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001685 * external-only flags, query `attributes`. Thanks to the check
1686 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001687 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001688 * may have set. */
1689 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001690
Gilles Peskinecbaff462019-07-12 23:46:04 +02001691#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001692 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001693 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001694 * create the key file in internal storage, create the
1695 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001696 * persistent data. This is done by starting a transaction that will
1697 * encompass these three actions.
1698 * For registering a volatile key, we just need to find an appropriate
1699 * slot number inside the SE. Since the key is designated volatile, creating
1700 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001701 /* The first thing to do is to find a slot number for the new key.
1702 * We save the slot number in persistent storage as part of the
1703 * transaction data. It will be needed to recover if the power
1704 * fails during the key creation process, to clean up on the secure
1705 * element side after restarting. Obtaining a slot number from the
1706 * secure element driver updates its persistent state, but we do not yet
1707 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001708 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001709 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001710 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001711 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001712 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001713 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001714 if( status != PSA_SUCCESS )
1715 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001716
1717 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001718 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001719 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1720 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001721 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001722 psa_crypto_transaction.key.id = slot->attr.id;
1723 status = psa_crypto_save_transaction( );
1724 if( status != PSA_SUCCESS )
1725 {
1726 (void) psa_crypto_stop_transaction( );
1727 return( status );
1728 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001729 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001730
1731 status = psa_copy_key_material_into_slot(
1732 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001733 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001734
1735 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1736 {
1737 /* Key registration only makes sense with a secure element. */
1738 return( PSA_ERROR_INVALID_ARGUMENT );
1739 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001740#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1741
Ronald Cronc4d1b512020-07-31 11:26:37 +02001742 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001743}
Gilles Peskine4747d192019-04-17 15:05:45 +02001744
1745/** Finalize the creation of a key once its key material has been set.
1746 *
1747 * This entails writing the key to persistent storage.
1748 *
1749 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001750 * See the documentation of psa_start_key_creation() for the intended use
1751 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001752 *
Ronald Cron5c522922020-11-14 16:35:34 +01001753 * If the finalization succeeds, the function unlocks the key slot (it was
1754 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1755 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001756 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001757 * \param[in,out] slot Pointer to the slot with key material.
1758 * \param[in] driver The secure element driver for the key,
1759 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001760 * \param[out] key On success, identifier of the key. Note that the
1761 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001762 *
1763 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001764 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001765 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1766 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1767 * \retval #PSA_ERROR_ALREADY_EXISTS
1768 * \retval #PSA_ERROR_DATA_INVALID
1769 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001770 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001771 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001772 * \return If this function fails, the key slot is an invalid state.
1773 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001775static psa_status_t psa_finish_key_creation(
1776 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001777 psa_se_drv_table_entry_t *driver,
1778 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001779{
1780 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001781 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001782 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001783
1784#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001785 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001786 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001787#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1788 if( driver != NULL )
1789 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001790 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001791 psa_key_slot_number_t slot_number =
1792 psa_key_slot_get_slot_number( slot ) ;
1793
Gilles Peskineb46bef22019-07-30 21:32:04 +02001794#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001795 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001796 sizeof( data.slot_number ),
1797 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001798#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001799 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001800 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001801 (uint8_t*) &data,
1802 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001803 }
1804 else
1805#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1806 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001807 /* Key material is saved in export representation in the slot, so
1808 * just pass the slot buffer for storage. */
1809 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001810 slot->key.data,
1811 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001812 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001813 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001814#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1815
Gilles Peskinecbaff462019-07-12 23:46:04 +02001816#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001817 /* Finish the transaction for a key creation. This does not
1818 * happen when registering an existing key. Detect this case
1819 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001820 * creation of a persistent key in a secure element requires a transaction,
1821 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001822 if( driver != NULL &&
1823 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001824 {
1825 status = psa_save_se_persistent_data( driver );
1826 if( status != PSA_SUCCESS )
1827 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001828 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001829 return( status );
1830 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001831 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001832 }
1833#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1834
Ronald Cron50972942020-11-14 11:28:25 +01001835 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001836 {
1837 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001838 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001839 if( status != PSA_SUCCESS )
1840 *key = MBEDTLS_SVC_KEY_ID_INIT;
1841 }
Ronald Cron50972942020-11-14 11:28:25 +01001842
Gilles Peskine4747d192019-04-17 15:05:45 +02001843 return( status );
1844}
1845
1846/** Abort the creation of a key.
1847 *
1848 * You may call this function after calling psa_start_key_creation(),
1849 * or after psa_finish_key_creation() fails. In other circumstances, this
1850 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001851 * See the documentation of psa_start_key_creation() for the intended use
1852 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001853 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001854 * \param[in,out] slot Pointer to the slot with key material.
1855 * \param[in] driver The secure element driver for the key,
1856 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001857 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001858static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001859 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001860{
Gilles Peskine011e4282019-06-26 18:34:38 +02001861 (void) driver;
1862
Gilles Peskine4747d192019-04-17 15:05:45 +02001863 if( slot == NULL )
1864 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001865
1866#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001867 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001868 * element, and the failure happened later (when saving metadata
1869 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001870 * element.
1871 * https://github.com/ARMmbed/mbed-crypto/issues/217
1872 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001873
Gilles Peskined7729582019-08-05 15:55:54 +02001874 /* Abort the ongoing transaction if any (there may not be one if
1875 * the creation process failed before starting one, or if the
1876 * key creation is a registration of a key in a secure element).
1877 * Earlier functions must already have done what it takes to undo any
1878 * partial creation. All that's left is to update the transaction data
1879 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001880 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001881#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1882
Gilles Peskine4747d192019-04-17 15:05:45 +02001883 psa_wipe_key_slot( slot );
1884}
1885
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001886/** Validate optional attributes during key creation.
1887 *
1888 * Some key attributes are optional during key creation. If they are
1889 * specified in the attributes structure, check that they are consistent
1890 * with the data in the slot.
1891 *
1892 * This function should be called near the end of key creation, after
1893 * the slot in memory is fully populated but before saving persistent data.
1894 */
1895static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001896 const psa_key_slot_t *slot,
1897 const psa_key_attributes_t *attributes )
1898{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001899 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001900 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001901 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001902 return( PSA_ERROR_INVALID_ARGUMENT );
1903 }
1904
1905 if( attributes->domain_parameters_size != 0 )
1906 {
John Durkop0e005192020-10-31 22:06:54 -07001907#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1908 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001909 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001910 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001911 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001912 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001913 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001914
Ronald Cron90857082020-11-25 14:58:33 +01001915 psa_status_t status = mbedtls_psa_rsa_load_representation(
1916 slot->attr.type,
1917 slot->key.data,
1918 slot->key.bytes,
1919 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001920 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001921 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001922
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001923 mbedtls_mpi_init( &actual );
1924 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001925 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001926 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001927 mbedtls_rsa_free( rsa );
1928 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001929 if( ret != 0 )
1930 goto rsa_exit;
1931 ret = mbedtls_mpi_read_binary( &required,
1932 attributes->domain_parameters,
1933 attributes->domain_parameters_size );
1934 if( ret != 0 )
1935 goto rsa_exit;
1936 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1937 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1938 rsa_exit:
1939 mbedtls_mpi_free( &actual );
1940 mbedtls_mpi_free( &required );
1941 if( ret != 0)
1942 return( mbedtls_to_psa_error( ret ) );
1943 }
1944 else
John Durkop9814fa22020-11-04 12:28:15 -08001945#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1946 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947 {
1948 return( PSA_ERROR_INVALID_ARGUMENT );
1949 }
1950 }
1951
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001952 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001953 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001954 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955 return( PSA_ERROR_INVALID_ARGUMENT );
1956 }
1957
1958 return( PSA_SUCCESS );
1959}
1960
Gilles Peskine4747d192019-04-17 15:05:45 +02001961psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001962 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001963 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001964 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001965{
1966 psa_status_t status;
1967 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001968 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001969 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001970
Ronald Cron81709fc2020-11-14 12:10:32 +01001971 *key = MBEDTLS_SVC_KEY_ID_INIT;
1972
Gilles Peskine0f84d622019-09-12 19:03:13 +02001973 /* Reject zero-length symmetric keys (including raw data key objects).
1974 * This also rejects any key which might be encoded as an empty string,
1975 * which is never valid. */
1976 if( data_length == 0 )
1977 return( PSA_ERROR_INVALID_ARGUMENT );
1978
Gilles Peskinedf179142019-07-15 22:02:14 +02001979 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001980 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001981 if( status != PSA_SUCCESS )
1982 goto exit;
1983
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001984 /* In the case of a transparent key or an opaque key stored in local
1985 * storage (thus not in the case of generating a key in a secure element
1986 * or cryptoprocessor with storage), we have to allocate a buffer to
1987 * hold the generated key material. */
1988 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001989 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001990 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001991 if( status != PSA_SUCCESS )
1992 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001993 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001994
1995 bits = slot->attr.bits;
1996 status = psa_driver_wrapper_import_key( attributes,
1997 data, data_length,
1998 slot->key.data,
1999 slot->key.bytes,
2000 &slot->key.bytes, &bits );
2001 if( status != PSA_SUCCESS )
2002 goto exit;
2003
2004 if( slot->attr.bits == 0 )
2005 slot->attr.bits = (psa_key_bits_t) bits;
2006 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01002007 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002008 status = PSA_ERROR_INVALID_ARGUMENT;
2009 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002010 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002011
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002012 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002013 if( status != PSA_SUCCESS )
2014 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002015
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002018 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002019 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002020
Gilles Peskine4747d192019-04-17 15:05:45 +02002021 return( status );
2022}
2023
Gilles Peskined7729582019-08-05 15:55:54 +02002024#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2025psa_status_t mbedtls_psa_register_se_key(
2026 const psa_key_attributes_t *attributes )
2027{
2028 psa_status_t status;
2029 psa_key_slot_t *slot = NULL;
2030 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002031 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002032
2033 /* Leaving attributes unspecified is not currently supported.
2034 * It could make sense to query the key type and size from the
2035 * secure element, but not all secure elements support this
2036 * and the driver HAL doesn't currently support it. */
2037 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2038 return( PSA_ERROR_NOT_SUPPORTED );
2039 if( psa_get_key_bits( attributes ) == 0 )
2040 return( PSA_ERROR_NOT_SUPPORTED );
2041
2042 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002043 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002044 if( status != PSA_SUCCESS )
2045 goto exit;
2046
Ronald Cron81709fc2020-11-14 12:10:32 +01002047 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002048
2049exit:
2050 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002051 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002052
Gilles Peskined7729582019-08-05 15:55:54 +02002053 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002054 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002055 return( status );
2056}
2057#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2058
Gilles Peskinef603c712019-01-19 13:40:11 +01002059static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002060 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002061{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002062 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002063 source->key.data,
2064 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002065 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002066 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002067
Steven Cooreman398aee52020-10-13 14:35:45 +02002068 target->attr.type = source->attr.type;
2069 target->attr.bits = source->attr.bits;
2070
2071 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002072}
2073
Ronald Croncf56a0a2020-08-04 09:51:30 +02002074psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002075 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002076 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002077{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002078 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002079 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002080 psa_key_slot_t *source_slot = NULL;
2081 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002082 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002083 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002084
Ronald Cron81709fc2020-11-14 12:10:32 +01002085 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2086
Ronald Cron5c522922020-11-14 16:35:34 +01002087 status = psa_get_and_lock_transparent_key_slot_with_policy(
2088 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002089 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002090 goto exit;
2091
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002092 status = psa_validate_optional_attributes( source_slot,
2093 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002094 if( status != PSA_SUCCESS )
2095 goto exit;
2096
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01002097 status = psa_restrict_key_policy( source_slot->attr.type,
2098 &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002099 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 if( status != PSA_SUCCESS )
2101 goto exit;
2102
Ronald Cron81709fc2020-11-14 12:10:32 +01002103 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2104 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002105 if( status != PSA_SUCCESS )
2106 goto exit;
2107
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002108#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2109 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002110 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002111 /* Copying to a secure element is not implemented yet. */
2112 status = PSA_ERROR_NOT_SUPPORTED;
2113 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002114 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002115#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002116
Ronald Cron6cc66312021-04-02 12:27:47 +02002117 if( psa_key_lifetime_is_external( actual_attributes.core.lifetime ) )
2118 {
2119 /*
2120 * Copying through an opaque driver is not implemented yet, consider
2121 * a lifetime with an external location as an invalid parameter for
2122 * now.
2123 */
2124 status = PSA_ERROR_INVALID_ARGUMENT;
2125 goto exit;
2126 }
2127
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002128 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002129 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002130 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002131
Ronald Cron81709fc2020-11-14 12:10:32 +01002132 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002133exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002134 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002135 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002136
Ronald Cron5c522922020-11-14 16:35:34 +01002137 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002138
Ronald Cron5c522922020-11-14 16:35:34 +01002139 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002140}
2141
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002142
2143
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002144/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002145/* Message digests */
2146/****************************************************************/
2147
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002148psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2149{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002150 /* Aborting a non-active operation is allowed */
2151 if( operation->id == 0 )
2152 return( PSA_SUCCESS );
2153
2154 psa_status_t status = psa_driver_wrapper_hash_abort( operation );
2155 operation->id = 0;
2156
2157 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002158}
2159
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002160psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002161 psa_algorithm_t alg )
2162{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002163 /* A context must be freshly initialized before it can be set up. */
2164 if( operation->id != 0 )
2165 return( PSA_ERROR_BAD_STATE );
2166
2167 if( !PSA_ALG_IS_HASH( alg ) )
Steven Cooreman0e307642021-02-18 16:18:32 +01002168 return( PSA_ERROR_INVALID_ARGUMENT );
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002169
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002170 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2171 * directly zeroes the int-sized dummy member of the context union. */
Steven Cooreman893232f2021-03-15 12:23:37 +01002172 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
2173
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002174 return( psa_driver_wrapper_hash_setup( operation, alg ) );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002175}
2176
2177psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2178 const uint8_t *input,
2179 size_t input_length )
2180{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002181 if( operation->id == 0 )
2182 return( PSA_ERROR_BAD_STATE );
Gilles Peskine94e44542018-07-12 16:58:43 +02002183
Steven Cooremanc8288352021-03-04 14:02:19 +01002184 /* Don't require hash implementations to behave correctly on a
2185 * zero-length input, which may have an invalid pointer. */
2186 if( input_length == 0 )
2187 return( PSA_SUCCESS );
2188
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002189 psa_status_t status = psa_driver_wrapper_hash_update( operation,
2190 input, input_length );
2191 if( status != PSA_SUCCESS )
2192 psa_hash_abort( operation );
2193
2194 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195}
2196
2197psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2198 uint8_t *hash,
2199 size_t hash_size,
2200 size_t *hash_length )
2201{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002202 *hash_length = 0;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002203 if( operation->id == 0 )
2204 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002205
Steven Cooreman1e582352021-02-18 17:24:37 +01002206 psa_status_t status = psa_driver_wrapper_hash_finish(
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002207 operation, hash, hash_size, hash_length );
Steven Cooreman0e307642021-02-18 16:18:32 +01002208 psa_hash_abort( operation );
2209 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002210}
2211
Gilles Peskine2d277862018-06-18 15:41:12 +02002212psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2213 const uint8_t *hash,
2214 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002215{
2216 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2217 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002218 psa_status_t status = psa_hash_finish(
2219 operation,
Steven Cooreman1e582352021-02-18 17:24:37 +01002220 actual_hash, sizeof( actual_hash ),
2221 &actual_hash_length );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002222 if( status != PSA_SUCCESS )
2223 return( status );
2224 if( actual_hash_length != hash_length )
2225 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002226 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227 return( PSA_ERROR_INVALID_SIGNATURE );
2228 return( PSA_SUCCESS );
2229}
2230
Gilles Peskine0a749c82019-11-28 19:33:58 +01002231psa_status_t psa_hash_compute( psa_algorithm_t alg,
2232 const uint8_t *input, size_t input_length,
2233 uint8_t *hash, size_t hash_size,
2234 size_t *hash_length )
2235{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002236 *hash_length = 0;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002237 if( !PSA_ALG_IS_HASH( alg ) )
2238 return( PSA_ERROR_INVALID_ARGUMENT );
2239
Steven Cooreman1e582352021-02-18 17:24:37 +01002240 return( psa_driver_wrapper_hash_compute( alg, input, input_length,
2241 hash, hash_size, hash_length ) );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002242}
2243
2244psa_status_t psa_hash_compare( psa_algorithm_t alg,
2245 const uint8_t *input, size_t input_length,
2246 const uint8_t *hash, size_t hash_length )
2247{
Steven Cooreman84d670d2021-02-18 16:22:53 +01002248 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2249 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002250
2251 if( !PSA_ALG_IS_HASH( alg ) )
2252 return( PSA_ERROR_INVALID_ARGUMENT );
2253
Steven Cooreman1e582352021-02-18 17:24:37 +01002254 psa_status_t status = psa_driver_wrapper_hash_compute(
2255 alg, input, input_length,
2256 actual_hash, sizeof(actual_hash),
2257 &actual_hash_length );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002258 if( status != PSA_SUCCESS )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002259 return( status );
2260 if( actual_hash_length != hash_length )
2261 return( PSA_ERROR_INVALID_SIGNATURE );
Steven Cooremana2a1b802021-04-29 16:37:59 +02002262 if( mbedtls_psa_safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
Steven Cooreman84d670d2021-02-18 16:22:53 +01002263 return( PSA_ERROR_INVALID_SIGNATURE );
2264 return( PSA_SUCCESS );
Gilles Peskine0a749c82019-11-28 19:33:58 +01002265}
2266
Gilles Peskineeb35d782019-01-22 17:56:16 +01002267psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2268 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002269{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002270 if( source_operation->id == 0 ||
2271 target_operation->id != 0 )
2272 {
2273 return( PSA_ERROR_BAD_STATE );
2274 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002275
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002276 psa_status_t status = psa_driver_wrapper_hash_clone( source_operation,
2277 target_operation );
2278 if( status != PSA_SUCCESS )
2279 psa_hash_abort( target_operation );
2280
2281 return( status );
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002282}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283
2284
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002285/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002286/* MAC */
2287/****************************************************************/
2288
Steven Cooreman07897832021-03-19 18:28:56 +01002289psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002290{
Steven Cooreman07897832021-03-19 18:28:56 +01002291 /* Aborting a non-active operation is allowed */
2292 if( operation->id == 0 )
2293 return( PSA_SUCCESS );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002294
Steven Cooreman07897832021-03-19 18:28:56 +01002295 psa_status_t status = psa_driver_wrapper_mac_abort( operation );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002296 operation->mac_size = 0;
2297 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002298 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002299
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002300 return( status );
2301}
2302
Ronald Cron1c650a12021-06-17 16:33:22 +02002303static psa_status_t psa_mac_finalize_alg_and_key_validation(
2304 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002305 const psa_key_attributes_t *attributes,
2306 uint8_t *mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002307{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondef68e72021-06-17 16:46:44 +02002309 psa_key_type_t key_type = psa_get_key_type( attributes );
2310 size_t key_bits = psa_get_key_bits( attributes );
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002311
Ronald Cron48f875e2021-06-17 16:10:24 +02002312 if( ! PSA_ALG_IS_MAC( alg ) )
Ronald Crondef68e72021-06-17 16:46:44 +02002313 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman07897832021-03-19 18:28:56 +01002314
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002315 /* Validate the combination of key type and algorithm */
Ronald Crondef68e72021-06-17 16:46:44 +02002316 status = psa_mac_key_can_do( alg, key_type );
Steven Cooreman15472f82021-03-02 16:16:22 +01002317 if( status != PSA_SUCCESS )
Ronald Crondef68e72021-06-17 16:46:44 +02002318 return( status );
Steven Cooreman15472f82021-03-02 16:16:22 +01002319
Steven Cooremana6474de2021-05-10 11:13:41 +02002320 /* Get the output length for the algorithm and key combination */
Ronald Crondef68e72021-06-17 16:46:44 +02002321 *mac_size = PSA_MAC_LENGTH( key_type, key_bits, alg );
Steven Cooreman15472f82021-03-02 16:16:22 +01002322
Ronald Crondef68e72021-06-17 16:46:44 +02002323 if( *mac_size < 4 )
Steven Cooreman15472f82021-03-02 16:16:22 +01002324 {
2325 /* A very short MAC is too short for security since it can be
2326 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2327 * so we make this our minimum, even though 32 bits is still
2328 * too small for security. */
Ronald Crondef68e72021-06-17 16:46:44 +02002329 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman15472f82021-03-02 16:16:22 +01002330 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002331
Ronald Crondef68e72021-06-17 16:46:44 +02002332 if( *mac_size > PSA_MAC_LENGTH( key_type, key_bits,
2333 PSA_ALG_FULL_LENGTH_MAC( alg ) ) )
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002334 {
2335 /* It's impossible to "truncate" to a larger length than the full length
2336 * of the algorithm. */
Ronald Crondef68e72021-06-17 16:46:44 +02002337 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002338 }
2339
Ronald Crondef68e72021-06-17 16:46:44 +02002340 return( PSA_SUCCESS );
Ronald Cron1c650a12021-06-17 16:33:22 +02002341}
2342
2343static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
2344 mbedtls_svc_key_id_t key,
2345 psa_algorithm_t alg,
2346 int is_sign )
2347{
2348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2349 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2350 psa_key_slot_t *slot;
2351
2352 /* A context must be freshly initialized before it can be set up. */
2353 if( operation->id != 0 )
2354 return( PSA_ERROR_BAD_STATE );
2355
2356 status = psa_get_and_lock_key_slot_with_policy(
2357 key,
2358 &slot,
2359 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2360 alg );
2361 if( status != PSA_SUCCESS )
2362 return( status );
2363
2364 psa_key_attributes_t attributes = {
2365 .core = slot->attr
2366 };
2367
Ronald Crondef68e72021-06-17 16:46:44 +02002368 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2369 &operation->mac_size );
Ronald Cron1c650a12021-06-17 16:33:22 +02002370 if( status != PSA_SUCCESS )
2371 goto exit;
2372
2373 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002374 /* Dispatch the MAC setup call with validated input */
2375 if( is_sign )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002376 {
Steven Cooreman07897832021-03-19 18:28:56 +01002377 status = psa_driver_wrapper_mac_sign_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002378 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002379 slot->key.data,
2380 slot->key.bytes,
2381 alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002382 }
2383 else
Gilles Peskinefbfac682018-07-08 20:51:54 +02002384 {
Steven Cooreman07897832021-03-19 18:28:56 +01002385 status = psa_driver_wrapper_mac_verify_setup( operation,
Ronald Cron1c650a12021-06-17 16:33:22 +02002386 &attributes,
Steven Cooreman07897832021-03-19 18:28:56 +01002387 slot->key.data,
2388 slot->key.bytes,
2389 alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002390 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002391
Gilles Peskinefbfac682018-07-08 20:51:54 +02002392exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002393 if( status != PSA_SUCCESS )
Steven Cooreman07897832021-03-19 18:28:56 +01002394 psa_mac_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002395
Ronald Cron5c522922020-11-14 16:35:34 +01002396 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002397
Ronald Cron5c522922020-11-14 16:35:34 +01002398 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002399}
2400
Gilles Peskine89167cb2018-07-08 20:12:23 +02002401psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002402 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002403 psa_algorithm_t alg )
2404{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002405 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002406}
2407
2408psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002409 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002410 psa_algorithm_t alg )
2411{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002412 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002413}
2414
Steven Cooreman11743f92021-03-19 18:38:46 +01002415psa_status_t psa_mac_update( psa_mac_operation_t *operation,
Gilles Peskine8c9def32018-02-08 10:02:12 +01002416 const uint8_t *input,
2417 size_t input_length )
2418{
Steven Cooreman11743f92021-03-19 18:38:46 +01002419 if( operation->id == 0 )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002420 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002421
Steven Cooreman11743f92021-03-19 18:38:46 +01002422 /* Don't require hash implementations to behave correctly on a
2423 * zero-length input, which may have an invalid pointer. */
2424 if( input_length == 0 )
2425 return( PSA_SUCCESS );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002426
Steven Cooreman11743f92021-03-19 18:38:46 +01002427 psa_status_t status = psa_driver_wrapper_mac_update( operation,
2428 input, input_length );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002429 if( status != PSA_SUCCESS )
Steven Cooreman11743f92021-03-19 18:38:46 +01002430 psa_mac_abort( operation );
2431
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002432 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002433}
2434
Steven Cooreman87885df2021-03-19 19:04:39 +01002435psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002436 uint8_t *mac,
2437 size_t mac_size,
2438 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07002439{
Steven Cooreman87885df2021-03-19 19:04:39 +01002440 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2441 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002442
Steven Cooreman15f0d922021-05-07 14:14:37 +02002443 /* Set the output length and content to a safe default, such that in
2444 * case the caller misses an error check, the output would be an
2445 * unachievable MAC. */
2446 *mac_length = mac_size;
2447
Steven Cooreman87885df2021-03-19 19:04:39 +01002448 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002449 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002450
Steven Cooreman15f0d922021-05-07 14:14:37 +02002451 if( ! operation->is_sign )
2452 return( PSA_ERROR_BAD_STATE );
2453
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002454 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2455 * once all the error checks are done. */
2456 if( operation->mac_size == 0 )
2457 return( PSA_ERROR_BAD_STATE );
2458
2459 if( mac_size < operation->mac_size )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002460 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002461
Steven Cooreman87885df2021-03-19 19:04:39 +01002462 status = psa_driver_wrapper_mac_sign_finish( operation,
Steven Cooreman15f0d922021-05-07 14:14:37 +02002463 mac, operation->mac_size,
2464 mac_length );
2465
Ronald Cron882eb782021-06-18 13:05:48 +02002466 /* In case of success, set the potential excess room in the output buffer
2467 * to an invalid value, to avoid potentially leaking a longer MAC.
2468 * In case of error, set the output length and content to a safe default,
2469 * such that in case the caller misses an error check, the output would be
2470 * an unachievable MAC.
2471 */
2472 if( status != PSA_SUCCESS )
Steven Cooreman15f0d922021-05-07 14:14:37 +02002473 {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002474 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002475 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002476 }
mohammad16036df908f2018-04-02 08:34:15 -07002477
Ronald Cron882eb782021-06-18 13:05:48 +02002478 if( mac_size > operation->mac_size )
2479 memset( &mac[operation->mac_size], '!',
2480 mac_size - operation->mac_size );
2481
Steven Cooreman87885df2021-03-19 19:04:39 +01002482 abort_status = psa_mac_abort( operation );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002483
Steven Cooreman87885df2021-03-19 19:04:39 +01002484 return( status == PSA_SUCCESS ? abort_status : status );
mohammad16036df908f2018-04-02 08:34:15 -07002485}
2486
Steven Cooreman87885df2021-03-19 19:04:39 +01002487psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
Gilles Peskineacd4be32018-07-08 19:56:25 +02002488 const uint8_t *mac,
2489 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002490{
Steven Cooreman87885df2021-03-19 19:04:39 +01002491 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2492 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002493
Steven Cooreman87885df2021-03-19 19:04:39 +01002494 if( operation->id == 0 )
Jaeden Amero252ef282019-02-15 14:05:35 +00002495 return( PSA_ERROR_BAD_STATE );
Jaeden Amero252ef282019-02-15 14:05:35 +00002496
Steven Cooreman15f0d922021-05-07 14:14:37 +02002497 if( operation->is_sign )
2498 return( PSA_ERROR_BAD_STATE );
2499
2500 if( operation->mac_size != mac_length )
2501 {
2502 status = PSA_ERROR_INVALID_SIGNATURE;
2503 goto cleanup;
2504 }
2505
Steven Cooreman87885df2021-03-19 19:04:39 +01002506 status = psa_driver_wrapper_mac_verify_finish( operation,
2507 mac, mac_length );
Steven Cooreman15f0d922021-05-07 14:14:37 +02002508
2509cleanup:
Steven Cooreman87885df2021-03-19 19:04:39 +01002510 abort_status = psa_mac_abort( operation );
mohammad16036df908f2018-04-02 08:34:15 -07002511
Steven Cooreman87885df2021-03-19 19:04:39 +01002512 return( status == PSA_SUCCESS ? abort_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002513}
2514
Ronald Cronef0d8f12021-06-18 14:23:33 +02002515static psa_status_t psa_mac_compute_internal( mbedtls_svc_key_id_t key,
2516 psa_algorithm_t alg,
2517 const uint8_t *input,
2518 size_t input_length,
2519 uint8_t *mac,
2520 size_t mac_size,
2521 size_t *mac_length,
2522 int is_sign )
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002523{
2524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002525 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2526 psa_key_slot_t *slot;
2527 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002528
Ronald Crondbb86462021-06-17 17:17:20 +02002529 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cronef0d8f12021-06-18 14:23:33 +02002530 key, &slot,
2531 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH,
2532 alg );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002533 if( status != PSA_SUCCESS )
2534 goto exit;
2535
Ronald Crondbb86462021-06-17 17:17:20 +02002536 psa_key_attributes_t attributes = {
2537 .core = slot->attr
2538 };
2539
2540 status = psa_mac_finalize_alg_and_key_validation( alg, &attributes,
2541 &operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002542 if( status != PSA_SUCCESS )
2543 goto exit;
2544
Ronald Crondbb86462021-06-17 17:17:20 +02002545 if( mac_size < operation_mac_size )
2546 {
2547 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002548 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002549 }
2550
2551 status = psa_driver_wrapper_mac_compute(
2552 &attributes,
2553 slot->key.data, slot->key.bytes,
2554 alg,
2555 input, input_length,
2556 mac, operation_mac_size, mac_length );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002557
2558exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002559 /* In case of success, set the potential excess room in the output buffer
2560 * to an invalid value, to avoid potentially leaking a longer MAC.
2561 * In case of error, set the output length and content to a safe default,
2562 * such that in case the caller misses an error check, the output would be
2563 * an unachievable MAC.
2564 */
2565 if( status != PSA_SUCCESS )
Ronald Crondbb86462021-06-17 17:17:20 +02002566 {
Ronald Crondbb86462021-06-17 17:17:20 +02002567 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002568 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002569 }
Ronald Cron882eb782021-06-18 13:05:48 +02002570 if( mac_size > operation_mac_size )
2571 memset( &mac[operation_mac_size], '!', mac_size - operation_mac_size );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002572
Ronald Crondbb86462021-06-17 17:17:20 +02002573 unlock_status = psa_unlock_key_slot( slot );
2574
2575 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002576}
2577
Ronald Cronef0d8f12021-06-18 14:23:33 +02002578psa_status_t psa_mac_compute( mbedtls_svc_key_id_t key,
2579 psa_algorithm_t alg,
2580 const uint8_t *input,
2581 size_t input_length,
2582 uint8_t *mac,
2583 size_t mac_size,
2584 size_t *mac_length)
2585{
2586 return( psa_mac_compute_internal( key, alg,
2587 input, input_length,
2588 mac, mac_size, mac_length, 1 ) );
2589}
2590
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002591psa_status_t psa_mac_verify( mbedtls_svc_key_id_t key,
2592 psa_algorithm_t alg,
2593 const uint8_t *input,
2594 size_t input_length,
2595 const uint8_t *mac,
2596 size_t mac_length)
2597{
2598 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002599 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2600 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002601
Ronald Cron4ed83682021-06-18 14:51:29 +02002602 status = psa_mac_compute_internal( key, alg,
2603 input, input_length,
2604 actual_mac, sizeof( actual_mac ),
2605 &actual_mac_length, 0 );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002606 if( status != PSA_SUCCESS )
2607 goto exit;
2608
Ronald Cron4ed83682021-06-18 14:51:29 +02002609 if( mac_length != actual_mac_length )
2610 {
2611 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002612 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002613 }
2614 if( mbedtls_psa_safer_memcmp( mac, actual_mac, actual_mac_length ) != 0 )
2615 {
2616 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002617 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002618 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002619
2620exit:
Ronald Cron4ed83682021-06-18 14:51:29 +02002621 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002622
2623 return ( status );
2624}
Gilles Peskine20035e32018-02-03 22:44:14 +01002625
Gilles Peskine20035e32018-02-03 22:44:14 +01002626/****************************************************************/
2627/* Asymmetric cryptography */
2628/****************************************************************/
2629
gabor-mezei-armc9795782021-05-12 11:03:09 +02002630static psa_status_t psa_sign_verify_check_alg( int input_is_message,
gabor-mezei-arm56980482021-05-05 13:56:27 +02002631 psa_algorithm_t alg )
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002632{
gabor-mezei-armc9795782021-05-12 11:03:09 +02002633 if( input_is_message )
gabor-mezei-arm56980482021-05-05 13:56:27 +02002634 {
2635 if( ! PSA_ALG_IS_SIGN_MESSAGE( alg ) )
2636 return( PSA_ERROR_INVALID_ARGUMENT );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002637
gabor-mezei-arm56980482021-05-05 13:56:27 +02002638 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2639 {
2640 if( ! PSA_ALG_IS_HASH( PSA_ALG_SIGN_GET_HASH( alg ) ) )
2641 return( PSA_ERROR_INVALID_ARGUMENT );
2642 }
2643 }
2644 else
2645 {
2646 if( ! PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2647 return( PSA_ERROR_INVALID_ARGUMENT );
2648 }
2649
2650 return( PSA_SUCCESS );
2651}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002652
2653static psa_status_t psa_sign_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002654 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002655 psa_algorithm_t alg,
2656 const uint8_t * input,
2657 size_t input_length,
2658 uint8_t * signature,
2659 size_t signature_size,
2660 size_t * signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002661{
2662 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2663 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2664 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002665
2666 *signature_length = 0;
2667
gabor-mezei-armc9795782021-05-12 11:03:09 +02002668 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002669 if( status != PSA_SUCCESS )
2670 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002671
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002672 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002673 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002674 * buffer can in principle be empty since it doesn't actually have
2675 * to be a hash.) */
2676 if( signature_size == 0 )
2677 return( PSA_ERROR_BUFFER_TOO_SMALL );
2678
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002679 status = psa_get_and_lock_key_slot_with_policy(
2680 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002681 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2682 PSA_KEY_USAGE_SIGN_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002683 alg );
2684
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002685 if( status != PSA_SUCCESS )
2686 goto exit;
2687
2688 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
2689 {
2690 status = PSA_ERROR_INVALID_ARGUMENT;
2691 goto exit;
2692 }
2693
2694 psa_key_attributes_t attributes = {
2695 .core = slot->attr
2696 };
2697
gabor-mezei-armc9795782021-05-12 11:03:09 +02002698 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002699 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002700 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002701 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002702 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002703 signature, signature_size, signature_length );
2704 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002705 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002706 {
2707
2708 status = psa_driver_wrapper_sign_hash(
2709 &attributes, slot->key.data, slot->key.bytes,
2710 alg, input, input_length,
2711 signature, signature_size, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002712 }
2713
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002714
2715exit:
2716 /* Fill the unused part of the output buffer (the whole buffer on error,
2717 * the trailing part on success) with something that isn't a valid signature
2718 * (barring an attack on the signature and deliberately-crafted input),
2719 * in case the caller doesn't check the return status properly. */
2720 if( status == PSA_SUCCESS )
2721 memset( signature + *signature_length, '!',
2722 signature_size - *signature_length );
2723 else
2724 memset( signature, '!', signature_size );
2725 /* If signature_size is 0 then we have nothing to do. We must not call
2726 * memset because signature may be NULL in this case. */
2727
2728 unlock_status = psa_unlock_key_slot( slot );
2729
2730 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
2731}
2732
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002733static psa_status_t psa_verify_internal( mbedtls_svc_key_id_t key,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002734 int input_is_message,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002735 psa_algorithm_t alg,
2736 const uint8_t * input,
2737 size_t input_length,
2738 const uint8_t * signature,
2739 size_t signature_length )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002740{
2741 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2742 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2743 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002744
gabor-mezei-armc9795782021-05-12 11:03:09 +02002745 status = psa_sign_verify_check_alg( input_is_message, alg );
gabor-mezei-arm56980482021-05-05 13:56:27 +02002746 if( status != PSA_SUCCESS )
2747 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002748
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002749 status = psa_get_and_lock_key_slot_with_policy(
2750 key, &slot,
gabor-mezei-armc9795782021-05-12 11:03:09 +02002751 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2752 PSA_KEY_USAGE_VERIFY_HASH,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002753 alg );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002754
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002755 if( status != PSA_SUCCESS )
2756 return( status );
2757
2758 psa_key_attributes_t attributes = {
2759 .core = slot->attr
2760 };
2761
gabor-mezei-armc9795782021-05-12 11:03:09 +02002762 if( input_is_message )
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002763 {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002764 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002765 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002766 alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002767 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002768 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002769 else
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002770 {
2771 status = psa_driver_wrapper_verify_hash(
2772 &attributes, slot->key.data, slot->key.bytes,
2773 alg, input, input_length,
2774 signature, signature_length );
2775 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002776
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002777 unlock_status = psa_unlock_key_slot( slot );
2778
2779 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002780
2781}
2782
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002783psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002784 const psa_key_attributes_t *attributes,
2785 const uint8_t *key_buffer,
2786 size_t key_buffer_size,
2787 psa_algorithm_t alg,
2788 const uint8_t *input,
2789 size_t input_length,
2790 uint8_t *signature,
2791 size_t signature_size,
2792 size_t *signature_length )
2793{
2794 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002795
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002796 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2797 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002798 size_t hash_length;
2799 uint8_t hash[PSA_HASH_MAX_SIZE];
2800
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002801 status = psa_driver_wrapper_hash_compute(
2802 PSA_ALG_SIGN_GET_HASH( alg ),
2803 input, input_length,
2804 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002805
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002806 if( status != PSA_SUCCESS )
2807 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002808
2809 return psa_driver_wrapper_sign_hash(
2810 attributes, key_buffer, key_buffer_size,
2811 alg, hash, hash_length,
2812 signature, signature_size, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002813 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002814
gabor-mezei-arm56980482021-05-05 13:56:27 +02002815 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002816}
2817
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002818psa_status_t psa_sign_message( mbedtls_svc_key_id_t key,
2819 psa_algorithm_t alg,
2820 const uint8_t * input,
2821 size_t input_length,
2822 uint8_t * signature,
2823 size_t signature_size,
2824 size_t * signature_length )
2825{
2826 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002827 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002828 signature, signature_size, signature_length );
2829}
2830
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002831psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002832 const psa_key_attributes_t *attributes,
2833 const uint8_t *key_buffer,
2834 size_t key_buffer_size,
2835 psa_algorithm_t alg,
2836 const uint8_t *input,
2837 size_t input_length,
2838 const uint8_t *signature,
2839 size_t signature_length )
2840{
2841 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002842
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002843 if ( PSA_ALG_IS_HASH_AND_SIGN( alg ) )
2844 {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002845 size_t hash_length;
2846 uint8_t hash[PSA_HASH_MAX_SIZE];
2847
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002848 status = psa_driver_wrapper_hash_compute(
2849 PSA_ALG_SIGN_GET_HASH( alg ),
2850 input, input_length,
2851 hash, sizeof( hash ), &hash_length );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002852
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002853 if( status != PSA_SUCCESS )
2854 return status;
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002855
2856 return psa_driver_wrapper_verify_hash(
2857 attributes, key_buffer, key_buffer_size,
2858 alg, hash, hash_length,
2859 signature, signature_length );
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002860 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002861
gabor-mezei-armef6f2aa2021-05-05 13:59:01 +02002862 return( PSA_ERROR_NOT_SUPPORTED );
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002863}
2864
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002865psa_status_t psa_verify_message( mbedtls_svc_key_id_t key,
2866 psa_algorithm_t alg,
2867 const uint8_t * input,
2868 size_t input_length,
2869 const uint8_t * signature,
2870 size_t signature_length )
2871{
2872 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002873 key, 1, alg, input, input_length,
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002874 signature, signature_length );
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002875}
2876
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002877psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002878 const psa_key_attributes_t *attributes,
2879 const uint8_t *key_buffer, size_t key_buffer_size,
2880 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2881 uint8_t *signature, size_t signature_size, size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01002882{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002883 if( attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01002884 {
Ronald Cron4501c982021-03-19 20:09:32 +01002885 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2886 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002887 {
Ronald Cron4501c982021-03-19 20:09:32 +01002888#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2889 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2890 return( mbedtls_psa_rsa_sign_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002891 attributes,
2892 key_buffer, key_buffer_size,
2893 alg, hash, hash_length,
2894 signature, signature_size, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002895#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2896 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002897 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002898 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002899 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002900 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002901 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002902 }
2903 else
Ronald Cron4501c982021-03-19 20:09:32 +01002904 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
2905 {
2906 if( PSA_ALG_IS_ECDSA( alg ) )
2907 {
2908#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2909 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2910 return( mbedtls_psa_ecdsa_sign_hash(
2911 attributes,
2912 key_buffer, key_buffer_size,
2913 alg, hash, hash_length,
2914 signature, signature_size, signature_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01002915#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2916 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Ronald Cron4501c982021-03-19 20:09:32 +01002917 }
2918 else
2919 {
2920 return( PSA_ERROR_INVALID_ARGUMENT );
2921 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002922 }
Ronald Cron4501c982021-03-19 20:09:32 +01002923
2924 (void)key_buffer;
2925 (void)key_buffer_size;
2926 (void)hash;
2927 (void)hash_length;
2928 (void)signature;
2929 (void)signature_size;
2930 (void)signature_length;
2931
2932 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01002933}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002934
2935psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
2936 psa_algorithm_t alg,
2937 const uint8_t *hash,
2938 size_t hash_length,
2939 uint8_t *signature,
2940 size_t signature_size,
2941 size_t *signature_length )
2942{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002943 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02002944 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01002945 signature, signature_size, signature_length );
itayzafrir5c753392018-05-08 11:18:38 +03002946}
2947
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002948psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002949 const psa_key_attributes_t *attributes,
2950 const uint8_t *key_buffer, size_t key_buffer_size,
2951 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
2952 const uint8_t *signature, size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03002953{
Ronald Cron99b8ed72021-02-17 10:33:32 +01002954 if( PSA_KEY_TYPE_IS_RSA( attributes->core.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03002955 {
Ronald Cron4501c982021-03-19 20:09:32 +01002956 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) ||
2957 PSA_ALG_IS_RSA_PSS( alg) )
Steven Cooremanacda8342020-07-24 23:09:52 +02002958 {
Ronald Cron4501c982021-03-19 20:09:32 +01002959#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
2960 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2961 return( mbedtls_psa_rsa_verify_hash(
Ronald Cron072722c2020-12-09 16:36:19 +01002962 attributes,
2963 key_buffer, key_buffer_size,
2964 alg, hash, hash_length,
2965 signature, signature_length ) );
Ronald Cron4501c982021-03-19 20:09:32 +01002966#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
2967 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Steven Cooremanacda8342020-07-24 23:09:52 +02002968 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002969 else
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002970 {
Ronald Cron8a494f32021-02-17 09:49:51 +01002971 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02002972 }
itayzafrir5c753392018-05-08 11:18:38 +03002973 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01002974 else
Ronald Cron4501c982021-03-19 20:09:32 +01002975 if( PSA_KEY_TYPE_IS_ECC( attributes->core.type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01002976 {
Ronald Cron4501c982021-03-19 20:09:32 +01002977 if( PSA_ALG_IS_ECDSA( alg ) )
2978 {
2979#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
2980 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
2981 return( mbedtls_psa_ecdsa_verify_hash(
2982 attributes,
2983 key_buffer, key_buffer_size,
2984 alg, hash, hash_length,
2985 signature, signature_length ) );
2986#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
2987 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
2988 }
2989 else
2990 {
2991 return( PSA_ERROR_INVALID_ARGUMENT );
2992 }
Ronald Cron8a494f32021-02-17 09:49:51 +01002993 }
Ronald Cron4501c982021-03-19 20:09:32 +01002994
2995 (void)key_buffer;
2996 (void)key_buffer_size;
2997 (void)hash;
2998 (void)hash_length;
2999 (void)signature;
3000 (void)signature_length;
3001
3002 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron18659932020-12-08 16:32:23 +01003003}
3004
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003005psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
3006 psa_algorithm_t alg,
3007 const uint8_t *hash,
3008 size_t hash_length,
3009 const uint8_t *signature,
3010 size_t signature_length )
3011{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003012 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003013 key, 0, alg, hash, hash_length,
Ronald Cron9f17aa42020-12-08 17:07:25 +01003014 signature, signature_length );
Gilles Peskinee59236f2018-01-27 23:32:46 +01003015}
3016
John Durkop0e005192020-10-31 22:06:54 -07003017#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003018static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3019 mbedtls_rsa_context *rsa )
3020{
3021 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3022 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3023 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3024 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3025}
John Durkop0e005192020-10-31 22:06:54 -07003026#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003027
Ronald Croncf56a0a2020-08-04 09:51:30 +02003028psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003029 psa_algorithm_t alg,
3030 const uint8_t *input,
3031 size_t input_length,
3032 const uint8_t *salt,
3033 size_t salt_length,
3034 uint8_t *output,
3035 size_t output_size,
3036 size_t *output_length )
3037{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003040 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003041
Darryl Green5cc689a2018-07-24 15:34:10 +01003042 (void) input;
3043 (void) input_length;
3044 (void) salt;
3045 (void) output;
3046 (void) output_size;
3047
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003048 *output_length = 0;
3049
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003050 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3051 return( PSA_ERROR_INVALID_ARGUMENT );
3052
Ronald Cron5c522922020-11-14 16:35:34 +01003053 status = psa_get_and_lock_transparent_key_slot_with_policy(
3054 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003055 if( status != PSA_SUCCESS )
3056 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003057 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3058 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003059 {
3060 status = PSA_ERROR_INVALID_ARGUMENT;
3061 goto exit;
3062 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003063
John Durkop6ba40d12020-11-10 08:50:04 -08003064#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3065 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003066 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003067 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003068 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003069 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3070 slot->key.data,
3071 slot->key.bytes,
3072 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003073 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003074 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003075
3076 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003077 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003078 status = PSA_ERROR_BUFFER_TOO_SMALL;
3079 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003080 }
John Durkop0e005192020-10-31 22:06:54 -07003081#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003082 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
3083 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003084 status = mbedtls_to_psa_error(
3085 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003086 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003087 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003088 MBEDTLS_RSA_PUBLIC,
3089 input_length,
3090 input,
3091 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003092 }
3093 else
John Durkop0e005192020-10-31 22:06:54 -07003094#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3095#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003096 if( PSA_ALG_IS_RSA_OAEP( alg ) )
3097 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003098 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003099 status = mbedtls_to_psa_error(
3100 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003101 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003102 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003103 MBEDTLS_RSA_PUBLIC,
3104 salt, salt_length,
3105 input_length,
3106 input,
3107 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003108 }
3109 else
John Durkop0e005192020-10-31 22:06:54 -07003110#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003111 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003112 status = PSA_ERROR_INVALID_ARGUMENT;
3113 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003114 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003115rsa_exit:
3116 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003117 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003118
Steven Cooremana2371e52020-07-28 14:30:39 +02003119 mbedtls_rsa_free( rsa );
3120 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003121 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003122 else
John Durkop9814fa22020-11-04 12:28:15 -08003123#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003124 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003125 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003126 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003127 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003128
3129exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003130 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003131
Ronald Cron5c522922020-11-14 16:35:34 +01003132 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003133}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003134
Ronald Croncf56a0a2020-08-04 09:51:30 +02003135psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003136 psa_algorithm_t alg,
3137 const uint8_t *input,
3138 size_t input_length,
3139 const uint8_t *salt,
3140 size_t salt_length,
3141 uint8_t *output,
3142 size_t output_size,
3143 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003144{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003145 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003146 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003147 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003148
Darryl Green5cc689a2018-07-24 15:34:10 +01003149 (void) input;
3150 (void) input_length;
3151 (void) salt;
3152 (void) output;
3153 (void) output_size;
3154
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003155 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003156
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003157 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3158 return( PSA_ERROR_INVALID_ARGUMENT );
3159
Ronald Cron5c522922020-11-14 16:35:34 +01003160 status = psa_get_and_lock_transparent_key_slot_with_policy(
3161 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003162 if( status != PSA_SUCCESS )
3163 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003164 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003165 {
3166 status = PSA_ERROR_INVALID_ARGUMENT;
3167 goto exit;
3168 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003169
John Durkop6ba40d12020-11-10 08:50:04 -08003170#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3171 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003172 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003173 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003174 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003175 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3176 slot->key.data,
3177 slot->key.bytes,
3178 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003179 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003180 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181
Steven Cooremana2371e52020-07-28 14:30:39 +02003182 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003183 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003184 status = PSA_ERROR_INVALID_ARGUMENT;
3185 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003186 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003187
John Durkop0e005192020-10-31 22:06:54 -07003188#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003189 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003190 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003191 status = mbedtls_to_psa_error(
3192 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003193 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003194 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003195 MBEDTLS_RSA_PRIVATE,
3196 output_length,
3197 input,
3198 output,
3199 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003200 }
3201 else
John Durkop0e005192020-10-31 22:06:54 -07003202#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3203#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003204 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003205 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003206 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003207 status = mbedtls_to_psa_error(
3208 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003209 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003210 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003211 MBEDTLS_RSA_PRIVATE,
3212 salt, salt_length,
3213 output_length,
3214 input,
3215 output,
3216 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003217 }
3218 else
John Durkop0e005192020-10-31 22:06:54 -07003219#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003220 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003221 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003222 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003223
Steven Cooreman4fed4552020-08-03 14:46:03 +02003224rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003225 mbedtls_rsa_free( rsa );
3226 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003227 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003228 else
John Durkop6ba40d12020-11-10 08:50:04 -08003229#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3230 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003231 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003232 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003233 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003234
3235exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003236 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003237
Ronald Cron5c522922020-11-14 16:35:34 +01003238 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003239}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003240
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003241
3242
mohammad1603503973b2018-03-12 15:59:30 +02003243/****************************************************************/
3244/* Symmetric cryptography */
3245/****************************************************************/
3246
Ronald Cronab99ac22020-10-01 16:38:28 +02003247static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
3248 mbedtls_svc_key_id_t key,
3249 psa_algorithm_t alg,
3250 mbedtls_operation_t cipher_operation )
3251{
3252 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3253 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3254 psa_key_slot_t *slot;
3255 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3256 PSA_KEY_USAGE_ENCRYPT :
3257 PSA_KEY_USAGE_DECRYPT );
3258
3259 /* A context must be freshly initialized before it can be set up. */
Ronald Cron49fafa92021-03-10 08:34:23 +01003260 if( operation->id != 0 )
Ronald Cronab99ac22020-10-01 16:38:28 +02003261 return( PSA_ERROR_BAD_STATE );
3262
3263 /* The requested algorithm must be one that can be processed by cipher. */
3264 if( ! PSA_ALG_IS_CIPHER( alg ) )
3265 return( PSA_ERROR_INVALID_ARGUMENT );
3266
3267 /* Fetch key material from key storage. */
3268 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
3269 if( status != PSA_SUCCESS )
3270 goto exit;
3271
Ronald Cron49fafa92021-03-10 08:34:23 +01003272 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003273 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003274 * so we only set it (in the driver wrapper) after resources have been
3275 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003276 operation->iv_set = 0;
Ronald Cronab99ac22020-10-01 16:38:28 +02003277 if( alg == PSA_ALG_ECB_NO_PADDING )
3278 operation->iv_required = 0;
3279 else
3280 operation->iv_required = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003281 operation->default_iv_length = PSA_CIPHER_IV_LENGTH( slot->attr.type, alg );
Ronald Cronab99ac22020-10-01 16:38:28 +02003282
Ronald Crona4af55f2020-12-14 14:36:06 +01003283 psa_key_attributes_t attributes = {
3284 .core = slot->attr
3285 };
3286
Ronald Cronab99ac22020-10-01 16:38:28 +02003287 /* Try doing the operation through a driver before using software fallback. */
3288 if( cipher_operation == MBEDTLS_ENCRYPT )
Ronald Crona4af55f2020-12-14 14:36:06 +01003289 status = psa_driver_wrapper_cipher_encrypt_setup( operation,
3290 &attributes,
3291 slot->key.data,
3292 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003293 alg );
3294 else
Ronald Crona4af55f2020-12-14 14:36:06 +01003295 status = psa_driver_wrapper_cipher_decrypt_setup( operation,
3296 &attributes,
3297 slot->key.data,
3298 slot->key.bytes,
Ronald Cronab99ac22020-10-01 16:38:28 +02003299 alg );
3300
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003301exit:
Ronald Cron06aa4422021-03-09 17:32:57 +01003302 if( status != PSA_SUCCESS )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003303 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003304
Ronald Cron5c522922020-11-14 16:35:34 +01003305 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003306
Ronald Cron5c522922020-11-14 16:35:34 +01003307 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003308}
3309
Gilles Peskinefe119512018-07-08 21:39:34 +02003310psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003311 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003312 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003313{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003314 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003315}
3316
Gilles Peskinefe119512018-07-08 21:39:34 +02003317psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003318 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003319 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003320{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003321 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003322}
3323
Gilles Peskinefe119512018-07-08 21:39:34 +02003324psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003325 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003326 size_t iv_size,
3327 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003328{
Ronald Cron6d051732020-10-01 14:10:20 +02003329 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003330
Ronald Cron5618a392021-03-26 09:52:26 +01003331 *iv_length = 0;
3332
Ronald Cron49fafa92021-03-10 08:34:23 +01003333 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003334 {
3335 return( PSA_ERROR_BAD_STATE );
3336 }
3337
Steven Cooreman7df02922020-09-09 15:28:49 +02003338 if( operation->iv_set || ! operation->iv_required )
3339 {
3340 return( PSA_ERROR_BAD_STATE );
3341 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003342
Ronald Cron5618a392021-03-26 09:52:26 +01003343 if( iv_size < operation->default_iv_length )
3344 {
3345 status = PSA_ERROR_BUFFER_TOO_SMALL;
3346 goto exit;
3347 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003348
Ronald Cron5618a392021-03-26 09:52:26 +01003349 status = psa_generate_random( iv, operation->default_iv_length );
3350 if( status != PSA_SUCCESS )
3351 goto exit;
3352
3353 status = psa_driver_wrapper_cipher_set_iv( operation,
3354 iv,
3355 operation->default_iv_length );
3356
3357exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003358 if( status == PSA_SUCCESS )
Ronald Cron5618a392021-03-26 09:52:26 +01003359 {
Steven Cooreman7df02922020-09-09 15:28:49 +02003360 operation->iv_set = 1;
Ronald Cron5618a392021-03-26 09:52:26 +01003361 *iv_length = operation->default_iv_length;
3362 }
Steven Cooreman7df02922020-09-09 15:28:49 +02003363 else
Moran Peker395db872018-05-31 14:07:14 +03003364 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003365
itayzafrir534bd7c2018-08-02 13:56:32 +03003366 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003367}
3368
Gilles Peskinefe119512018-07-08 21:39:34 +02003369psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003370 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02003371 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02003372{
Ronald Cron6d051732020-10-01 14:10:20 +02003373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003374
Ronald Cron49fafa92021-03-10 08:34:23 +01003375 if( operation->id == 0 )
Ronald Cronc45b4af2020-09-29 16:18:05 +02003376 return( PSA_ERROR_BAD_STATE );
Ronald Cronc45b4af2020-09-29 16:18:05 +02003377
Steven Cooreman7df02922020-09-09 15:28:49 +02003378 if( operation->iv_set || ! operation->iv_required )
Steven Cooreman7df02922020-09-09 15:28:49 +02003379 return( PSA_ERROR_BAD_STATE );
Ronald Crona0d68172021-03-26 10:15:08 +01003380
3381 if( iv_length > PSA_CIPHER_IV_MAX_SIZE )
3382 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003383
Ronald Crondd24c9b2020-12-15 14:10:01 +01003384 status = psa_driver_wrapper_cipher_set_iv( operation,
3385 iv,
3386 iv_length );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003387
itayzafrir534bd7c2018-08-02 13:56:32 +03003388 if( status == PSA_SUCCESS )
3389 operation->iv_set = 1;
3390 else
mohammad1603503973b2018-03-12 15:59:30 +02003391 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03003392 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003393}
3394
Gilles Peskinee553c652018-06-04 16:22:46 +02003395psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
3396 const uint8_t *input,
3397 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01003398 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02003399 size_t output_size,
3400 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003401{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003403
Ronald Cron49fafa92021-03-10 08:34:23 +01003404 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003405 {
3406 return( PSA_ERROR_BAD_STATE );
3407 }
3408 if( operation->iv_required && ! operation->iv_set )
3409 {
3410 return( PSA_ERROR_BAD_STATE );
3411 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003412
Ronald Crondd24c9b2020-12-15 14:10:01 +01003413 status = psa_driver_wrapper_cipher_update( operation,
3414 input,
3415 input_length,
3416 output,
3417 output_size,
3418 output_length );
itayzafrir534bd7c2018-08-02 13:56:32 +03003419 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02003420 psa_cipher_abort( operation );
Ronald Cron6d051732020-10-01 14:10:20 +02003421
itayzafrir534bd7c2018-08-02 13:56:32 +03003422 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02003423}
3424
Gilles Peskinee553c652018-06-04 16:22:46 +02003425psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
3426 uint8_t *output,
3427 size_t output_size,
3428 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02003429{
David Saadab4ecc272019-02-14 13:48:10 +02003430 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003431
Ronald Cron49fafa92021-03-10 08:34:23 +01003432 if( operation->id == 0 )
Steven Cooreman7df02922020-09-09 15:28:49 +02003433 {
3434 return( PSA_ERROR_BAD_STATE );
3435 }
3436 if( operation->iv_required && ! operation->iv_set )
3437 {
3438 return( PSA_ERROR_BAD_STATE );
3439 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003440
Ronald Crondd24c9b2020-12-15 14:10:01 +01003441 status = psa_driver_wrapper_cipher_finish( operation,
3442 output,
3443 output_size,
3444 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003445 if( status == PSA_SUCCESS )
3446 return( psa_cipher_abort( operation ) );
3447 else
3448 {
3449 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003450 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01003451
Steven Cooremanef8575e2020-09-11 11:44:50 +02003452 return( status );
3453 }
mohammad1603503973b2018-03-12 15:59:30 +02003454}
3455
Gilles Peskinee553c652018-06-04 16:22:46 +02003456psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
3457{
Ronald Cron49fafa92021-03-10 08:34:23 +01003458 if( operation->id == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02003459 {
Steven Cooremana07b9972020-09-10 14:54:14 +02003460 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003461 * in use. It's ok to call abort on such an object, and there's
3462 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003463 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02003464 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003465
Ronald Crondd24c9b2020-12-15 14:10:01 +01003466 psa_driver_wrapper_cipher_abort( operation );
Gilles Peskinee553c652018-06-04 16:22:46 +02003467
Ronald Cron49fafa92021-03-10 08:34:23 +01003468 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003469 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003470 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003471
Moran Peker395db872018-05-31 14:07:14 +03003472 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02003473}
3474
mohammad16035955c982018-04-26 00:53:03 +03003475/****************************************************************/
3476/* AEAD */
3477/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003478
Ronald Croncf56a0a2020-08-04 09:51:30 +02003479psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003480 psa_algorithm_t alg,
3481 const uint8_t *nonce,
3482 size_t nonce_length,
3483 const uint8_t *additional_data,
3484 size_t additional_data_length,
3485 const uint8_t *plaintext,
3486 size_t plaintext_length,
3487 uint8_t *ciphertext,
3488 size_t ciphertext_size,
3489 size_t *ciphertext_length )
3490{
Ronald Cron215633c2021-03-16 17:15:37 +01003491 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3492 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003493
mohammad1603f08a5502018-06-03 15:05:47 +03003494 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003495
Steven Cooremanea7ab132021-03-17 16:28:00 +01003496 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3497 return( PSA_ERROR_NOT_SUPPORTED );
3498
Ronald Cron9a986162021-03-26 12:40:07 +01003499 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003500 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003501 if( status != PSA_SUCCESS )
3502 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003503
Ronald Cron215633c2021-03-16 17:15:37 +01003504 psa_key_attributes_t attributes = {
3505 .core = slot->attr
3506 };
mohammad16035955c982018-04-26 00:53:03 +03003507
Ronald Cronde822812021-03-17 16:08:20 +01003508 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003509 &attributes, slot->key.data, slot->key.bytes,
3510 alg,
3511 nonce, nonce_length,
3512 additional_data, additional_data_length,
3513 plaintext, plaintext_length,
3514 ciphertext, ciphertext_size, ciphertext_length );
Gilles Peskine2d277862018-06-18 15:41:12 +02003515
Gilles Peskineedf9a652018-08-17 18:11:56 +02003516 if( status != PSA_SUCCESS && ciphertext_size != 0 )
3517 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02003518
Ronald Cron9f310172021-03-16 16:36:37 +01003519 psa_unlock_key_slot( slot );
mohammad16035955c982018-04-26 00:53:03 +03003520
mohammad16035955c982018-04-26 00:53:03 +03003521 return( status );
Gilles Peskineee652a32018-06-01 19:23:52 +02003522}
3523
Ronald Croncf56a0a2020-08-04 09:51:30 +02003524psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03003525 psa_algorithm_t alg,
3526 const uint8_t *nonce,
3527 size_t nonce_length,
3528 const uint8_t *additional_data,
3529 size_t additional_data_length,
3530 const uint8_t *ciphertext,
3531 size_t ciphertext_length,
3532 uint8_t *plaintext,
3533 size_t plaintext_size,
3534 size_t *plaintext_length )
3535{
Ronald Cron215633c2021-03-16 17:15:37 +01003536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3537 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003538
Gilles Peskineee652a32018-06-01 19:23:52 +02003539 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003540
Steven Cooremanea7ab132021-03-17 16:28:00 +01003541 if( !PSA_ALG_IS_AEAD( alg ) || PSA_ALG_IS_WILDCARD( alg ) )
3542 return( PSA_ERROR_NOT_SUPPORTED );
3543
Ronald Cron9a986162021-03-26 12:40:07 +01003544 status = psa_get_and_lock_key_slot_with_policy(
Ronald Cron215633c2021-03-16 17:15:37 +01003545 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003546 if( status != PSA_SUCCESS )
3547 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003548
Ronald Cron215633c2021-03-16 17:15:37 +01003549 psa_key_attributes_t attributes = {
3550 .core = slot->attr
3551 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003552
Ronald Cronde822812021-03-17 16:08:20 +01003553 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003554 &attributes, slot->key.data, slot->key.bytes,
3555 alg,
3556 nonce, nonce_length,
3557 additional_data, additional_data_length,
3558 ciphertext, ciphertext_length,
3559 plaintext, plaintext_size, plaintext_length );
Gilles Peskinea40d7742018-06-01 16:28:30 +02003560
Gilles Peskineedf9a652018-08-17 18:11:56 +02003561 if( status != PSA_SUCCESS && plaintext_size != 0 )
3562 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03003563
Ronald Cron215633c2021-03-16 17:15:37 +01003564 psa_unlock_key_slot( slot );
3565
Gilles Peskineedf9a652018-08-17 18:11:56 +02003566 return( status );
mohammad16035955c982018-04-26 00:53:03 +03003567}
3568
Gilles Peskinee59236f2018-01-27 23:32:46 +01003569/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003570/* Generators */
3571/****************************************************************/
3572
John Durkop07cc04a2020-11-16 22:08:34 -08003573#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3574 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3575 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3576#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003577#endif /* At least one builtin KDF */
3578
3579#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3580 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3581 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3582static psa_status_t psa_key_derivation_start_hmac(
3583 psa_mac_operation_t *operation,
3584 psa_algorithm_t hash_alg,
3585 const uint8_t *hmac_key,
3586 size_t hmac_key_length )
3587{
3588 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3589 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
3590 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
3591 psa_set_key_bits( &attributes, PSA_BYTES_TO_BITS( hmac_key_length ) );
3592 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_HASH );
3593
Steven Cooreman15f0d922021-05-07 14:14:37 +02003594 operation->is_sign = 1;
3595 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
3596
Steven Cooreman9878a162021-05-06 17:58:36 +02003597 status = psa_driver_wrapper_mac_sign_setup( operation,
3598 &attributes,
3599 hmac_key, hmac_key_length,
3600 PSA_ALG_HMAC( hash_alg ) );
3601
3602 psa_reset_key_attributes( &attributes );
3603 return( status );
3604}
3605#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003606
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003607#define HKDF_STATE_INIT 0 /* no input yet */
3608#define HKDF_STATE_STARTED 1 /* got salt */
3609#define HKDF_STATE_KEYED 2 /* got key */
3610#define HKDF_STATE_OUTPUT 3 /* output started */
3611
Gilles Peskinecbe66502019-05-16 16:59:18 +02003612static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003613 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01003614{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003615 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
3616 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003617 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003618 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003619}
3620
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003621psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003622{
3623 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003624 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01003625 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003626 {
3627 /* The object has (apparently) been initialized but it is not
3628 * in use. It's ok to call abort on such an object, and there's
3629 * nothing to do. */
3630 }
3631 else
John Durkopd0321952020-10-29 21:37:36 -07003632#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003633 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003634 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003635 mbedtls_free( operation->ctx.hkdf.info );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003636 status = psa_mac_abort( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003637 }
John Durkop07cc04a2020-11-16 22:08:34 -08003638 else
3639#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3640#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3641 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3642 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003643 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01003644 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003645 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003646 if( operation->ctx.tls12_prf.secret != NULL )
3647 {
3648 mbedtls_platform_zeroize( operation->ctx.tls12_prf.secret,
3649 operation->ctx.tls12_prf.secret_length );
3650 mbedtls_free( operation->ctx.tls12_prf.secret );
3651 }
3652
Janos Follath6a1d2622019-06-11 10:37:28 +01003653 if( operation->ctx.tls12_prf.seed != NULL )
3654 {
3655 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
3656 operation->ctx.tls12_prf.seed_length );
3657 mbedtls_free( operation->ctx.tls12_prf.seed );
3658 }
3659
3660 if( operation->ctx.tls12_prf.label != NULL )
3661 {
3662 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
3663 operation->ctx.tls12_prf.label_length );
3664 mbedtls_free( operation->ctx.tls12_prf.label );
3665 }
3666
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003667 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01003668
3669 /* We leave the fields Ai and output_block to be erased safely by the
3670 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003671 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003672 else
John Durkop07cc04a2020-11-16 22:08:34 -08003673#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
3674 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02003675 {
3676 status = PSA_ERROR_BAD_STATE;
3677 }
Janos Follath083036a2019-06-11 10:22:26 +01003678 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003679 return( status );
3680}
3681
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003682psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02003683 size_t *capacity)
3684{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003685 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003686 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003687 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003688 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003689 }
3690
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003691 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003692 return( PSA_SUCCESS );
3693}
3694
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003695psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003696 size_t capacity )
3697{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003698 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003699 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003700 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003701 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003702 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003703 return( PSA_SUCCESS );
3704}
3705
John Durkopd0321952020-10-29 21:37:36 -07003706#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003707/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02003708 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02003709static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Steven Cooremanb27e3502021-04-29 19:11:25 +02003710 psa_algorithm_t hash_alg,
3711 uint8_t *output,
3712 size_t output_length )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003713{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003714 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003715 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02003716 psa_status_t status;
3717
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003718 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
3719 return( PSA_ERROR_BAD_STATE );
3720 hkdf->state = HKDF_STATE_OUTPUT;
3721
Gilles Peskinebef7f142018-07-12 17:22:21 +02003722 while( output_length != 0 )
3723 {
3724 /* Copy what remains of the current block */
3725 uint8_t n = hash_length - hkdf->offset_in_block;
3726 if( n > output_length )
3727 n = (uint8_t) output_length;
3728 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
3729 output += n;
3730 output_length -= n;
3731 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02003732 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003733 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02003734 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02003735 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003736 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02003737 * object was corrupted or if this function is called directly
3738 * inside the library. */
3739 if( hkdf->block_number == 0xff )
3740 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003741
3742 /* We need a new block */
3743 ++hkdf->block_number;
3744 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02003745
Steven Cooreman9878a162021-05-06 17:58:36 +02003746 status = psa_key_derivation_start_hmac( &hkdf->hmac,
3747 hash_alg,
3748 hkdf->prk,
3749 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003750 if( status != PSA_SUCCESS )
3751 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003752
Gilles Peskinebef7f142018-07-12 17:22:21 +02003753 if( hkdf->block_number != 1 )
3754 {
Steven Cooremanb27e3502021-04-29 19:11:25 +02003755 status = psa_mac_update( &hkdf->hmac,
3756 hkdf->output_block,
3757 hash_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003758 if( status != PSA_SUCCESS )
3759 return( status );
3760 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02003761 status = psa_mac_update( &hkdf->hmac,
3762 hkdf->info,
3763 hkdf->info_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003764 if( status != PSA_SUCCESS )
3765 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003766 status = psa_mac_update( &hkdf->hmac,
3767 &hkdf->block_number, 1 );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003768 if( status != PSA_SUCCESS )
3769 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02003770 status = psa_mac_sign_finish( &hkdf->hmac,
3771 hkdf->output_block,
3772 sizeof( hkdf->output_block ),
3773 &hmac_output_length );
Gilles Peskinebef7f142018-07-12 17:22:21 +02003774 if( status != PSA_SUCCESS )
3775 return( status );
3776 }
3777
3778 return( PSA_SUCCESS );
3779}
John Durkop07cc04a2020-11-16 22:08:34 -08003780#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003781
John Durkop07cc04a2020-11-16 22:08:34 -08003782#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3783 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01003784static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
3785 psa_tls12_prf_key_derivation_t *tls12_prf,
3786 psa_algorithm_t alg )
3787{
3788 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003789 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003790 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
3791 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01003792 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003793
Janos Follath7742fee2019-06-17 12:58:10 +01003794 /* We can't be wanting more output after block 0xff, otherwise
3795 * the capacity check in psa_key_derivation_output_bytes() would have
3796 * prevented this call. It could happen only if the operation
3797 * object was corrupted or if this function is called directly
3798 * inside the library. */
3799 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01003800 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01003801
3802 /* We need a new block */
3803 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01003804 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01003805
3806 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
3807 *
3808 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
3809 *
3810 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
3811 * HMAC_hash(secret, A(2) + seed) +
3812 * HMAC_hash(secret, A(3) + seed) + ...
3813 *
3814 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01003815 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01003816 *
Janos Follathea29bfb2019-06-19 12:21:20 +01003817 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01003818 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01003819 * is currently extracted as `output_block` and where i is
3820 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01003821 */
3822
Steven Cooreman9878a162021-05-06 17:58:36 +02003823 status = psa_key_derivation_start_hmac( &hmac,
3824 hash_alg,
3825 tls12_prf->secret,
3826 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003827 if( status != PSA_SUCCESS )
3828 goto cleanup;
3829
3830 /* Calculate A(i) where i = tls12_prf->block_number. */
3831 if( tls12_prf->block_number == 1 )
3832 {
3833 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
3834 * the variable seed and in this instance means it in the context of the
3835 * P_hash function, where seed = label + seed.) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003836 status = psa_mac_update( &hmac,
3837 tls12_prf->label,
3838 tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003839 if( status != PSA_SUCCESS )
3840 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003841 status = psa_mac_update( &hmac,
3842 tls12_prf->seed,
3843 tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003844 if( status != PSA_SUCCESS )
3845 goto cleanup;
3846 }
3847 else
3848 {
3849 /* A(i) = HMAC_hash(secret, A(i-1)) */
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003850 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003851 if( status != PSA_SUCCESS )
3852 goto cleanup;
3853 }
3854
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003855 status = psa_mac_sign_finish( &hmac,
3856 tls12_prf->Ai, hash_length,
3857 &hmac_output_length );
3858 if( hmac_output_length != hash_length )
3859 status = PSA_ERROR_CORRUPTION_DETECTED;
Janos Follathea29bfb2019-06-19 12:21:20 +01003860 if( status != PSA_SUCCESS )
3861 goto cleanup;
3862
3863 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Steven Cooreman9878a162021-05-06 17:58:36 +02003864 status = psa_key_derivation_start_hmac( &hmac,
3865 hash_alg,
3866 tls12_prf->secret,
3867 tls12_prf->secret_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003868 if( status != PSA_SUCCESS )
3869 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003870 status = psa_mac_update( &hmac, tls12_prf->Ai, hash_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003871 if( status != PSA_SUCCESS )
3872 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003873 status = psa_mac_update( &hmac, tls12_prf->label, tls12_prf->label_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003874 if( status != PSA_SUCCESS )
3875 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003876 status = psa_mac_update( &hmac, tls12_prf->seed, tls12_prf->seed_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003877 if( status != PSA_SUCCESS )
3878 goto cleanup;
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003879 status = psa_mac_sign_finish( &hmac,
3880 tls12_prf->output_block, hash_length,
3881 &hmac_output_length );
Janos Follathea29bfb2019-06-19 12:21:20 +01003882 if( status != PSA_SUCCESS )
3883 goto cleanup;
3884
Janos Follath7742fee2019-06-17 12:58:10 +01003885
3886cleanup:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003887 cleanup_status = psa_mac_abort( &hmac );
Janos Follathea29bfb2019-06-19 12:21:20 +01003888 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
3889 status = cleanup_status;
3890
3891 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01003892}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003893
Janos Follath844eb0e2019-06-19 12:10:49 +01003894static psa_status_t psa_key_derivation_tls12_prf_read(
3895 psa_tls12_prf_key_derivation_t *tls12_prf,
3896 psa_algorithm_t alg,
3897 uint8_t *output,
3898 size_t output_length )
3899{
3900 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003901 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01003902 psa_status_t status;
3903 uint8_t offset, length;
3904
Gilles Peskinef216f0d2021-06-11 22:41:46 +02003905 switch( tls12_prf->state )
3906 {
3907 case PSA_TLS12_PRF_STATE_LABEL_SET:
3908 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
3909 break;
3910 case PSA_TLS12_PRF_STATE_OUTPUT:
3911 break;
3912 default:
3913 return( PSA_ERROR_BAD_STATE );
3914 }
3915
Janos Follath844eb0e2019-06-19 12:10:49 +01003916 while( output_length != 0 )
3917 {
3918 /* Check if we have fully processed the current block. */
3919 if( tls12_prf->left_in_block == 0 )
3920 {
3921 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
3922 alg );
3923 if( status != PSA_SUCCESS )
3924 return( status );
3925
3926 continue;
3927 }
3928
3929 if( tls12_prf->left_in_block > output_length )
3930 length = (uint8_t) output_length;
3931 else
3932 length = tls12_prf->left_in_block;
3933
3934 offset = hash_length - tls12_prf->left_in_block;
3935 memcpy( output, tls12_prf->output_block + offset, length );
3936 output += length;
3937 output_length -= length;
3938 tls12_prf->left_in_block -= length;
3939 }
3940
3941 return( PSA_SUCCESS );
3942}
John Durkop07cc04a2020-11-16 22:08:34 -08003943#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
3944 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02003945
Janos Follath6c6c8fc2019-06-17 12:38:20 +01003946psa_status_t psa_key_derivation_output_bytes(
3947 psa_key_derivation_operation_t *operation,
3948 uint8_t *output,
3949 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003950{
3951 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003952 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003953
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003954 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003955 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003956 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02003957 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003958 }
3959
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003960 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003961 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003962 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003963 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003964 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02003965 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003966 goto exit;
3967 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003968 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02003969 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003970 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00003971 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02003972 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
3973 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003974 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02003975 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02003976 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02003977 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003978 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02003979
John Durkopd0321952020-10-29 21:37:36 -07003980#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003981 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02003982 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01003983 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003984 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02003985 output, output_length );
3986 }
Janos Follathadbec812019-06-14 11:05:39 +01003987 else
John Durkop07cc04a2020-11-16 22:08:34 -08003988#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3989#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3990 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01003991 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08003992 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003993 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02003994 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003995 kdf_alg, output,
3996 output_length );
Hanno Beckerc8a41d72018-10-09 17:33:01 +01003997 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02003998 else
John Durkop07cc04a2020-11-16 22:08:34 -08003999#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4000 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004001 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004002 (void) kdf_alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004003 return( PSA_ERROR_BAD_STATE );
4004 }
4005
4006exit:
4007 if( status != PSA_SUCCESS )
4008 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004009 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004010 * This allows us to differentiate between exhausted operations and
4011 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4012 * operations. */
4013 psa_algorithm_t alg = operation->alg;
4014 psa_key_derivation_abort( operation );
4015 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004016 memset( output, '!', output_length );
4017 }
4018 return( status );
4019}
4020
David Brown7807bf72021-02-09 16:28:23 -07004021#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine08542d82018-07-19 17:05:42 +02004022static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
4023{
4024 if( data_size >= 8 )
4025 mbedtls_des_key_set_parity( data );
4026 if( data_size >= 16 )
4027 mbedtls_des_key_set_parity( data + 8 );
4028 if( data_size >= 24 )
4029 mbedtls_des_key_set_parity( data + 16 );
4030}
David Brown7807bf72021-02-09 16:28:23 -07004031#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004032
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004033static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004034 psa_key_slot_t *slot,
4035 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004036 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004037{
4038 uint8_t *data = NULL;
4039 size_t bytes = PSA_BITS_TO_BYTES( bits );
4040 psa_status_t status;
4041
Gilles Peskine8e338702019-07-30 20:06:31 +02004042 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004043 return( PSA_ERROR_INVALID_ARGUMENT );
4044 if( bits % 8 != 0 )
4045 return( PSA_ERROR_INVALID_ARGUMENT );
4046 data = mbedtls_calloc( 1, bytes );
4047 if( data == NULL )
4048 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4049
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004050 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004051 if( status != PSA_SUCCESS )
4052 goto exit;
David Brown12ca5032021-02-11 11:02:00 -07004053#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine8e338702019-07-30 20:06:31 +02004054 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02004055 psa_des_set_key_parity( data, bytes );
David Brown8107e312021-02-12 08:08:46 -07004056#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004057
4058 status = psa_allocate_buffer_to_slot( slot, bytes );
4059 if( status != PSA_SUCCESS )
Paul Elliottda3e7db2021-02-09 18:58:20 +00004060 goto exit;
Ronald Crondd04d422020-11-28 15:14:42 +01004061
Ronald Cronbf33c932020-11-28 18:06:53 +01004062 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004063 psa_key_attributes_t attributes = {
4064 .core = slot->attr
4065 };
4066
Ronald Cronbf33c932020-11-28 18:06:53 +01004067 status = psa_driver_wrapper_import_key( &attributes,
4068 data, bytes,
4069 slot->key.data,
4070 slot->key.bytes,
4071 &slot->key.bytes, &bits );
4072 if( bits != slot->attr.bits )
4073 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004074
4075exit:
4076 mbedtls_free( data );
4077 return( status );
4078}
4079
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004080psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004081 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004082 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004083{
4084 psa_status_t status;
4085 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004086 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004087
Ronald Cron81709fc2020-11-14 12:10:32 +01004088 *key = MBEDTLS_SVC_KEY_ID_INIT;
4089
Gilles Peskine0f84d622019-09-12 19:03:13 +02004090 /* Reject any attempt to create a zero-length key so that we don't
4091 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
4092 if( psa_get_key_bits( attributes ) == 0 )
4093 return( PSA_ERROR_INVALID_ARGUMENT );
4094
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004095 if( ! operation->can_output_key )
4096 return( PSA_ERROR_NOT_PERMITTED );
4097
Ronald Cron81709fc2020-11-14 12:10:32 +01004098 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
4099 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004100#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
4101 if( driver != NULL )
4102 {
4103 /* Deriving a key in a secure element is not implemented yet. */
4104 status = PSA_ERROR_NOT_SUPPORTED;
4105 }
4106#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004107 if( status == PSA_SUCCESS )
4108 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004109 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02004110 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004111 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004112 }
4113 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01004114 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004115 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02004116 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004117
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004118 return( status );
4119}
4120
Gilles Peskineeab56e42018-07-12 17:12:33 +02004121
4122
4123/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004124/* Key derivation */
4125/****************************************************************/
4126
Steven Cooreman932ffb72021-02-15 12:14:32 +01004127#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004128static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004129 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004130 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004131{
John Durkop07cc04a2020-11-16 22:08:34 -08004132 int is_kdf_alg_supported;
4133
Janos Follath5fe19732019-06-20 15:09:30 +01004134 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4135 * initialisers for this union leave some bytes unspecified.) */
4136 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
4137
Gilles Peskine969c5d62019-01-16 15:53:06 +01004138 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07004139#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08004140 if( PSA_ALG_IS_HKDF( kdf_alg ) )
4141 is_kdf_alg_supported = 1;
4142 else
4143#endif
4144#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4145 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
4146 is_kdf_alg_supported = 1;
4147 else
4148#endif
4149#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4150 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
4151 is_kdf_alg_supported = 1;
4152 else
4153#endif
4154 is_kdf_alg_supported = 0;
4155
4156 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004157 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01004158 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004159 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004160 if( hash_size == 0 )
4161 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004162 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
4163 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02004164 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004165 {
4166 return( PSA_ERROR_NOT_SUPPORTED );
4167 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004168 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004169 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004170 }
John Durkop07cc04a2020-11-16 22:08:34 -08004171
4172 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004173}
John Durkop07cc04a2020-11-16 22:08:34 -08004174#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004175
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004176psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004177 psa_algorithm_t alg )
4178{
4179 psa_status_t status;
4180
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004181 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004182 return( PSA_ERROR_BAD_STATE );
4183
Gilles Peskine6843c292019-01-18 16:44:49 +01004184 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
4185 return( PSA_ERROR_INVALID_ARGUMENT );
4186 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004187 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004188#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004189 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004190 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004191#else
4192 return( PSA_ERROR_NOT_SUPPORTED );
4193#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004194 }
4195 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
4196 {
Steven Cooreman932ffb72021-02-15 12:14:32 +01004197#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004198 status = psa_key_derivation_setup_kdf( operation, alg );
Steven Cooreman932ffb72021-02-15 12:14:32 +01004199#else
4200 return( PSA_ERROR_NOT_SUPPORTED );
4201#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004202 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004203 else
4204 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004205
4206 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004207 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004208 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004209}
4210
John Durkopd0321952020-10-29 21:37:36 -07004211#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02004212static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004213 psa_algorithm_t hash_alg,
4214 psa_key_derivation_step_t step,
4215 const uint8_t *data,
4216 size_t data_length )
4217{
4218 psa_status_t status;
4219 switch( step )
4220 {
Gilles Peskine03410b52019-05-16 16:05:19 +02004221 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02004222 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004223 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004224 else
4225 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004226 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4227 hash_alg,
4228 data, data_length );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004229 if( status != PSA_SUCCESS )
4230 return( status );
4231 hkdf->state = HKDF_STATE_STARTED;
4232 return( PSA_SUCCESS );
4233 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004234 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004235 /* If no salt was provided, use an empty salt. */
4236 if( hkdf->state == HKDF_STATE_INIT )
4237 {
Steven Cooreman9878a162021-05-06 17:58:36 +02004238 status = psa_key_derivation_start_hmac( &hkdf->hmac,
4239 hash_alg,
4240 NULL, 0 );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004241 if( status != PSA_SUCCESS )
4242 return( status );
4243 hkdf->state = HKDF_STATE_STARTED;
4244 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02004245 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004246 return( PSA_ERROR_BAD_STATE );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004247 status = psa_mac_update( &hkdf->hmac,
4248 data, data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004249 if( status != PSA_SUCCESS )
4250 return( status );
Steven Cooremanb27e3502021-04-29 19:11:25 +02004251 status = psa_mac_sign_finish( &hkdf->hmac,
4252 hkdf->prk,
4253 sizeof( hkdf->prk ),
4254 &data_length );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004255 if( status != PSA_SUCCESS )
4256 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004257 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02004258 hkdf->block_number = 0;
4259 hkdf->state = HKDF_STATE_KEYED;
4260 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02004261 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004262 if( hkdf->state == HKDF_STATE_OUTPUT )
4263 return( PSA_ERROR_BAD_STATE );
4264 if( hkdf->info_set )
4265 return( PSA_ERROR_BAD_STATE );
4266 hkdf->info_length = data_length;
4267 if( data_length != 0 )
4268 {
4269 hkdf->info = mbedtls_calloc( 1, data_length );
4270 if( hkdf->info == NULL )
4271 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4272 memcpy( hkdf->info, data, data_length );
4273 }
4274 hkdf->info_set = 1;
4275 return( PSA_SUCCESS );
4276 default:
4277 return( PSA_ERROR_INVALID_ARGUMENT );
4278 }
4279}
John Durkop07cc04a2020-11-16 22:08:34 -08004280#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004281
John Durkop07cc04a2020-11-16 22:08:34 -08004282#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4283 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01004284static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
4285 const uint8_t *data,
4286 size_t data_length )
4287{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004288 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01004289 return( PSA_ERROR_BAD_STATE );
4290
Janos Follathd6dce9f2019-07-04 09:11:38 +01004291 if( data_length != 0 )
4292 {
4293 prf->seed = mbedtls_calloc( 1, data_length );
4294 if( prf->seed == NULL )
4295 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01004296
Janos Follathd6dce9f2019-07-04 09:11:38 +01004297 memcpy( prf->seed, data, data_length );
4298 prf->seed_length = data_length;
4299 }
Janos Follathf08e2652019-06-13 09:05:41 +01004300
Gilles Peskine43f958b2020-12-13 14:55:14 +01004301 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004302
4303 return( PSA_SUCCESS );
4304}
4305
Janos Follath81550542019-06-13 14:26:34 +01004306static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
Janos Follath81550542019-06-13 14:26:34 +01004307 const uint8_t *data,
4308 size_t data_length )
4309{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004310 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01004311 return( PSA_ERROR_BAD_STATE );
4312
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004313 if( data_length != 0 )
4314 {
4315 prf->secret = mbedtls_calloc( 1, data_length );
4316 if( prf->secret == NULL )
4317 return( PSA_ERROR_INSUFFICIENT_MEMORY );
4318
4319 memcpy( prf->secret, data, data_length );
4320 prf->secret_length = data_length;
4321 }
Janos Follath81550542019-06-13 14:26:34 +01004322
Gilles Peskine43f958b2020-12-13 14:55:14 +01004323 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004324
4325 return( PSA_SUCCESS );
4326}
4327
Janos Follath63028dd2019-06-13 09:15:47 +01004328static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
4329 const uint8_t *data,
4330 size_t data_length )
4331{
Gilles Peskine43f958b2020-12-13 14:55:14 +01004332 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01004333 return( PSA_ERROR_BAD_STATE );
4334
Janos Follathd6dce9f2019-07-04 09:11:38 +01004335 if( data_length != 0 )
4336 {
4337 prf->label = mbedtls_calloc( 1, data_length );
4338 if( prf->label == NULL )
4339 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01004340
Janos Follathd6dce9f2019-07-04 09:11:38 +01004341 memcpy( prf->label, data, data_length );
4342 prf->label_length = data_length;
4343 }
Janos Follath63028dd2019-06-13 09:15:47 +01004344
Gilles Peskine43f958b2020-12-13 14:55:14 +01004345 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004346
4347 return( PSA_SUCCESS );
4348}
4349
Janos Follathb03233e2019-06-11 15:30:30 +01004350static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004351 psa_key_derivation_step_t step,
4352 const uint8_t *data,
4353 size_t data_length )
4354{
Janos Follathb03233e2019-06-11 15:30:30 +01004355 switch( step )
4356 {
Janos Follathf08e2652019-06-13 09:05:41 +01004357 case PSA_KEY_DERIVATION_INPUT_SEED:
4358 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01004359 case PSA_KEY_DERIVATION_INPUT_SECRET:
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004360 return( psa_tls12_prf_set_key( prf, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01004361 case PSA_KEY_DERIVATION_INPUT_LABEL:
4362 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01004363 default:
4364 return( PSA_ERROR_INVALID_ARGUMENT );
4365 }
4366}
John Durkop07cc04a2020-11-16 22:08:34 -08004367#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4368 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4369
4370#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4371static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4372 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004373 const uint8_t *data,
4374 size_t data_length )
4375{
4376 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004377 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08004378 uint8_t *cur = pms;
4379
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004380 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08004381 return( PSA_ERROR_INVALID_ARGUMENT );
4382
4383 /* Quoting RFC 4279, Section 2:
4384 *
4385 * The premaster secret is formed as follows: if the PSK is N octets
4386 * long, concatenate a uint16 with the value N, N zero octets, a second
4387 * uint16 with the value N, and the PSK itself.
4388 */
4389
4390 *cur++ = ( data_length >> 8 ) & 0xff;
4391 *cur++ = ( data_length >> 0 ) & 0xff;
4392 memset( cur, 0, data_length );
4393 cur += data_length;
4394 *cur++ = pms[0];
4395 *cur++ = pms[1];
4396 memcpy( cur, data, data_length );
4397 cur += data_length;
4398
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004399 status = psa_tls12_prf_set_key( prf, pms, cur - pms );
John Durkop07cc04a2020-11-16 22:08:34 -08004400
4401 mbedtls_platform_zeroize( pms, sizeof( pms ) );
4402 return( status );
4403}
Janos Follath6660f0e2019-06-17 08:44:03 +01004404
4405static psa_status_t psa_tls12_prf_psk_to_ms_input(
4406 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004407 psa_key_derivation_step_t step,
4408 const uint8_t *data,
4409 size_t data_length )
4410{
4411 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01004412 {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004413 return( psa_tls12_prf_psk_to_ms_set_key( prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004414 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01004415 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004416
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004417 return( psa_tls12_prf_input( prf, step, data, data_length ) );
Janos Follath6660f0e2019-06-17 08:44:03 +01004418}
John Durkop07cc04a2020-11-16 22:08:34 -08004419#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004420
Gilles Peskineb8965192019-09-24 16:21:10 +02004421/** Check whether the given key type is acceptable for the given
4422 * input step of a key derivation.
4423 *
4424 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4425 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4426 * Both secret and non-secret inputs can alternatively have the type
4427 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4428 * that the input was passed as a buffer rather than via a key object.
4429 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004430static int psa_key_derivation_check_input_type(
4431 psa_key_derivation_step_t step,
4432 psa_key_type_t key_type )
4433{
4434 switch( step )
4435 {
4436 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02004437 if( key_type == PSA_KEY_TYPE_DERIVE )
4438 return( PSA_SUCCESS );
4439 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004440 return( PSA_SUCCESS );
4441 break;
4442 case PSA_KEY_DERIVATION_INPUT_LABEL:
4443 case PSA_KEY_DERIVATION_INPUT_SALT:
4444 case PSA_KEY_DERIVATION_INPUT_INFO:
4445 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02004446 if( key_type == PSA_KEY_TYPE_RAW_DATA )
4447 return( PSA_SUCCESS );
4448 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02004449 return( PSA_SUCCESS );
4450 break;
4451 }
4452 return( PSA_ERROR_INVALID_ARGUMENT );
4453}
4454
Janos Follathb80a94e2019-06-12 15:54:46 +01004455static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004456 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004457 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004458 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004459 const uint8_t *data,
4460 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004461{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004462 psa_status_t status;
4463 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
4464
4465 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02004466 if( status != PSA_SUCCESS )
4467 goto exit;
4468
John Durkopd0321952020-10-29 21:37:36 -07004469#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004470 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004471 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004472 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004473 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004474 step, data, data_length );
4475 }
John Durkop07cc04a2020-11-16 22:08:34 -08004476 else
4477#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4478#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
4479 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004480 {
Janos Follathb03233e2019-06-11 15:30:30 +01004481 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
Janos Follathb03233e2019-06-11 15:30:30 +01004482 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01004483 }
John Durkop07cc04a2020-11-16 22:08:34 -08004484 else
4485#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4486#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4487 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01004488 {
4489 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004490 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004491 }
4492 else
John Durkop07cc04a2020-11-16 22:08:34 -08004493#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004494 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004495 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004496 (void) data;
4497 (void) data_length;
4498 (void) kdf_alg;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004499 return( PSA_ERROR_BAD_STATE );
4500 }
4501
Gilles Peskine224b0d62019-09-23 18:13:17 +02004502exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004503 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004504 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004505 return( status );
4506}
4507
Janos Follath51f4a0f2019-06-14 11:35:55 +01004508psa_status_t psa_key_derivation_input_bytes(
4509 psa_key_derivation_operation_t *operation,
4510 psa_key_derivation_step_t step,
4511 const uint8_t *data,
4512 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004513{
Gilles Peskineb8965192019-09-24 16:21:10 +02004514 return( psa_key_derivation_input_internal( operation, step,
4515 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01004516 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004517}
4518
Janos Follath51f4a0f2019-06-14 11:35:55 +01004519psa_status_t psa_key_derivation_input_key(
4520 psa_key_derivation_operation_t *operation,
4521 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004522 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004523{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004525 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004526 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004527
Ronald Cron5c522922020-11-14 16:35:34 +01004528 status = psa_get_and_lock_transparent_key_slot_with_policy(
4529 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004530 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02004531 {
4532 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004533 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02004534 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004535
4536 /* Passing a key object as a SECRET input unlocks the permission
4537 * to output to a key object. */
4538 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4539 operation->can_output_key = 1;
4540
Ronald Cronf95a2b12020-10-22 15:24:49 +02004541 status = psa_key_derivation_input_internal( operation,
4542 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004543 slot->key.data,
4544 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004545
Ronald Cron5c522922020-11-14 16:35:34 +01004546 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004547
Ronald Cron5c522922020-11-14 16:35:34 +01004548 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004549}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004550
4551
4552
4553/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004554/* Key agreement */
4555/****************************************************************/
4556
John Durkop6ba40d12020-11-10 08:50:04 -08004557#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004558static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
4559 size_t peer_key_length,
4560 const mbedtls_ecp_keypair *our_key,
4561 uint8_t *shared_secret,
4562 size_t shared_secret_size,
4563 size_t *shared_secret_length )
4564{
Steven Cooremand4867872020-08-05 16:31:39 +02004565 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004566 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004567 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004568 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01004569 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004570 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004571
Ronald Cron90857082020-11-25 14:58:33 +01004572 status = mbedtls_psa_ecp_load_representation(
4573 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004574 bits,
Ronald Cron90857082020-11-25 14:58:33 +01004575 peer_key,
4576 peer_key_length,
4577 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00004578 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004579 goto exit;
4580
Jaeden Amero97271b32019-01-10 19:38:51 +00004581 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02004582 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00004583 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004584 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00004585 status = mbedtls_to_psa_error(
4586 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
4587 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004588 goto exit;
4589
Jaeden Amero97271b32019-01-10 19:38:51 +00004590 status = mbedtls_to_psa_error(
4591 mbedtls_ecdh_calc_secret( &ecdh,
4592 shared_secret_length,
4593 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004594 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004595 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004596 if( status != PSA_SUCCESS )
4597 goto exit;
4598 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
4599 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004600
4601exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01004602 if( status != PSA_SUCCESS )
4603 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004604 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02004605 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02004606 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02004607
Jaeden Amero97271b32019-01-10 19:38:51 +00004608 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004609}
John Durkop6ba40d12020-11-10 08:50:04 -08004610#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004611
Gilles Peskine01d718c2018-09-18 12:01:02 +02004612#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
4613
Gilles Peskine0216fe12019-04-11 21:23:21 +02004614static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
4615 psa_key_slot_t *private_key,
4616 const uint8_t *peer_key,
4617 size_t peer_key_length,
4618 uint8_t *shared_secret,
4619 size_t shared_secret_size,
4620 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004621{
Gilles Peskine0216fe12019-04-11 21:23:21 +02004622 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004623 {
John Durkop6ba40d12020-11-10 08:50:04 -08004624#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02004625 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02004626 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004627 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02004628 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004629 psa_status_t status = mbedtls_psa_ecp_load_representation(
4630 private_key->attr.type,
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +01004631 private_key->attr.bits,
Ronald Cron90857082020-11-25 14:58:33 +01004632 private_key->key.data,
4633 private_key->key.bytes,
4634 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02004635 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02004636 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02004637 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02004638 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02004639 shared_secret, shared_secret_size,
4640 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02004641 mbedtls_ecp_keypair_free( ecp );
4642 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02004643 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08004644#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02004645 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01004646 (void) private_key;
4647 (void) peer_key;
4648 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004649 (void) shared_secret;
4650 (void) shared_secret_size;
4651 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02004652 return( PSA_ERROR_NOT_SUPPORTED );
4653 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02004654}
4655
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004656/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02004657 * to potentially free embedded data structures and wipe confidential data.
4658 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004659static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004660 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02004661 psa_key_slot_t *private_key,
4662 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004663 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02004664{
4665 psa_status_t status;
4666 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
4667 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004668 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02004669
4670 /* Step 1: run the secret agreement algorithm to generate the shared
4671 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02004672 status = psa_key_agreement_raw_internal( ka_alg,
4673 private_key,
4674 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03004675 shared_secret,
4676 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02004677 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02004678 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004679 goto exit;
4680
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004681 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02004682 * the shared secret. A shared secret is permitted wherever a key
4683 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01004684 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004685 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01004686 shared_secret,
4687 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004688exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01004689 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004690 return( status );
4691}
4692
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004693psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004694 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004695 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02004696 const uint8_t *peer_key,
4697 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004698{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004699 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004700 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004701 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004702
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004703 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02004704 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01004705 status = psa_get_and_lock_transparent_key_slot_with_policy(
4706 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02004707 if( status != PSA_SUCCESS )
4708 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004709 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01004710 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01004711 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01004712 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004713 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02004714 else
4715 {
4716 /* If a private key has been added as SECRET, we allow the derived
4717 * key material to be used as a key in PSA Crypto. */
4718 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
4719 operation->can_output_key = 1;
4720 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004721
Ronald Cron5c522922020-11-14 16:35:34 +01004722 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004723
Ronald Cron5c522922020-11-14 16:35:34 +01004724 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02004725}
4726
Gilles Peskinebe697d82019-05-16 18:00:41 +02004727psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004728 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02004729 const uint8_t *peer_key,
4730 size_t peer_key_length,
4731 uint8_t *output,
4732 size_t output_size,
4733 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02004734{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004735 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004736 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004737 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02004738
4739 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
4740 {
4741 status = PSA_ERROR_INVALID_ARGUMENT;
4742 goto exit;
4743 }
Ronald Cron5c522922020-11-14 16:35:34 +01004744 status = psa_get_and_lock_transparent_key_slot_with_policy(
4745 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004746 if( status != PSA_SUCCESS )
4747 goto exit;
4748
4749 status = psa_key_agreement_raw_internal( alg, slot,
4750 peer_key, peer_key_length,
4751 output, output_size,
4752 output_length );
4753
4754exit:
4755 if( status != PSA_SUCCESS )
4756 {
4757 /* If an error happens and is not handled properly, the output
4758 * may be used as a key to protect sensitive data. Arrange for such
4759 * a key to be random, which is likely to result in decryption or
4760 * verification errors. This is better than filling the buffer with
4761 * some constant data such as zeros, which would result in the data
4762 * being protected with a reproducible, easily knowable key.
4763 */
4764 psa_generate_random( output, output_size );
4765 *output_length = output_size;
4766 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004767
Ronald Cron5c522922020-11-14 16:35:34 +01004768 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004769
Ronald Cron5c522922020-11-14 16:35:34 +01004770 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02004771}
Gilles Peskine86a440b2018-11-12 18:39:40 +01004772
4773
Gilles Peskine30524eb2020-11-13 17:02:26 +01004774
Gilles Peskine86a440b2018-11-12 18:39:40 +01004775/****************************************************************/
4776/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02004777/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02004778
Gilles Peskine30524eb2020-11-13 17:02:26 +01004779/** Initialize the PSA random generator.
4780 */
4781static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
4782{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004783#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4784 memset( rng, 0, sizeof( *rng ) );
4785#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4786
Gilles Peskine30524eb2020-11-13 17:02:26 +01004787 /* Set default configuration if
4788 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
4789 if( rng->entropy_init == NULL )
4790 rng->entropy_init = mbedtls_entropy_init;
4791 if( rng->entropy_free == NULL )
4792 rng->entropy_free = mbedtls_entropy_free;
4793
4794 rng->entropy_init( &rng->entropy );
4795#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
4796 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
4797 /* The PSA entropy injection feature depends on using NV seed as an entropy
4798 * source. Add NV seed as an entropy source for PSA entropy injection. */
4799 mbedtls_entropy_add_source( &rng->entropy,
4800 mbedtls_nv_seed_poll, NULL,
4801 MBEDTLS_ENTROPY_BLOCK_SIZE,
4802 MBEDTLS_ENTROPY_SOURCE_STRONG );
4803#endif
4804
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004805 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004806#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004807}
4808
4809/** Deinitialize the PSA random generator.
4810 */
4811static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
4812{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004813#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4814 memset( rng, 0, sizeof( *rng ) );
4815#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004816 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004817 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004818#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004819}
4820
4821/** Seed the PSA random generator.
4822 */
4823static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
4824{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004825#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4826 /* Do nothing: the external RNG seeds itself. */
4827 (void) rng;
4828 return( PSA_SUCCESS );
4829#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004830 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004831 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
4832 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01004833 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004834#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01004835}
4836
Gilles Peskinee59236f2018-01-27 23:32:46 +01004837psa_status_t psa_generate_random( uint8_t *output,
4838 size_t output_size )
4839{
Gilles Peskinee59236f2018-01-27 23:32:46 +01004840 GUARD_MODULE_INITIALIZED;
4841
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004842#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4843
4844 size_t output_length = 0;
4845 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
4846 output, output_size,
4847 &output_length );
4848 if( status != PSA_SUCCESS )
4849 return( status );
4850 /* Breaking up a request into smaller chunks is currently not supported
4851 * for the extrernal RNG interface. */
4852 if( output_length != output_size )
4853 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
4854 return( PSA_SUCCESS );
4855
4856#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4857
Gilles Peskine71ddab92021-01-04 21:01:07 +01004858 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02004859 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01004860 size_t request_size =
4861 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4862 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4863 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004864 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
4865 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02004866 if( ret != 0 )
4867 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01004868 output_size -= request_size;
4869 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02004870 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01004871 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01004872#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01004873}
4874
Gilles Peskine8814fc42020-12-14 15:33:44 +01004875/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004876 *
4877 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
4878 * `psa_generate_random(...)`. The state parameter is ignored since the
4879 * PSA API doesn't support passing an explicit state.
4880 *
4881 * In the non-external case, psa_generate_random() calls an
4882 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
4883 * and semantics as mbedtls_psa_get_random(). As an optimization,
4884 * instead of doing this back-and-forth between the PSA API and the
4885 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
4886 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01004887 */
4888#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4889int mbedtls_psa_get_random( void *p_rng,
4890 unsigned char *output,
4891 size_t output_size )
4892{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01004893 /* This function takes a pointer to the RNG state because that's what
4894 * classic mbedtls functions using an RNG expect. The PSA RNG manages
4895 * its own state internally and doesn't let the caller access that state.
4896 * So we just ignore the state parameter, and in practice we'll pass
4897 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01004898 (void) p_rng;
4899 psa_status_t status = psa_generate_random( output, output_size );
4900 if( status == PSA_SUCCESS )
4901 return( 0 );
4902 else
4903 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
4904}
4905#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4906
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004907#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
4908#include "mbedtls/entropy_poll.h"
4909
Gilles Peskine7228da22019-07-15 11:06:15 +02004910psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004911 size_t seed_size )
4912{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004913 if( global_data.initialized )
4914 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02004915
4916 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
4917 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
4918 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
4919 return( PSA_ERROR_INVALID_ARGUMENT );
4920
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004921 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004922}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01004923#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02004924
Ronald Cron3772afe2021-02-08 16:10:05 +01004925/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02004926 *
Ronald Cron3772afe2021-02-08 16:10:05 +01004927 * \param type The key type
4928 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02004929 *
4930 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01004931 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02004932 * \retval #PSA_ERROR_INVALID_ARGUMENT
4933 * The size in bits of the key is not valid.
4934 * \retval #PSA_ERROR_NOT_SUPPORTED
4935 * The type and/or the size in bits of the key or the combination of
4936 * the two is not supported.
4937 */
Ronald Cron3772afe2021-02-08 16:10:05 +01004938static psa_status_t psa_validate_key_type_and_size_for_key_generation(
4939 psa_key_type_t type, size_t bits )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004940{
Ronald Cronf3bb7612020-10-02 20:11:59 +02004941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01004942
Gilles Peskinee59236f2018-01-27 23:32:46 +01004943 if( key_type_is_raw_bytes( type ) )
4944 {
Ronald Cronf3bb7612020-10-02 20:11:59 +02004945 status = validate_unstructured_key_bit_size( type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004946 if( status != PSA_SUCCESS )
4947 return( status );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004948 }
4949 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004950#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004951 if( PSA_KEY_TYPE_IS_RSA( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4952 {
4953 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
4954 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004955
Ronald Cron01b2aba2020-10-05 09:42:02 +02004956 /* Accept only byte-aligned keys, for the same reasons as
4957 * in psa_import_rsa_key(). */
4958 if( bits % 8 != 0 )
4959 return( PSA_ERROR_NOT_SUPPORTED );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004960 }
4961 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004962#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004963
Ronald Cron5c4d3862020-12-07 11:07:24 +01004964#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Ronald Cron01b2aba2020-10-05 09:42:02 +02004965 if( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
4966 {
Ronald Crond81ab562021-02-16 09:01:16 +01004967 /* To avoid empty block, return successfully here. */
4968 return( PSA_SUCCESS );
Ronald Cron01b2aba2020-10-05 09:42:02 +02004969 }
4970 else
Ronald Cron5c4d3862020-12-07 11:07:24 +01004971#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02004972 {
4973 return( PSA_ERROR_NOT_SUPPORTED );
4974 }
4975
4976 return( PSA_SUCCESS );
4977}
4978
Ronald Cron55ed0592020-10-05 10:30:40 +02004979psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004980 const psa_key_attributes_t *attributes,
4981 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004982{
4983 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004984 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02004985
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004986 if( ( attributes->domain_parameters == NULL ) &&
4987 ( attributes->domain_parameters_size != 0 ) )
Ronald Cron01b2aba2020-10-05 09:42:02 +02004988 return( PSA_ERROR_INVALID_ARGUMENT );
4989
Ronald Cron01b2aba2020-10-05 09:42:02 +02004990 if( key_type_is_raw_bytes( type ) )
4991 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004992 status = psa_generate_random( key_buffer, key_buffer_size );
Gilles Peskinee59236f2018-01-27 23:32:46 +01004993 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01004994 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02004995
David Brown12ca5032021-02-11 11:02:00 -07004996#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskinee59236f2018-01-27 23:32:46 +01004997 if( type == PSA_KEY_TYPE_DES )
Ronald Cron2a38a6b2020-10-02 20:02:04 +02004998 psa_des_set_key_parity( key_buffer, key_buffer_size );
David Brown8107e312021-02-12 08:08:46 -07004999#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005000 }
5001 else
5002
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005003#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5004 defined(MBEDTLS_GENPRIME)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005005 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005006 {
Ronald Cron9e18fc12020-11-05 17:36:40 +01005007 return( mbedtls_psa_rsa_generate_key( attributes,
5008 key_buffer,
5009 key_buffer_size,
5010 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005011 }
5012 else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005013#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5014 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005015
John Durkop9814fa22020-11-04 12:28:15 -08005016#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02005017 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005018 {
Ronald Cron7023db52020-11-20 18:17:42 +01005019 return( mbedtls_psa_ecp_generate_key( attributes,
5020 key_buffer,
5021 key_buffer_size,
5022 key_buffer_length ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005023 }
5024 else
John Durkop9814fa22020-11-04 12:28:15 -08005025#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005026 {
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005027 (void)key_buffer_length;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005028 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02005029 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005030
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005031 return( PSA_SUCCESS );
5032}
Darryl Green0c6575a2018-11-07 16:05:30 +00005033
Gilles Peskine35ef36b2019-05-16 19:42:05 +02005034psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005035 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005036{
5037 psa_status_t status;
5038 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005039 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005040 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005041
Ronald Cron81709fc2020-11-14 12:10:32 +01005042 *key = MBEDTLS_SVC_KEY_ID_INIT;
5043
Gilles Peskine0f84d622019-09-12 19:03:13 +02005044 /* Reject any attempt to create a zero-length key so that we don't
5045 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5046 if( psa_get_key_bits( attributes ) == 0 )
5047 return( PSA_ERROR_INVALID_ARGUMENT );
5048
Ronald Cron81709fc2020-11-14 12:10:32 +01005049 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
5050 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02005051 if( status != PSA_SUCCESS )
5052 goto exit;
5053
Ronald Cron977c2472020-10-13 08:32:21 +02005054 /* In the case of a transparent key or an opaque key stored in local
5055 * storage (thus not in the case of generating a key in a secure element
5056 * or cryptoprocessor with storage), we have to allocate a buffer to
5057 * hold the generated key material. */
5058 if( slot->key.data == NULL )
5059 {
5060 if ( PSA_KEY_LIFETIME_GET_LOCATION( attributes->core.lifetime ) ==
5061 PSA_KEY_LOCATION_LOCAL_STORAGE )
5062 {
Ronald Cron3772afe2021-02-08 16:10:05 +01005063 status = psa_validate_key_type_and_size_for_key_generation(
5064 attributes->core.type, attributes->core.bits );
5065 if( status != PSA_SUCCESS )
5066 goto exit;
5067
5068 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
5069 attributes->core.type,
5070 attributes->core.bits );
Ronald Cron977c2472020-10-13 08:32:21 +02005071 }
5072 else
5073 {
5074 status = psa_driver_wrapper_get_key_buffer_size(
5075 attributes, &key_buffer_size );
Ronald Cron3772afe2021-02-08 16:10:05 +01005076 if( status != PSA_SUCCESS )
5077 goto exit;
Ronald Cron977c2472020-10-13 08:32:21 +02005078 }
Ronald Cron977c2472020-10-13 08:32:21 +02005079
5080 status = psa_allocate_buffer_to_slot( slot, key_buffer_size );
5081 if( status != PSA_SUCCESS )
5082 goto exit;
5083 }
5084
Steven Cooreman2a1664c2020-07-20 15:33:08 +02005085 status = psa_driver_wrapper_generate_key( attributes,
Ronald Cron977c2472020-10-13 08:32:21 +02005086 slot->key.data, slot->key.bytes, &slot->key.bytes );
Gilles Peskine11792082019-08-06 18:36:36 +02005087
Ronald Cron2b56bc82020-10-05 10:02:26 +02005088 if( status != PSA_SUCCESS )
5089 psa_remove_key_data_from_memory( slot );
5090
Gilles Peskine11792082019-08-06 18:36:36 +02005091exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005092 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005093 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005094 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005095 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005096
Darryl Green0c6575a2018-11-07 16:05:30 +00005097 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005098}
5099
Gilles Peskinee59236f2018-01-27 23:32:46 +01005100/****************************************************************/
5101/* Module setup */
5102/****************************************************************/
5103
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005105psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
5106 void (* entropy_init )( mbedtls_entropy_context *ctx ),
5107 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
5108{
5109 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5110 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005111 global_data.rng.entropy_init = entropy_init;
5112 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01005113 return( PSA_SUCCESS );
5114}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005115#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005116
Gilles Peskinee59236f2018-01-27 23:32:46 +01005117void mbedtls_psa_crypto_free( void )
5118{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005119 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005120 if( global_data.rng_state != RNG_NOT_INITIALIZED )
5121 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005122 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005123 }
5124 /* Wipe all remaining data, including configuration.
5125 * In particular, this sets all state indicator to the value
5126 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01005127 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005128#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02005129 /* Unregister all secure element drivers, so that we restart from
5130 * a pristine state. */
5131 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02005132#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005133}
5134
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005135#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5136/** Recover a transaction that was interrupted by a power failure.
5137 *
5138 * This function is called during initialization, before psa_crypto_init()
5139 * returns. If this function returns a failure status, the initialization
5140 * fails.
5141 */
5142static psa_status_t psa_crypto_recover_transaction(
5143 const psa_crypto_transaction_t *transaction )
5144{
5145 switch( transaction->unknown.type )
5146 {
5147 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5148 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01005149 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02005150 * is implemented.
5151 * https://github.com/ARMmbed/mbed-crypto/issues/218
5152 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005153 default:
5154 /* We found an unsupported transaction in the storage.
5155 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01005156 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005157 }
5158}
5159#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5160
Gilles Peskinee59236f2018-01-27 23:32:46 +01005161psa_status_t psa_crypto_init( void )
5162{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005163 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005164
Gilles Peskinec6b69072018-11-20 21:42:52 +01005165 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005166 if( global_data.initialized != 0 )
5167 return( PSA_SUCCESS );
5168
Gilles Peskine30524eb2020-11-13 17:02:26 +01005169 /* Initialize and seed the random generator. */
5170 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01005171 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01005172 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005173 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005174 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005175 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005176
Gilles Peskine66fb1262018-12-10 16:29:04 +01005177 status = psa_initialize_key_slots( );
5178 if( status != PSA_SUCCESS )
5179 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01005180
Gilles Peskined9348f22019-10-01 15:22:29 +02005181#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5182 status = psa_init_all_se_drivers( );
5183 if( status != PSA_SUCCESS )
5184 goto exit;
5185#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
5186
Gilles Peskine4b734222019-07-24 15:56:31 +02005187#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02005188 status = psa_crypto_load_transaction( );
5189 if( status == PSA_SUCCESS )
5190 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005191 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
5192 if( status != PSA_SUCCESS )
5193 goto exit;
5194 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02005195 }
5196 else if( status == PSA_ERROR_DOES_NOT_EXIST )
5197 {
5198 /* There's no transaction to complete. It's all good. */
5199 status = PSA_SUCCESS;
5200 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005201#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005202
Gilles Peskinec6b69072018-11-20 21:42:52 +01005203 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005204 global_data.initialized = 1;
5205
5206exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01005207 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005208 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01005209 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01005210}
5211
5212#endif /* MBEDTLS_PSA_CRYPTO_C */