blob: 411010c6053f27f37d296eabb1c80811d45e49cd [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
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
36#include "psa_crypto_rsa.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020038#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020039#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010040#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010041/* Include internal declarations that are useful for implementing persistently
42 * stored keys. */
43#include "psa_crypto_storage.h"
44
Gilles Peskineb2b64d32020-12-14 16:43:58 +010045#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010046
Gilles Peskineb46bef22019-07-30 21:32:04 +020047#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#include <stdlib.h>
49#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010050#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020051#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#define mbedtls_calloc calloc
53#define mbedtls_free free
54#endif
55
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010056#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020058#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000059#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020060#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/blowfish.h"
62#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020063#include "mbedtls/chacha20.h"
64#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/cipher.h"
66#include "mbedtls/ccm.h"
67#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020069#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010070#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010071#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/error.h"
73#include "mbedtls/gcm.h"
74#include "mbedtls/md2.h"
75#include "mbedtls/md4.h"
76#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010077#include "mbedtls/md.h"
78#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010079#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010081#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000082#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010083#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/sha1.h"
86#include "mbedtls/sha256.h"
87#include "mbedtls/sha512.h"
88#include "mbedtls/xtea.h"
89
Gilles Peskine996deb12018-08-01 15:45:45 +020090#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
91
Gilles Peskine9ef733f2018-02-07 21:05:37 +010092/* constant-time buffer comparison */
93static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
94{
95 size_t i;
96 unsigned char diff = 0;
97
98 for( i = 0; i < n; i++ )
99 diff |= a[i] ^ b[i];
100
101 return( diff );
102}
103
104
105
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100106/****************************************************************/
107/* Global data, support functions and library management */
108/****************************************************************/
109
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200110static int key_type_is_raw_bytes( psa_key_type_t type )
111{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200112 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200113}
114
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100115/* Values for psa_global_data_t::rng_state */
116#define RNG_NOT_INITIALIZED 0
117#define RNG_INITIALIZED 1
118#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100119
Gilles Peskine2d277862018-06-18 15:41:12 +0200120typedef struct
121{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100122 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100123 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100124 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100125} psa_global_data_t;
126
127static psa_global_data_t global_data;
128
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100129#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
130mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
131 &global_data.rng.drbg;
132#endif
133
itayzafrir0adf0fc2018-09-06 16:24:41 +0300134#define GUARD_MODULE_INITIALIZED \
135 if( global_data.initialized == 0 ) \
136 return( PSA_ERROR_BAD_STATE );
137
Steven Cooreman01164162020-07-20 15:31:37 +0200138psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100139{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100140 /* Mbed TLS error codes can combine a high-level error code and a
141 * low-level error code. The low-level error usually reflects the
142 * root cause better, so dispatch on that preferably. */
143 int low_level_ret = - ( -ret & 0x007f );
144 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100145 {
146 case 0:
147 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100148
149 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
150 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
151 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
152 return( PSA_ERROR_NOT_SUPPORTED );
153 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
154 return( PSA_ERROR_HARDWARE_FAILURE );
155
156 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
157 return( PSA_ERROR_HARDWARE_FAILURE );
158
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
160 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
161 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
162 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
163 case MBEDTLS_ERR_ASN1_INVALID_DATA:
164 return( PSA_ERROR_INVALID_ARGUMENT );
165 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
166 return( PSA_ERROR_INSUFFICIENT_MEMORY );
167 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
168 return( PSA_ERROR_BUFFER_TOO_SMALL );
169
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000171 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
173 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
174#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
176 return( PSA_ERROR_NOT_SUPPORTED );
177 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
178 return( PSA_ERROR_HARDWARE_FAILURE );
179
Jaeden Amero93e21112019-02-20 13:57:28 +0000180#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000181 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000182#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
183 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
184#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
186 return( PSA_ERROR_NOT_SUPPORTED );
187 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
188 return( PSA_ERROR_HARDWARE_FAILURE );
189
190 case MBEDTLS_ERR_CCM_BAD_INPUT:
191 return( PSA_ERROR_INVALID_ARGUMENT );
192 case MBEDTLS_ERR_CCM_AUTH_FAILED:
193 return( PSA_ERROR_INVALID_SIGNATURE );
194 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
195 return( PSA_ERROR_HARDWARE_FAILURE );
196
Gilles Peskine26869f22019-05-06 15:25:00 +0200197 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
198 return( PSA_ERROR_INVALID_ARGUMENT );
199
200 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
201 return( PSA_ERROR_BAD_STATE );
202 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204
Gilles Peskinea5905292018-02-07 20:59:33 +0100205 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
206 return( PSA_ERROR_NOT_SUPPORTED );
207 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
208 return( PSA_ERROR_INVALID_ARGUMENT );
209 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
210 return( PSA_ERROR_INSUFFICIENT_MEMORY );
211 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
212 return( PSA_ERROR_INVALID_PADDING );
213 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200214 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100215 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
216 return( PSA_ERROR_INVALID_SIGNATURE );
217 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200218 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100219 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
220 return( PSA_ERROR_HARDWARE_FAILURE );
221
222 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
223 return( PSA_ERROR_HARDWARE_FAILURE );
224
Gilles Peskine82e57d12020-11-13 21:31:17 +0100225#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
226 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100227 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
228 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100229 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
230 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
231 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
232 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
233 return( PSA_ERROR_NOT_SUPPORTED );
234 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
235 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100236#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100237
238 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
239 return( PSA_ERROR_NOT_SUPPORTED );
240 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
Gilles Peskinee59236f2018-01-27 23:32:46 +0100243 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
244 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
245 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
246 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100247
248 case MBEDTLS_ERR_GCM_AUTH_FAILED:
249 return( PSA_ERROR_INVALID_SIGNATURE );
250 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200251 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
253 return( PSA_ERROR_HARDWARE_FAILURE );
254
Gilles Peskine82e57d12020-11-13 21:31:17 +0100255#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
256 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100257 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
258 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100259 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
260 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
261 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
262 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
263 return( PSA_ERROR_NOT_SUPPORTED );
264 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
265 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
266#endif
267
Gilles Peskinea5905292018-02-07 20:59:33 +0100268 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
269 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
270 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
271 return( PSA_ERROR_HARDWARE_FAILURE );
272
273 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
274 return( PSA_ERROR_NOT_SUPPORTED );
275 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_MD_ALLOC_FAILED:
278 return( PSA_ERROR_INSUFFICIENT_MEMORY );
279 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
280 return( PSA_ERROR_STORAGE_FAILURE );
281 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283
Gilles Peskinef76aa772018-10-29 19:24:33 +0100284 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
285 return( PSA_ERROR_STORAGE_FAILURE );
286 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
289 return( PSA_ERROR_INVALID_ARGUMENT );
290 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
293 return( PSA_ERROR_INVALID_ARGUMENT );
294 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
295 return( PSA_ERROR_INVALID_ARGUMENT );
296 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
297 return( PSA_ERROR_INVALID_ARGUMENT );
298 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
299 return( PSA_ERROR_INSUFFICIENT_MEMORY );
300
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100301 case MBEDTLS_ERR_PK_ALLOC_FAILED:
302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
303 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
304 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
305 return( PSA_ERROR_INVALID_ARGUMENT );
306 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100308 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
309 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
312 return( PSA_ERROR_NOT_SUPPORTED );
313 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
314 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
315 return( PSA_ERROR_NOT_PERMITTED );
316 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
317 return( PSA_ERROR_INVALID_ARGUMENT );
318 case MBEDTLS_ERR_PK_INVALID_ALG:
319 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
320 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
321 return( PSA_ERROR_NOT_SUPPORTED );
322 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
323 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
Gilles Peskineff2d2002019-05-06 15:26:23 +0200327 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
330 return( PSA_ERROR_NOT_SUPPORTED );
331
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
333 return( PSA_ERROR_HARDWARE_FAILURE );
334
335 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
336 return( PSA_ERROR_INVALID_ARGUMENT );
337 case MBEDTLS_ERR_RSA_INVALID_PADDING:
338 return( PSA_ERROR_INVALID_PADDING );
339 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
340 return( PSA_ERROR_HARDWARE_FAILURE );
341 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
342 return( PSA_ERROR_INVALID_ARGUMENT );
343 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
344 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200345 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100346 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
347 return( PSA_ERROR_INVALID_SIGNATURE );
348 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
349 return( PSA_ERROR_BUFFER_TOO_SMALL );
350 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100351 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
353 return( PSA_ERROR_NOT_SUPPORTED );
354 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
355 return( PSA_ERROR_HARDWARE_FAILURE );
356
357 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
358 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
359 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
360 return( PSA_ERROR_HARDWARE_FAILURE );
361
362 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
363 return( PSA_ERROR_INVALID_ARGUMENT );
364 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
365 return( PSA_ERROR_HARDWARE_FAILURE );
366
itayzafrir5c753392018-05-08 11:18:38 +0300367 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300368 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300369 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300370 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
371 return( PSA_ERROR_BUFFER_TOO_SMALL );
372 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
373 return( PSA_ERROR_NOT_SUPPORTED );
374 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
375 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
376 return( PSA_ERROR_INVALID_SIGNATURE );
377 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
378 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100379 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
380 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300381 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
382 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100383
Janos Follatha13b9052019-11-22 12:48:59 +0000384 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
385 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300386
Gilles Peskinee59236f2018-01-27 23:32:46 +0100387 default:
David Saadab4ecc272019-02-14 13:48:10 +0200388 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100389 }
390}
391
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200392
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200393
394
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100395/****************************************************************/
396/* Key management */
397/****************************************************************/
398
Gilles Peskine73167e12019-07-12 23:44:37 +0200399#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
400static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
401{
Gilles Peskine8e338702019-07-30 20:06:31 +0200402 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200403}
404#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
405
John Durkop07cc04a2020-11-16 22:08:34 -0800406/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
407 * current test driver in key_management.c is using this function
408 * when accelerators are used for ECC key pair and public key.
409 * Once that dependency is resolved these guards can be removed.
410 */
John Durkop9814fa22020-11-04 12:28:15 -0800411#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800412 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
413 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
414 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100415mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100416 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200417{
418 switch( curve )
419 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100420 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 switch( byte_length )
422 {
423 case PSA_BITS_TO_BYTES( 192 ):
424 return( MBEDTLS_ECP_DP_SECP192R1 );
425 case PSA_BITS_TO_BYTES( 224 ):
426 return( MBEDTLS_ECP_DP_SECP224R1 );
427 case PSA_BITS_TO_BYTES( 256 ):
428 return( MBEDTLS_ECP_DP_SECP256R1 );
429 case PSA_BITS_TO_BYTES( 384 ):
430 return( MBEDTLS_ECP_DP_SECP384R1 );
431 case PSA_BITS_TO_BYTES( 521 ):
432 return( MBEDTLS_ECP_DP_SECP521R1 );
433 default:
434 return( MBEDTLS_ECP_DP_NONE );
435 }
436 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100437
Paul Elliott8ff510a2020-06-02 17:19:28 +0100438 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 switch( byte_length )
440 {
441 case PSA_BITS_TO_BYTES( 256 ):
442 return( MBEDTLS_ECP_DP_BP256R1 );
443 case PSA_BITS_TO_BYTES( 384 ):
444 return( MBEDTLS_ECP_DP_BP384R1 );
445 case PSA_BITS_TO_BYTES( 512 ):
446 return( MBEDTLS_ECP_DP_BP512R1 );
447 default:
448 return( MBEDTLS_ECP_DP_NONE );
449 }
450 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100451
Paul Elliott8ff510a2020-06-02 17:19:28 +0100452 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 switch( byte_length )
454 {
455 case PSA_BITS_TO_BYTES( 255 ):
456 return( MBEDTLS_ECP_DP_CURVE25519 );
457 case PSA_BITS_TO_BYTES( 448 ):
458 return( MBEDTLS_ECP_DP_CURVE448 );
459 default:
460 return( MBEDTLS_ECP_DP_NONE );
461 }
462 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100463
Paul Elliott8ff510a2020-06-02 17:19:28 +0100464 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100465 switch( byte_length )
466 {
467 case PSA_BITS_TO_BYTES( 192 ):
468 return( MBEDTLS_ECP_DP_SECP192K1 );
469 case PSA_BITS_TO_BYTES( 224 ):
470 return( MBEDTLS_ECP_DP_SECP224K1 );
471 case PSA_BITS_TO_BYTES( 256 ):
472 return( MBEDTLS_ECP_DP_SECP256K1 );
473 default:
474 return( MBEDTLS_ECP_DP_NONE );
475 }
476 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100477
Gilles Peskine12313cd2018-06-20 00:20:32 +0200478 default:
479 return( MBEDTLS_ECP_DP_NONE );
480 }
481}
John Durkop9814fa22020-11-04 12:28:15 -0800482#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800483 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
484 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
485 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200486
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200487static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
488 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200489{
490 /* Check that the bit size is acceptable for the key type */
491 switch( type )
492 {
493 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200494 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200495 case PSA_KEY_TYPE_DERIVE:
496 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200497#if defined(MBEDTLS_AES_C)
498 case PSA_KEY_TYPE_AES:
499 if( bits != 128 && bits != 192 && bits != 256 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
501 break;
502#endif
503#if defined(MBEDTLS_CAMELLIA_C)
504 case PSA_KEY_TYPE_CAMELLIA:
505 if( bits != 128 && bits != 192 && bits != 256 )
506 return( PSA_ERROR_INVALID_ARGUMENT );
507 break;
508#endif
509#if defined(MBEDTLS_DES_C)
510 case PSA_KEY_TYPE_DES:
511 if( bits != 64 && bits != 128 && bits != 192 )
512 return( PSA_ERROR_INVALID_ARGUMENT );
513 break;
514#endif
515#if defined(MBEDTLS_ARC4_C)
516 case PSA_KEY_TYPE_ARC4:
517 if( bits < 8 || bits > 2048 )
518 return( PSA_ERROR_INVALID_ARGUMENT );
519 break;
520#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200521#if defined(MBEDTLS_CHACHA20_C)
522 case PSA_KEY_TYPE_CHACHA20:
523 if( bits != 256 )
524 return( PSA_ERROR_INVALID_ARGUMENT );
525 break;
526#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200527 default:
528 return( PSA_ERROR_NOT_SUPPORTED );
529 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200530 if( bits % 8 != 0 )
531 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200532
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200533 return( PSA_SUCCESS );
534}
535
Gilles Peskineb46bef22019-07-30 21:32:04 +0200536/** Return the size of the key in the given slot, in bits.
537 *
538 * \param[in] slot A key slot.
539 *
540 * \return The key size in bits, read from the metadata in the slot.
541 */
542static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
543{
544 return( slot->attr.bits );
545}
546
Steven Cooreman75b74362020-07-28 14:30:13 +0200547/** Try to allocate a buffer to an empty key slot.
548 *
549 * \param[in,out] slot Key slot to attach buffer to.
550 * \param[in] buffer_length Requested size of the buffer.
551 *
552 * \retval #PSA_SUCCESS
553 * The buffer has been successfully allocated.
554 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
555 * Not enough memory was available for allocation.
556 * \retval #PSA_ERROR_ALREADY_EXISTS
557 * Trying to allocate a buffer to a non-empty key slot.
558 */
559static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
560 size_t buffer_length )
561{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100562 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200563 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200564
Ronald Cronea0f8a62020-11-25 17:52:23 +0100565 slot->key.data = mbedtls_calloc( 1, buffer_length );
566 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200567 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200568
Ronald Cronea0f8a62020-11-25 17:52:23 +0100569 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200570 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200571}
572
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200573psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
574 const uint8_t* data,
575 size_t data_length )
576{
577 psa_status_t status = psa_allocate_buffer_to_slot( slot,
578 data_length );
579 if( status != PSA_SUCCESS )
580 return( status );
581
Ronald Cronea0f8a62020-11-25 17:52:23 +0100582 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200583 return( PSA_SUCCESS );
584}
585
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200586/** Import key data into a slot.
587 *
588 * `slot->type` must have been set previously.
589 * This function assumes that the slot does not contain any key material yet.
590 * On failure, the slot content is unchanged.
591 *
592 * Persistent storage is not affected.
593 *
Ronald Crondd04d422020-11-28 15:14:42 +0100594 * \param[in,out] slot The key slot to import data into.
595 * Its `type` field must have previously been set to
596 * the desired key type.
597 * It must not contain any key material yet.
598 * \param[in] data Buffer containing the key material to parse and
599 * import.
600 * \param data_length Size of \p data in bytes.
601 * \param[out] key_buffer The buffer containing the export representation.
602 * \param[in] key_buffer_size The size of \p key_buffer in bytes. The size
603 * is greater or equal to \p data_length.
604 * \param[out] key_buffer_length The length of the data written in \p
605 * key_buffer in bytes.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200606 *
607 * \retval #PSA_SUCCESS
608 * \retval #PSA_ERROR_INVALID_ARGUMENT
609 * \retval #PSA_ERROR_NOT_SUPPORTED
610 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
611 */
612static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
613 const uint8_t *data,
Ronald Crondd04d422020-11-28 15:14:42 +0100614 size_t data_length,
615 uint8_t *key_buffer,
616 size_t key_buffer_size,
617 size_t *key_buffer_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100618{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200619 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200620 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100621
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200622 /* zero-length keys are never supported. */
623 if( data_length == 0 )
624 return( PSA_ERROR_NOT_SUPPORTED );
625
Gilles Peskine8e338702019-07-30 20:06:31 +0200626 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100627 {
Steven Cooreman04524762020-10-13 17:43:44 +0200628 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200629
Steven Cooreman75b74362020-07-28 14:30:13 +0200630 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
631 if( data_length > SIZE_MAX / 8 )
632 return( PSA_ERROR_NOT_SUPPORTED );
633
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200634 /* Enforce a size limit, and in particular ensure that the bit
635 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200636 if( bit_size > PSA_MAX_KEY_BITS )
637 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200638
639 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200640 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200641 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200642
Ronald Crondd04d422020-11-28 15:14:42 +0100643 /* Copy the key material. */
644 memcpy( key_buffer, data, data_length );
645 *key_buffer_length = data_length;
646 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200647
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200648 /* Write the actual key size to the slot.
649 * psa_start_key_creation() wrote the size declared by the
650 * caller, which may be 0 (meaning unspecified) or wrong. */
651 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +0100652
653 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100654 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200655 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200656 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200657 /* Try validation through accelerators first. */
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200658 psa_key_attributes_t attributes = {
659 .core = slot->attr
660 };
Ronald Cron83282872020-11-22 14:02:39 +0100661
Ronald Cron83282872020-11-22 14:02:39 +0100662 bit_size = slot->attr.bits;
663 status = psa_driver_wrapper_import_key( &attributes,
664 data, data_length,
Ronald Crondd04d422020-11-28 15:14:42 +0100665 key_buffer,
666 key_buffer_size,
667 key_buffer_length,
Ronald Cron83282872020-11-22 14:02:39 +0100668 &bit_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200669 if( status == PSA_SUCCESS )
670 {
Ronald Cron83282872020-11-22 14:02:39 +0100671 if( slot->attr.bits == 0 )
672 slot->attr.bits = (psa_key_bits_t) bit_size;
673 else if( bit_size != slot->attr.bits )
674 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200675
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200676 return( PSA_SUCCESS );
677 }
Ronald Cron83282872020-11-22 14:02:39 +0100678 else
679 {
680 if( status != PSA_ERROR_NOT_SUPPORTED )
681 return( status );
682 }
683
Ronald Crondd04d422020-11-28 15:14:42 +0100684 mbedtls_platform_zeroize( key_buffer, key_buffer_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200685
686 /* Key format is not supported by any accelerator, try software fallback
687 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800688#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
689 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200690 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
691 {
Ronald Cronb14dbbe2020-11-22 16:36:49 +0100692 status = mbedtls_psa_ecp_import_key( &attributes,
693 data, data_length,
Ronald Crondd04d422020-11-28 15:14:42 +0100694 key_buffer, key_buffer_size,
695 key_buffer_length,
Ronald Cronb14dbbe2020-11-22 16:36:49 +0100696 &bit_size );
Ronald Cron79cc5482020-11-08 14:54:25 +0100697 slot->attr.bits = (psa_key_bits_t) bit_size;
Ronald Cron13f8b092020-11-29 10:48:58 +0100698 return( status );
Steven Cooreman40120f62020-10-29 11:42:22 +0100699 }
John Durkop9814fa22020-11-04 12:28:15 -0800700#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
701 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700702#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
703 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +0100704 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200705 {
Ronald Cronb6420e32020-11-22 16:15:38 +0100706 status = mbedtls_psa_rsa_import_key( &attributes,
707 data, data_length,
Ronald Crondd04d422020-11-28 15:14:42 +0100708 key_buffer, key_buffer_size,
709 key_buffer_length,
Ronald Cronb6420e32020-11-22 16:15:38 +0100710 &bit_size );
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100711 slot->attr.bits = (psa_key_bits_t) bit_size;
Ronald Cron8f813ee2020-11-07 18:22:09 +0100712 return( status );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200713 }
John Durkop9814fa22020-11-04 12:28:15 -0800714#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
715 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +0100716
717 /* Fell through the fallback as well, so have nothing else to try. */
718 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100719 }
720 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +0100721 {
Steven Cooreman19fd5742020-07-24 23:31:01 +0200722 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100723 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +0100724 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100725}
726
Gilles Peskinef603c712019-01-19 13:40:11 +0100727/** Calculate the intersection of two algorithm usage policies.
728 *
729 * Return 0 (which allows no operation) on incompatibility.
730 */
731static psa_algorithm_t psa_key_policy_algorithm_intersection(
732 psa_algorithm_t alg1,
733 psa_algorithm_t alg2 )
734{
Gilles Peskine549ea862019-05-22 11:45:59 +0200735 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100736 if( alg1 == alg2 )
737 return( alg1 );
738 /* If the policies are from the same hash-and-sign family, check
739 * if one is a wildcard. If so the other has the specific algorithm. */
740 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
741 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
742 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
743 {
744 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
745 return( alg2 );
746 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
747 return( alg1 );
748 }
749 /* If the policies are incompatible, allow nothing. */
750 return( 0 );
751}
752
Gilles Peskined6f371b2019-05-10 19:33:38 +0200753static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
754 psa_algorithm_t requested_alg )
755{
Gilles Peskine549ea862019-05-22 11:45:59 +0200756 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200757 if( requested_alg == policy_alg )
758 return( 1 );
759 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200760 * and requested_alg is the same hash-and-sign family with any hash,
761 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200762 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
763 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
764 {
765 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
766 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
767 }
Steven Cooremance48e852020-10-05 16:02:45 +0200768 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200769 * a key derivation with that key agreement should also be allowed. This
770 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200771 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
772 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
773 {
774 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
775 policy_alg );
776 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200777 /* If it isn't permitted, it's forbidden. */
778 return( 0 );
779}
780
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100781/** Test whether a policy permits an algorithm.
782 *
783 * The caller must test usage flags separately.
784 */
785static int psa_key_policy_permits( const psa_key_policy_t *policy,
786 psa_algorithm_t alg )
787{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200788 return( psa_key_algorithm_permits( policy->alg, alg ) ||
789 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100790}
791
Gilles Peskinef603c712019-01-19 13:40:11 +0100792/** Restrict a key policy based on a constraint.
793 *
794 * \param[in,out] policy The policy to restrict.
795 * \param[in] constraint The policy constraint to apply.
796 *
797 * \retval #PSA_SUCCESS
798 * \c *policy contains the intersection of the original value of
799 * \c *policy and \c *constraint.
800 * \retval #PSA_ERROR_INVALID_ARGUMENT
801 * \c *policy and \c *constraint are incompatible.
802 * \c *policy is unchanged.
803 */
804static psa_status_t psa_restrict_key_policy(
805 psa_key_policy_t *policy,
806 const psa_key_policy_t *constraint )
807{
808 psa_algorithm_t intersection_alg =
809 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 psa_algorithm_t intersection_alg2 =
811 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100812 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
813 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200814 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
815 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100816 policy->usage &= constraint->usage;
817 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200818 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100819 return( PSA_SUCCESS );
820}
821
Ronald Cron5c522922020-11-14 16:35:34 +0100822/** Get the description of a key given its identifier and policy constraints
823 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200824 *
Ronald Cron5c522922020-11-14 16:35:34 +0100825 * The key must have allow all the usage flags set in \p usage. If \p alg is
826 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100827 *
Ronald Cron5c522922020-11-14 16:35:34 +0100828 * In case of a persistent key, the function loads the description of the key
829 * into a key slot if not already done.
830 *
831 * On success, the returned key slot is locked. It is the responsibility of
832 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200833 */
Ronald Cron5c522922020-11-14 16:35:34 +0100834static psa_status_t psa_get_and_lock_key_slot_with_policy(
835 mbedtls_svc_key_id_t key,
836 psa_key_slot_t **p_slot,
837 psa_key_usage_t usage,
838 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100839{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
841 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100842
Ronald Cron5c522922020-11-14 16:35:34 +0100843 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100844 if( status != PSA_SUCCESS )
845 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200846 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100847
848 /* Enforce that usage policy for the key slot contains all the flags
849 * required by the usage parameter. There is one exception: public
850 * keys can always be exported, so we treat public key objects as
851 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200852 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100853 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200854
855 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200856 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200857 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858
859 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200860 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200861 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100862
Darryl Green06fd18d2018-07-16 11:21:11 +0100863 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200864
865error:
866 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100867 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200868
869 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100870}
Darryl Green940d72c2018-07-13 13:18:51 +0100871
Ronald Cron5c522922020-11-14 16:35:34 +0100872/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200873 *
874 * A transparent key is a key for which the key material is directly
875 * available, as opposed to a key in a secure element.
876 *
Ronald Cron5c522922020-11-14 16:35:34 +0100877 * This is a temporary function to use instead of
878 * psa_get_and_lock_key_slot_with_policy() until secure element support is
879 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200880 *
Ronald Cron5c522922020-11-14 16:35:34 +0100881 * On success, the returned key slot is locked. It is the responsibility of the
882 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200883 */
884#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100885static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
886 mbedtls_svc_key_id_t key,
887 psa_key_slot_t **p_slot,
888 psa_key_usage_t usage,
889 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200890{
Ronald Cron5c522922020-11-14 16:35:34 +0100891 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
892 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200893 if( status != PSA_SUCCESS )
894 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895
Gilles Peskineadad8132019-07-25 11:31:23 +0200896 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200897 {
Ronald Cron5c522922020-11-14 16:35:34 +0100898 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200899 *p_slot = NULL;
900 return( PSA_ERROR_NOT_SUPPORTED );
901 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200902
Gilles Peskine28f8f302019-07-24 13:30:31 +0200903 return( PSA_SUCCESS );
904}
905#else /* MBEDTLS_PSA_CRYPTO_SE_C */
906/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100907#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
908 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200909#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
910
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100911/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100912static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000913{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100914 /* Data pointer will always be either a valid pointer or NULL in an
915 * initialized slot, so we can just free it. */
916 if( slot->key.data != NULL )
917 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
918
919 mbedtls_free( slot->key.data );
920 slot->key.data = NULL;
921 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000922
923 return( PSA_SUCCESS );
924}
925
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100926/** Completely wipe a slot in memory, including its policy.
927 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100928psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100929{
930 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100931
932 /*
933 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +0100934 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +0100935 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
936 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +0100937 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +0100938 */
Ronald Cron5c522922020-11-14 16:35:34 +0100939 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100940 {
941#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +0100942 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100943#endif
Ronald Cronddd3d052020-10-30 14:07:07 +0100944 status = PSA_ERROR_CORRUPTION_DETECTED;
945 }
946
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200947 /* Multipart operations may still be using the key. This is safe
948 * because all multipart operation objects are independent from
949 * the key slot: if they need to access the key after the setup
950 * phase, they have a copy of the key. Note that this means that
951 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100952 /* At this point, key material and other type-specific content has
953 * been wiped. Clear remaining metadata. We can call memset and not
954 * zeroize because the metadata is not particularly sensitive. */
955 memset( slot, 0, sizeof( *slot ) );
956 return( status );
957}
958
Ronald Croncf56a0a2020-08-04 09:51:30 +0200959psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100960{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100961 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200962 psa_status_t status; /* status of the last operation */
963 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +0200964#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
965 psa_se_drv_table_entry_t *driver;
966#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100967
Ronald Croncf56a0a2020-08-04 09:51:30 +0200968 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +0200969 return( PSA_SUCCESS );
970
Ronald Cronf2911112020-10-29 17:51:10 +0100971 /*
Ronald Cron19daca92020-11-10 18:08:03 +0100972 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +0100973 * key, this will load the key description from persistent memory if not
974 * done yet. We cannot avoid this loading as without it we don't know if
975 * the key is operated by an SE or not and this information is needed by
976 * the current implementation.
977 */
Ronald Cron5c522922020-11-14 16:35:34 +0100978 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200979 if( status != PSA_SUCCESS )
980 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +0200981
Ronald Cronf2911112020-10-29 17:51:10 +0100982 /*
983 * If the key slot containing the key description is under access by the
984 * library (apart from the present access), the key cannot be destroyed
985 * yet. For the time being, just return in error. Eventually (to be
986 * implemented), the key should be destroyed when all accesses have
987 * stopped.
988 */
Ronald Cron5c522922020-11-14 16:35:34 +0100989 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +0100990 {
Ronald Cron5c522922020-11-14 16:35:34 +0100991 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +0100992 return( PSA_ERROR_GENERIC_ERROR );
993 }
994
Gilles Peskine354f7672019-07-12 23:46:38 +0200995#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200996 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +0200997 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +0200998 {
Gilles Peskine60450a42019-07-25 11:32:45 +0200999 /* For a key in a secure element, we need to do three things:
1000 * remove the key file in internal storage, destroy the
1001 * key inside the secure element, and update the driver's
1002 * persistent data. Start a transaction that will encompass these
1003 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001004 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001005 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001006 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001007 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001008 status = psa_crypto_save_transaction( );
1009 if( status != PSA_SUCCESS )
1010 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001011 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001012 /* We should still try to destroy the key in the secure
1013 * element and the key metadata in storage. This is especially
1014 * important if the error is that the storage is full.
1015 * But how to do it exactly without risking an inconsistent
1016 * state after a reset?
1017 * https://github.com/ARMmbed/mbed-crypto/issues/215
1018 */
1019 overall_status = status;
1020 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001021 }
1022
Ronald Cronea0f8a62020-11-25 17:52:23 +01001023 status = psa_destroy_se_key( driver,
1024 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001025 if( overall_status == PSA_SUCCESS )
1026 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001027 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001028#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1029
Darryl Greend49a4992018-06-18 17:27:26 +01001030#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001031 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001032 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001033 status = psa_destroy_persistent_key( slot->attr.id );
1034 if( overall_status == PSA_SUCCESS )
1035 overall_status = status;
1036
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001037 /* TODO: other slots may have a copy of the same key. We should
1038 * invalidate them.
1039 * https://github.com/ARMmbed/mbed-crypto/issues/214
1040 */
Darryl Greend49a4992018-06-18 17:27:26 +01001041 }
1042#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001043
Gilles Peskinefc762652019-07-22 19:30:34 +02001044#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1045 if( driver != NULL )
1046 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001047 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001048 if( overall_status == PSA_SUCCESS )
1049 overall_status = status;
1050 status = psa_crypto_stop_transaction( );
1051 if( overall_status == PSA_SUCCESS )
1052 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001053 }
1054#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1055
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001056#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1057exit:
1058#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001059 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001060 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1061 if( overall_status == PSA_SUCCESS )
1062 overall_status = status;
1063 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001064}
1065
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001066void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001067{
Gilles Peskineb699f072019-04-26 16:06:02 +02001068 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001069 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001070}
1071
Gilles Peskineb699f072019-04-26 16:06:02 +02001072psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1073 psa_key_type_t type,
1074 const uint8_t *data,
1075 size_t data_length )
1076{
1077 uint8_t *copy = NULL;
1078
1079 if( data_length != 0 )
1080 {
1081 copy = mbedtls_calloc( 1, data_length );
1082 if( copy == NULL )
1083 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1084 memcpy( copy, data, data_length );
1085 }
1086 /* After this point, this function is guaranteed to succeed, so it
1087 * can start modifying `*attributes`. */
1088
1089 if( attributes->domain_parameters != NULL )
1090 {
1091 mbedtls_free( attributes->domain_parameters );
1092 attributes->domain_parameters = NULL;
1093 attributes->domain_parameters_size = 0;
1094 }
1095
1096 attributes->domain_parameters = copy;
1097 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001098 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001099 return( PSA_SUCCESS );
1100}
1101
1102psa_status_t psa_get_key_domain_parameters(
1103 const psa_key_attributes_t *attributes,
1104 uint8_t *data, size_t data_size, size_t *data_length )
1105{
1106 if( attributes->domain_parameters_size > data_size )
1107 return( PSA_ERROR_BUFFER_TOO_SMALL );
1108 *data_length = attributes->domain_parameters_size;
1109 if( attributes->domain_parameters_size != 0 )
1110 memcpy( data, attributes->domain_parameters,
1111 attributes->domain_parameters_size );
1112 return( PSA_SUCCESS );
1113}
1114
John Durkop07cc04a2020-11-16 22:08:34 -08001115#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001116 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001117static psa_status_t psa_get_rsa_public_exponent(
1118 const mbedtls_rsa_context *rsa,
1119 psa_key_attributes_t *attributes )
1120{
1121 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001122 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001123 uint8_t *buffer = NULL;
1124 size_t buflen;
1125 mbedtls_mpi_init( &mpi );
1126
1127 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1128 if( ret != 0 )
1129 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001130 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1131 {
1132 /* It's the default value, which is reported as an empty string,
1133 * so there's nothing to do. */
1134 goto exit;
1135 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001136
1137 buflen = mbedtls_mpi_size( &mpi );
1138 buffer = mbedtls_calloc( 1, buflen );
1139 if( buffer == NULL )
1140 {
1141 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1142 goto exit;
1143 }
1144 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1145 if( ret != 0 )
1146 goto exit;
1147 attributes->domain_parameters = buffer;
1148 attributes->domain_parameters_size = buflen;
1149
1150exit:
1151 mbedtls_mpi_free( &mpi );
1152 if( ret != 0 )
1153 mbedtls_free( buffer );
1154 return( mbedtls_to_psa_error( ret ) );
1155}
John Durkop07cc04a2020-11-16 22:08:34 -08001156#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001157 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001158
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001159/** Retrieve all the publicly-accessible attributes of a key.
1160 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001161psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001162 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001163{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001164 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001165 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001166 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001167
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001168 psa_reset_key_attributes( attributes );
1169
Ronald Cron5c522922020-11-14 16:35:34 +01001170 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001171 if( status != PSA_SUCCESS )
1172 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001173
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001174 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001175 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1176 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1177
1178#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1179 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001180 psa_set_key_slot_number( attributes,
1181 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001182#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001183
Gilles Peskine8e338702019-07-30 20:06:31 +02001184 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001185 {
John Durkop07cc04a2020-11-16 22:08:34 -08001186#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001187 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001188 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001189 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001190#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001191 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001192 * is not yet implemented.
1193 * https://github.com/ARMmbed/mbed-crypto/issues/216
1194 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001195 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001196 break;
1197#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001198 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001199 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001200
Ronald Cron90857082020-11-25 14:58:33 +01001201 status = mbedtls_psa_rsa_load_representation(
1202 slot->attr.type,
1203 slot->key.data,
1204 slot->key.bytes,
1205 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001206 if( status != PSA_SUCCESS )
1207 break;
1208
Steven Cooremana2371e52020-07-28 14:30:39 +02001209 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001210 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001211 mbedtls_rsa_free( rsa );
1212 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001214 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001215#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001216 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001217 default:
1218 /* Nothing else to do. */
1219 break;
1220 }
1221
1222 if( status != PSA_SUCCESS )
1223 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001224
Ronald Cron5c522922020-11-14 16:35:34 +01001225 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001226
Ronald Cron5c522922020-11-14 16:35:34 +01001227 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001228}
1229
Gilles Peskinec8000c02019-08-02 20:15:51 +02001230#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1231psa_status_t psa_get_key_slot_number(
1232 const psa_key_attributes_t *attributes,
1233 psa_key_slot_number_t *slot_number )
1234{
1235 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1236 {
1237 *slot_number = attributes->slot_number;
1238 return( PSA_SUCCESS );
1239 }
1240 else
1241 return( PSA_ERROR_INVALID_ARGUMENT );
1242}
1243#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1244
Ronald Crond18b5f82020-11-25 16:46:05 +01001245static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1246 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001247 uint8_t *data,
1248 size_t data_size,
1249 size_t *data_length )
1250{
Ronald Crond18b5f82020-11-25 16:46:05 +01001251 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001252 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001253 memcpy( data, key_buffer, key_buffer_size );
1254 memset( data + key_buffer_size, 0,
1255 data_size - key_buffer_size );
1256 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001257 return( PSA_SUCCESS );
1258}
1259
Ronald Cron7285cda2020-11-26 14:46:37 +01001260psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001261 const psa_key_attributes_t *attributes,
1262 const uint8_t *key_buffer, size_t key_buffer_size,
1263 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001264{
Ronald Crond18b5f82020-11-25 16:46:05 +01001265 psa_key_type_t type = attributes->core.type;
1266
Ronald Crond18b5f82020-11-25 16:46:05 +01001267 if( key_type_is_raw_bytes( type ) ||
1268 PSA_KEY_TYPE_IS_RSA( type ) ||
1269 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001270 {
1271 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001272 key_buffer, key_buffer_size,
1273 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001274 }
1275 else
1276 {
1277 /* This shouldn't happen in the reference implementation, but
1278 it is valid for a special-purpose implementation to omit
1279 support for exporting certain key types. */
1280 return( PSA_ERROR_NOT_SUPPORTED );
1281 }
1282}
1283
1284psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1285 uint8_t *data,
1286 size_t data_size,
1287 size_t *data_length )
1288{
1289 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1290 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1291 psa_key_slot_t *slot;
1292
1293 /* Set the key to empty now, so that even when there are errors, we always
1294 * set data_length to a value between 0 and data_size. On error, setting
1295 * the key to empty is a good choice because an empty key representation is
1296 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001297 *data_length = 0;
1298
Ronald Cron9486f9d2020-11-26 13:36:23 +01001299 /* Export requires the EXPORT flag. There is an exception for public keys,
1300 * which don't require any flag, but
1301 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1302 */
1303 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1304 PSA_KEY_USAGE_EXPORT, 0 );
1305 if( status != PSA_SUCCESS )
1306 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001307
Gilles Peskinef9168942019-09-12 19:20:29 +02001308 /* Reject a zero-length output buffer now, since this can never be a
1309 * valid key representation. This way we know that data must be a valid
1310 * pointer and we can do things like memset(data, ..., data_size). */
1311 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001312 {
1313 status = PSA_ERROR_BUFFER_TOO_SMALL;
1314 goto exit;
1315 }
1316
Ronald Crond18b5f82020-11-25 16:46:05 +01001317 psa_key_attributes_t attributes = {
1318 .core = slot->attr
1319 };
Ronald Cron67227982020-11-26 15:16:05 +01001320 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001321 slot->key.data, slot->key.bytes,
1322 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001323
1324exit:
1325 unlock_status = psa_unlock_key_slot( slot );
1326
1327 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1328}
1329
Ronald Cron7285cda2020-11-26 14:46:37 +01001330psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001331 const psa_key_attributes_t *attributes,
1332 const uint8_t *key_buffer,
1333 size_t key_buffer_size,
1334 uint8_t *data,
1335 size_t data_size,
1336 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001337{
Ronald Crond18b5f82020-11-25 16:46:05 +01001338 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001339
Ronald Crond18b5f82020-11-25 16:46:05 +01001340 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001341 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001343 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001344 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001345 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001346 key_buffer, key_buffer_size,
1347 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001348 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001349
Ronald Crond18b5f82020-11-25 16:46:05 +01001350 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001351 {
John Durkop0e005192020-10-31 22:06:54 -07001352#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1353 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001354 return( mbedtls_psa_rsa_export_public_key( attributes,
1355 key_buffer,
1356 key_buffer_size,
1357 data,
1358 data_size,
1359 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001360#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001361 /* We don't know how to convert a private RSA key to public. */
1362 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001363#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1364 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001365 }
1366 else
Moran Pekera998bc62018-04-16 18:16:20 +03001367 {
John Durkop6ba40d12020-11-10 08:50:04 -08001368#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1369 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001370 return( mbedtls_psa_ecp_export_public_key( attributes,
1371 key_buffer,
1372 key_buffer_size,
1373 data,
1374 data_size,
1375 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001376#else
1377 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001378 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001379#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1380 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001381 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001382 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001383 else
1384 {
1385 /* This shouldn't happen in the reference implementation, but
1386 it is valid for a special-purpose implementation to omit
1387 support for exporting certain key types. */
1388 return( PSA_ERROR_NOT_SUPPORTED );
1389 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001390}
Ronald Crond18b5f82020-11-25 16:46:05 +01001391
Ronald Croncf56a0a2020-08-04 09:51:30 +02001392psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001393 uint8_t *data,
1394 size_t data_size,
1395 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001396{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001397 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001398 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001399 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001400
1401 /* Set the key to empty now, so that even when there are errors, we always
1402 * set data_length to a value between 0 and data_size. On error, setting
1403 * the key to empty is a good choice because an empty key representation is
1404 * unlikely to be accepted anywhere. */
1405 *data_length = 0;
1406
1407 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001408 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001409 if( status != PSA_SUCCESS )
1410 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001411
Ronald Cron9486f9d2020-11-26 13:36:23 +01001412 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1413 {
1414 status = PSA_ERROR_INVALID_ARGUMENT;
1415 goto exit;
1416 }
1417
1418 /* Reject a zero-length output buffer now, since this can never be a
1419 * valid key representation. This way we know that data must be a valid
1420 * pointer and we can do things like memset(data, ..., data_size). */
1421 if( data_size == 0 )
1422 {
1423 status = PSA_ERROR_BUFFER_TOO_SMALL;
1424 goto exit;
1425 }
1426
Ronald Crond18b5f82020-11-25 16:46:05 +01001427 psa_key_attributes_t attributes = {
1428 .core = slot->attr
1429 };
Ronald Cron67227982020-11-26 15:16:05 +01001430 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 &attributes, slot->key.data, slot->key.bytes,
1432 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001433
1434exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001435 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001436
Ronald Cron5c522922020-11-14 16:35:34 +01001437 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001438}
1439
Gilles Peskine91e8c332019-08-02 19:19:39 +02001440#if defined(static_assert)
1441static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1442 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001443static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001444 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001445static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001446 "One or more key attribute flag is listed as both internal-only and external-only" );
1447#endif
1448
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001449/** Validate that a key policy is internally well-formed.
1450 *
1451 * This function only rejects invalid policies. It does not validate the
1452 * consistency of the policy with respect to other attributes of the key
1453 * such as the key type.
1454 */
1455static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001456{
1457 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001458 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001459 PSA_KEY_USAGE_ENCRYPT |
1460 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001461 PSA_KEY_USAGE_SIGN_HASH |
1462 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001463 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1464 return( PSA_ERROR_INVALID_ARGUMENT );
1465
Gilles Peskine4747d192019-04-17 15:05:45 +02001466 return( PSA_SUCCESS );
1467}
1468
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001469/** Validate the internal consistency of key attributes.
1470 *
1471 * This function only rejects invalid attribute values. If does not
1472 * validate the consistency of the attributes with any key data that may
1473 * be involved in the creation of the key.
1474 *
1475 * Call this function early in the key creation process.
1476 *
1477 * \param[in] attributes Key attributes for the new key.
1478 * \param[out] p_drv On any return, the driver for the key, if any.
1479 * NULL for a transparent key.
1480 *
1481 */
1482static psa_status_t psa_validate_key_attributes(
1483 const psa_key_attributes_t *attributes,
1484 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001485{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001486 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001487 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001488 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001489
Ronald Cron54b90082020-10-29 15:26:43 +01001490 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001491 if( status != PSA_SUCCESS )
1492 return( status );
1493
Ronald Crond2ed4812020-07-17 16:11:30 +02001494 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001495 if( status != PSA_SUCCESS )
1496 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001497
Ronald Cron65f38a32020-10-23 17:11:13 +02001498 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1499 {
1500 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1501 return( PSA_ERROR_INVALID_ARGUMENT );
1502 }
1503 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001504 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001505 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001506 if( status != PSA_SUCCESS )
1507 return( status );
1508 }
1509
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001510 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001511 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001512 return( status );
1513
1514 /* Refuse to create overly large keys.
1515 * Note that this doesn't trigger on import if the attributes don't
1516 * explicitly specify a size (so psa_get_key_bits returns 0), so
1517 * psa_import_key() needs its own checks. */
1518 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1519 return( PSA_ERROR_NOT_SUPPORTED );
1520
Gilles Peskine91e8c332019-08-02 19:19:39 +02001521 /* Reject invalid flags. These should not be reachable through the API. */
1522 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1523 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1524 return( PSA_ERROR_INVALID_ARGUMENT );
1525
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001526 return( PSA_SUCCESS );
1527}
1528
Gilles Peskine4747d192019-04-17 15:05:45 +02001529/** Prepare a key slot to receive key material.
1530 *
1531 * This function allocates a key slot and sets its metadata.
1532 *
1533 * If this function fails, call psa_fail_key_creation().
1534 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001535 * This function is intended to be used as follows:
1536 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001537 * it with the specified attributes, and in case of a volatile key assign it
1538 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001539 * -# Populate the slot with the key material.
1540 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1541 * In case of failure at any step, stop the sequence and call
1542 * psa_fail_key_creation().
1543 *
Ronald Cron5c522922020-11-14 16:35:34 +01001544 * On success, the key slot is locked. It is the responsibility of the caller
1545 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001546 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001547 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001548 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001549 * \param[out] p_slot On success, a pointer to the prepared slot.
1550 * \param[out] p_drv On any return, the driver for the key, if any.
1551 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001552 *
1553 * \retval #PSA_SUCCESS
1554 * The key slot is ready to receive key material.
1555 * \return If this function fails, the key slot is an invalid state.
1556 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001557 */
1558static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001559 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001560 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001561 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001562 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001563{
1564 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001565 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001566 psa_key_slot_t *slot;
1567
Gilles Peskinedf179142019-07-15 22:02:14 +02001568 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001569 *p_drv = NULL;
1570
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001571 status = psa_validate_key_attributes( attributes, p_drv );
1572 if( status != PSA_SUCCESS )
1573 return( status );
1574
Ronald Cronc4d1b512020-07-31 11:26:37 +02001575 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001576 if( status != PSA_SUCCESS )
1577 return( status );
1578 slot = *p_slot;
1579
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001580 /* We're storing the declared bit-size of the key. It's up to each
1581 * creation mechanism to verify that this information is correct.
1582 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001583 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001584 * is optional (import, copy). In case of a volatile key, assign it the
1585 * volatile key identifier associated to the slot returned to contain its
1586 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001587
1588 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001589 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1590 {
1591#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1592 slot->attr.id = volatile_key_id;
1593#else
1594 slot->attr.id.key_id = volatile_key_id;
1595#endif
1596 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001597
Gilles Peskine91e8c332019-08-02 19:19:39 +02001598 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001599 * external-only flags, query `attributes`. Thanks to the check
1600 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001601 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001602 * may have set. */
1603 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001604
Gilles Peskinecbaff462019-07-12 23:46:04 +02001605#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001606 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001607 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001608 * create the key file in internal storage, create the
1609 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001610 * persistent data. This is done by starting a transaction that will
1611 * encompass these three actions.
1612 * For registering a volatile key, we just need to find an appropriate
1613 * slot number inside the SE. Since the key is designated volatile, creating
1614 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001615 /* The first thing to do is to find a slot number for the new key.
1616 * We save the slot number in persistent storage as part of the
1617 * transaction data. It will be needed to recover if the power
1618 * fails during the key creation process, to clean up on the secure
1619 * element side after restarting. Obtaining a slot number from the
1620 * secure element driver updates its persistent state, but we do not yet
1621 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001622 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001623 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001624 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001625 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001626 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001627 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001628 if( status != PSA_SUCCESS )
1629 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001630
1631 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001632 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001633 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1634 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001635 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001636 psa_crypto_transaction.key.id = slot->attr.id;
1637 status = psa_crypto_save_transaction( );
1638 if( status != PSA_SUCCESS )
1639 {
1640 (void) psa_crypto_stop_transaction( );
1641 return( status );
1642 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001643 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001644
1645 status = psa_copy_key_material_into_slot(
1646 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001647 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001648
1649 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1650 {
1651 /* Key registration only makes sense with a secure element. */
1652 return( PSA_ERROR_INVALID_ARGUMENT );
1653 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001654#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1655
Ronald Cronc4d1b512020-07-31 11:26:37 +02001656 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001657}
Gilles Peskine4747d192019-04-17 15:05:45 +02001658
1659/** Finalize the creation of a key once its key material has been set.
1660 *
1661 * This entails writing the key to persistent storage.
1662 *
1663 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001664 * See the documentation of psa_start_key_creation() for the intended use
1665 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001666 *
Ronald Cron5c522922020-11-14 16:35:34 +01001667 * If the finalization succeeds, the function unlocks the key slot (it was
1668 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1669 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001670 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001671 * \param[in,out] slot Pointer to the slot with key material.
1672 * \param[in] driver The secure element driver for the key,
1673 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001674 * \param[out] key On success, identifier of the key. Note that the
1675 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001676 *
1677 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001678 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001679 * \return If this function fails, the key slot is an invalid state.
1680 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001681 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001682static psa_status_t psa_finish_key_creation(
1683 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001684 psa_se_drv_table_entry_t *driver,
1685 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001686{
1687 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001688 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001689 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001690
1691#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001692 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001693 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001694#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1695 if( driver != NULL )
1696 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001697 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001698 psa_key_slot_number_t slot_number =
1699 psa_key_slot_get_slot_number( slot ) ;
1700
Gilles Peskineb46bef22019-07-30 21:32:04 +02001701#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001702 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001703 sizeof( data.slot_number ),
1704 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001705#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001706 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001707 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001708 (uint8_t*) &data,
1709 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001710 }
1711 else
1712#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1713 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001714 /* Key material is saved in export representation in the slot, so
1715 * just pass the slot buffer for storage. */
1716 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001717 slot->key.data,
1718 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001719 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001720 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001721#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1722
Gilles Peskinecbaff462019-07-12 23:46:04 +02001723#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001724 /* Finish the transaction for a key creation. This does not
1725 * happen when registering an existing key. Detect this case
1726 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001727 * creation of a persistent key in a secure element requires a transaction,
1728 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001729 if( driver != NULL &&
1730 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001731 {
1732 status = psa_save_se_persistent_data( driver );
1733 if( status != PSA_SUCCESS )
1734 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001735 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001736 return( status );
1737 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001738 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001739 }
1740#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1741
Ronald Cron50972942020-11-14 11:28:25 +01001742 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001743 {
1744 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001745 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001746 if( status != PSA_SUCCESS )
1747 *key = MBEDTLS_SVC_KEY_ID_INIT;
1748 }
Ronald Cron50972942020-11-14 11:28:25 +01001749
Gilles Peskine4747d192019-04-17 15:05:45 +02001750 return( status );
1751}
1752
1753/** Abort the creation of a key.
1754 *
1755 * You may call this function after calling psa_start_key_creation(),
1756 * or after psa_finish_key_creation() fails. In other circumstances, this
1757 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001758 * See the documentation of psa_start_key_creation() for the intended use
1759 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001760 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001761 * \param[in,out] slot Pointer to the slot with key material.
1762 * \param[in] driver The secure element driver for the key,
1763 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001764 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001765static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001766 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001767{
Gilles Peskine011e4282019-06-26 18:34:38 +02001768 (void) driver;
1769
Gilles Peskine4747d192019-04-17 15:05:45 +02001770 if( slot == NULL )
1771 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001772
1773#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001774 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * element, and the failure happened later (when saving metadata
1776 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001777 * element.
1778 * https://github.com/ARMmbed/mbed-crypto/issues/217
1779 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001780
Gilles Peskined7729582019-08-05 15:55:54 +02001781 /* Abort the ongoing transaction if any (there may not be one if
1782 * the creation process failed before starting one, or if the
1783 * key creation is a registration of a key in a secure element).
1784 * Earlier functions must already have done what it takes to undo any
1785 * partial creation. All that's left is to update the transaction data
1786 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001787 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001788#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1789
Gilles Peskine4747d192019-04-17 15:05:45 +02001790 psa_wipe_key_slot( slot );
1791}
1792
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001793/** Validate optional attributes during key creation.
1794 *
1795 * Some key attributes are optional during key creation. If they are
1796 * specified in the attributes structure, check that they are consistent
1797 * with the data in the slot.
1798 *
1799 * This function should be called near the end of key creation, after
1800 * the slot in memory is fully populated but before saving persistent data.
1801 */
1802static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001803 const psa_key_slot_t *slot,
1804 const psa_key_attributes_t *attributes )
1805{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001806 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001807 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001808 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001809 return( PSA_ERROR_INVALID_ARGUMENT );
1810 }
1811
1812 if( attributes->domain_parameters_size != 0 )
1813 {
John Durkop0e005192020-10-31 22:06:54 -07001814#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1815 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001816 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001817 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001818 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001819 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001820 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001821
Ronald Cron90857082020-11-25 14:58:33 +01001822 psa_status_t status = mbedtls_psa_rsa_load_representation(
1823 slot->attr.type,
1824 slot->key.data,
1825 slot->key.bytes,
1826 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001827 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001828 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001829
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001830 mbedtls_mpi_init( &actual );
1831 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001832 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001833 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001834 mbedtls_rsa_free( rsa );
1835 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001836 if( ret != 0 )
1837 goto rsa_exit;
1838 ret = mbedtls_mpi_read_binary( &required,
1839 attributes->domain_parameters,
1840 attributes->domain_parameters_size );
1841 if( ret != 0 )
1842 goto rsa_exit;
1843 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1844 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1845 rsa_exit:
1846 mbedtls_mpi_free( &actual );
1847 mbedtls_mpi_free( &required );
1848 if( ret != 0)
1849 return( mbedtls_to_psa_error( ret ) );
1850 }
1851 else
John Durkop9814fa22020-11-04 12:28:15 -08001852#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1853 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001854 {
1855 return( PSA_ERROR_INVALID_ARGUMENT );
1856 }
1857 }
1858
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001859 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001860 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001861 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001862 return( PSA_ERROR_INVALID_ARGUMENT );
1863 }
1864
1865 return( PSA_SUCCESS );
1866}
1867
Gilles Peskine4747d192019-04-17 15:05:45 +02001868psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001869 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001870 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001871 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001872{
1873 psa_status_t status;
1874 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001875 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001876
Ronald Cron81709fc2020-11-14 12:10:32 +01001877 *key = MBEDTLS_SVC_KEY_ID_INIT;
1878
Gilles Peskine0f84d622019-09-12 19:03:13 +02001879 /* Reject zero-length symmetric keys (including raw data key objects).
1880 * This also rejects any key which might be encoded as an empty string,
1881 * which is never valid. */
1882 if( data_length == 0 )
1883 return( PSA_ERROR_INVALID_ARGUMENT );
1884
Gilles Peskinedf179142019-07-15 22:02:14 +02001885 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001886 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001887 if( status != PSA_SUCCESS )
1888 goto exit;
1889
Gilles Peskine5d309672019-07-12 23:47:28 +02001890#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1891 if( driver != NULL )
1892 {
1893 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001894 /* The driver should set the number of key bits, however in
1895 * case it doesn't, we initialize bits to an invalid value. */
1896 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001897 if( drv->key_management == NULL ||
1898 drv->key_management->p_import == NULL )
1899 {
1900 status = PSA_ERROR_NOT_SUPPORTED;
1901 goto exit;
1902 }
1903 status = drv->key_management->p_import(
1904 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01001905 psa_key_slot_get_slot_number( slot ),
1906 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001907 if( status != PSA_SUCCESS )
1908 goto exit;
1909 if( bits > PSA_MAX_KEY_BITS )
1910 {
1911 status = PSA_ERROR_NOT_SUPPORTED;
1912 goto exit;
1913 }
1914 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001915 }
1916 else
1917#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01001918 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
1919 {
1920 /* Importing a key with external lifetime through the driver wrapper
1921 * interface is not yet supported. Return as if this was an invalid
1922 * lifetime. */
1923 status = PSA_ERROR_INVALID_ARGUMENT;
1924 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001925 }
1926 else
Gilles Peskine5d309672019-07-12 23:47:28 +02001927 {
Ronald Crondd04d422020-11-28 15:14:42 +01001928 status = psa_allocate_buffer_to_slot( slot, data_length );
1929 if( status != PSA_SUCCESS )
1930 goto exit;
1931
1932 status = psa_import_key_into_slot( slot, data, data_length,
1933 slot->key.data,
1934 slot->key.bytes,
1935 &slot->key.bytes );
Gilles Peskine5d309672019-07-12 23:47:28 +02001936 if( status != PSA_SUCCESS )
1937 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001938 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001939 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001940 if( status != PSA_SUCCESS )
1941 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001942
Ronald Cron81709fc2020-11-14 12:10:32 +01001943 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001944exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001945 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001946 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001947
Gilles Peskine4747d192019-04-17 15:05:45 +02001948 return( status );
1949}
1950
Gilles Peskined7729582019-08-05 15:55:54 +02001951#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1952psa_status_t mbedtls_psa_register_se_key(
1953 const psa_key_attributes_t *attributes )
1954{
1955 psa_status_t status;
1956 psa_key_slot_t *slot = NULL;
1957 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001958 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001959
1960 /* Leaving attributes unspecified is not currently supported.
1961 * It could make sense to query the key type and size from the
1962 * secure element, but not all secure elements support this
1963 * and the driver HAL doesn't currently support it. */
1964 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1965 return( PSA_ERROR_NOT_SUPPORTED );
1966 if( psa_get_key_bits( attributes ) == 0 )
1967 return( PSA_ERROR_NOT_SUPPORTED );
1968
1969 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001970 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001971 if( status != PSA_SUCCESS )
1972 goto exit;
1973
Ronald Cron81709fc2020-11-14 12:10:32 +01001974 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001975
1976exit:
1977 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001978 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001979
Gilles Peskined7729582019-08-05 15:55:54 +02001980 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001981 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001982 return( status );
1983}
1984#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1985
Gilles Peskinef603c712019-01-19 13:40:11 +01001986static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001987 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001988{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001989 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001990 source->key.data,
1991 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001992 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001993 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001994
Steven Cooreman398aee52020-10-13 14:35:45 +02001995 target->attr.type = source->attr.type;
1996 target->attr.bits = source->attr.bits;
1997
1998 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001999}
2000
Ronald Croncf56a0a2020-08-04 09:51:30 +02002001psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002002 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002003 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002004{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002005 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002006 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002007 psa_key_slot_t *source_slot = NULL;
2008 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002009 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002010 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002011
Ronald Cron81709fc2020-11-14 12:10:32 +01002012 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2013
Ronald Cron5c522922020-11-14 16:35:34 +01002014 status = psa_get_and_lock_transparent_key_slot_with_policy(
2015 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002016 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002017 goto exit;
2018
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002019 status = psa_validate_optional_attributes( source_slot,
2020 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 if( status != PSA_SUCCESS )
2022 goto exit;
2023
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002024 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002025 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002026 if( status != PSA_SUCCESS )
2027 goto exit;
2028
Ronald Cron81709fc2020-11-14 12:10:32 +01002029 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2030 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002031 if( status != PSA_SUCCESS )
2032 goto exit;
2033
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002034#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2035 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002036 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002037 /* Copying to a secure element is not implemented yet. */
2038 status = PSA_ERROR_NOT_SUPPORTED;
2039 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002040 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002041#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002042
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002043 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002044 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002045 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002046
Ronald Cron81709fc2020-11-14 12:10:32 +01002047 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002048exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002049 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002050 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002051
Ronald Cron5c522922020-11-14 16:35:34 +01002052 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002053
Ronald Cron5c522922020-11-14 16:35:34 +01002054 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002055}
2056
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002057
2058
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002059/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002060/* Message digests */
2061/****************************************************************/
2062
John Durkop07cc04a2020-11-16 22:08:34 -08002063#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002064 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2065 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002066 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002067static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002068{
2069 switch( alg )
2070 {
John Durkopee4e6602020-11-27 08:48:46 -08002071#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002072 case PSA_ALG_MD2:
2073 return( &mbedtls_md2_info );
2074#endif
John Durkopee4e6602020-11-27 08:48:46 -08002075#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002076 case PSA_ALG_MD4:
2077 return( &mbedtls_md4_info );
2078#endif
John Durkopee4e6602020-11-27 08:48:46 -08002079#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002080 case PSA_ALG_MD5:
2081 return( &mbedtls_md5_info );
2082#endif
John Durkopee4e6602020-11-27 08:48:46 -08002083#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002084 case PSA_ALG_RIPEMD160:
2085 return( &mbedtls_ripemd160_info );
2086#endif
John Durkopee4e6602020-11-27 08:48:46 -08002087#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002088 case PSA_ALG_SHA_1:
2089 return( &mbedtls_sha1_info );
2090#endif
John Durkopee4e6602020-11-27 08:48:46 -08002091#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002092 case PSA_ALG_SHA_224:
2093 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002094#endif
2095#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002096 case PSA_ALG_SHA_256:
2097 return( &mbedtls_sha256_info );
2098#endif
John Durkopee4e6602020-11-27 08:48:46 -08002099#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002100 case PSA_ALG_SHA_384:
2101 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002102#endif
John Durkopee4e6602020-11-27 08:48:46 -08002103#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002104 case PSA_ALG_SHA_512:
2105 return( &mbedtls_sha512_info );
2106#endif
2107 default:
2108 return( NULL );
2109 }
2110}
John Durkop07cc04a2020-11-16 22:08:34 -08002111#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002112 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2113 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2114 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002115
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002116psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2117{
2118 switch( operation->alg )
2119 {
Gilles Peskine81736312018-06-26 15:04:31 +02002120 case 0:
2121 /* The object has (apparently) been initialized but it is not
2122 * in use. It's ok to call abort on such an object, and there's
2123 * nothing to do. */
2124 break;
John Durkopee4e6602020-11-27 08:48:46 -08002125#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002126 case PSA_ALG_MD2:
2127 mbedtls_md2_free( &operation->ctx.md2 );
2128 break;
2129#endif
John Durkopee4e6602020-11-27 08:48:46 -08002130#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002131 case PSA_ALG_MD4:
2132 mbedtls_md4_free( &operation->ctx.md4 );
2133 break;
2134#endif
John Durkopee4e6602020-11-27 08:48:46 -08002135#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002136 case PSA_ALG_MD5:
2137 mbedtls_md5_free( &operation->ctx.md5 );
2138 break;
2139#endif
John Durkopee4e6602020-11-27 08:48:46 -08002140#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002141 case PSA_ALG_RIPEMD160:
2142 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2143 break;
2144#endif
John Durkopee4e6602020-11-27 08:48:46 -08002145#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146 case PSA_ALG_SHA_1:
2147 mbedtls_sha1_free( &operation->ctx.sha1 );
2148 break;
2149#endif
John Durkop6ca23272020-12-03 06:01:32 -08002150#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002151 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002152 mbedtls_sha256_free( &operation->ctx.sha256 );
2153 break;
2154#endif
2155#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002156 case PSA_ALG_SHA_256:
2157 mbedtls_sha256_free( &operation->ctx.sha256 );
2158 break;
2159#endif
John Durkop6ca23272020-12-03 06:01:32 -08002160#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002161 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002162 mbedtls_sha512_free( &operation->ctx.sha512 );
2163 break;
2164#endif
2165#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002166 case PSA_ALG_SHA_512:
2167 mbedtls_sha512_free( &operation->ctx.sha512 );
2168 break;
2169#endif
2170 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002171 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002172 }
2173 operation->alg = 0;
2174 return( PSA_SUCCESS );
2175}
2176
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002177psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002178 psa_algorithm_t alg )
2179{
Janos Follath24eed8d2019-11-22 13:21:35 +00002180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002181
2182 /* A context must be freshly initialized before it can be set up. */
2183 if( operation->alg != 0 )
2184 {
2185 return( PSA_ERROR_BAD_STATE );
2186 }
2187
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188 switch( alg )
2189 {
John Durkopee4e6602020-11-27 08:48:46 -08002190#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002191 case PSA_ALG_MD2:
2192 mbedtls_md2_init( &operation->ctx.md2 );
2193 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2194 break;
2195#endif
John Durkopee4e6602020-11-27 08:48:46 -08002196#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197 case PSA_ALG_MD4:
2198 mbedtls_md4_init( &operation->ctx.md4 );
2199 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2200 break;
2201#endif
John Durkopee4e6602020-11-27 08:48:46 -08002202#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002203 case PSA_ALG_MD5:
2204 mbedtls_md5_init( &operation->ctx.md5 );
2205 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2206 break;
2207#endif
John Durkopee4e6602020-11-27 08:48:46 -08002208#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002209 case PSA_ALG_RIPEMD160:
2210 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2211 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2212 break;
2213#endif
John Durkopee4e6602020-11-27 08:48:46 -08002214#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002215 case PSA_ALG_SHA_1:
2216 mbedtls_sha1_init( &operation->ctx.sha1 );
2217 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2218 break;
2219#endif
John Durkopee4e6602020-11-27 08:48:46 -08002220#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221 case PSA_ALG_SHA_224:
2222 mbedtls_sha256_init( &operation->ctx.sha256 );
2223 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2224 break;
John Durkopee4e6602020-11-27 08:48:46 -08002225#endif
2226#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227 case PSA_ALG_SHA_256:
2228 mbedtls_sha256_init( &operation->ctx.sha256 );
2229 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2230 break;
2231#endif
John Durkopee4e6602020-11-27 08:48:46 -08002232#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233 case PSA_ALG_SHA_384:
2234 mbedtls_sha512_init( &operation->ctx.sha512 );
2235 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2236 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002237#endif
John Durkopee4e6602020-11-27 08:48:46 -08002238#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239 case PSA_ALG_SHA_512:
2240 mbedtls_sha512_init( &operation->ctx.sha512 );
2241 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2242 break;
2243#endif
2244 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002245 return( PSA_ALG_IS_HASH( alg ) ?
2246 PSA_ERROR_NOT_SUPPORTED :
2247 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248 }
2249 if( ret == 0 )
2250 operation->alg = alg;
2251 else
2252 psa_hash_abort( operation );
2253 return( mbedtls_to_psa_error( ret ) );
2254}
2255
2256psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2257 const uint8_t *input,
2258 size_t input_length )
2259{
Janos Follath24eed8d2019-11-22 13:21:35 +00002260 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002261
2262 /* Don't require hash implementations to behave correctly on a
2263 * zero-length input, which may have an invalid pointer. */
2264 if( input_length == 0 )
2265 return( PSA_SUCCESS );
2266
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002267 switch( operation->alg )
2268 {
John Durkopee4e6602020-11-27 08:48:46 -08002269#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270 case PSA_ALG_MD2:
2271 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2272 input, input_length );
2273 break;
2274#endif
John Durkopee4e6602020-11-27 08:48:46 -08002275#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276 case PSA_ALG_MD4:
2277 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2278 input, input_length );
2279 break;
2280#endif
John Durkopee4e6602020-11-27 08:48:46 -08002281#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002282 case PSA_ALG_MD5:
2283 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2284 input, input_length );
2285 break;
2286#endif
John Durkopee4e6602020-11-27 08:48:46 -08002287#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002288 case PSA_ALG_RIPEMD160:
2289 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2290 input, input_length );
2291 break;
2292#endif
John Durkopee4e6602020-11-27 08:48:46 -08002293#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294 case PSA_ALG_SHA_1:
2295 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2296 input, input_length );
2297 break;
2298#endif
John Durkop6ca23272020-12-03 06:01:32 -08002299#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002300 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002301 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2302 input, input_length );
2303 break;
2304#endif
2305#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002306 case PSA_ALG_SHA_256:
2307 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2308 input, input_length );
2309 break;
2310#endif
John Durkop6ca23272020-12-03 06:01:32 -08002311#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002312 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002313 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2314 input, input_length );
2315 break;
2316#endif
2317#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002318 case PSA_ALG_SHA_512:
2319 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2320 input, input_length );
2321 break;
2322#endif
2323 default:
John Durkopee4e6602020-11-27 08:48:46 -08002324 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002325 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002327
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328 if( ret != 0 )
2329 psa_hash_abort( operation );
2330 return( mbedtls_to_psa_error( ret ) );
2331}
2332
2333psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2334 uint8_t *hash,
2335 size_t hash_size,
2336 size_t *hash_length )
2337{
itayzafrir40835d42018-08-02 13:14:17 +03002338 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002339 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002340 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002341
2342 /* Fill the output buffer with something that isn't a valid hash
2343 * (barring an attack on the hash and deliberately-crafted input),
2344 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002345 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002346 /* If hash_size is 0 then hash may be NULL and then the
2347 * call to memset would have undefined behavior. */
2348 if( hash_size != 0 )
2349 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002350
2351 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002352 {
2353 status = PSA_ERROR_BUFFER_TOO_SMALL;
2354 goto exit;
2355 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356
2357 switch( operation->alg )
2358 {
John Durkopee4e6602020-11-27 08:48:46 -08002359#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002360 case PSA_ALG_MD2:
2361 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2362 break;
2363#endif
John Durkopee4e6602020-11-27 08:48:46 -08002364#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002365 case PSA_ALG_MD4:
2366 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2367 break;
2368#endif
John Durkopee4e6602020-11-27 08:48:46 -08002369#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002370 case PSA_ALG_MD5:
2371 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2372 break;
2373#endif
John Durkopee4e6602020-11-27 08:48:46 -08002374#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002375 case PSA_ALG_RIPEMD160:
2376 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2377 break;
2378#endif
John Durkopee4e6602020-11-27 08:48:46 -08002379#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002380 case PSA_ALG_SHA_1:
2381 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2382 break;
2383#endif
John Durkop6ca23272020-12-03 06:01:32 -08002384#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002385 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002386 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2387 break;
2388#endif
2389#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002390 case PSA_ALG_SHA_256:
2391 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2392 break;
2393#endif
John Durkop6ca23272020-12-03 06:01:32 -08002394#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002395 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002396 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2397 break;
2398#endif
2399#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002400 case PSA_ALG_SHA_512:
2401 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2402 break;
2403#endif
2404 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002405 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002406 }
itayzafrir40835d42018-08-02 13:14:17 +03002407 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002408
itayzafrir40835d42018-08-02 13:14:17 +03002409exit:
2410 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002412 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002413 return( psa_hash_abort( operation ) );
2414 }
2415 else
2416 {
2417 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002418 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002419 }
2420}
2421
Gilles Peskine2d277862018-06-18 15:41:12 +02002422psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2423 const uint8_t *hash,
2424 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425{
2426 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2427 size_t actual_hash_length;
2428 psa_status_t status = psa_hash_finish( operation,
2429 actual_hash, sizeof( actual_hash ),
2430 &actual_hash_length );
2431 if( status != PSA_SUCCESS )
2432 return( status );
2433 if( actual_hash_length != hash_length )
2434 return( PSA_ERROR_INVALID_SIGNATURE );
2435 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2436 return( PSA_ERROR_INVALID_SIGNATURE );
2437 return( PSA_SUCCESS );
2438}
2439
Gilles Peskine0a749c82019-11-28 19:33:58 +01002440psa_status_t psa_hash_compute( psa_algorithm_t alg,
2441 const uint8_t *input, size_t input_length,
2442 uint8_t *hash, size_t hash_size,
2443 size_t *hash_length )
2444{
2445 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2446 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2447
2448 *hash_length = hash_size;
2449 status = psa_hash_setup( &operation, alg );
2450 if( status != PSA_SUCCESS )
2451 goto exit;
2452 status = psa_hash_update( &operation, input, input_length );
2453 if( status != PSA_SUCCESS )
2454 goto exit;
2455 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2456 if( status != PSA_SUCCESS )
2457 goto exit;
2458
2459exit:
2460 if( status == PSA_SUCCESS )
2461 status = psa_hash_abort( &operation );
2462 else
2463 psa_hash_abort( &operation );
2464 return( status );
2465}
2466
2467psa_status_t psa_hash_compare( psa_algorithm_t alg,
2468 const uint8_t *input, size_t input_length,
2469 const uint8_t *hash, size_t hash_length )
2470{
2471 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2473
2474 status = psa_hash_setup( &operation, alg );
2475 if( status != PSA_SUCCESS )
2476 goto exit;
2477 status = psa_hash_update( &operation, input, input_length );
2478 if( status != PSA_SUCCESS )
2479 goto exit;
2480 status = psa_hash_verify( &operation, hash, hash_length );
2481 if( status != PSA_SUCCESS )
2482 goto exit;
2483
2484exit:
2485 if( status == PSA_SUCCESS )
2486 status = psa_hash_abort( &operation );
2487 else
2488 psa_hash_abort( &operation );
2489 return( status );
2490}
2491
Gilles Peskineeb35d782019-01-22 17:56:16 +01002492psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2493 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002494{
2495 if( target_operation->alg != 0 )
2496 return( PSA_ERROR_BAD_STATE );
2497
2498 switch( source_operation->alg )
2499 {
2500 case 0:
2501 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002502#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002503 case PSA_ALG_MD2:
2504 mbedtls_md2_clone( &target_operation->ctx.md2,
2505 &source_operation->ctx.md2 );
2506 break;
2507#endif
John Durkopee4e6602020-11-27 08:48:46 -08002508#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002509 case PSA_ALG_MD4:
2510 mbedtls_md4_clone( &target_operation->ctx.md4,
2511 &source_operation->ctx.md4 );
2512 break;
2513#endif
John Durkopee4e6602020-11-27 08:48:46 -08002514#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002515 case PSA_ALG_MD5:
2516 mbedtls_md5_clone( &target_operation->ctx.md5,
2517 &source_operation->ctx.md5 );
2518 break;
2519#endif
John Durkopee4e6602020-11-27 08:48:46 -08002520#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002521 case PSA_ALG_RIPEMD160:
2522 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2523 &source_operation->ctx.ripemd160 );
2524 break;
2525#endif
John Durkopee4e6602020-11-27 08:48:46 -08002526#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002527 case PSA_ALG_SHA_1:
2528 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2529 &source_operation->ctx.sha1 );
2530 break;
2531#endif
John Durkop6ca23272020-12-03 06:01:32 -08002532#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002533 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002534 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2535 &source_operation->ctx.sha256 );
2536 break;
2537#endif
2538#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002539 case PSA_ALG_SHA_256:
2540 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2541 &source_operation->ctx.sha256 );
2542 break;
2543#endif
John Durkop6ca23272020-12-03 06:01:32 -08002544#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002545 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002546 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2547 &source_operation->ctx.sha512 );
2548 break;
2549#endif
2550#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002551 case PSA_ALG_SHA_512:
2552 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2553 &source_operation->ctx.sha512 );
2554 break;
2555#endif
2556 default:
2557 return( PSA_ERROR_NOT_SUPPORTED );
2558 }
2559
2560 target_operation->alg = source_operation->alg;
2561 return( PSA_SUCCESS );
2562}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002563
2564
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002565/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002566/* MAC */
2567/****************************************************************/
2568
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002569static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002570 psa_algorithm_t alg,
2571 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002572 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002573 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002574{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002575 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002576 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002577
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002578 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002579 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002580
Gilles Peskine8c9def32018-02-08 10:02:12 +01002581 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2582 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002583 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002584 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002585 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002586 mode = MBEDTLS_MODE_STREAM;
2587 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002588 case PSA_ALG_CTR:
2589 mode = MBEDTLS_MODE_CTR;
2590 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002591 case PSA_ALG_CFB:
2592 mode = MBEDTLS_MODE_CFB;
2593 break;
2594 case PSA_ALG_OFB:
2595 mode = MBEDTLS_MODE_OFB;
2596 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002597 case PSA_ALG_ECB_NO_PADDING:
2598 mode = MBEDTLS_MODE_ECB;
2599 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002600 case PSA_ALG_CBC_NO_PADDING:
2601 mode = MBEDTLS_MODE_CBC;
2602 break;
2603 case PSA_ALG_CBC_PKCS7:
2604 mode = MBEDTLS_MODE_CBC;
2605 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002606 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002607 mode = MBEDTLS_MODE_CCM;
2608 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002609 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002610 mode = MBEDTLS_MODE_GCM;
2611 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002612 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2613 mode = MBEDTLS_MODE_CHACHAPOLY;
2614 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002615 default:
2616 return( NULL );
2617 }
2618 }
2619 else if( alg == PSA_ALG_CMAC )
2620 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002621 else
2622 return( NULL );
2623
2624 switch( key_type )
2625 {
2626 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002627 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628 break;
2629 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002630 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2631 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002632 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002633 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002634 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002635 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002636 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2637 * but two-key Triple-DES is functionally three-key Triple-DES
2638 * with K1=K3, so that's how we present it to mbedtls. */
2639 if( key_bits == 128 )
2640 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641 break;
2642 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002643 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002644 break;
2645 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002646 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002648 case PSA_KEY_TYPE_CHACHA20:
2649 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2650 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002651 default:
2652 return( NULL );
2653 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002654 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002655 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656
Jaeden Amero23bbb752018-06-26 14:16:54 +01002657 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2658 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659}
2660
John Durkop6ba40d12020-11-10 08:50:04 -08002661#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002662static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002663{
Gilles Peskine2d277862018-06-18 15:41:12 +02002664 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002665 {
2666 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002667 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002668 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002669 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002670 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002671 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002672 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002673 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002674 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002675 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002676 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002677 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002678 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002679 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002680 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002681 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002682 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002683 return( 128 );
2684 default:
2685 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002686 }
2687}
John Durkop07cc04a2020-11-16 22:08:34 -08002688#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002689
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002690/* Initialize the MAC operation structure. Once this function has been
2691 * called, psa_mac_abort can run and will do the right thing. */
2692static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2693 psa_algorithm_t alg )
2694{
2695 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2696
2697 operation->alg = alg;
2698 operation->key_set = 0;
2699 operation->iv_set = 0;
2700 operation->iv_required = 0;
2701 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002702 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002703
2704#if defined(MBEDTLS_CMAC_C)
2705 if( alg == PSA_ALG_CMAC )
2706 {
2707 operation->iv_required = 0;
2708 mbedtls_cipher_init( &operation->ctx.cmac );
2709 status = PSA_SUCCESS;
2710 }
2711 else
2712#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002713#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002714 if( PSA_ALG_IS_HMAC( operation->alg ) )
2715 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002716 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2717 operation->ctx.hmac.hash_ctx.alg = 0;
2718 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002719 }
2720 else
John Durkopd0321952020-10-29 21:37:36 -07002721#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002722 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002723 if( ! PSA_ALG_IS_MAC( alg ) )
2724 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002725 }
2726
2727 if( status != PSA_SUCCESS )
2728 memset( operation, 0, sizeof( *operation ) );
2729 return( status );
2730}
2731
John Durkop6ba40d12020-11-10 08:50:04 -08002732#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002733static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2734{
Gilles Peskine3f108122018-12-07 18:14:53 +01002735 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002736 return( psa_hash_abort( &hmac->hash_ctx ) );
2737}
John Durkop6ba40d12020-11-10 08:50:04 -08002738#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002739
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2741{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002742 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002744 /* The object has (apparently) been initialized but it is not
2745 * in use. It's ok to call abort on such an object, and there's
2746 * nothing to do. */
2747 return( PSA_SUCCESS );
2748 }
2749 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002751 if( operation->alg == PSA_ALG_CMAC )
2752 {
2753 mbedtls_cipher_free( &operation->ctx.cmac );
2754 }
2755 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002756#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002757#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002758 if( PSA_ALG_IS_HMAC( operation->alg ) )
2759 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002760 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002761 }
2762 else
John Durkopd0321952020-10-29 21:37:36 -07002763#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002764 {
2765 /* Sanity check (shouldn't happen: operation->alg should
2766 * always have been initialized to a valid value). */
2767 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002768 }
Moran Peker41deec42018-04-04 15:43:05 +03002769
Gilles Peskine8c9def32018-02-08 10:02:12 +01002770 operation->alg = 0;
2771 operation->key_set = 0;
2772 operation->iv_set = 0;
2773 operation->iv_required = 0;
2774 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002775 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002776
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002778
2779bad_state:
2780 /* If abort is called on an uninitialized object, we can't trust
2781 * anything. Wipe the object in case it contains confidential data.
2782 * This may result in a memory leak if a pointer gets overwritten,
2783 * but it's too late to do anything about this. */
2784 memset( operation, 0, sizeof( *operation ) );
2785 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002786}
2787
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002788#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002789static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002790 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002791 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002792 const mbedtls_cipher_info_t *cipher_info )
2793{
Janos Follath24eed8d2019-11-22 13:21:35 +00002794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002795
2796 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002797
2798 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2799 if( ret != 0 )
2800 return( ret );
2801
2802 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002803 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002804 key_bits );
2805 return( ret );
2806}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002807#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002808
John Durkop6ba40d12020-11-10 08:50:04 -08002809#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002810static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2811 const uint8_t *key,
2812 size_t key_length,
2813 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002814{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002815 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002816 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002817 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002818 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002819 psa_status_t status;
2820
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002821 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2822 * overflow below. This should never trigger if the hash algorithm
2823 * is implemented correctly. */
2824 /* The size checks against the ipad and opad buffers cannot be written
2825 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2826 * because that triggers -Wlogical-op on GCC 7.3. */
2827 if( block_size > sizeof( ipad ) )
2828 return( PSA_ERROR_NOT_SUPPORTED );
2829 if( block_size > sizeof( hmac->opad ) )
2830 return( PSA_ERROR_NOT_SUPPORTED );
2831 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002832 return( PSA_ERROR_NOT_SUPPORTED );
2833
Gilles Peskined223b522018-06-11 18:12:58 +02002834 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002835 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002836 status = psa_hash_compute( hash_alg, key, key_length,
2837 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002838 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002839 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002840 }
Gilles Peskine96889972018-07-12 17:07:03 +02002841 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2842 * but it is permitted. It is common when HMAC is used in HKDF, for
2843 * example. Don't call `memcpy` in the 0-length because `key` could be
2844 * an invalid pointer which would make the behavior undefined. */
2845 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002846 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002847
Gilles Peskined223b522018-06-11 18:12:58 +02002848 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2849 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002850 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002851 ipad[i] ^= 0x36;
2852 memset( ipad + key_length, 0x36, block_size - key_length );
2853
2854 /* Copy the key material from ipad to opad, flipping the requisite bits,
2855 * and filling the rest of opad with the requisite constant. */
2856 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002857 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2858 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002859
Gilles Peskine01126fa2018-07-12 17:04:55 +02002860 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002861 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002862 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002863
Gilles Peskine01126fa2018-07-12 17:04:55 +02002864 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002865
2866cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002867 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002868
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002869 return( status );
2870}
John Durkop6ba40d12020-11-10 08:50:04 -08002871#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002872
Gilles Peskine89167cb2018-07-08 20:12:23 +02002873static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002874 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002875 psa_algorithm_t alg,
2876 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002877{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002879 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002880 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002881 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002882 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002883 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002884 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002885 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002886
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002887 /* A context must be freshly initialized before it can be set up. */
2888 if( operation->alg != 0 )
2889 {
2890 return( PSA_ERROR_BAD_STATE );
2891 }
2892
Gilles Peskined911eb72018-08-14 15:18:45 +02002893 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002894 if( status != PSA_SUCCESS )
2895 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002896 if( is_sign )
2897 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002898
Ronald Cron5c522922020-11-14 16:35:34 +01002899 status = psa_get_and_lock_transparent_key_slot_with_policy(
2900 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002901 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002902 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002903 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002904
Gilles Peskine8c9def32018-02-08 10:02:12 +01002905#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002906 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002907 {
2908 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002909 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002910 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002912 if( cipher_info == NULL )
2913 {
2914 status = PSA_ERROR_NOT_SUPPORTED;
2915 goto exit;
2916 }
2917 operation->mac_size = cipher_info->block_size;
2918 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2919 status = mbedtls_to_psa_error( ret );
2920 }
2921 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002922#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002923#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002924 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002925 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002926 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002927 if( hash_alg == 0 )
2928 {
2929 status = PSA_ERROR_NOT_SUPPORTED;
2930 goto exit;
2931 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002932
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002933 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002934 /* Sanity check. This shouldn't fail on a valid configuration. */
2935 if( operation->mac_size == 0 ||
2936 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2937 {
2938 status = PSA_ERROR_NOT_SUPPORTED;
2939 goto exit;
2940 }
2941
Gilles Peskine8e338702019-07-30 20:06:31 +02002942 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002943 {
2944 status = PSA_ERROR_INVALID_ARGUMENT;
2945 goto exit;
2946 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002947
Gilles Peskine01126fa2018-07-12 17:04:55 +02002948 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002949 slot->key.data,
2950 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02002951 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002952 }
2953 else
John Durkopd0321952020-10-29 21:37:36 -07002954#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002955 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002956 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002957 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002958 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002959
Gilles Peskined911eb72018-08-14 15:18:45 +02002960 if( truncated == 0 )
2961 {
2962 /* The "normal" case: untruncated algorithm. Nothing to do. */
2963 }
2964 else if( truncated < 4 )
2965 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002966 /* A very short MAC is too short for security since it can be
2967 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2968 * so we make this our minimum, even though 32 bits is still
2969 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002970 status = PSA_ERROR_NOT_SUPPORTED;
2971 }
2972 else if( truncated > operation->mac_size )
2973 {
2974 /* It's impossible to "truncate" to a larger length. */
2975 status = PSA_ERROR_INVALID_ARGUMENT;
2976 }
2977 else
2978 operation->mac_size = truncated;
2979
Gilles Peskinefbfac682018-07-08 20:51:54 +02002980exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002981 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002982 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002983 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002984 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002985 else
2986 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002987 operation->key_set = 1;
2988 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002989
Ronald Cron5c522922020-11-14 16:35:34 +01002990 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002991
Ronald Cron5c522922020-11-14 16:35:34 +01002992 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002993}
2994
Gilles Peskine89167cb2018-07-08 20:12:23 +02002995psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002996 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002997 psa_algorithm_t alg )
2998{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002999 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003000}
3001
3002psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003003 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003004 psa_algorithm_t alg )
3005{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003006 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003007}
3008
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3010 const uint8_t *input,
3011 size_t input_length )
3012{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003013 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003014 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003015 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003016 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003017 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003018 operation->has_input = 1;
3019
Gilles Peskine8c9def32018-02-08 10:02:12 +01003020#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003021 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003022 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003023 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3024 input, input_length );
3025 status = mbedtls_to_psa_error( ret );
3026 }
3027 else
3028#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003029#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003030 if( PSA_ALG_IS_HMAC( operation->alg ) )
3031 {
3032 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3033 input_length );
3034 }
3035 else
John Durkopd0321952020-10-29 21:37:36 -07003036#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003037 {
3038 /* This shouldn't happen if `operation` was initialized by
3039 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003040 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003041 }
3042
Gilles Peskinefbfac682018-07-08 20:51:54 +02003043 if( status != PSA_SUCCESS )
3044 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003045 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003046}
3047
John Durkop6ba40d12020-11-10 08:50:04 -08003048#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003049static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3050 uint8_t *mac,
3051 size_t mac_size )
3052{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003053 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003054 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3055 size_t hash_size = 0;
3056 size_t block_size = psa_get_hash_block_size( hash_alg );
3057 psa_status_t status;
3058
Gilles Peskine01126fa2018-07-12 17:04:55 +02003059 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3060 if( status != PSA_SUCCESS )
3061 return( status );
3062 /* From here on, tmp needs to be wiped. */
3063
3064 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3065 if( status != PSA_SUCCESS )
3066 goto exit;
3067
3068 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3069 if( status != PSA_SUCCESS )
3070 goto exit;
3071
3072 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3073 if( status != PSA_SUCCESS )
3074 goto exit;
3075
Gilles Peskined911eb72018-08-14 15:18:45 +02003076 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3077 if( status != PSA_SUCCESS )
3078 goto exit;
3079
3080 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003081
3082exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003083 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003084 return( status );
3085}
John Durkop6ba40d12020-11-10 08:50:04 -08003086#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003087
mohammad16036df908f2018-04-02 08:34:15 -07003088static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003089 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003090 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003091{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003092 if( ! operation->key_set )
3093 return( PSA_ERROR_BAD_STATE );
3094 if( operation->iv_required && ! operation->iv_set )
3095 return( PSA_ERROR_BAD_STATE );
3096
Gilles Peskine8c9def32018-02-08 10:02:12 +01003097 if( mac_size < operation->mac_size )
3098 return( PSA_ERROR_BUFFER_TOO_SMALL );
3099
Gilles Peskine8c9def32018-02-08 10:02:12 +01003100#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003101 if( operation->alg == PSA_ALG_CMAC )
3102 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003103 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003104 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3105 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003106 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003107 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003108 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003109 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003110 else
3111#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003112#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003113 if( PSA_ALG_IS_HMAC( operation->alg ) )
3114 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003115 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003116 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003117 }
3118 else
John Durkopd0321952020-10-29 21:37:36 -07003119#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003120 {
3121 /* This shouldn't happen if `operation` was initialized by
3122 * a setup function. */
3123 return( PSA_ERROR_BAD_STATE );
3124 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003125}
3126
Gilles Peskineacd4be32018-07-08 19:56:25 +02003127psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3128 uint8_t *mac,
3129 size_t mac_size,
3130 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003131{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003132 psa_status_t status;
3133
Jaeden Amero252ef282019-02-15 14:05:35 +00003134 if( operation->alg == 0 )
3135 {
3136 return( PSA_ERROR_BAD_STATE );
3137 }
3138
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003139 /* Fill the output buffer with something that isn't a valid mac
3140 * (barring an attack on the mac and deliberately-crafted input),
3141 * in case the caller doesn't check the return status properly. */
3142 *mac_length = mac_size;
3143 /* If mac_size is 0 then mac may be NULL and then the
3144 * call to memset would have undefined behavior. */
3145 if( mac_size != 0 )
3146 memset( mac, '!', mac_size );
3147
Gilles Peskine89167cb2018-07-08 20:12:23 +02003148 if( ! operation->is_sign )
3149 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003150 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003151 }
mohammad16036df908f2018-04-02 08:34:15 -07003152
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003153 status = psa_mac_finish_internal( operation, mac, mac_size );
3154
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003155 if( status == PSA_SUCCESS )
3156 {
3157 status = psa_mac_abort( operation );
3158 if( status == PSA_SUCCESS )
3159 *mac_length = operation->mac_size;
3160 else
3161 memset( mac, '!', mac_size );
3162 }
3163 else
3164 psa_mac_abort( operation );
3165 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003166}
3167
Gilles Peskineacd4be32018-07-08 19:56:25 +02003168psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3169 const uint8_t *mac,
3170 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003171{
Gilles Peskine828ed142018-06-18 23:25:51 +02003172 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003173 psa_status_t status;
3174
Jaeden Amero252ef282019-02-15 14:05:35 +00003175 if( operation->alg == 0 )
3176 {
3177 return( PSA_ERROR_BAD_STATE );
3178 }
3179
Gilles Peskine89167cb2018-07-08 20:12:23 +02003180 if( operation->is_sign )
3181 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003182 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003183 }
3184 if( operation->mac_size != mac_length )
3185 {
3186 status = PSA_ERROR_INVALID_SIGNATURE;
3187 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003188 }
mohammad16036df908f2018-04-02 08:34:15 -07003189
3190 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003191 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003192 if( status != PSA_SUCCESS )
3193 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003194
3195 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3196 status = PSA_ERROR_INVALID_SIGNATURE;
3197
3198cleanup:
3199 if( status == PSA_SUCCESS )
3200 status = psa_mac_abort( operation );
3201 else
3202 psa_mac_abort( operation );
3203
Gilles Peskine3f108122018-12-07 18:14:53 +01003204 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003205
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003206 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003207}
3208
3209
Gilles Peskine20035e32018-02-03 22:44:14 +01003210
Gilles Peskine20035e32018-02-03 22:44:14 +01003211/****************************************************************/
3212/* Asymmetric cryptography */
3213/****************************************************************/
3214
John Durkop6ba40d12020-11-10 08:50:04 -08003215#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3216 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003217/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003218 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003219static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3220 size_t hash_length,
3221 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003222{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003223 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003224 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003225 *md_alg = mbedtls_md_get_type( md_info );
3226
3227 /* The Mbed TLS RSA module uses an unsigned int for hash length
3228 * parameters. Validate that it fits so that we don't risk an
3229 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003230#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003231 if( hash_length > UINT_MAX )
3232 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003233#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003234
John Durkop0e005192020-10-31 22:06:54 -07003235#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003236 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3237 * must be correct. */
3238 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3239 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003240 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003241 if( md_info == NULL )
3242 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003243 if( mbedtls_md_get_size( md_info ) != hash_length )
3244 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003245 }
John Durkop0e005192020-10-31 22:06:54 -07003246#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003247
John Durkop0e005192020-10-31 22:06:54 -07003248#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003249 /* PSS requires a hash internally. */
3250 if( PSA_ALG_IS_RSA_PSS( alg ) )
3251 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003252 if( md_info == NULL )
3253 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003254 }
John Durkop0e005192020-10-31 22:06:54 -07003255#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003256
Gilles Peskine61b91d42018-06-08 16:09:36 +02003257 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003258}
3259
Gilles Peskine2b450e32018-06-27 15:42:46 +02003260static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3261 psa_algorithm_t alg,
3262 const uint8_t *hash,
3263 size_t hash_length,
3264 uint8_t *signature,
3265 size_t signature_size,
3266 size_t *signature_length )
3267{
3268 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003270 mbedtls_md_type_t md_alg;
3271
3272 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3273 if( status != PSA_SUCCESS )
3274 return( status );
3275
Gilles Peskine630a18a2018-06-29 17:49:35 +02003276 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003277 return( PSA_ERROR_BUFFER_TOO_SMALL );
3278
John Durkop0e005192020-10-31 22:06:54 -07003279#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003280 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3281 {
3282 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3283 MBEDTLS_MD_NONE );
3284 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003285 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003286 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003287 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003288 md_alg,
3289 (unsigned int) hash_length,
3290 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003291 signature );
3292 }
3293 else
John Durkop0e005192020-10-31 22:06:54 -07003294#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3295#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003296 if( PSA_ALG_IS_RSA_PSS( alg ) )
3297 {
3298 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3299 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003300 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003301 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003302 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003303 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003304 (unsigned int) hash_length,
3305 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003306 signature );
3307 }
3308 else
John Durkop0e005192020-10-31 22:06:54 -07003309#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003310 {
3311 return( PSA_ERROR_INVALID_ARGUMENT );
3312 }
3313
3314 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003315 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003316 return( mbedtls_to_psa_error( ret ) );
3317}
3318
3319static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3320 psa_algorithm_t alg,
3321 const uint8_t *hash,
3322 size_t hash_length,
3323 const uint8_t *signature,
3324 size_t signature_length )
3325{
3326 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003327 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003328 mbedtls_md_type_t md_alg;
3329
3330 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3331 if( status != PSA_SUCCESS )
3332 return( status );
3333
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003334 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3335 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003336
John Durkop0e005192020-10-31 22:06:54 -07003337#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003338 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3339 {
3340 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3341 MBEDTLS_MD_NONE );
3342 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003343 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003344 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003345 MBEDTLS_RSA_PUBLIC,
3346 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003347 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003348 hash,
3349 signature );
3350 }
3351 else
John Durkop0e005192020-10-31 22:06:54 -07003352#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3353#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003354 if( PSA_ALG_IS_RSA_PSS( alg ) )
3355 {
3356 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3357 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003358 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003359 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003360 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003361 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003362 (unsigned int) hash_length,
3363 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003364 signature );
3365 }
3366 else
John Durkop0e005192020-10-31 22:06:54 -07003367#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003368 {
3369 return( PSA_ERROR_INVALID_ARGUMENT );
3370 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003371
3372 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3373 * the rest of the signature is invalid". This has little use in
3374 * practice and PSA doesn't report this distinction. */
3375 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3376 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003377 return( mbedtls_to_psa_error( ret ) );
3378}
John Durkop6ba40d12020-11-10 08:50:04 -08003379#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3380 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003381
John Durkop6ba40d12020-11-10 08:50:04 -08003382#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3383 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003384/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3385 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3386 * (even though these functions don't modify it). */
3387static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3388 psa_algorithm_t alg,
3389 const uint8_t *hash,
3390 size_t hash_length,
3391 uint8_t *signature,
3392 size_t signature_size,
3393 size_t *signature_length )
3394{
Janos Follath24eed8d2019-11-22 13:21:35 +00003395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003396 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003397 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003398 mbedtls_mpi_init( &r );
3399 mbedtls_mpi_init( &s );
3400
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003401 if( signature_size < 2 * curve_bytes )
3402 {
3403 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3404 goto cleanup;
3405 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003406
John Durkop0ea39e02020-10-13 19:58:20 -07003407#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003408 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3409 {
3410 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3411 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3412 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003413 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3414 &ecp->d, hash,
3415 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003416 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003417 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003418 }
3419 else
John Durkop0ea39e02020-10-13 19:58:20 -07003420#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003421 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003422 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003423 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3424 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003425 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003426 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003427 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003428
3429 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3430 signature,
3431 curve_bytes ) );
3432 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3433 signature + curve_bytes,
3434 curve_bytes ) );
3435
3436cleanup:
3437 mbedtls_mpi_free( &r );
3438 mbedtls_mpi_free( &s );
3439 if( ret == 0 )
3440 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003441 return( mbedtls_to_psa_error( ret ) );
3442}
3443
3444static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3445 const uint8_t *hash,
3446 size_t hash_length,
3447 const uint8_t *signature,
3448 size_t signature_length )
3449{
Janos Follath24eed8d2019-11-22 13:21:35 +00003450 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003451 mbedtls_mpi r, s;
3452 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3453 mbedtls_mpi_init( &r );
3454 mbedtls_mpi_init( &s );
3455
3456 if( signature_length != 2 * curve_bytes )
3457 return( PSA_ERROR_INVALID_SIGNATURE );
3458
3459 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3460 signature,
3461 curve_bytes ) );
3462 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3463 signature + curve_bytes,
3464 curve_bytes ) );
3465
Steven Cooremanacda8342020-07-24 23:09:52 +02003466 /* Check whether the public part is loaded. If not, load it. */
3467 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3468 {
3469 MBEDTLS_MPI_CHK(
3470 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003471 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003472 }
3473
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003474 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3475 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003476
3477cleanup:
3478 mbedtls_mpi_free( &r );
3479 mbedtls_mpi_free( &s );
3480 return( mbedtls_to_psa_error( ret ) );
3481}
John Durkop6ba40d12020-11-10 08:50:04 -08003482#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3483 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003484
Ronald Croncf56a0a2020-08-04 09:51:30 +02003485psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003486 psa_algorithm_t alg,
3487 const uint8_t *hash,
3488 size_t hash_length,
3489 uint8_t *signature,
3490 size_t signature_size,
3491 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003492{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003494 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003495 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003496
3497 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003498 /* Immediately reject a zero-length signature buffer. This guarantees
3499 * that signature must be a valid pointer. (On the other hand, the hash
3500 * buffer can in principle be empty since it doesn't actually have
3501 * to be a hash.) */
3502 if( signature_size == 0 )
3503 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003504
Ronald Cron5c522922020-11-14 16:35:34 +01003505 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3506 PSA_KEY_USAGE_SIGN_HASH,
3507 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003508 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003509 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003510 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003511 {
3512 status = PSA_ERROR_INVALID_ARGUMENT;
3513 goto exit;
3514 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003515
Steven Cooremancd84cb42020-07-16 20:28:36 +02003516 /* Try any of the available accelerators first */
3517 status = psa_driver_wrapper_sign_hash( slot,
3518 alg,
3519 hash,
3520 hash_length,
3521 signature,
3522 signature_size,
3523 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003524 if( status != PSA_ERROR_NOT_SUPPORTED ||
3525 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003526 goto exit;
3527
Steven Cooreman7a250572020-07-17 16:43:05 +02003528 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003529#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3530 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003531 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003532 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003533 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003534
Ronald Cron90857082020-11-25 14:58:33 +01003535 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3536 slot->key.data,
3537 slot->key.bytes,
3538 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003539 if( status != PSA_SUCCESS )
3540 goto exit;
3541
Steven Cooremana2371e52020-07-28 14:30:39 +02003542 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003543 alg,
3544 hash, hash_length,
3545 signature, signature_size,
3546 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003547
Steven Cooremana2371e52020-07-28 14:30:39 +02003548 mbedtls_rsa_free( rsa );
3549 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003550 }
3551 else
John Durkop6ba40d12020-11-10 08:50:04 -08003552#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3553 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003554 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003555 {
John Durkop9814fa22020-11-04 12:28:15 -08003556#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3557 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003558 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003559#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003560 PSA_ALG_IS_ECDSA( alg )
3561#else
3562 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3563#endif
3564 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003565 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003566 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003567 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3568 slot->key.data,
3569 slot->key.bytes,
3570 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003571 if( status != PSA_SUCCESS )
3572 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003573 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003574 alg,
3575 hash, hash_length,
3576 signature, signature_size,
3577 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003578 mbedtls_ecp_keypair_free( ecp );
3579 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003580 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003581 else
John Durkop9814fa22020-11-04 12:28:15 -08003582#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3583 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003584 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003585 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003586 }
itayzafrir5c753392018-05-08 11:18:38 +03003587 }
3588 else
itayzafrir5c753392018-05-08 11:18:38 +03003589 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003590 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003591 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003592
3593exit:
3594 /* Fill the unused part of the output buffer (the whole buffer on error,
3595 * the trailing part on success) with something that isn't a valid mac
3596 * (barring an attack on the mac and deliberately-crafted input),
3597 * in case the caller doesn't check the return status properly. */
3598 if( status == PSA_SUCCESS )
3599 memset( signature + *signature_length, '!',
3600 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003601 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003602 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003603 /* If signature_size is 0 then we have nothing to do. We must not call
3604 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003605
Ronald Cron5c522922020-11-14 16:35:34 +01003606 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003607
Ronald Cron5c522922020-11-14 16:35:34 +01003608 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003609}
3610
Ronald Croncf56a0a2020-08-04 09:51:30 +02003611psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003612 psa_algorithm_t alg,
3613 const uint8_t *hash,
3614 size_t hash_length,
3615 const uint8_t *signature,
3616 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003617{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003618 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003619 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003620 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003621
Ronald Cron5c522922020-11-14 16:35:34 +01003622 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3623 PSA_KEY_USAGE_VERIFY_HASH,
3624 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003625 if( status != PSA_SUCCESS )
3626 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003627
Steven Cooreman55ae2172020-07-17 19:46:15 +02003628 /* Try any of the available accelerators first */
3629 status = psa_driver_wrapper_verify_hash( slot,
3630 alg,
3631 hash,
3632 hash_length,
3633 signature,
3634 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003635 if( status != PSA_ERROR_NOT_SUPPORTED ||
3636 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003637 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003638
John Durkop6ba40d12020-11-10 08:50:04 -08003639#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3640 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003641 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003642 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003643 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003644
Ronald Cron90857082020-11-25 14:58:33 +01003645 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3646 slot->key.data,
3647 slot->key.bytes,
3648 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003649 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003650 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003651
Steven Cooremana2371e52020-07-28 14:30:39 +02003652 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003653 alg,
3654 hash, hash_length,
3655 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003656 mbedtls_rsa_free( rsa );
3657 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003658 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003659 }
3660 else
John Durkop6ba40d12020-11-10 08:50:04 -08003661#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3662 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003663 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003664 {
John Durkop9814fa22020-11-04 12:28:15 -08003665#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3666 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003667 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003668 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003669 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003670 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3671 slot->key.data,
3672 slot->key.bytes,
3673 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003674 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003675 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003676 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003677 hash, hash_length,
3678 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003679 mbedtls_ecp_keypair_free( ecp );
3680 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003681 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003682 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003683 else
John Durkop9814fa22020-11-04 12:28:15 -08003684#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3685 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003686 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003687 status = PSA_ERROR_INVALID_ARGUMENT;
3688 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003689 }
itayzafrir5c753392018-05-08 11:18:38 +03003690 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003691 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003692 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003693 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003694 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003695
3696exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003697 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003698
Ronald Cron5c522922020-11-14 16:35:34 +01003699 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003700}
3701
John Durkop0e005192020-10-31 22:06:54 -07003702#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003703static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3704 mbedtls_rsa_context *rsa )
3705{
3706 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3707 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3708 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3709 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3710}
John Durkop0e005192020-10-31 22:06:54 -07003711#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003712
Ronald Croncf56a0a2020-08-04 09:51:30 +02003713psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003714 psa_algorithm_t alg,
3715 const uint8_t *input,
3716 size_t input_length,
3717 const uint8_t *salt,
3718 size_t salt_length,
3719 uint8_t *output,
3720 size_t output_size,
3721 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003722{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003723 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003724 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003725 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003726
Darryl Green5cc689a2018-07-24 15:34:10 +01003727 (void) input;
3728 (void) input_length;
3729 (void) salt;
3730 (void) output;
3731 (void) output_size;
3732
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003733 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003734
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003735 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3736 return( PSA_ERROR_INVALID_ARGUMENT );
3737
Ronald Cron5c522922020-11-14 16:35:34 +01003738 status = psa_get_and_lock_transparent_key_slot_with_policy(
3739 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003740 if( status != PSA_SUCCESS )
3741 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003742 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3743 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003744 {
3745 status = PSA_ERROR_INVALID_ARGUMENT;
3746 goto exit;
3747 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003748
John Durkop6ba40d12020-11-10 08:50:04 -08003749#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3750 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003751 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003752 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003753 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003754 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3755 slot->key.data,
3756 slot->key.bytes,
3757 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003758 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003759 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003760
3761 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003762 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003763 status = PSA_ERROR_BUFFER_TOO_SMALL;
3764 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003765 }
John Durkop0e005192020-10-31 22:06:54 -07003766#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003767 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003768 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003769 status = mbedtls_to_psa_error(
3770 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003771 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003772 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003773 MBEDTLS_RSA_PUBLIC,
3774 input_length,
3775 input,
3776 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003777 }
3778 else
John Durkop0e005192020-10-31 22:06:54 -07003779#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3780#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003781 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003782 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003783 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003784 status = mbedtls_to_psa_error(
3785 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003786 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003787 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003788 MBEDTLS_RSA_PUBLIC,
3789 salt, salt_length,
3790 input_length,
3791 input,
3792 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003793 }
3794 else
John Durkop0e005192020-10-31 22:06:54 -07003795#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003796 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003797 status = PSA_ERROR_INVALID_ARGUMENT;
3798 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003799 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003800rsa_exit:
3801 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003802 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003803
Steven Cooremana2371e52020-07-28 14:30:39 +02003804 mbedtls_rsa_free( rsa );
3805 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003806 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003807 else
John Durkop9814fa22020-11-04 12:28:15 -08003808#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003809 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003810 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003811 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003812 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003813
3814exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003815 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003816
Ronald Cron5c522922020-11-14 16:35:34 +01003817 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003818}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003819
Ronald Croncf56a0a2020-08-04 09:51:30 +02003820psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003821 psa_algorithm_t alg,
3822 const uint8_t *input,
3823 size_t input_length,
3824 const uint8_t *salt,
3825 size_t salt_length,
3826 uint8_t *output,
3827 size_t output_size,
3828 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003829{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003830 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003831 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003832 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003833
Darryl Green5cc689a2018-07-24 15:34:10 +01003834 (void) input;
3835 (void) input_length;
3836 (void) salt;
3837 (void) output;
3838 (void) output_size;
3839
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003840 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003841
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003842 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3843 return( PSA_ERROR_INVALID_ARGUMENT );
3844
Ronald Cron5c522922020-11-14 16:35:34 +01003845 status = psa_get_and_lock_transparent_key_slot_with_policy(
3846 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003847 if( status != PSA_SUCCESS )
3848 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003849 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003850 {
3851 status = PSA_ERROR_INVALID_ARGUMENT;
3852 goto exit;
3853 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003854
John Durkop6ba40d12020-11-10 08:50:04 -08003855#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3856 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003857 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003858 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003859 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003860 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3861 slot->key.data,
3862 slot->key.bytes,
3863 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003864 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003865 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003866
Steven Cooremana2371e52020-07-28 14:30:39 +02003867 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003868 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003869 status = PSA_ERROR_INVALID_ARGUMENT;
3870 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003871 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003872
John Durkop0e005192020-10-31 22:06:54 -07003873#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003874 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003875 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003876 status = mbedtls_to_psa_error(
3877 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003878 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003879 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003880 MBEDTLS_RSA_PRIVATE,
3881 output_length,
3882 input,
3883 output,
3884 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003885 }
3886 else
John Durkop0e005192020-10-31 22:06:54 -07003887#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3888#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003889 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003890 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003891 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003892 status = mbedtls_to_psa_error(
3893 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003894 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003895 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003896 MBEDTLS_RSA_PRIVATE,
3897 salt, salt_length,
3898 output_length,
3899 input,
3900 output,
3901 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003902 }
3903 else
John Durkop0e005192020-10-31 22:06:54 -07003904#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003905 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003906 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003907 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003908
Steven Cooreman4fed4552020-08-03 14:46:03 +02003909rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003910 mbedtls_rsa_free( rsa );
3911 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003912 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003913 else
John Durkop6ba40d12020-11-10 08:50:04 -08003914#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3915 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003916 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003917 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003918 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003919
3920exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003921 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003922
Ronald Cron5c522922020-11-14 16:35:34 +01003923 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003924}
Gilles Peskine20035e32018-02-03 22:44:14 +01003925
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003926
3927
mohammad1603503973b2018-03-12 15:59:30 +02003928/****************************************************************/
3929/* Symmetric cryptography */
3930/****************************************************************/
3931
Gilles Peskinee553c652018-06-04 16:22:46 +02003932static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003933 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003934 psa_algorithm_t alg,
3935 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003936{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003937 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003938 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003939 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003940 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003941 size_t key_bits;
3942 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003943 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3944 PSA_KEY_USAGE_ENCRYPT :
3945 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003946
Steven Cooremand3feccd2020-09-01 15:56:14 +02003947 /* A context must be freshly initialized before it can be set up. */
3948 if( operation->alg != 0 )
3949 return( PSA_ERROR_BAD_STATE );
3950
Steven Cooremana07b9972020-09-10 14:54:14 +02003951 /* The requested algorithm must be one that can be processed by cipher. */
3952 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003953 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003954
Steven Cooremanef8575e2020-09-11 11:44:50 +02003955 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003956 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003957 if( status != PSA_SUCCESS )
3958 goto exit;
3959
3960 /* Initialize the operation struct members, except for alg. The alg member
3961 * is used to indicate to psa_cipher_abort that there are resources to free,
3962 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003963 operation->key_set = 0;
3964 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003965 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003966 operation->iv_size = 0;
3967 operation->block_size = 0;
3968 if( alg == PSA_ALG_ECB_NO_PADDING )
3969 operation->iv_required = 0;
3970 else
3971 operation->iv_required = 1;
3972
Steven Cooremana07b9972020-09-10 14:54:14 +02003973 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003974 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003975 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003976 slot,
3977 alg );
3978 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003979 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003980 slot,
3981 alg );
3982
Steven Cooremanef8575e2020-09-11 11:44:50 +02003983 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003984 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003985 /* Once the driver context is initialised, it needs to be freed using
3986 * psa_cipher_abort. Indicate this through setting alg. */
3987 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003988 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003989
Steven Cooremand3feccd2020-09-01 15:56:14 +02003990 if( status != PSA_ERROR_NOT_SUPPORTED ||
3991 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3992 goto exit;
3993
Steven Cooremana07b9972020-09-10 14:54:14 +02003994 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003995 * available for the given algorithm & key. */
3996 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003997
Steven Cooremana07b9972020-09-10 14:54:14 +02003998 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003999 * psa_cipher_abort. Indicate there is something to be freed through setting
4000 * alg, and indicate the operation is being done using mbedtls crypto through
4001 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004002 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004003 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004004
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004005 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004006 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004007 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004008 {
4009 status = PSA_ERROR_NOT_SUPPORTED;
4010 goto exit;
4011 }
mohammad1603503973b2018-03-12 15:59:30 +02004012
mohammad1603503973b2018-03-12 15:59:30 +02004013 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004014 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004015 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004016
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004017#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004018 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004019 {
4020 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004021 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004022 memcpy( keys, slot->key.data, 16 );
4023 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004024 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4025 keys,
4026 192, cipher_operation );
4027 }
4028 else
4029#endif
4030 {
4031 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004032 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004033 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004034 }
Moran Peker41deec42018-04-04 15:43:05 +03004035 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004036 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004037
mohammad16038481e742018-03-18 13:57:31 +02004038#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004039 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004040 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004041 case PSA_ALG_CBC_NO_PADDING:
4042 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4043 MBEDTLS_PADDING_NONE );
4044 break;
4045 case PSA_ALG_CBC_PKCS7:
4046 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4047 MBEDTLS_PADDING_PKCS7 );
4048 break;
4049 default:
4050 /* The algorithm doesn't involve padding. */
4051 ret = 0;
4052 break;
4053 }
4054 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004055 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004056#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4057
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004058 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004059 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004060 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4061 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004062 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004063 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004064 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004065#if defined(MBEDTLS_CHACHA20_C)
4066 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004067 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004068 operation->iv_size = 12;
4069#endif
mohammad1603503973b2018-03-12 15:59:30 +02004070
Steven Cooreman7df02922020-09-09 15:28:49 +02004071 status = PSA_SUCCESS;
4072
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004073exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004074 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004075 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004076 if( status == PSA_SUCCESS )
4077 {
4078 /* Update operation flags for both driver and software implementations */
4079 operation->key_set = 1;
4080 }
4081 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004082 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004083
Ronald Cron5c522922020-11-14 16:35:34 +01004084 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004085
Ronald Cron5c522922020-11-14 16:35:34 +01004086 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004087}
4088
Gilles Peskinefe119512018-07-08 21:39:34 +02004089psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004090 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004091 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004092{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004093 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004094}
4095
Gilles Peskinefe119512018-07-08 21:39:34 +02004096psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004097 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004098 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004099{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004100 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004101}
4102
Gilles Peskinefe119512018-07-08 21:39:34 +02004103psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004104 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004105 size_t iv_size,
4106 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004107{
itayzafrir534bd7c2018-08-02 13:56:32 +03004108 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004110 if( operation->iv_set || ! operation->iv_required )
4111 {
4112 return( PSA_ERROR_BAD_STATE );
4113 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004114
Steven Cooremanef8575e2020-09-11 11:44:50 +02004115 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004116 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004117 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004118 iv,
4119 iv_size,
4120 iv_length );
4121 goto exit;
4122 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004123
Moran Peker41deec42018-04-04 15:43:05 +03004124 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004125 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004126 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004127 goto exit;
4128 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004129 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004130 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004131 if( ret != 0 )
4132 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004133 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004134 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004135 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004136
mohammad16038481e742018-03-18 13:57:31 +02004137 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004138 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004139
Moran Peker395db872018-05-31 14:07:14 +03004140exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004141 if( status == PSA_SUCCESS )
4142 operation->iv_set = 1;
4143 else
Moran Peker395db872018-05-31 14:07:14 +03004144 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004145 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004146}
4147
Gilles Peskinefe119512018-07-08 21:39:34 +02004148psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004149 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004150 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004151{
itayzafrir534bd7c2018-08-02 13:56:32 +03004152 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004154 if( operation->iv_set || ! operation->iv_required )
4155 {
4156 return( PSA_ERROR_BAD_STATE );
4157 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004158
Steven Cooremanef8575e2020-09-11 11:44:50 +02004159 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004160 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004161 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004162 iv,
4163 iv_length );
4164 goto exit;
4165 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004166
Moran Pekera28258c2018-05-29 16:25:04 +03004167 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004168 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004169 status = PSA_ERROR_INVALID_ARGUMENT;
4170 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004171 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004172 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4173 status = mbedtls_to_psa_error( ret );
4174exit:
4175 if( status == PSA_SUCCESS )
4176 operation->iv_set = 1;
4177 else
mohammad1603503973b2018-03-12 15:59:30 +02004178 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004179 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004180}
4181
Steven Cooreman177deba2020-09-07 17:14:14 +02004182/* Process input for which the algorithm is set to ECB mode. This requires
4183 * manual processing, since the PSA API is defined as being able to process
4184 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4185 * underlying mbedtls_cipher_update only takes full blocks. */
4186static psa_status_t psa_cipher_update_ecb_internal(
4187 mbedtls_cipher_context_t *ctx,
4188 const uint8_t *input,
4189 size_t input_length,
4190 uint8_t *output,
4191 size_t output_size,
4192 size_t *output_length )
4193{
4194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4195 size_t block_size = ctx->cipher_info->block_size;
4196 size_t internal_output_length = 0;
4197 *output_length = 0;
4198
4199 if( input_length == 0 )
4200 {
4201 status = PSA_SUCCESS;
4202 goto exit;
4203 }
4204
4205 if( ctx->unprocessed_len > 0 )
4206 {
4207 /* Fill up to block size, and run the block if there's a full one. */
4208 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4209
4210 if( input_length < bytes_to_copy )
4211 bytes_to_copy = input_length;
4212
4213 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4214 input, bytes_to_copy );
4215 input_length -= bytes_to_copy;
4216 input += bytes_to_copy;
4217 ctx->unprocessed_len += bytes_to_copy;
4218
4219 if( ctx->unprocessed_len == block_size )
4220 {
4221 status = mbedtls_to_psa_error(
4222 mbedtls_cipher_update( ctx,
4223 ctx->unprocessed_data,
4224 block_size,
4225 output, &internal_output_length ) );
4226
4227 if( status != PSA_SUCCESS )
4228 goto exit;
4229
4230 output += internal_output_length;
4231 output_size -= internal_output_length;
4232 *output_length += internal_output_length;
4233 ctx->unprocessed_len = 0;
4234 }
4235 }
4236
4237 while( input_length >= block_size )
4238 {
4239 /* Run all full blocks we have, one by one */
4240 status = mbedtls_to_psa_error(
4241 mbedtls_cipher_update( ctx, input,
4242 block_size,
4243 output, &internal_output_length ) );
4244
4245 if( status != PSA_SUCCESS )
4246 goto exit;
4247
4248 input_length -= block_size;
4249 input += block_size;
4250
4251 output += internal_output_length;
4252 output_size -= internal_output_length;
4253 *output_length += internal_output_length;
4254 }
4255
4256 if( input_length > 0 )
4257 {
4258 /* Save unprocessed bytes for later processing */
4259 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4260 input, input_length );
4261 ctx->unprocessed_len += input_length;
4262 }
4263
4264 status = PSA_SUCCESS;
4265
4266exit:
4267 return( status );
4268}
4269
Gilles Peskinee553c652018-06-04 16:22:46 +02004270psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4271 const uint8_t *input,
4272 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004273 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004274 size_t output_size,
4275 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004276{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004277 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004278 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004279 if( operation->alg == 0 )
4280 {
4281 return( PSA_ERROR_BAD_STATE );
4282 }
4283 if( operation->iv_required && ! operation->iv_set )
4284 {
4285 return( PSA_ERROR_BAD_STATE );
4286 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004287
Steven Cooremanef8575e2020-09-11 11:44:50 +02004288 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004289 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004290 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004291 input,
4292 input_length,
4293 output,
4294 output_size,
4295 output_length );
4296 goto exit;
4297 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004298
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004299 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004300 {
4301 /* Take the unprocessed partial block left over from previous
4302 * update calls, if any, plus the input to this call. Remove
4303 * the last partial block, if any. You get the data that will be
4304 * output in this call. */
4305 expected_output_size =
4306 ( operation->ctx.cipher.unprocessed_len + input_length )
4307 / operation->block_size * operation->block_size;
4308 }
4309 else
4310 {
4311 expected_output_size = input_length;
4312 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004313
Gilles Peskine89d789c2018-06-04 17:17:16 +02004314 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004315 {
4316 status = PSA_ERROR_BUFFER_TOO_SMALL;
4317 goto exit;
4318 }
mohammad160382759612018-03-12 18:16:40 +02004319
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004320 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4321 {
4322 /* mbedtls_cipher_update has an API inconsistency: it will only
4323 * process a single block at a time in ECB mode. Abstract away that
4324 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004325 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4326 input,
4327 input_length,
4328 output,
4329 output_size,
4330 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004331 }
4332 else
4333 {
4334 status = mbedtls_to_psa_error(
4335 mbedtls_cipher_update( &operation->ctx.cipher, input,
4336 input_length, output, output_length ) );
4337 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004338exit:
4339 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004340 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004341 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004342}
4343
Gilles Peskinee553c652018-06-04 16:22:46 +02004344psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4345 uint8_t *output,
4346 size_t output_size,
4347 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004348{
David Saadab4ecc272019-02-14 13:48:10 +02004349 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004350 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004351 if( operation->alg == 0 )
4352 {
4353 return( PSA_ERROR_BAD_STATE );
4354 }
4355 if( operation->iv_required && ! operation->iv_set )
4356 {
4357 return( PSA_ERROR_BAD_STATE );
4358 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004359
Steven Cooremanef8575e2020-09-11 11:44:50 +02004360 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004361 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004362 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004363 output,
4364 output_size,
4365 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004366 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004367 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004368
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004369 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004370 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004371 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004372 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004373 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004374 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004375 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004376 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004377 }
4378
Steven Cooremanef8575e2020-09-11 11:44:50 +02004379 status = mbedtls_to_psa_error(
4380 mbedtls_cipher_finish( &operation->ctx.cipher,
4381 temp_output_buffer,
4382 output_length ) );
4383 if( status != PSA_SUCCESS )
4384 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004385
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004386 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004387 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004388 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004389 memcpy( output, temp_output_buffer, *output_length );
4390 else
Janos Follath315b51c2018-07-09 16:04:51 +01004391 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004392
Steven Cooremanef8575e2020-09-11 11:44:50 +02004393exit:
4394 if( operation->mbedtls_in_use == 1 )
4395 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004396
Steven Cooremanef8575e2020-09-11 11:44:50 +02004397 if( status == PSA_SUCCESS )
4398 return( psa_cipher_abort( operation ) );
4399 else
4400 {
4401 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004402 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004403
Steven Cooremanef8575e2020-09-11 11:44:50 +02004404 return( status );
4405 }
mohammad1603503973b2018-03-12 15:59:30 +02004406}
4407
Gilles Peskinee553c652018-06-04 16:22:46 +02004408psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4409{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004410 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004411 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004412 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004413 * in use. It's ok to call abort on such an object, and there's
4414 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004415 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004416 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004417
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004418 /* Sanity check (shouldn't happen: operation->alg should
4419 * always have been initialized to a valid value). */
4420 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4421 return( PSA_ERROR_BAD_STATE );
4422
Steven Cooremanef8575e2020-09-11 11:44:50 +02004423 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004424 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004425 else
4426 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004427
Moran Peker41deec42018-04-04 15:43:05 +03004428 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004429 operation->key_set = 0;
4430 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004431 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004432 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004433 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004434 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004435
Moran Peker395db872018-05-31 14:07:14 +03004436 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004437}
4438
Gilles Peskinea0655c32018-04-30 17:06:50 +02004439
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004440
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004441
mohammad16035955c982018-04-26 00:53:03 +03004442/****************************************************************/
4443/* AEAD */
4444/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004445
Gilles Peskineedf9a652018-08-17 18:11:56 +02004446typedef struct
4447{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004448 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004449 const mbedtls_cipher_info_t *cipher_info;
4450 union
4451 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004452 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004453#if defined(MBEDTLS_CCM_C)
4454 mbedtls_ccm_context ccm;
4455#endif /* MBEDTLS_CCM_C */
4456#if defined(MBEDTLS_GCM_C)
4457 mbedtls_gcm_context gcm;
4458#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004459#if defined(MBEDTLS_CHACHAPOLY_C)
4460 mbedtls_chachapoly_context chachapoly;
4461#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004462 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004463 psa_algorithm_t core_alg;
4464 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004465 uint8_t tag_length;
4466} aead_operation_t;
4467
Ronald Cronf95a2b12020-10-22 15:24:49 +02004468#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4469
Gilles Peskine30a9e412019-01-14 18:36:12 +01004470static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004471{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004472 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004473 {
4474#if defined(MBEDTLS_CCM_C)
4475 case PSA_ALG_CCM:
4476 mbedtls_ccm_free( &operation->ctx.ccm );
4477 break;
4478#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004479#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004480 case PSA_ALG_GCM:
4481 mbedtls_gcm_free( &operation->ctx.gcm );
4482 break;
4483#endif /* MBEDTLS_GCM_C */
4484 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004485
Ronald Cron5c522922020-11-14 16:35:34 +01004486 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004487}
4488
4489static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004490 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004491 psa_key_usage_t usage,
4492 psa_algorithm_t alg )
4493{
4494 psa_status_t status;
4495 size_t key_bits;
4496 mbedtls_cipher_id_t cipher_id;
4497
Ronald Cron5c522922020-11-14 16:35:34 +01004498 status = psa_get_and_lock_transparent_key_slot_with_policy(
4499 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004500 if( status != PSA_SUCCESS )
4501 return( status );
4502
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004503 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004504
4505 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004506 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004507 &cipher_id );
4508 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004509 {
4510 status = PSA_ERROR_NOT_SUPPORTED;
4511 goto cleanup;
4512 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004513
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004514 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004515 {
4516#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004517 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4518 operation->core_alg = PSA_ALG_CCM;
4519 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004520 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4521 * The call to mbedtls_ccm_encrypt_and_tag or
4522 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004523 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004524 {
4525 status = PSA_ERROR_INVALID_ARGUMENT;
4526 goto cleanup;
4527 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004528 mbedtls_ccm_init( &operation->ctx.ccm );
4529 status = mbedtls_to_psa_error(
4530 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004531 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004532 (unsigned int) key_bits ) );
4533 if( status != 0 )
4534 goto cleanup;
4535 break;
4536#endif /* MBEDTLS_CCM_C */
4537
4538#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004539 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4540 operation->core_alg = PSA_ALG_GCM;
4541 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004542 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4543 * The call to mbedtls_gcm_crypt_and_tag or
4544 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004545 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004546 {
4547 status = PSA_ERROR_INVALID_ARGUMENT;
4548 goto cleanup;
4549 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004550 mbedtls_gcm_init( &operation->ctx.gcm );
4551 status = mbedtls_to_psa_error(
4552 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004553 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004554 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004555 if( status != 0 )
4556 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004557 break;
4558#endif /* MBEDTLS_GCM_C */
4559
Gilles Peskine26869f22019-05-06 15:25:00 +02004560#if defined(MBEDTLS_CHACHAPOLY_C)
4561 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4562 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4563 operation->full_tag_length = 16;
4564 /* We only support the default tag length. */
4565 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004566 {
4567 status = PSA_ERROR_NOT_SUPPORTED;
4568 goto cleanup;
4569 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004570 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4571 status = mbedtls_to_psa_error(
4572 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004573 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004574 if( status != 0 )
4575 goto cleanup;
4576 break;
4577#endif /* MBEDTLS_CHACHAPOLY_C */
4578
Gilles Peskineedf9a652018-08-17 18:11:56 +02004579 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004580 status = PSA_ERROR_NOT_SUPPORTED;
4581 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004582 }
4583
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004584 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4585 {
4586 status = PSA_ERROR_INVALID_ARGUMENT;
4587 goto cleanup;
4588 }
4589 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004590
Gilles Peskineedf9a652018-08-17 18:11:56 +02004591 return( PSA_SUCCESS );
4592
4593cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004594 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004595 return( status );
4596}
4597
Ronald Croncf56a0a2020-08-04 09:51:30 +02004598psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004599 psa_algorithm_t alg,
4600 const uint8_t *nonce,
4601 size_t nonce_length,
4602 const uint8_t *additional_data,
4603 size_t additional_data_length,
4604 const uint8_t *plaintext,
4605 size_t plaintext_length,
4606 uint8_t *ciphertext,
4607 size_t ciphertext_size,
4608 size_t *ciphertext_length )
4609{
mohammad16035955c982018-04-26 00:53:03 +03004610 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004611 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004612 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004613
mohammad1603f08a5502018-06-03 15:05:47 +03004614 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004615
Ronald Croncf56a0a2020-08-04 09:51:30 +02004616 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004617 if( status != PSA_SUCCESS )
4618 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004619
Gilles Peskineedf9a652018-08-17 18:11:56 +02004620 /* For all currently supported modes, the tag is at the end of the
4621 * ciphertext. */
4622 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4623 {
4624 status = PSA_ERROR_BUFFER_TOO_SMALL;
4625 goto exit;
4626 }
4627 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004628
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004629#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004630 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004631 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004632 status = mbedtls_to_psa_error(
4633 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4634 MBEDTLS_GCM_ENCRYPT,
4635 plaintext_length,
4636 nonce, nonce_length,
4637 additional_data, additional_data_length,
4638 plaintext, ciphertext,
4639 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004640 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004641 else
4642#endif /* MBEDTLS_GCM_C */
4643#if defined(MBEDTLS_CCM_C)
4644 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004645 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004646 status = mbedtls_to_psa_error(
4647 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4648 plaintext_length,
4649 nonce, nonce_length,
4650 additional_data,
4651 additional_data_length,
4652 plaintext, ciphertext,
4653 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004654 }
mohammad16035c8845f2018-05-09 05:40:09 -07004655 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004656#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004657#if defined(MBEDTLS_CHACHAPOLY_C)
4658 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4659 {
4660 if( nonce_length != 12 || operation.tag_length != 16 )
4661 {
4662 status = PSA_ERROR_NOT_SUPPORTED;
4663 goto exit;
4664 }
4665 status = mbedtls_to_psa_error(
4666 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4667 plaintext_length,
4668 nonce,
4669 additional_data,
4670 additional_data_length,
4671 plaintext,
4672 ciphertext,
4673 tag ) );
4674 }
4675 else
4676#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004677 {
mohammad1603554faad2018-06-03 15:07:38 +03004678 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004679 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004680
Gilles Peskineedf9a652018-08-17 18:11:56 +02004681 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4682 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004683
Gilles Peskineedf9a652018-08-17 18:11:56 +02004684exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004685 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004686 if( status == PSA_SUCCESS )
4687 *ciphertext_length = plaintext_length + operation.tag_length;
4688 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004689}
4690
Gilles Peskineee652a32018-06-01 19:23:52 +02004691/* Locate the tag in a ciphertext buffer containing the encrypted data
4692 * followed by the tag. Return the length of the part preceding the tag in
4693 * *plaintext_length. This is the size of the plaintext in modes where
4694 * the encrypted data has the same size as the plaintext, such as
4695 * CCM and GCM. */
4696static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4697 const uint8_t *ciphertext,
4698 size_t ciphertext_length,
4699 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004700 const uint8_t **p_tag )
4701{
4702 size_t payload_length;
4703 if( tag_length > ciphertext_length )
4704 return( PSA_ERROR_INVALID_ARGUMENT );
4705 payload_length = ciphertext_length - tag_length;
4706 if( payload_length > plaintext_size )
4707 return( PSA_ERROR_BUFFER_TOO_SMALL );
4708 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004709 return( PSA_SUCCESS );
4710}
4711
Ronald Croncf56a0a2020-08-04 09:51:30 +02004712psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004713 psa_algorithm_t alg,
4714 const uint8_t *nonce,
4715 size_t nonce_length,
4716 const uint8_t *additional_data,
4717 size_t additional_data_length,
4718 const uint8_t *ciphertext,
4719 size_t ciphertext_length,
4720 uint8_t *plaintext,
4721 size_t plaintext_size,
4722 size_t *plaintext_length )
4723{
mohammad16035955c982018-04-26 00:53:03 +03004724 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004725 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004726 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004727
Gilles Peskineee652a32018-06-01 19:23:52 +02004728 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004729
Ronald Croncf56a0a2020-08-04 09:51:30 +02004730 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004731 if( status != PSA_SUCCESS )
4732 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004733
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004734 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4735 ciphertext, ciphertext_length,
4736 plaintext_size, &tag );
4737 if( status != PSA_SUCCESS )
4738 goto exit;
4739
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004740#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004741 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004742 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004743 status = mbedtls_to_psa_error(
4744 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4745 ciphertext_length - operation.tag_length,
4746 nonce, nonce_length,
4747 additional_data,
4748 additional_data_length,
4749 tag, operation.tag_length,
4750 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004751 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004752 else
4753#endif /* MBEDTLS_GCM_C */
4754#if defined(MBEDTLS_CCM_C)
4755 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004756 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004757 status = mbedtls_to_psa_error(
4758 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4759 ciphertext_length - operation.tag_length,
4760 nonce, nonce_length,
4761 additional_data,
4762 additional_data_length,
4763 ciphertext, plaintext,
4764 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004765 }
mohammad160339574652018-06-01 04:39:53 -07004766 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004767#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004768#if defined(MBEDTLS_CHACHAPOLY_C)
4769 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4770 {
4771 if( nonce_length != 12 || operation.tag_length != 16 )
4772 {
4773 status = PSA_ERROR_NOT_SUPPORTED;
4774 goto exit;
4775 }
4776 status = mbedtls_to_psa_error(
4777 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4778 ciphertext_length - operation.tag_length,
4779 nonce,
4780 additional_data,
4781 additional_data_length,
4782 tag,
4783 ciphertext,
4784 plaintext ) );
4785 }
4786 else
4787#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004788 {
mohammad1603554faad2018-06-03 15:07:38 +03004789 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004790 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004791
Gilles Peskineedf9a652018-08-17 18:11:56 +02004792 if( status != PSA_SUCCESS && plaintext_size != 0 )
4793 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004794
Gilles Peskineedf9a652018-08-17 18:11:56 +02004795exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004796 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004797 if( status == PSA_SUCCESS )
4798 *plaintext_length = ciphertext_length - operation.tag_length;
4799 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004800}
4801
Gilles Peskinea0655c32018-04-30 17:06:50 +02004802
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004803
Gilles Peskine20035e32018-02-03 22:44:14 +01004804/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004805/* Generators */
4806/****************************************************************/
4807
John Durkop07cc04a2020-11-16 22:08:34 -08004808#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4809 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4810 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4811#define AT_LEAST_ONE_BUILTIN_KDF
4812#endif
4813
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004814#define HKDF_STATE_INIT 0 /* no input yet */
4815#define HKDF_STATE_STARTED 1 /* got salt */
4816#define HKDF_STATE_KEYED 2 /* got key */
4817#define HKDF_STATE_OUTPUT 3 /* output started */
4818
Gilles Peskinecbe66502019-05-16 16:59:18 +02004819static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004820 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004821{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004822 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4823 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004824 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004825 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004826}
4827
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004828psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004829{
4830 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004831 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004832 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004833 {
4834 /* The object has (apparently) been initialized but it is not
4835 * in use. It's ok to call abort on such an object, and there's
4836 * nothing to do. */
4837 }
4838 else
John Durkopd0321952020-10-29 21:37:36 -07004839#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004840 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004841 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004842 mbedtls_free( operation->ctx.hkdf.info );
4843 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004844 }
John Durkop07cc04a2020-11-16 22:08:34 -08004845 else
4846#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4847#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4848 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4849 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004850 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004851 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004852 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004853 if( operation->ctx.tls12_prf.seed != NULL )
4854 {
4855 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4856 operation->ctx.tls12_prf.seed_length );
4857 mbedtls_free( operation->ctx.tls12_prf.seed );
4858 }
4859
4860 if( operation->ctx.tls12_prf.label != NULL )
4861 {
4862 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4863 operation->ctx.tls12_prf.label_length );
4864 mbedtls_free( operation->ctx.tls12_prf.label );
4865 }
4866
4867 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4868
4869 /* We leave the fields Ai and output_block to be erased safely by the
4870 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004871 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004872 else
John Durkop07cc04a2020-11-16 22:08:34 -08004873#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4874 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004875 {
4876 status = PSA_ERROR_BAD_STATE;
4877 }
Janos Follath083036a2019-06-11 10:22:26 +01004878 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004879 return( status );
4880}
4881
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004882psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004883 size_t *capacity)
4884{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004885 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004886 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004887 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004888 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004889 }
4890
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004891 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004892 return( PSA_SUCCESS );
4893}
4894
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004895psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004896 size_t capacity )
4897{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004898 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004899 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004900 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004901 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004902 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004903 return( PSA_SUCCESS );
4904}
4905
John Durkopd0321952020-10-29 21:37:36 -07004906#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004907/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004908 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004909static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004910 psa_algorithm_t hash_alg,
4911 uint8_t *output,
4912 size_t output_length )
4913{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004914 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004915 psa_status_t status;
4916
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004917 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4918 return( PSA_ERROR_BAD_STATE );
4919 hkdf->state = HKDF_STATE_OUTPUT;
4920
Gilles Peskinebef7f142018-07-12 17:22:21 +02004921 while( output_length != 0 )
4922 {
4923 /* Copy what remains of the current block */
4924 uint8_t n = hash_length - hkdf->offset_in_block;
4925 if( n > output_length )
4926 n = (uint8_t) output_length;
4927 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4928 output += n;
4929 output_length -= n;
4930 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004931 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004932 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004933 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004934 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004935 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004936 * object was corrupted or if this function is called directly
4937 * inside the library. */
4938 if( hkdf->block_number == 0xff )
4939 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004940
4941 /* We need a new block */
4942 ++hkdf->block_number;
4943 hkdf->offset_in_block = 0;
4944 status = psa_hmac_setup_internal( &hkdf->hmac,
4945 hkdf->prk, hash_length,
4946 hash_alg );
4947 if( status != PSA_SUCCESS )
4948 return( status );
4949 if( hkdf->block_number != 1 )
4950 {
4951 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4952 hkdf->output_block,
4953 hash_length );
4954 if( status != PSA_SUCCESS )
4955 return( status );
4956 }
4957 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4958 hkdf->info,
4959 hkdf->info_length );
4960 if( status != PSA_SUCCESS )
4961 return( status );
4962 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4963 &hkdf->block_number, 1 );
4964 if( status != PSA_SUCCESS )
4965 return( status );
4966 status = psa_hmac_finish_internal( &hkdf->hmac,
4967 hkdf->output_block,
4968 sizeof( hkdf->output_block ) );
4969 if( status != PSA_SUCCESS )
4970 return( status );
4971 }
4972
4973 return( PSA_SUCCESS );
4974}
John Durkop07cc04a2020-11-16 22:08:34 -08004975#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004976
John Durkop07cc04a2020-11-16 22:08:34 -08004977#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4978 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004979static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4980 psa_tls12_prf_key_derivation_t *tls12_prf,
4981 psa_algorithm_t alg )
4982{
4983 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004984 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004985 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4986 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004987
Janos Follath7742fee2019-06-17 12:58:10 +01004988 /* We can't be wanting more output after block 0xff, otherwise
4989 * the capacity check in psa_key_derivation_output_bytes() would have
4990 * prevented this call. It could happen only if the operation
4991 * object was corrupted or if this function is called directly
4992 * inside the library. */
4993 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004994 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004995
4996 /* We need a new block */
4997 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004998 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004999
5000 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5001 *
5002 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5003 *
5004 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5005 * HMAC_hash(secret, A(2) + seed) +
5006 * HMAC_hash(secret, A(3) + seed) + ...
5007 *
5008 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005009 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005010 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005011 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005012 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005013 * is currently extracted as `output_block` and where i is
5014 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005015 */
5016
Janos Follathea29bfb2019-06-19 12:21:20 +01005017 /* Save the hash context before using it, to preserve the hash state with
5018 * only the inner padding in it. We need this, because inner padding depends
5019 * on the key (secret in the RFC's terminology). */
5020 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5021 if( status != PSA_SUCCESS )
5022 goto cleanup;
5023
5024 /* Calculate A(i) where i = tls12_prf->block_number. */
5025 if( tls12_prf->block_number == 1 )
5026 {
5027 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5028 * the variable seed and in this instance means it in the context of the
5029 * P_hash function, where seed = label + seed.) */
5030 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5031 tls12_prf->label, tls12_prf->label_length );
5032 if( status != PSA_SUCCESS )
5033 goto cleanup;
5034 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5035 tls12_prf->seed, tls12_prf->seed_length );
5036 if( status != PSA_SUCCESS )
5037 goto cleanup;
5038 }
5039 else
5040 {
5041 /* A(i) = HMAC_hash(secret, A(i-1)) */
5042 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5043 tls12_prf->Ai, hash_length );
5044 if( status != PSA_SUCCESS )
5045 goto cleanup;
5046 }
5047
5048 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5049 tls12_prf->Ai, hash_length );
5050 if( status != PSA_SUCCESS )
5051 goto cleanup;
5052 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5053 if( status != PSA_SUCCESS )
5054 goto cleanup;
5055
5056 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5057 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5058 tls12_prf->Ai, hash_length );
5059 if( status != PSA_SUCCESS )
5060 goto cleanup;
5061 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5062 tls12_prf->label, tls12_prf->label_length );
5063 if( status != PSA_SUCCESS )
5064 goto cleanup;
5065 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5066 tls12_prf->seed, tls12_prf->seed_length );
5067 if( status != PSA_SUCCESS )
5068 goto cleanup;
5069 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5070 tls12_prf->output_block, hash_length );
5071 if( status != PSA_SUCCESS )
5072 goto cleanup;
5073 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5074 if( status != PSA_SUCCESS )
5075 goto cleanup;
5076
Janos Follath7742fee2019-06-17 12:58:10 +01005077
5078cleanup:
5079
Janos Follathea29bfb2019-06-19 12:21:20 +01005080 cleanup_status = psa_hash_abort( &backup );
5081 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5082 status = cleanup_status;
5083
5084 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005085}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005086
Janos Follath844eb0e2019-06-19 12:10:49 +01005087static psa_status_t psa_key_derivation_tls12_prf_read(
5088 psa_tls12_prf_key_derivation_t *tls12_prf,
5089 psa_algorithm_t alg,
5090 uint8_t *output,
5091 size_t output_length )
5092{
5093 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005094 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005095 psa_status_t status;
5096 uint8_t offset, length;
5097
5098 while( output_length != 0 )
5099 {
5100 /* Check if we have fully processed the current block. */
5101 if( tls12_prf->left_in_block == 0 )
5102 {
5103 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5104 alg );
5105 if( status != PSA_SUCCESS )
5106 return( status );
5107
5108 continue;
5109 }
5110
5111 if( tls12_prf->left_in_block > output_length )
5112 length = (uint8_t) output_length;
5113 else
5114 length = tls12_prf->left_in_block;
5115
5116 offset = hash_length - tls12_prf->left_in_block;
5117 memcpy( output, tls12_prf->output_block + offset, length );
5118 output += length;
5119 output_length -= length;
5120 tls12_prf->left_in_block -= length;
5121 }
5122
5123 return( PSA_SUCCESS );
5124}
John Durkop07cc04a2020-11-16 22:08:34 -08005125#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5126 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005127
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005128psa_status_t psa_key_derivation_output_bytes(
5129 psa_key_derivation_operation_t *operation,
5130 uint8_t *output,
5131 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005132{
5133 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005134 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005135
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005136 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005137 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005138 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005139 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005140 }
5141
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005142 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005143 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005144 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005145 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005146 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005147 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005148 goto exit;
5149 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005150 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005151 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005152 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005153 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005154 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5155 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005156 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005157 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005158 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005159 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005160 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005161
John Durkopd0321952020-10-29 21:37:36 -07005162#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005163 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005164 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005165 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005166 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005167 output, output_length );
5168 }
Janos Follathadbec812019-06-14 11:05:39 +01005169 else
John Durkop07cc04a2020-11-16 22:08:34 -08005170#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5171#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5172 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005173 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005174 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005175 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005176 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005177 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005178 output_length );
5179 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005180 else
John Durkop07cc04a2020-11-16 22:08:34 -08005181#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5182 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005183 {
5184 return( PSA_ERROR_BAD_STATE );
5185 }
5186
5187exit:
5188 if( status != PSA_SUCCESS )
5189 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005190 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005191 * This allows us to differentiate between exhausted operations and
5192 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5193 * operations. */
5194 psa_algorithm_t alg = operation->alg;
5195 psa_key_derivation_abort( operation );
5196 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005197 memset( output, '!', output_length );
5198 }
5199 return( status );
5200}
5201
Gilles Peskine08542d82018-07-19 17:05:42 +02005202#if defined(MBEDTLS_DES_C)
5203static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5204{
5205 if( data_size >= 8 )
5206 mbedtls_des_key_set_parity( data );
5207 if( data_size >= 16 )
5208 mbedtls_des_key_set_parity( data + 8 );
5209 if( data_size >= 24 )
5210 mbedtls_des_key_set_parity( data + 16 );
5211}
5212#endif /* MBEDTLS_DES_C */
5213
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005214static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005215 psa_key_slot_t *slot,
5216 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005218{
5219 uint8_t *data = NULL;
5220 size_t bytes = PSA_BITS_TO_BYTES( bits );
5221 psa_status_t status;
5222
Gilles Peskine8e338702019-07-30 20:06:31 +02005223 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005224 return( PSA_ERROR_INVALID_ARGUMENT );
5225 if( bits % 8 != 0 )
5226 return( PSA_ERROR_INVALID_ARGUMENT );
5227 data = mbedtls_calloc( 1, bytes );
5228 if( data == NULL )
5229 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5230
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005231 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005232 if( status != PSA_SUCCESS )
5233 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005234#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005235 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005236 psa_des_set_key_parity( data, bytes );
5237#endif /* MBEDTLS_DES_C */
Ronald Crondd04d422020-11-28 15:14:42 +01005238
5239 status = psa_allocate_buffer_to_slot( slot, bytes );
5240 if( status != PSA_SUCCESS )
5241 return( status );
5242
5243 status = psa_import_key_into_slot( slot, data, bytes,
5244 slot->key.data, slot->key.bytes,
5245 &slot->key.bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005246
5247exit:
5248 mbedtls_free( data );
5249 return( status );
5250}
5251
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005252psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005253 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005254 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005255{
5256 psa_status_t status;
5257 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005258 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005259
Ronald Cron81709fc2020-11-14 12:10:32 +01005260 *key = MBEDTLS_SVC_KEY_ID_INIT;
5261
Gilles Peskine0f84d622019-09-12 19:03:13 +02005262 /* Reject any attempt to create a zero-length key so that we don't
5263 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5264 if( psa_get_key_bits( attributes ) == 0 )
5265 return( PSA_ERROR_INVALID_ARGUMENT );
5266
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005267 if( ! operation->can_output_key )
5268 return( PSA_ERROR_NOT_PERMITTED );
5269
Ronald Cron81709fc2020-11-14 12:10:32 +01005270 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5271 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005272#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5273 if( driver != NULL )
5274 {
5275 /* Deriving a key in a secure element is not implemented yet. */
5276 status = PSA_ERROR_NOT_SUPPORTED;
5277 }
5278#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005279 if( status == PSA_SUCCESS )
5280 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005281 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005282 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005283 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005284 }
5285 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005286 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005287 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005288 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005289
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005290 return( status );
5291}
5292
Gilles Peskineeab56e42018-07-12 17:12:33 +02005293
5294
5295/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005296/* Key derivation */
5297/****************************************************************/
5298
John Durkop07cc04a2020-11-16 22:08:34 -08005299#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005300static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005301 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005302 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005303{
John Durkop07cc04a2020-11-16 22:08:34 -08005304 int is_kdf_alg_supported;
5305
Janos Follath5fe19732019-06-20 15:09:30 +01005306 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5307 * initialisers for this union leave some bytes unspecified.) */
5308 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5309
Gilles Peskine969c5d62019-01-16 15:53:06 +01005310 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005311#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005312 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5313 is_kdf_alg_supported = 1;
5314 else
5315#endif
5316#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5317 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5318 is_kdf_alg_supported = 1;
5319 else
5320#endif
5321#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5322 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5323 is_kdf_alg_supported = 1;
5324 else
5325#endif
5326 is_kdf_alg_supported = 0;
5327
5328 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005329 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005330 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005331 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005332 if( hash_size == 0 )
5333 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005334 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5335 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005336 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005337 {
5338 return( PSA_ERROR_NOT_SUPPORTED );
5339 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005340 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005341 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005342 }
John Durkop07cc04a2020-11-16 22:08:34 -08005343
5344 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005345}
John Durkop07cc04a2020-11-16 22:08:34 -08005346#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005347
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005348psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005349 psa_algorithm_t alg )
5350{
5351 psa_status_t status;
5352
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005353 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005354 return( PSA_ERROR_BAD_STATE );
5355
Gilles Peskine6843c292019-01-18 16:44:49 +01005356 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5357 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005358#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005359 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005360 {
5361 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005362 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005363 }
5364 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5365 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005366 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005367 }
John Durkop07cc04a2020-11-16 22:08:34 -08005368#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005369 else
5370 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005371
5372 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005373 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005374 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005375}
5376
John Durkopd0321952020-10-29 21:37:36 -07005377#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005378static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005379 psa_algorithm_t hash_alg,
5380 psa_key_derivation_step_t step,
5381 const uint8_t *data,
5382 size_t data_length )
5383{
5384 psa_status_t status;
5385 switch( step )
5386 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005387 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005388 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005389 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005390 status = psa_hmac_setup_internal( &hkdf->hmac,
5391 data, data_length,
5392 hash_alg );
5393 if( status != PSA_SUCCESS )
5394 return( status );
5395 hkdf->state = HKDF_STATE_STARTED;
5396 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005397 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005398 /* If no salt was provided, use an empty salt. */
5399 if( hkdf->state == HKDF_STATE_INIT )
5400 {
5401 status = psa_hmac_setup_internal( &hkdf->hmac,
5402 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005403 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005404 if( status != PSA_SUCCESS )
5405 return( status );
5406 hkdf->state = HKDF_STATE_STARTED;
5407 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005408 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005409 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005410 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5411 data, data_length );
5412 if( status != PSA_SUCCESS )
5413 return( status );
5414 status = psa_hmac_finish_internal( &hkdf->hmac,
5415 hkdf->prk,
5416 sizeof( hkdf->prk ) );
5417 if( status != PSA_SUCCESS )
5418 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005419 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005420 hkdf->block_number = 0;
5421 hkdf->state = HKDF_STATE_KEYED;
5422 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005423 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005424 if( hkdf->state == HKDF_STATE_OUTPUT )
5425 return( PSA_ERROR_BAD_STATE );
5426 if( hkdf->info_set )
5427 return( PSA_ERROR_BAD_STATE );
5428 hkdf->info_length = data_length;
5429 if( data_length != 0 )
5430 {
5431 hkdf->info = mbedtls_calloc( 1, data_length );
5432 if( hkdf->info == NULL )
5433 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5434 memcpy( hkdf->info, data, data_length );
5435 }
5436 hkdf->info_set = 1;
5437 return( PSA_SUCCESS );
5438 default:
5439 return( PSA_ERROR_INVALID_ARGUMENT );
5440 }
5441}
John Durkop07cc04a2020-11-16 22:08:34 -08005442#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005443
John Durkop07cc04a2020-11-16 22:08:34 -08005444#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5445 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005446static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5447 const uint8_t *data,
5448 size_t data_length )
5449{
5450 if( prf->state != TLS12_PRF_STATE_INIT )
5451 return( PSA_ERROR_BAD_STATE );
5452
Janos Follathd6dce9f2019-07-04 09:11:38 +01005453 if( data_length != 0 )
5454 {
5455 prf->seed = mbedtls_calloc( 1, data_length );
5456 if( prf->seed == NULL )
5457 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005458
Janos Follathd6dce9f2019-07-04 09:11:38 +01005459 memcpy( prf->seed, data, data_length );
5460 prf->seed_length = data_length;
5461 }
Janos Follathf08e2652019-06-13 09:05:41 +01005462
5463 prf->state = TLS12_PRF_STATE_SEED_SET;
5464
5465 return( PSA_SUCCESS );
5466}
5467
Janos Follath81550542019-06-13 14:26:34 +01005468static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5469 psa_algorithm_t hash_alg,
5470 const uint8_t *data,
5471 size_t data_length )
5472{
5473 psa_status_t status;
5474 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5475 return( PSA_ERROR_BAD_STATE );
5476
5477 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5478 if( status != PSA_SUCCESS )
5479 return( status );
5480
5481 prf->state = TLS12_PRF_STATE_KEY_SET;
5482
5483 return( PSA_SUCCESS );
5484}
5485
Janos Follath63028dd2019-06-13 09:15:47 +01005486static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5487 const uint8_t *data,
5488 size_t data_length )
5489{
5490 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5491 return( PSA_ERROR_BAD_STATE );
5492
Janos Follathd6dce9f2019-07-04 09:11:38 +01005493 if( data_length != 0 )
5494 {
5495 prf->label = mbedtls_calloc( 1, data_length );
5496 if( prf->label == NULL )
5497 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005498
Janos Follathd6dce9f2019-07-04 09:11:38 +01005499 memcpy( prf->label, data, data_length );
5500 prf->label_length = data_length;
5501 }
Janos Follath63028dd2019-06-13 09:15:47 +01005502
5503 prf->state = TLS12_PRF_STATE_LABEL_SET;
5504
5505 return( PSA_SUCCESS );
5506}
5507
Janos Follathb03233e2019-06-11 15:30:30 +01005508static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5509 psa_algorithm_t hash_alg,
5510 psa_key_derivation_step_t step,
5511 const uint8_t *data,
5512 size_t data_length )
5513{
Janos Follathb03233e2019-06-11 15:30:30 +01005514 switch( step )
5515 {
Janos Follathf08e2652019-06-13 09:05:41 +01005516 case PSA_KEY_DERIVATION_INPUT_SEED:
5517 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005518 case PSA_KEY_DERIVATION_INPUT_SECRET:
5519 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005520 case PSA_KEY_DERIVATION_INPUT_LABEL:
5521 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005522 default:
5523 return( PSA_ERROR_INVALID_ARGUMENT );
5524 }
5525}
John Durkop07cc04a2020-11-16 22:08:34 -08005526#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5527 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5528
5529#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5530static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5531 psa_tls12_prf_key_derivation_t *prf,
5532 psa_algorithm_t hash_alg,
5533 const uint8_t *data,
5534 size_t data_length )
5535{
5536 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005537 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005538 uint8_t *cur = pms;
5539
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005540 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005541 return( PSA_ERROR_INVALID_ARGUMENT );
5542
5543 /* Quoting RFC 4279, Section 2:
5544 *
5545 * The premaster secret is formed as follows: if the PSK is N octets
5546 * long, concatenate a uint16 with the value N, N zero octets, a second
5547 * uint16 with the value N, and the PSK itself.
5548 */
5549
5550 *cur++ = ( data_length >> 8 ) & 0xff;
5551 *cur++ = ( data_length >> 0 ) & 0xff;
5552 memset( cur, 0, data_length );
5553 cur += data_length;
5554 *cur++ = pms[0];
5555 *cur++ = pms[1];
5556 memcpy( cur, data, data_length );
5557 cur += data_length;
5558
5559 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5560
5561 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5562 return( status );
5563}
Janos Follath6660f0e2019-06-17 08:44:03 +01005564
5565static psa_status_t psa_tls12_prf_psk_to_ms_input(
5566 psa_tls12_prf_key_derivation_t *prf,
5567 psa_algorithm_t hash_alg,
5568 psa_key_derivation_step_t step,
5569 const uint8_t *data,
5570 size_t data_length )
5571{
5572 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005573 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005574 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5575 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005576 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005577
5578 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5579}
John Durkop07cc04a2020-11-16 22:08:34 -08005580#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005581
Gilles Peskineb8965192019-09-24 16:21:10 +02005582/** Check whether the given key type is acceptable for the given
5583 * input step of a key derivation.
5584 *
5585 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5586 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5587 * Both secret and non-secret inputs can alternatively have the type
5588 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5589 * that the input was passed as a buffer rather than via a key object.
5590 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005591static int psa_key_derivation_check_input_type(
5592 psa_key_derivation_step_t step,
5593 psa_key_type_t key_type )
5594{
5595 switch( step )
5596 {
5597 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005598 if( key_type == PSA_KEY_TYPE_DERIVE )
5599 return( PSA_SUCCESS );
5600 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005601 return( PSA_SUCCESS );
5602 break;
5603 case PSA_KEY_DERIVATION_INPUT_LABEL:
5604 case PSA_KEY_DERIVATION_INPUT_SALT:
5605 case PSA_KEY_DERIVATION_INPUT_INFO:
5606 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005607 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5608 return( PSA_SUCCESS );
5609 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005610 return( PSA_SUCCESS );
5611 break;
5612 }
5613 return( PSA_ERROR_INVALID_ARGUMENT );
5614}
5615
Janos Follathb80a94e2019-06-12 15:54:46 +01005616static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005617 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005618 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005619 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005620 const uint8_t *data,
5621 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005622{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005623 psa_status_t status;
5624 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5625
5626 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005627 if( status != PSA_SUCCESS )
5628 goto exit;
5629
John Durkopd0321952020-10-29 21:37:36 -07005630#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005631 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005632 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005633 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005634 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005635 step, data, data_length );
5636 }
John Durkop07cc04a2020-11-16 22:08:34 -08005637 else
5638#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5639#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5640 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005641 {
Janos Follathb03233e2019-06-11 15:30:30 +01005642 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5643 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5644 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005645 }
John Durkop07cc04a2020-11-16 22:08:34 -08005646 else
5647#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5648#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5649 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005650 {
5651 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5652 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5653 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005654 }
5655 else
John Durkop07cc04a2020-11-16 22:08:34 -08005656#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005657 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005658 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005659 return( PSA_ERROR_BAD_STATE );
5660 }
5661
Gilles Peskine224b0d62019-09-23 18:13:17 +02005662exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005663 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005664 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005665 return( status );
5666}
5667
Janos Follath51f4a0f2019-06-14 11:35:55 +01005668psa_status_t psa_key_derivation_input_bytes(
5669 psa_key_derivation_operation_t *operation,
5670 psa_key_derivation_step_t step,
5671 const uint8_t *data,
5672 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005673{
Gilles Peskineb8965192019-09-24 16:21:10 +02005674 return( psa_key_derivation_input_internal( operation, step,
5675 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005676 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005677}
5678
Janos Follath51f4a0f2019-06-14 11:35:55 +01005679psa_status_t psa_key_derivation_input_key(
5680 psa_key_derivation_operation_t *operation,
5681 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005682 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005683{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005684 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005685 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005686 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005687
Ronald Cron5c522922020-11-14 16:35:34 +01005688 status = psa_get_and_lock_transparent_key_slot_with_policy(
5689 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005690 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005691 {
5692 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005693 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005694 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005695
5696 /* Passing a key object as a SECRET input unlocks the permission
5697 * to output to a key object. */
5698 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5699 operation->can_output_key = 1;
5700
Ronald Cronf95a2b12020-10-22 15:24:49 +02005701 status = psa_key_derivation_input_internal( operation,
5702 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005703 slot->key.data,
5704 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005705
Ronald Cron5c522922020-11-14 16:35:34 +01005706 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005707
Ronald Cron5c522922020-11-14 16:35:34 +01005708 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005709}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005710
5711
5712
5713/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005714/* Key agreement */
5715/****************************************************************/
5716
John Durkop6ba40d12020-11-10 08:50:04 -08005717#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005718static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5719 size_t peer_key_length,
5720 const mbedtls_ecp_keypair *our_key,
5721 uint8_t *shared_secret,
5722 size_t shared_secret_size,
5723 size_t *shared_secret_length )
5724{
Steven Cooremand4867872020-08-05 16:31:39 +02005725 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005726 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005727 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005728 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005729 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005730 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005731
Ronald Cron90857082020-11-25 14:58:33 +01005732 status = mbedtls_psa_ecp_load_representation(
5733 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5734 peer_key,
5735 peer_key_length,
5736 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005737 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005738 goto exit;
5739
Jaeden Amero97271b32019-01-10 19:38:51 +00005740 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005741 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005742 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005743 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005744 status = mbedtls_to_psa_error(
5745 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5746 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005747 goto exit;
5748
Jaeden Amero97271b32019-01-10 19:38:51 +00005749 status = mbedtls_to_psa_error(
5750 mbedtls_ecdh_calc_secret( &ecdh,
5751 shared_secret_length,
5752 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005753 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005754 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005755 if( status != PSA_SUCCESS )
5756 goto exit;
5757 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5758 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005759
5760exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005761 if( status != PSA_SUCCESS )
5762 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005763 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005764 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005765 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005766
Jaeden Amero97271b32019-01-10 19:38:51 +00005767 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005768}
John Durkop6ba40d12020-11-10 08:50:04 -08005769#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005770
Gilles Peskine01d718c2018-09-18 12:01:02 +02005771#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5772
Gilles Peskine0216fe12019-04-11 21:23:21 +02005773static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5774 psa_key_slot_t *private_key,
5775 const uint8_t *peer_key,
5776 size_t peer_key_length,
5777 uint8_t *shared_secret,
5778 size_t shared_secret_size,
5779 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005780{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005781 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005782 {
John Durkop6ba40d12020-11-10 08:50:04 -08005783#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005784 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005785 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005786 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005787 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005788 psa_status_t status = mbedtls_psa_ecp_load_representation(
5789 private_key->attr.type,
5790 private_key->key.data,
5791 private_key->key.bytes,
5792 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005793 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005794 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005795 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005796 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005797 shared_secret, shared_secret_size,
5798 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005799 mbedtls_ecp_keypair_free( ecp );
5800 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005801 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005802#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005803 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005804 (void) private_key;
5805 (void) peer_key;
5806 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005807 (void) shared_secret;
5808 (void) shared_secret_size;
5809 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005810 return( PSA_ERROR_NOT_SUPPORTED );
5811 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005812}
5813
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005814/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005815 * to potentially free embedded data structures and wipe confidential data.
5816 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005817static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005818 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005819 psa_key_slot_t *private_key,
5820 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005821 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005822{
5823 psa_status_t status;
5824 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5825 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005826 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005827
5828 /* Step 1: run the secret agreement algorithm to generate the shared
5829 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005830 status = psa_key_agreement_raw_internal( ka_alg,
5831 private_key,
5832 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005833 shared_secret,
5834 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005835 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005836 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005837 goto exit;
5838
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005839 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005840 * the shared secret. A shared secret is permitted wherever a key
5841 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005842 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005843 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005844 shared_secret,
5845 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005846exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005847 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005848 return( status );
5849}
5850
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005851psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005852 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005853 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005854 const uint8_t *peer_key,
5855 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005856{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005858 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005859 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005860
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005861 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005862 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005863 status = psa_get_and_lock_transparent_key_slot_with_policy(
5864 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005865 if( status != PSA_SUCCESS )
5866 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005867 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005868 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005869 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005870 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005871 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005872 else
5873 {
5874 /* If a private key has been added as SECRET, we allow the derived
5875 * key material to be used as a key in PSA Crypto. */
5876 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5877 operation->can_output_key = 1;
5878 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005879
Ronald Cron5c522922020-11-14 16:35:34 +01005880 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005881
Ronald Cron5c522922020-11-14 16:35:34 +01005882 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005883}
5884
Gilles Peskinebe697d82019-05-16 18:00:41 +02005885psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005886 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005887 const uint8_t *peer_key,
5888 size_t peer_key_length,
5889 uint8_t *output,
5890 size_t output_size,
5891 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005892{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005894 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005895 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005896
5897 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5898 {
5899 status = PSA_ERROR_INVALID_ARGUMENT;
5900 goto exit;
5901 }
Ronald Cron5c522922020-11-14 16:35:34 +01005902 status = psa_get_and_lock_transparent_key_slot_with_policy(
5903 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005904 if( status != PSA_SUCCESS )
5905 goto exit;
5906
5907 status = psa_key_agreement_raw_internal( alg, slot,
5908 peer_key, peer_key_length,
5909 output, output_size,
5910 output_length );
5911
5912exit:
5913 if( status != PSA_SUCCESS )
5914 {
5915 /* If an error happens and is not handled properly, the output
5916 * may be used as a key to protect sensitive data. Arrange for such
5917 * a key to be random, which is likely to result in decryption or
5918 * verification errors. This is better than filling the buffer with
5919 * some constant data such as zeros, which would result in the data
5920 * being protected with a reproducible, easily knowable key.
5921 */
5922 psa_generate_random( output, output_size );
5923 *output_length = output_size;
5924 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005925
Ronald Cron5c522922020-11-14 16:35:34 +01005926 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005927
Ronald Cron5c522922020-11-14 16:35:34 +01005928 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005929}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005930
5931
Gilles Peskine30524eb2020-11-13 17:02:26 +01005932
Gilles Peskine86a440b2018-11-12 18:39:40 +01005933/****************************************************************/
5934/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005935/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005936
Gilles Peskine30524eb2020-11-13 17:02:26 +01005937/** Initialize the PSA random generator.
5938 */
5939static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5940{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005941#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5942 memset( rng, 0, sizeof( *rng ) );
5943#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5944
Gilles Peskine30524eb2020-11-13 17:02:26 +01005945 /* Set default configuration if
5946 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5947 if( rng->entropy_init == NULL )
5948 rng->entropy_init = mbedtls_entropy_init;
5949 if( rng->entropy_free == NULL )
5950 rng->entropy_free = mbedtls_entropy_free;
5951
5952 rng->entropy_init( &rng->entropy );
5953#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5954 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5955 /* The PSA entropy injection feature depends on using NV seed as an entropy
5956 * source. Add NV seed as an entropy source for PSA entropy injection. */
5957 mbedtls_entropy_add_source( &rng->entropy,
5958 mbedtls_nv_seed_poll, NULL,
5959 MBEDTLS_ENTROPY_BLOCK_SIZE,
5960 MBEDTLS_ENTROPY_SOURCE_STRONG );
5961#endif
5962
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005963 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005964#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005965}
5966
5967/** Deinitialize the PSA random generator.
5968 */
5969static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5970{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005971#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5972 memset( rng, 0, sizeof( *rng ) );
5973#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005974 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005975 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005976#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005977}
5978
5979/** Seed the PSA random generator.
5980 */
5981static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5982{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005983#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5984 /* Do nothing: the external RNG seeds itself. */
5985 (void) rng;
5986 return( PSA_SUCCESS );
5987#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005988 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005989 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5990 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005991 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005992#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005993}
5994
Gilles Peskinee59236f2018-01-27 23:32:46 +01005995psa_status_t psa_generate_random( uint8_t *output,
5996 size_t output_size )
5997{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005998 GUARD_MODULE_INITIALIZED;
5999
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006000#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6001
6002 size_t output_length = 0;
6003 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6004 output, output_size,
6005 &output_length );
6006 if( status != PSA_SUCCESS )
6007 return( status );
6008 /* Breaking up a request into smaller chunks is currently not supported
6009 * for the extrernal RNG interface. */
6010 if( output_length != output_size )
6011 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6012 return( PSA_SUCCESS );
6013
6014#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6015
Gilles Peskine71ddab92021-01-04 21:01:07 +01006016 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006017 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006018 size_t request_size =
6019 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6020 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6021 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006022 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6023 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006024 if( ret != 0 )
6025 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006026 output_size -= request_size;
6027 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006028 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006029 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006030#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006031}
6032
Gilles Peskine8814fc42020-12-14 15:33:44 +01006033/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006034 *
6035 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6036 * `psa_generate_random(...)`. The state parameter is ignored since the
6037 * PSA API doesn't support passing an explicit state.
6038 *
6039 * In the non-external case, psa_generate_random() calls an
6040 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6041 * and semantics as mbedtls_psa_get_random(). As an optimization,
6042 * instead of doing this back-and-forth between the PSA API and the
6043 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6044 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006045 */
6046#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6047int mbedtls_psa_get_random( void *p_rng,
6048 unsigned char *output,
6049 size_t output_size )
6050{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006051 /* This function takes a pointer to the RNG state because that's what
6052 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6053 * its own state internally and doesn't let the caller access that state.
6054 * So we just ignore the state parameter, and in practice we'll pass
6055 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006056 (void) p_rng;
6057 psa_status_t status = psa_generate_random( output, output_size );
6058 if( status == PSA_SUCCESS )
6059 return( 0 );
6060 else
6061 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6062}
6063#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6064
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006065#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6066#include "mbedtls/entropy_poll.h"
6067
Gilles Peskine7228da22019-07-15 11:06:15 +02006068psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006069 size_t seed_size )
6070{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006071 if( global_data.initialized )
6072 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006073
6074 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6075 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6076 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6077 return( PSA_ERROR_INVALID_ARGUMENT );
6078
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006079 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006080}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006081#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006082
John Durkop07cc04a2020-11-16 22:08:34 -08006083#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006084static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6085 size_t domain_parameters_size,
6086 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006087{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006088 size_t i;
6089 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006090
Gilles Peskinee56e8782019-04-26 17:34:02 +02006091 if( domain_parameters_size == 0 )
6092 {
6093 *exponent = 65537;
6094 return( PSA_SUCCESS );
6095 }
6096
6097 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6098 * support values that fit in a 32-bit integer, which is larger than
6099 * int on just about every platform anyway. */
6100 if( domain_parameters_size > sizeof( acc ) )
6101 return( PSA_ERROR_NOT_SUPPORTED );
6102 for( i = 0; i < domain_parameters_size; i++ )
6103 acc = ( acc << 8 ) | domain_parameters[i];
6104 if( acc > INT_MAX )
6105 return( PSA_ERROR_NOT_SUPPORTED );
6106 *exponent = acc;
6107 return( PSA_SUCCESS );
6108}
John Durkop07cc04a2020-11-16 22:08:34 -08006109#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006110
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006111static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006112 psa_key_slot_t *slot, size_t bits,
6113 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006114{
Gilles Peskine8e338702019-07-30 20:06:31 +02006115 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006116
Gilles Peskinee56e8782019-04-26 17:34:02 +02006117 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006118 return( PSA_ERROR_INVALID_ARGUMENT );
6119
Gilles Peskinee59236f2018-01-27 23:32:46 +01006120 if( key_type_is_raw_bytes( type ) )
6121 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006122 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006123
6124 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006125 if( status != PSA_SUCCESS )
6126 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006127
6128 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006129 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6130 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006131 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006132
Ronald Cronea0f8a62020-11-25 17:52:23 +01006133 status = psa_generate_random( slot->key.data,
6134 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006135 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006136 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006137
6138 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006139#if defined(MBEDTLS_DES_C)
6140 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006141 psa_des_set_key_parity( slot->key.data,
6142 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006143#endif /* MBEDTLS_DES_C */
6144 }
6145 else
6146
John Durkop07cc04a2020-11-16 22:08:34 -08006147#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006148 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006149 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006150 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006152 int exponent;
6153 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006154 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6155 return( PSA_ERROR_NOT_SUPPORTED );
6156 /* Accept only byte-aligned keys, for the same reasons as
Ronald Cronb6420e32020-11-22 16:15:38 +01006157 * in mbedtls_psa_rsa_import_key(). */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006158 if( bits % 8 != 0 )
6159 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006160 status = psa_read_rsa_exponent( domain_parameters,
6161 domain_parameters_size,
6162 &exponent );
6163 if( status != PSA_SUCCESS )
6164 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006165 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6166 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006167 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006168 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006169 (unsigned int) bits,
6170 exponent );
6171 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006172 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006173
6174 /* Make sure to always have an export representation available */
6175 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6176
Steven Cooreman75b74362020-07-28 14:30:13 +02006177 status = psa_allocate_buffer_to_slot( slot, bytes );
6178 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006179 {
6180 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006181 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006182 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006183
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006184 status = mbedtls_psa_rsa_export_key( type,
6185 &rsa,
6186 slot->key.data,
6187 bytes,
6188 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006189 mbedtls_rsa_free( &rsa );
6190 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006191 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006192 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006193 }
6194 else
John Durkop07cc04a2020-11-16 22:08:34 -08006195#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006196
John Durkop9814fa22020-11-04 12:28:15 -08006197#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006198 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006199 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006200 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006201 mbedtls_ecp_group_id grp_id =
6202 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006203 const mbedtls_ecp_curve_info *curve_info =
6204 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006205 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006206 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006207 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006208 return( PSA_ERROR_NOT_SUPPORTED );
6209 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6210 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006211 mbedtls_ecp_keypair_init( &ecp );
6212 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006213 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006214 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006215 if( ret != 0 )
6216 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006217 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006218 return( mbedtls_to_psa_error( ret ) );
6219 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006220
6221
6222 /* Make sure to always have an export representation available */
6223 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006224 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6225 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006226 {
6227 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006228 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006229 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006230
6231 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006232 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006233
6234 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006235 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006236 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006237 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006238 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006239 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006240 }
6241 else
John Durkop9814fa22020-11-04 12:28:15 -08006242#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006243 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006244 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006245 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006246
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006247 return( PSA_SUCCESS );
6248}
Darryl Green0c6575a2018-11-07 16:05:30 +00006249
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006250psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006251 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006252{
6253 psa_status_t status;
6254 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006255 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006256
Ronald Cron81709fc2020-11-14 12:10:32 +01006257 *key = MBEDTLS_SVC_KEY_ID_INIT;
6258
Gilles Peskine0f84d622019-09-12 19:03:13 +02006259 /* Reject any attempt to create a zero-length key so that we don't
6260 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6261 if( psa_get_key_bits( attributes ) == 0 )
6262 return( PSA_ERROR_INVALID_ARGUMENT );
6263
Ronald Cron81709fc2020-11-14 12:10:32 +01006264 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6265 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006266 if( status != PSA_SUCCESS )
6267 goto exit;
6268
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006269 status = psa_driver_wrapper_generate_key( attributes,
6270 slot );
6271 if( status != PSA_ERROR_NOT_SUPPORTED ||
6272 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6273 goto exit;
6274
6275 status = psa_generate_key_internal(
6276 slot, attributes->core.bits,
6277 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006278
6279exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006280 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006281 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006282 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006283 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006284
Darryl Green0c6575a2018-11-07 16:05:30 +00006285 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006286}
6287
6288
Gilles Peskinee59236f2018-01-27 23:32:46 +01006289
6290/****************************************************************/
6291/* Module setup */
6292/****************************************************************/
6293
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006294#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006295psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6296 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6297 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6298{
6299 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6300 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006301 global_data.rng.entropy_init = entropy_init;
6302 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006303 return( PSA_SUCCESS );
6304}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006305#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006306
Gilles Peskinee59236f2018-01-27 23:32:46 +01006307void mbedtls_psa_crypto_free( void )
6308{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006309 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006310 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6311 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006312 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006313 }
6314 /* Wipe all remaining data, including configuration.
6315 * In particular, this sets all state indicator to the value
6316 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006317 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006318#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006319 /* Unregister all secure element drivers, so that we restart from
6320 * a pristine state. */
6321 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006323}
6324
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006325#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6326/** Recover a transaction that was interrupted by a power failure.
6327 *
6328 * This function is called during initialization, before psa_crypto_init()
6329 * returns. If this function returns a failure status, the initialization
6330 * fails.
6331 */
6332static psa_status_t psa_crypto_recover_transaction(
6333 const psa_crypto_transaction_t *transaction )
6334{
6335 switch( transaction->unknown.type )
6336 {
6337 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6338 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006339 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006340 * is implemented.
6341 * https://github.com/ARMmbed/mbed-crypto/issues/218
6342 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006343 default:
6344 /* We found an unsupported transaction in the storage.
6345 * We don't know what state the storage is in. Give up. */
6346 return( PSA_ERROR_STORAGE_FAILURE );
6347 }
6348}
6349#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6350
Gilles Peskinee59236f2018-01-27 23:32:46 +01006351psa_status_t psa_crypto_init( void )
6352{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006353 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006354
Gilles Peskinec6b69072018-11-20 21:42:52 +01006355 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006356 if( global_data.initialized != 0 )
6357 return( PSA_SUCCESS );
6358
Gilles Peskine30524eb2020-11-13 17:02:26 +01006359 /* Initialize and seed the random generator. */
6360 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006361 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006362 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006363 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006364 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006365 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006366
Gilles Peskine66fb1262018-12-10 16:29:04 +01006367 status = psa_initialize_key_slots( );
6368 if( status != PSA_SUCCESS )
6369 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006370
Gilles Peskined9348f22019-10-01 15:22:29 +02006371#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6372 status = psa_init_all_se_drivers( );
6373 if( status != PSA_SUCCESS )
6374 goto exit;
6375#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6376
Gilles Peskine4b734222019-07-24 15:56:31 +02006377#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006378 status = psa_crypto_load_transaction( );
6379 if( status == PSA_SUCCESS )
6380 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006381 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6382 if( status != PSA_SUCCESS )
6383 goto exit;
6384 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006385 }
6386 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6387 {
6388 /* There's no transaction to complete. It's all good. */
6389 status = PSA_SUCCESS;
6390 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006391#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006392
Gilles Peskinec6b69072018-11-20 21:42:52 +01006393 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006394 global_data.initialized = 1;
6395
6396exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006397 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006398 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006399 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006400}
6401
6402#endif /* MBEDTLS_PSA_CRYPTO_C */