blob: 4cdfd99486a29e66692db77c4e47db3784d22fee [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
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100586/** Import a key in binary format.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200587 *
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100588 * \note The signature of this function is that of a PSA driver
589 * import_key entry point. This function behaves as an import_key
590 * entry point as defined in the PSA driver interface specification for
591 * transparent drivers.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200592 *
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100593 * \param[in] attributes The attributes for the key to import.
594 * \param[in] data The buffer containing the key data in import
595 * format.
596 * \param[in] data_length Size of the \p data buffer in bytes.
597 * \param[out] key_buffer The buffer containing the key data in output
598 * format.
599 * \param[in] key_buffer_size Size of the \p key_buffer buffer in bytes. This
600 * size is greater or equal to \p data_length.
Ronald Crondd04d422020-11-28 15:14:42 +0100601 * \param[out] key_buffer_length The length of the data written in \p
602 * key_buffer in bytes.
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100603 * \param[out] bits The key size in number of bits.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200604 *
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100605 * \retval #PSA_SUCCESS The key was imported successfully.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200606 * \retval #PSA_ERROR_INVALID_ARGUMENT
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100607 * The key data is not correctly formatted.
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200608 * \retval #PSA_ERROR_NOT_SUPPORTED
609 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100610 * \retval #PSA_ERROR_CORRUPTION_DETECTED
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200611 */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100612static psa_status_t psa_import_key_into_slot(
613 const psa_key_attributes_t *attributes,
614 const uint8_t *data, size_t data_length,
615 uint8_t *key_buffer, size_t key_buffer_size,
616 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100617{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100618 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
619 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100620
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200621 /* zero-length keys are never supported. */
622 if( data_length == 0 )
623 return( PSA_ERROR_NOT_SUPPORTED );
624
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100625 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100626 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100627 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200628
Steven Cooreman75b74362020-07-28 14:30:13 +0200629 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
630 if( data_length > SIZE_MAX / 8 )
631 return( PSA_ERROR_NOT_SUPPORTED );
632
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200633 /* Enforce a size limit, and in particular ensure that the bit
634 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100635 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200636 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200637
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100638 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200639 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200640 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200641
Ronald Crondd04d422020-11-28 15:14:42 +0100642 /* Copy the key material. */
643 memcpy( key_buffer, data, data_length );
644 *key_buffer_length = data_length;
645 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200646
Steven Cooreman40120f62020-10-29 11:42:22 +0100647 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100648 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100649 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200650 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100651 status = psa_driver_wrapper_import_key( attributes,
Ronald Cron83282872020-11-22 14:02:39 +0100652 data, data_length,
Ronald Crondd04d422020-11-28 15:14:42 +0100653 key_buffer,
654 key_buffer_size,
655 key_buffer_length,
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100656 bits );
657 if( status != PSA_ERROR_NOT_SUPPORTED )
658 return( status );
Ronald Cron83282872020-11-22 14:02:39 +0100659
Ronald Crondd04d422020-11-28 15:14:42 +0100660 mbedtls_platform_zeroize( key_buffer, key_buffer_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200661
662 /* Key format is not supported by any accelerator, try software fallback
663 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800664#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
665 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100666 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200667 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100668 return( mbedtls_psa_ecp_import_key( attributes,
669 data, data_length,
670 key_buffer, key_buffer_size,
671 key_buffer_length,
672 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100673 }
John Durkop9814fa22020-11-04 12:28:15 -0800674#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
675 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700676#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
677 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100678 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200679 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100680 return( mbedtls_psa_rsa_import_key( attributes,
681 data, data_length,
682 key_buffer, key_buffer_size,
683 key_buffer_length,
684 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200685 }
John Durkop9814fa22020-11-04 12:28:15 -0800686#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
687 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100688 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100689
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100690 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100691}
692
Gilles Peskinef603c712019-01-19 13:40:11 +0100693/** Calculate the intersection of two algorithm usage policies.
694 *
695 * Return 0 (which allows no operation) on incompatibility.
696 */
697static psa_algorithm_t psa_key_policy_algorithm_intersection(
698 psa_algorithm_t alg1,
699 psa_algorithm_t alg2 )
700{
Gilles Peskine549ea862019-05-22 11:45:59 +0200701 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100702 if( alg1 == alg2 )
703 return( alg1 );
704 /* If the policies are from the same hash-and-sign family, check
705 * if one is a wildcard. If so the other has the specific algorithm. */
706 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
707 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
708 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
709 {
710 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
711 return( alg2 );
712 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
713 return( alg1 );
714 }
715 /* If the policies are incompatible, allow nothing. */
716 return( 0 );
717}
718
Gilles Peskined6f371b2019-05-10 19:33:38 +0200719static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
720 psa_algorithm_t requested_alg )
721{
Gilles Peskine549ea862019-05-22 11:45:59 +0200722 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200723 if( requested_alg == policy_alg )
724 return( 1 );
725 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200726 * and requested_alg is the same hash-and-sign family with any hash,
727 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200728 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
729 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
730 {
731 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
732 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
733 }
Steven Cooremance48e852020-10-05 16:02:45 +0200734 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200735 * a key derivation with that key agreement should also be allowed. This
736 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200737 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
738 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
739 {
740 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
741 policy_alg );
742 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200743 /* If it isn't permitted, it's forbidden. */
744 return( 0 );
745}
746
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100747/** Test whether a policy permits an algorithm.
748 *
749 * The caller must test usage flags separately.
750 */
751static int psa_key_policy_permits( const psa_key_policy_t *policy,
752 psa_algorithm_t alg )
753{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200754 return( psa_key_algorithm_permits( policy->alg, alg ) ||
755 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100756}
757
Gilles Peskinef603c712019-01-19 13:40:11 +0100758/** Restrict a key policy based on a constraint.
759 *
760 * \param[in,out] policy The policy to restrict.
761 * \param[in] constraint The policy constraint to apply.
762 *
763 * \retval #PSA_SUCCESS
764 * \c *policy contains the intersection of the original value of
765 * \c *policy and \c *constraint.
766 * \retval #PSA_ERROR_INVALID_ARGUMENT
767 * \c *policy and \c *constraint are incompatible.
768 * \c *policy is unchanged.
769 */
770static psa_status_t psa_restrict_key_policy(
771 psa_key_policy_t *policy,
772 const psa_key_policy_t *constraint )
773{
774 psa_algorithm_t intersection_alg =
775 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200776 psa_algorithm_t intersection_alg2 =
777 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100778 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
779 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200780 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
781 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100782 policy->usage &= constraint->usage;
783 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200784 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100785 return( PSA_SUCCESS );
786}
787
Ronald Cron5c522922020-11-14 16:35:34 +0100788/** Get the description of a key given its identifier and policy constraints
789 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200790 *
Ronald Cron5c522922020-11-14 16:35:34 +0100791 * The key must have allow all the usage flags set in \p usage. If \p alg is
792 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100793 *
Ronald Cron5c522922020-11-14 16:35:34 +0100794 * In case of a persistent key, the function loads the description of the key
795 * into a key slot if not already done.
796 *
797 * On success, the returned key slot is locked. It is the responsibility of
798 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200799 */
Ronald Cron5c522922020-11-14 16:35:34 +0100800static psa_status_t psa_get_and_lock_key_slot_with_policy(
801 mbedtls_svc_key_id_t key,
802 psa_key_slot_t **p_slot,
803 psa_key_usage_t usage,
804 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100805{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
807 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100808
Ronald Cron5c522922020-11-14 16:35:34 +0100809 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100810 if( status != PSA_SUCCESS )
811 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200812 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100813
814 /* Enforce that usage policy for the key slot contains all the flags
815 * required by the usage parameter. There is one exception: public
816 * keys can always be exported, so we treat public key objects as
817 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200818 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100819 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200820
821 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200822 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200823 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100824
825 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200826 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200827 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100828
Darryl Green06fd18d2018-07-16 11:21:11 +0100829 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200830
831error:
832 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100833 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200834
835 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100836}
Darryl Green940d72c2018-07-13 13:18:51 +0100837
Ronald Cron5c522922020-11-14 16:35:34 +0100838/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200839 *
840 * A transparent key is a key for which the key material is directly
841 * available, as opposed to a key in a secure element.
842 *
Ronald Cron5c522922020-11-14 16:35:34 +0100843 * This is a temporary function to use instead of
844 * psa_get_and_lock_key_slot_with_policy() until secure element support is
845 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200846 *
Ronald Cron5c522922020-11-14 16:35:34 +0100847 * On success, the returned key slot is locked. It is the responsibility of the
848 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200849 */
850#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100851static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
852 mbedtls_svc_key_id_t key,
853 psa_key_slot_t **p_slot,
854 psa_key_usage_t usage,
855 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200856{
Ronald Cron5c522922020-11-14 16:35:34 +0100857 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
858 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200859 if( status != PSA_SUCCESS )
860 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200861
Gilles Peskineadad8132019-07-25 11:31:23 +0200862 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200863 {
Ronald Cron5c522922020-11-14 16:35:34 +0100864 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200865 *p_slot = NULL;
866 return( PSA_ERROR_NOT_SUPPORTED );
867 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200868
Gilles Peskine28f8f302019-07-24 13:30:31 +0200869 return( PSA_SUCCESS );
870}
871#else /* MBEDTLS_PSA_CRYPTO_SE_C */
872/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100873#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
874 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200875#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
876
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100877/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100878static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000879{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100880 /* Data pointer will always be either a valid pointer or NULL in an
881 * initialized slot, so we can just free it. */
882 if( slot->key.data != NULL )
883 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
884
885 mbedtls_free( slot->key.data );
886 slot->key.data = NULL;
887 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000888
889 return( PSA_SUCCESS );
890}
891
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100892/** Completely wipe a slot in memory, including its policy.
893 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100894psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100895{
896 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100897
898 /*
899 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +0100900 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +0100901 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
902 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +0100903 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +0100904 */
Ronald Cron5c522922020-11-14 16:35:34 +0100905 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100906 {
907#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +0100908 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100909#endif
Ronald Cronddd3d052020-10-30 14:07:07 +0100910 status = PSA_ERROR_CORRUPTION_DETECTED;
911 }
912
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200913 /* Multipart operations may still be using the key. This is safe
914 * because all multipart operation objects are independent from
915 * the key slot: if they need to access the key after the setup
916 * phase, they have a copy of the key. Note that this means that
917 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100918 /* At this point, key material and other type-specific content has
919 * been wiped. Clear remaining metadata. We can call memset and not
920 * zeroize because the metadata is not particularly sensitive. */
921 memset( slot, 0, sizeof( *slot ) );
922 return( status );
923}
924
Ronald Croncf56a0a2020-08-04 09:51:30 +0200925psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100926{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100927 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200928 psa_status_t status; /* status of the last operation */
929 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +0200930#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
931 psa_se_drv_table_entry_t *driver;
932#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100933
Ronald Croncf56a0a2020-08-04 09:51:30 +0200934 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +0200935 return( PSA_SUCCESS );
936
Ronald Cronf2911112020-10-29 17:51:10 +0100937 /*
Ronald Cron19daca92020-11-10 18:08:03 +0100938 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +0100939 * key, this will load the key description from persistent memory if not
940 * done yet. We cannot avoid this loading as without it we don't know if
941 * the key is operated by an SE or not and this information is needed by
942 * the current implementation.
943 */
Ronald Cron5c522922020-11-14 16:35:34 +0100944 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200945 if( status != PSA_SUCCESS )
946 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +0200947
Ronald Cronf2911112020-10-29 17:51:10 +0100948 /*
949 * If the key slot containing the key description is under access by the
950 * library (apart from the present access), the key cannot be destroyed
951 * yet. For the time being, just return in error. Eventually (to be
952 * implemented), the key should be destroyed when all accesses have
953 * stopped.
954 */
Ronald Cron5c522922020-11-14 16:35:34 +0100955 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +0100956 {
Ronald Cron5c522922020-11-14 16:35:34 +0100957 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +0100958 return( PSA_ERROR_GENERIC_ERROR );
959 }
960
Gilles Peskine354f7672019-07-12 23:46:38 +0200961#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200962 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +0200963 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +0200964 {
Gilles Peskine60450a42019-07-25 11:32:45 +0200965 /* For a key in a secure element, we need to do three things:
966 * remove the key file in internal storage, destroy the
967 * key inside the secure element, and update the driver's
968 * persistent data. Start a transaction that will encompass these
969 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +0200970 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +0200971 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +0100972 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +0200973 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +0200974 status = psa_crypto_save_transaction( );
975 if( status != PSA_SUCCESS )
976 {
Gilles Peskine66be51c2019-07-25 18:02:52 +0200977 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200978 /* We should still try to destroy the key in the secure
979 * element and the key metadata in storage. This is especially
980 * important if the error is that the storage is full.
981 * But how to do it exactly without risking an inconsistent
982 * state after a reset?
983 * https://github.com/ARMmbed/mbed-crypto/issues/215
984 */
985 overall_status = status;
986 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +0200987 }
988
Ronald Cronea0f8a62020-11-25 17:52:23 +0100989 status = psa_destroy_se_key( driver,
990 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200991 if( overall_status == PSA_SUCCESS )
992 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +0200993 }
Gilles Peskine354f7672019-07-12 23:46:38 +0200994#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
995
Darryl Greend49a4992018-06-18 17:27:26 +0100996#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +0200997 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +0100998 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200999 status = psa_destroy_persistent_key( slot->attr.id );
1000 if( overall_status == PSA_SUCCESS )
1001 overall_status = status;
1002
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001003 /* TODO: other slots may have a copy of the same key. We should
1004 * invalidate them.
1005 * https://github.com/ARMmbed/mbed-crypto/issues/214
1006 */
Darryl Greend49a4992018-06-18 17:27:26 +01001007 }
1008#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001009
Gilles Peskinefc762652019-07-22 19:30:34 +02001010#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1011 if( driver != NULL )
1012 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001013 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001014 if( overall_status == PSA_SUCCESS )
1015 overall_status = status;
1016 status = psa_crypto_stop_transaction( );
1017 if( overall_status == PSA_SUCCESS )
1018 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001019 }
1020#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1021
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023exit:
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001025 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001026 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1027 if( overall_status == PSA_SUCCESS )
1028 overall_status = status;
1029 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001030}
1031
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001032void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001033{
Gilles Peskineb699f072019-04-26 16:06:02 +02001034 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001035 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001036}
1037
Gilles Peskineb699f072019-04-26 16:06:02 +02001038psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1039 psa_key_type_t type,
1040 const uint8_t *data,
1041 size_t data_length )
1042{
1043 uint8_t *copy = NULL;
1044
1045 if( data_length != 0 )
1046 {
1047 copy = mbedtls_calloc( 1, data_length );
1048 if( copy == NULL )
1049 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1050 memcpy( copy, data, data_length );
1051 }
1052 /* After this point, this function is guaranteed to succeed, so it
1053 * can start modifying `*attributes`. */
1054
1055 if( attributes->domain_parameters != NULL )
1056 {
1057 mbedtls_free( attributes->domain_parameters );
1058 attributes->domain_parameters = NULL;
1059 attributes->domain_parameters_size = 0;
1060 }
1061
1062 attributes->domain_parameters = copy;
1063 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001064 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001065 return( PSA_SUCCESS );
1066}
1067
1068psa_status_t psa_get_key_domain_parameters(
1069 const psa_key_attributes_t *attributes,
1070 uint8_t *data, size_t data_size, size_t *data_length )
1071{
1072 if( attributes->domain_parameters_size > data_size )
1073 return( PSA_ERROR_BUFFER_TOO_SMALL );
1074 *data_length = attributes->domain_parameters_size;
1075 if( attributes->domain_parameters_size != 0 )
1076 memcpy( data, attributes->domain_parameters,
1077 attributes->domain_parameters_size );
1078 return( PSA_SUCCESS );
1079}
1080
John Durkop07cc04a2020-11-16 22:08:34 -08001081#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001082 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001083static psa_status_t psa_get_rsa_public_exponent(
1084 const mbedtls_rsa_context *rsa,
1085 psa_key_attributes_t *attributes )
1086{
1087 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001089 uint8_t *buffer = NULL;
1090 size_t buflen;
1091 mbedtls_mpi_init( &mpi );
1092
1093 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1094 if( ret != 0 )
1095 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001096 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1097 {
1098 /* It's the default value, which is reported as an empty string,
1099 * so there's nothing to do. */
1100 goto exit;
1101 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001102
1103 buflen = mbedtls_mpi_size( &mpi );
1104 buffer = mbedtls_calloc( 1, buflen );
1105 if( buffer == NULL )
1106 {
1107 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1108 goto exit;
1109 }
1110 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1111 if( ret != 0 )
1112 goto exit;
1113 attributes->domain_parameters = buffer;
1114 attributes->domain_parameters_size = buflen;
1115
1116exit:
1117 mbedtls_mpi_free( &mpi );
1118 if( ret != 0 )
1119 mbedtls_free( buffer );
1120 return( mbedtls_to_psa_error( ret ) );
1121}
John Durkop07cc04a2020-11-16 22:08:34 -08001122#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001123 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001124
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001125/** Retrieve all the publicly-accessible attributes of a key.
1126 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001127psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001128 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001129{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001130 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001131 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001132 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001133
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001134 psa_reset_key_attributes( attributes );
1135
Ronald Cron5c522922020-11-14 16:35:34 +01001136 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001137 if( status != PSA_SUCCESS )
1138 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001139
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001140 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001141 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1142 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1143
1144#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1145 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001146 psa_set_key_slot_number( attributes,
1147 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001148#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001149
Gilles Peskine8e338702019-07-30 20:06:31 +02001150 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001151 {
John Durkop07cc04a2020-11-16 22:08:34 -08001152#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001153 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001154 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001155 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001156#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001157 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001158 * is not yet implemented.
1159 * https://github.com/ARMmbed/mbed-crypto/issues/216
1160 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001161 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001162 break;
1163#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001164 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001165 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001166
Ronald Cron90857082020-11-25 14:58:33 +01001167 status = mbedtls_psa_rsa_load_representation(
1168 slot->attr.type,
1169 slot->key.data,
1170 slot->key.bytes,
1171 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001172 if( status != PSA_SUCCESS )
1173 break;
1174
Steven Cooremana2371e52020-07-28 14:30:39 +02001175 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001176 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001177 mbedtls_rsa_free( rsa );
1178 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001179 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001180 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001181#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001182 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001183 default:
1184 /* Nothing else to do. */
1185 break;
1186 }
1187
1188 if( status != PSA_SUCCESS )
1189 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001190
Ronald Cron5c522922020-11-14 16:35:34 +01001191 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001192
Ronald Cron5c522922020-11-14 16:35:34 +01001193 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001194}
1195
Gilles Peskinec8000c02019-08-02 20:15:51 +02001196#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1197psa_status_t psa_get_key_slot_number(
1198 const psa_key_attributes_t *attributes,
1199 psa_key_slot_number_t *slot_number )
1200{
1201 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1202 {
1203 *slot_number = attributes->slot_number;
1204 return( PSA_SUCCESS );
1205 }
1206 else
1207 return( PSA_ERROR_INVALID_ARGUMENT );
1208}
1209#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1210
Ronald Crond18b5f82020-11-25 16:46:05 +01001211static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1212 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001213 uint8_t *data,
1214 size_t data_size,
1215 size_t *data_length )
1216{
Ronald Crond18b5f82020-11-25 16:46:05 +01001217 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001218 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001219 memcpy( data, key_buffer, key_buffer_size );
1220 memset( data + key_buffer_size, 0,
1221 data_size - key_buffer_size );
1222 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001223 return( PSA_SUCCESS );
1224}
1225
Ronald Cron7285cda2020-11-26 14:46:37 +01001226psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001227 const psa_key_attributes_t *attributes,
1228 const uint8_t *key_buffer, size_t key_buffer_size,
1229 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001230{
Ronald Crond18b5f82020-11-25 16:46:05 +01001231 psa_key_type_t type = attributes->core.type;
1232
Ronald Crond18b5f82020-11-25 16:46:05 +01001233 if( key_type_is_raw_bytes( type ) ||
1234 PSA_KEY_TYPE_IS_RSA( type ) ||
1235 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001236 {
1237 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001238 key_buffer, key_buffer_size,
1239 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001240 }
1241 else
1242 {
1243 /* This shouldn't happen in the reference implementation, but
1244 it is valid for a special-purpose implementation to omit
1245 support for exporting certain key types. */
1246 return( PSA_ERROR_NOT_SUPPORTED );
1247 }
1248}
1249
1250psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1251 uint8_t *data,
1252 size_t data_size,
1253 size_t *data_length )
1254{
1255 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1256 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1257 psa_key_slot_t *slot;
1258
1259 /* Set the key to empty now, so that even when there are errors, we always
1260 * set data_length to a value between 0 and data_size. On error, setting
1261 * the key to empty is a good choice because an empty key representation is
1262 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001263 *data_length = 0;
1264
Ronald Cron9486f9d2020-11-26 13:36:23 +01001265 /* Export requires the EXPORT flag. There is an exception for public keys,
1266 * which don't require any flag, but
1267 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1268 */
1269 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1270 PSA_KEY_USAGE_EXPORT, 0 );
1271 if( status != PSA_SUCCESS )
1272 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001273
Gilles Peskinef9168942019-09-12 19:20:29 +02001274 /* Reject a zero-length output buffer now, since this can never be a
1275 * valid key representation. This way we know that data must be a valid
1276 * pointer and we can do things like memset(data, ..., data_size). */
1277 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001278 {
1279 status = PSA_ERROR_BUFFER_TOO_SMALL;
1280 goto exit;
1281 }
1282
Ronald Crond18b5f82020-11-25 16:46:05 +01001283 psa_key_attributes_t attributes = {
1284 .core = slot->attr
1285 };
Ronald Cron67227982020-11-26 15:16:05 +01001286 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001287 slot->key.data, slot->key.bytes,
1288 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001289
1290exit:
1291 unlock_status = psa_unlock_key_slot( slot );
1292
1293 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1294}
1295
Ronald Cron7285cda2020-11-26 14:46:37 +01001296psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001297 const psa_key_attributes_t *attributes,
1298 const uint8_t *key_buffer,
1299 size_t key_buffer_size,
1300 uint8_t *data,
1301 size_t data_size,
1302 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001303{
Ronald Crond18b5f82020-11-25 16:46:05 +01001304 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001305
Ronald Crond18b5f82020-11-25 16:46:05 +01001306 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001307 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001308 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001309 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001310 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001311 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001312 key_buffer, key_buffer_size,
1313 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001314 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001315
Ronald Crond18b5f82020-11-25 16:46:05 +01001316 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001317 {
John Durkop0e005192020-10-31 22:06:54 -07001318#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1319 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001320 return( mbedtls_psa_rsa_export_public_key( attributes,
1321 key_buffer,
1322 key_buffer_size,
1323 data,
1324 data_size,
1325 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001326#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001327 /* We don't know how to convert a private RSA key to public. */
1328 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001329#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1330 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001331 }
1332 else
Moran Pekera998bc62018-04-16 18:16:20 +03001333 {
John Durkop6ba40d12020-11-10 08:50:04 -08001334#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1335 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001336 return( mbedtls_psa_ecp_export_public_key( attributes,
1337 key_buffer,
1338 key_buffer_size,
1339 data,
1340 data_size,
1341 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001342#else
1343 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001344 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001345#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1346 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001347 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001348 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001349 else
1350 {
1351 /* This shouldn't happen in the reference implementation, but
1352 it is valid for a special-purpose implementation to omit
1353 support for exporting certain key types. */
1354 return( PSA_ERROR_NOT_SUPPORTED );
1355 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001356}
Ronald Crond18b5f82020-11-25 16:46:05 +01001357
Ronald Croncf56a0a2020-08-04 09:51:30 +02001358psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001359 uint8_t *data,
1360 size_t data_size,
1361 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001362{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001363 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001364 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001365 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001366
1367 /* Set the key to empty now, so that even when there are errors, we always
1368 * set data_length to a value between 0 and data_size. On error, setting
1369 * the key to empty is a good choice because an empty key representation is
1370 * unlikely to be accepted anywhere. */
1371 *data_length = 0;
1372
1373 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001374 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001375 if( status != PSA_SUCCESS )
1376 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001377
Ronald Cron9486f9d2020-11-26 13:36:23 +01001378 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1379 {
1380 status = PSA_ERROR_INVALID_ARGUMENT;
1381 goto exit;
1382 }
1383
1384 /* Reject a zero-length output buffer now, since this can never be a
1385 * valid key representation. This way we know that data must be a valid
1386 * pointer and we can do things like memset(data, ..., data_size). */
1387 if( data_size == 0 )
1388 {
1389 status = PSA_ERROR_BUFFER_TOO_SMALL;
1390 goto exit;
1391 }
1392
Ronald Crond18b5f82020-11-25 16:46:05 +01001393 psa_key_attributes_t attributes = {
1394 .core = slot->attr
1395 };
Ronald Cron67227982020-11-26 15:16:05 +01001396 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001397 &attributes, slot->key.data, slot->key.bytes,
1398 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399
1400exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001401 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001402
Ronald Cron5c522922020-11-14 16:35:34 +01001403 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001404}
1405
Gilles Peskine91e8c332019-08-02 19:19:39 +02001406#if defined(static_assert)
1407static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1408 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001409static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001410 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001411static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001412 "One or more key attribute flag is listed as both internal-only and external-only" );
1413#endif
1414
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001415/** Validate that a key policy is internally well-formed.
1416 *
1417 * This function only rejects invalid policies. It does not validate the
1418 * consistency of the policy with respect to other attributes of the key
1419 * such as the key type.
1420 */
1421static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001422{
1423 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001424 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001425 PSA_KEY_USAGE_ENCRYPT |
1426 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001427 PSA_KEY_USAGE_SIGN_HASH |
1428 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001429 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1430 return( PSA_ERROR_INVALID_ARGUMENT );
1431
Gilles Peskine4747d192019-04-17 15:05:45 +02001432 return( PSA_SUCCESS );
1433}
1434
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001435/** Validate the internal consistency of key attributes.
1436 *
1437 * This function only rejects invalid attribute values. If does not
1438 * validate the consistency of the attributes with any key data that may
1439 * be involved in the creation of the key.
1440 *
1441 * Call this function early in the key creation process.
1442 *
1443 * \param[in] attributes Key attributes for the new key.
1444 * \param[out] p_drv On any return, the driver for the key, if any.
1445 * NULL for a transparent key.
1446 *
1447 */
1448static psa_status_t psa_validate_key_attributes(
1449 const psa_key_attributes_t *attributes,
1450 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001451{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001452 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001453 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001454 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001455
Ronald Cron54b90082020-10-29 15:26:43 +01001456 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001457 if( status != PSA_SUCCESS )
1458 return( status );
1459
Ronald Crond2ed4812020-07-17 16:11:30 +02001460 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001461 if( status != PSA_SUCCESS )
1462 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001463
Ronald Cron65f38a32020-10-23 17:11:13 +02001464 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1465 {
1466 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1467 return( PSA_ERROR_INVALID_ARGUMENT );
1468 }
1469 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001470 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001471 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001472 if( status != PSA_SUCCESS )
1473 return( status );
1474 }
1475
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001476 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001477 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001478 return( status );
1479
1480 /* Refuse to create overly large keys.
1481 * Note that this doesn't trigger on import if the attributes don't
1482 * explicitly specify a size (so psa_get_key_bits returns 0), so
1483 * psa_import_key() needs its own checks. */
1484 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1485 return( PSA_ERROR_NOT_SUPPORTED );
1486
Gilles Peskine91e8c332019-08-02 19:19:39 +02001487 /* Reject invalid flags. These should not be reachable through the API. */
1488 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1489 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1490 return( PSA_ERROR_INVALID_ARGUMENT );
1491
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001492 return( PSA_SUCCESS );
1493}
1494
Gilles Peskine4747d192019-04-17 15:05:45 +02001495/** Prepare a key slot to receive key material.
1496 *
1497 * This function allocates a key slot and sets its metadata.
1498 *
1499 * If this function fails, call psa_fail_key_creation().
1500 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001501 * This function is intended to be used as follows:
1502 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001503 * it with the specified attributes, and in case of a volatile key assign it
1504 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001505 * -# Populate the slot with the key material.
1506 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1507 * In case of failure at any step, stop the sequence and call
1508 * psa_fail_key_creation().
1509 *
Ronald Cron5c522922020-11-14 16:35:34 +01001510 * On success, the key slot is locked. It is the responsibility of the caller
1511 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001512 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001513 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001514 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001515 * \param[out] p_slot On success, a pointer to the prepared slot.
1516 * \param[out] p_drv On any return, the driver for the key, if any.
1517 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001518 *
1519 * \retval #PSA_SUCCESS
1520 * The key slot is ready to receive key material.
1521 * \return If this function fails, the key slot is an invalid state.
1522 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001523 */
1524static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001525 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001526 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001527 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001528 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001529{
1530 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001531 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001532 psa_key_slot_t *slot;
1533
Gilles Peskinedf179142019-07-15 22:02:14 +02001534 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001535 *p_drv = NULL;
1536
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001537 status = psa_validate_key_attributes( attributes, p_drv );
1538 if( status != PSA_SUCCESS )
1539 return( status );
1540
Ronald Cronc4d1b512020-07-31 11:26:37 +02001541 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001542 if( status != PSA_SUCCESS )
1543 return( status );
1544 slot = *p_slot;
1545
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001546 /* We're storing the declared bit-size of the key. It's up to each
1547 * creation mechanism to verify that this information is correct.
1548 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001549 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001550 * is optional (import, copy). In case of a volatile key, assign it the
1551 * volatile key identifier associated to the slot returned to contain its
1552 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001553
1554 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001555 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1556 {
1557#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1558 slot->attr.id = volatile_key_id;
1559#else
1560 slot->attr.id.key_id = volatile_key_id;
1561#endif
1562 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001563
Gilles Peskine91e8c332019-08-02 19:19:39 +02001564 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001565 * external-only flags, query `attributes`. Thanks to the check
1566 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001567 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001568 * may have set. */
1569 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001570
Gilles Peskinecbaff462019-07-12 23:46:04 +02001571#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001572 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001573 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001574 * create the key file in internal storage, create the
1575 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001576 * persistent data. This is done by starting a transaction that will
1577 * encompass these three actions.
1578 * For registering a volatile key, we just need to find an appropriate
1579 * slot number inside the SE. Since the key is designated volatile, creating
1580 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001581 /* The first thing to do is to find a slot number for the new key.
1582 * We save the slot number in persistent storage as part of the
1583 * transaction data. It will be needed to recover if the power
1584 * fails during the key creation process, to clean up on the secure
1585 * element side after restarting. Obtaining a slot number from the
1586 * secure element driver updates its persistent state, but we do not yet
1587 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001588 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001589 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001590 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001591 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001592 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001593 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001594 if( status != PSA_SUCCESS )
1595 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001596
1597 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001598 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001599 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1600 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001601 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001602 psa_crypto_transaction.key.id = slot->attr.id;
1603 status = psa_crypto_save_transaction( );
1604 if( status != PSA_SUCCESS )
1605 {
1606 (void) psa_crypto_stop_transaction( );
1607 return( status );
1608 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001609 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001610
1611 status = psa_copy_key_material_into_slot(
1612 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001613 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001614
1615 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1616 {
1617 /* Key registration only makes sense with a secure element. */
1618 return( PSA_ERROR_INVALID_ARGUMENT );
1619 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001620#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1621
Ronald Cronc4d1b512020-07-31 11:26:37 +02001622 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001623}
Gilles Peskine4747d192019-04-17 15:05:45 +02001624
1625/** Finalize the creation of a key once its key material has been set.
1626 *
1627 * This entails writing the key to persistent storage.
1628 *
1629 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001630 * See the documentation of psa_start_key_creation() for the intended use
1631 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001632 *
Ronald Cron5c522922020-11-14 16:35:34 +01001633 * If the finalization succeeds, the function unlocks the key slot (it was
1634 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1635 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001636 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001637 * \param[in,out] slot Pointer to the slot with key material.
1638 * \param[in] driver The secure element driver for the key,
1639 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001640 * \param[out] key On success, identifier of the key. Note that the
1641 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001642 *
1643 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001644 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001645 * \return If this function fails, the key slot is an invalid state.
1646 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001647 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001648static psa_status_t psa_finish_key_creation(
1649 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001650 psa_se_drv_table_entry_t *driver,
1651 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001652{
1653 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001654 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001656
1657#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001658 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001659 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001660#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1661 if( driver != NULL )
1662 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001663 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001664 psa_key_slot_number_t slot_number =
1665 psa_key_slot_get_slot_number( slot ) ;
1666
Gilles Peskineb46bef22019-07-30 21:32:04 +02001667#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001668 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001669 sizeof( data.slot_number ),
1670 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001671#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001672 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001673 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001674 (uint8_t*) &data,
1675 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001676 }
1677 else
1678#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1679 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001680 /* Key material is saved in export representation in the slot, so
1681 * just pass the slot buffer for storage. */
1682 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001683 slot->key.data,
1684 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001685 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001686 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001687#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1688
Gilles Peskinecbaff462019-07-12 23:46:04 +02001689#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001690 /* Finish the transaction for a key creation. This does not
1691 * happen when registering an existing key. Detect this case
1692 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001693 * creation of a persistent key in a secure element requires a transaction,
1694 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001695 if( driver != NULL &&
1696 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001697 {
1698 status = psa_save_se_persistent_data( driver );
1699 if( status != PSA_SUCCESS )
1700 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001701 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001702 return( status );
1703 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001704 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001705 }
1706#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1707
Ronald Cron50972942020-11-14 11:28:25 +01001708 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001709 {
1710 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001711 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001712 if( status != PSA_SUCCESS )
1713 *key = MBEDTLS_SVC_KEY_ID_INIT;
1714 }
Ronald Cron50972942020-11-14 11:28:25 +01001715
Gilles Peskine4747d192019-04-17 15:05:45 +02001716 return( status );
1717}
1718
1719/** Abort the creation of a key.
1720 *
1721 * You may call this function after calling psa_start_key_creation(),
1722 * or after psa_finish_key_creation() fails. In other circumstances, this
1723 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001724 * See the documentation of psa_start_key_creation() for the intended use
1725 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001726 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001727 * \param[in,out] slot Pointer to the slot with key material.
1728 * \param[in] driver The secure element driver for the key,
1729 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001730 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001731static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001732 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001733{
Gilles Peskine011e4282019-06-26 18:34:38 +02001734 (void) driver;
1735
Gilles Peskine4747d192019-04-17 15:05:45 +02001736 if( slot == NULL )
1737 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001738
1739#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001740 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001741 * element, and the failure happened later (when saving metadata
1742 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001743 * element.
1744 * https://github.com/ARMmbed/mbed-crypto/issues/217
1745 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001746
Gilles Peskined7729582019-08-05 15:55:54 +02001747 /* Abort the ongoing transaction if any (there may not be one if
1748 * the creation process failed before starting one, or if the
1749 * key creation is a registration of a key in a secure element).
1750 * Earlier functions must already have done what it takes to undo any
1751 * partial creation. All that's left is to update the transaction data
1752 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001753 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001754#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1755
Gilles Peskine4747d192019-04-17 15:05:45 +02001756 psa_wipe_key_slot( slot );
1757}
1758
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001759/** Validate optional attributes during key creation.
1760 *
1761 * Some key attributes are optional during key creation. If they are
1762 * specified in the attributes structure, check that they are consistent
1763 * with the data in the slot.
1764 *
1765 * This function should be called near the end of key creation, after
1766 * the slot in memory is fully populated but before saving persistent data.
1767 */
1768static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001769 const psa_key_slot_t *slot,
1770 const psa_key_attributes_t *attributes )
1771{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001772 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001773 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001774 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001775 return( PSA_ERROR_INVALID_ARGUMENT );
1776 }
1777
1778 if( attributes->domain_parameters_size != 0 )
1779 {
John Durkop0e005192020-10-31 22:06:54 -07001780#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1781 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001782 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001783 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001784 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001785 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001787
Ronald Cron90857082020-11-25 14:58:33 +01001788 psa_status_t status = mbedtls_psa_rsa_load_representation(
1789 slot->attr.type,
1790 slot->key.data,
1791 slot->key.bytes,
1792 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001793 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001794 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001795
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001796 mbedtls_mpi_init( &actual );
1797 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001798 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001799 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001800 mbedtls_rsa_free( rsa );
1801 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001802 if( ret != 0 )
1803 goto rsa_exit;
1804 ret = mbedtls_mpi_read_binary( &required,
1805 attributes->domain_parameters,
1806 attributes->domain_parameters_size );
1807 if( ret != 0 )
1808 goto rsa_exit;
1809 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1810 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1811 rsa_exit:
1812 mbedtls_mpi_free( &actual );
1813 mbedtls_mpi_free( &required );
1814 if( ret != 0)
1815 return( mbedtls_to_psa_error( ret ) );
1816 }
1817 else
John Durkop9814fa22020-11-04 12:28:15 -08001818#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1819 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001820 {
1821 return( PSA_ERROR_INVALID_ARGUMENT );
1822 }
1823 }
1824
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001825 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001826 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001827 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001828 return( PSA_ERROR_INVALID_ARGUMENT );
1829 }
1830
1831 return( PSA_SUCCESS );
1832}
1833
Gilles Peskine4747d192019-04-17 15:05:45 +02001834psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001835 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001836 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001837 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001838{
1839 psa_status_t status;
1840 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001841 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842
Ronald Cron81709fc2020-11-14 12:10:32 +01001843 *key = MBEDTLS_SVC_KEY_ID_INIT;
1844
Gilles Peskine0f84d622019-09-12 19:03:13 +02001845 /* Reject zero-length symmetric keys (including raw data key objects).
1846 * This also rejects any key which might be encoded as an empty string,
1847 * which is never valid. */
1848 if( data_length == 0 )
1849 return( PSA_ERROR_INVALID_ARGUMENT );
1850
Gilles Peskinedf179142019-07-15 22:02:14 +02001851 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001852 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001853 if( status != PSA_SUCCESS )
1854 goto exit;
1855
Gilles Peskine5d309672019-07-12 23:47:28 +02001856#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1857 if( driver != NULL )
1858 {
1859 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001860 /* The driver should set the number of key bits, however in
1861 * case it doesn't, we initialize bits to an invalid value. */
1862 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001863 if( drv->key_management == NULL ||
1864 drv->key_management->p_import == NULL )
1865 {
1866 status = PSA_ERROR_NOT_SUPPORTED;
1867 goto exit;
1868 }
1869 status = drv->key_management->p_import(
1870 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01001871 psa_key_slot_get_slot_number( slot ),
1872 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001873 if( status != PSA_SUCCESS )
1874 goto exit;
1875 if( bits > PSA_MAX_KEY_BITS )
1876 {
1877 status = PSA_ERROR_NOT_SUPPORTED;
1878 goto exit;
1879 }
1880 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001881 }
1882 else
1883#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01001884 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
1885 {
1886 /* Importing a key with external lifetime through the driver wrapper
1887 * interface is not yet supported. Return as if this was an invalid
1888 * lifetime. */
1889 status = PSA_ERROR_INVALID_ARGUMENT;
1890 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001891 }
1892 else
Gilles Peskine5d309672019-07-12 23:47:28 +02001893 {
Ronald Crondd04d422020-11-28 15:14:42 +01001894 status = psa_allocate_buffer_to_slot( slot, data_length );
1895 if( status != PSA_SUCCESS )
1896 goto exit;
1897
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001898 size_t bits = slot->attr.bits;
1899 status = psa_import_key_into_slot( attributes,
1900 data, data_length,
Ronald Crondd04d422020-11-28 15:14:42 +01001901 slot->key.data,
1902 slot->key.bytes,
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001903 &slot->key.bytes, &bits );
Gilles Peskine5d309672019-07-12 23:47:28 +02001904 if( status != PSA_SUCCESS )
1905 goto exit;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001906
1907 if( slot->attr.bits == 0 )
1908 slot->attr.bits = (psa_key_bits_t) bits;
1909 else if( bits != slot->attr.bits )
1910 {
1911 status = PSA_ERROR_INVALID_ARGUMENT;
1912 goto exit;
1913 }
Gilles Peskine5d309672019-07-12 23:47:28 +02001914 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001915
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001916 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001917 if( status != PSA_SUCCESS )
1918 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001919
Ronald Cron81709fc2020-11-14 12:10:32 +01001920 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001922 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001923 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001924
Gilles Peskine4747d192019-04-17 15:05:45 +02001925 return( status );
1926}
1927
Gilles Peskined7729582019-08-05 15:55:54 +02001928#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1929psa_status_t mbedtls_psa_register_se_key(
1930 const psa_key_attributes_t *attributes )
1931{
1932 psa_status_t status;
1933 psa_key_slot_t *slot = NULL;
1934 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001935 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001936
1937 /* Leaving attributes unspecified is not currently supported.
1938 * It could make sense to query the key type and size from the
1939 * secure element, but not all secure elements support this
1940 * and the driver HAL doesn't currently support it. */
1941 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1942 return( PSA_ERROR_NOT_SUPPORTED );
1943 if( psa_get_key_bits( attributes ) == 0 )
1944 return( PSA_ERROR_NOT_SUPPORTED );
1945
1946 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001948 if( status != PSA_SUCCESS )
1949 goto exit;
1950
Ronald Cron81709fc2020-11-14 12:10:32 +01001951 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001952
1953exit:
1954 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001955 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001956
Gilles Peskined7729582019-08-05 15:55:54 +02001957 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001958 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001959 return( status );
1960}
1961#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1962
Gilles Peskinef603c712019-01-19 13:40:11 +01001963static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001964 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001965{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001966 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001967 source->key.data,
1968 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001969 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001970 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001971
Steven Cooreman398aee52020-10-13 14:35:45 +02001972 target->attr.type = source->attr.type;
1973 target->attr.bits = source->attr.bits;
1974
1975 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001976}
1977
Ronald Croncf56a0a2020-08-04 09:51:30 +02001978psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001979 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001980 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001981{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001982 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001983 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01001984 psa_key_slot_t *source_slot = NULL;
1985 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001986 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001987 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001988
Ronald Cron81709fc2020-11-14 12:10:32 +01001989 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
1990
Ronald Cron5c522922020-11-14 16:35:34 +01001991 status = psa_get_and_lock_transparent_key_slot_with_policy(
1992 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001993 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001994 goto exit;
1995
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001996 status = psa_validate_optional_attributes( source_slot,
1997 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001998 if( status != PSA_SUCCESS )
1999 goto exit;
2000
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002001 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002002 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002003 if( status != PSA_SUCCESS )
2004 goto exit;
2005
Ronald Cron81709fc2020-11-14 12:10:32 +01002006 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2007 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002008 if( status != PSA_SUCCESS )
2009 goto exit;
2010
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002011#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2012 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002013 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002014 /* Copying to a secure element is not implemented yet. */
2015 status = PSA_ERROR_NOT_SUPPORTED;
2016 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002017 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002018#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002019
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002020 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002021 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002023
Ronald Cron81709fc2020-11-14 12:10:32 +01002024 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002025exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002026 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002027 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002028
Ronald Cron5c522922020-11-14 16:35:34 +01002029 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002030
Ronald Cron5c522922020-11-14 16:35:34 +01002031 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002032}
2033
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002034
2035
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002036/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002037/* Message digests */
2038/****************************************************************/
2039
John Durkop07cc04a2020-11-16 22:08:34 -08002040#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002041 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2042 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002043 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002044static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002045{
2046 switch( alg )
2047 {
John Durkopee4e6602020-11-27 08:48:46 -08002048#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002049 case PSA_ALG_MD2:
2050 return( &mbedtls_md2_info );
2051#endif
John Durkopee4e6602020-11-27 08:48:46 -08002052#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002053 case PSA_ALG_MD4:
2054 return( &mbedtls_md4_info );
2055#endif
John Durkopee4e6602020-11-27 08:48:46 -08002056#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002057 case PSA_ALG_MD5:
2058 return( &mbedtls_md5_info );
2059#endif
John Durkopee4e6602020-11-27 08:48:46 -08002060#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002061 case PSA_ALG_RIPEMD160:
2062 return( &mbedtls_ripemd160_info );
2063#endif
John Durkopee4e6602020-11-27 08:48:46 -08002064#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002065 case PSA_ALG_SHA_1:
2066 return( &mbedtls_sha1_info );
2067#endif
John Durkopee4e6602020-11-27 08:48:46 -08002068#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002069 case PSA_ALG_SHA_224:
2070 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002071#endif
2072#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002073 case PSA_ALG_SHA_256:
2074 return( &mbedtls_sha256_info );
2075#endif
John Durkopee4e6602020-11-27 08:48:46 -08002076#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002077 case PSA_ALG_SHA_384:
2078 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002079#endif
John Durkopee4e6602020-11-27 08:48:46 -08002080#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002081 case PSA_ALG_SHA_512:
2082 return( &mbedtls_sha512_info );
2083#endif
2084 default:
2085 return( NULL );
2086 }
2087}
John Durkop07cc04a2020-11-16 22:08:34 -08002088#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002089 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2090 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2091 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002092
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002093psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2094{
2095 switch( operation->alg )
2096 {
Gilles Peskine81736312018-06-26 15:04:31 +02002097 case 0:
2098 /* The object has (apparently) been initialized but it is not
2099 * in use. It's ok to call abort on such an object, and there's
2100 * nothing to do. */
2101 break;
John Durkopee4e6602020-11-27 08:48:46 -08002102#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002103 case PSA_ALG_MD2:
2104 mbedtls_md2_free( &operation->ctx.md2 );
2105 break;
2106#endif
John Durkopee4e6602020-11-27 08:48:46 -08002107#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002108 case PSA_ALG_MD4:
2109 mbedtls_md4_free( &operation->ctx.md4 );
2110 break;
2111#endif
John Durkopee4e6602020-11-27 08:48:46 -08002112#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002113 case PSA_ALG_MD5:
2114 mbedtls_md5_free( &operation->ctx.md5 );
2115 break;
2116#endif
John Durkopee4e6602020-11-27 08:48:46 -08002117#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002118 case PSA_ALG_RIPEMD160:
2119 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2120 break;
2121#endif
John Durkopee4e6602020-11-27 08:48:46 -08002122#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002123 case PSA_ALG_SHA_1:
2124 mbedtls_sha1_free( &operation->ctx.sha1 );
2125 break;
2126#endif
John Durkop6ca23272020-12-03 06:01:32 -08002127#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002128 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002129 mbedtls_sha256_free( &operation->ctx.sha256 );
2130 break;
2131#endif
2132#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002133 case PSA_ALG_SHA_256:
2134 mbedtls_sha256_free( &operation->ctx.sha256 );
2135 break;
2136#endif
John Durkop6ca23272020-12-03 06:01:32 -08002137#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002138 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002139 mbedtls_sha512_free( &operation->ctx.sha512 );
2140 break;
2141#endif
2142#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002143 case PSA_ALG_SHA_512:
2144 mbedtls_sha512_free( &operation->ctx.sha512 );
2145 break;
2146#endif
2147 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002148 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002149 }
2150 operation->alg = 0;
2151 return( PSA_SUCCESS );
2152}
2153
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002154psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155 psa_algorithm_t alg )
2156{
Janos Follath24eed8d2019-11-22 13:21:35 +00002157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002158
2159 /* A context must be freshly initialized before it can be set up. */
2160 if( operation->alg != 0 )
2161 {
2162 return( PSA_ERROR_BAD_STATE );
2163 }
2164
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002165 switch( alg )
2166 {
John Durkopee4e6602020-11-27 08:48:46 -08002167#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002168 case PSA_ALG_MD2:
2169 mbedtls_md2_init( &operation->ctx.md2 );
2170 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2171 break;
2172#endif
John Durkopee4e6602020-11-27 08:48:46 -08002173#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174 case PSA_ALG_MD4:
2175 mbedtls_md4_init( &operation->ctx.md4 );
2176 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2177 break;
2178#endif
John Durkopee4e6602020-11-27 08:48:46 -08002179#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002180 case PSA_ALG_MD5:
2181 mbedtls_md5_init( &operation->ctx.md5 );
2182 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2183 break;
2184#endif
John Durkopee4e6602020-11-27 08:48:46 -08002185#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002186 case PSA_ALG_RIPEMD160:
2187 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2188 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2189 break;
2190#endif
John Durkopee4e6602020-11-27 08:48:46 -08002191#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192 case PSA_ALG_SHA_1:
2193 mbedtls_sha1_init( &operation->ctx.sha1 );
2194 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2195 break;
2196#endif
John Durkopee4e6602020-11-27 08:48:46 -08002197#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002198 case PSA_ALG_SHA_224:
2199 mbedtls_sha256_init( &operation->ctx.sha256 );
2200 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2201 break;
John Durkopee4e6602020-11-27 08:48:46 -08002202#endif
2203#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002204 case PSA_ALG_SHA_256:
2205 mbedtls_sha256_init( &operation->ctx.sha256 );
2206 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2207 break;
2208#endif
John Durkopee4e6602020-11-27 08:48:46 -08002209#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002210 case PSA_ALG_SHA_384:
2211 mbedtls_sha512_init( &operation->ctx.sha512 );
2212 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2213 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002214#endif
John Durkopee4e6602020-11-27 08:48:46 -08002215#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002216 case PSA_ALG_SHA_512:
2217 mbedtls_sha512_init( &operation->ctx.sha512 );
2218 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2219 break;
2220#endif
2221 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002222 return( PSA_ALG_IS_HASH( alg ) ?
2223 PSA_ERROR_NOT_SUPPORTED :
2224 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225 }
2226 if( ret == 0 )
2227 operation->alg = alg;
2228 else
2229 psa_hash_abort( operation );
2230 return( mbedtls_to_psa_error( ret ) );
2231}
2232
2233psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2234 const uint8_t *input,
2235 size_t input_length )
2236{
Janos Follath24eed8d2019-11-22 13:21:35 +00002237 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002238
2239 /* Don't require hash implementations to behave correctly on a
2240 * zero-length input, which may have an invalid pointer. */
2241 if( input_length == 0 )
2242 return( PSA_SUCCESS );
2243
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244 switch( operation->alg )
2245 {
John Durkopee4e6602020-11-27 08:48:46 -08002246#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002247 case PSA_ALG_MD2:
2248 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2249 input, input_length );
2250 break;
2251#endif
John Durkopee4e6602020-11-27 08:48:46 -08002252#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002253 case PSA_ALG_MD4:
2254 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2255 input, input_length );
2256 break;
2257#endif
John Durkopee4e6602020-11-27 08:48:46 -08002258#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259 case PSA_ALG_MD5:
2260 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2261 input, input_length );
2262 break;
2263#endif
John Durkopee4e6602020-11-27 08:48:46 -08002264#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265 case PSA_ALG_RIPEMD160:
2266 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2267 input, input_length );
2268 break;
2269#endif
John Durkopee4e6602020-11-27 08:48:46 -08002270#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002271 case PSA_ALG_SHA_1:
2272 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2273 input, input_length );
2274 break;
2275#endif
John Durkop6ca23272020-12-03 06:01:32 -08002276#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002277 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002278 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2279 input, input_length );
2280 break;
2281#endif
2282#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283 case PSA_ALG_SHA_256:
2284 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2285 input, input_length );
2286 break;
2287#endif
John Durkop6ca23272020-12-03 06:01:32 -08002288#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002289 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002290 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2291 input, input_length );
2292 break;
2293#endif
2294#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002295 case PSA_ALG_SHA_512:
2296 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2297 input, input_length );
2298 break;
2299#endif
2300 default:
John Durkopee4e6602020-11-27 08:48:46 -08002301 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002302 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002303 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002304
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002305 if( ret != 0 )
2306 psa_hash_abort( operation );
2307 return( mbedtls_to_psa_error( ret ) );
2308}
2309
2310psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2311 uint8_t *hash,
2312 size_t hash_size,
2313 size_t *hash_length )
2314{
itayzafrir40835d42018-08-02 13:14:17 +03002315 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002317 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002318
2319 /* Fill the output buffer with something that isn't a valid hash
2320 * (barring an attack on the hash and deliberately-crafted input),
2321 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002322 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002323 /* If hash_size is 0 then hash may be NULL and then the
2324 * call to memset would have undefined behavior. */
2325 if( hash_size != 0 )
2326 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002327
2328 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002329 {
2330 status = PSA_ERROR_BUFFER_TOO_SMALL;
2331 goto exit;
2332 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333
2334 switch( operation->alg )
2335 {
John Durkopee4e6602020-11-27 08:48:46 -08002336#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337 case PSA_ALG_MD2:
2338 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2339 break;
2340#endif
John Durkopee4e6602020-11-27 08:48:46 -08002341#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342 case PSA_ALG_MD4:
2343 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2344 break;
2345#endif
John Durkopee4e6602020-11-27 08:48:46 -08002346#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002347 case PSA_ALG_MD5:
2348 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2349 break;
2350#endif
John Durkopee4e6602020-11-27 08:48:46 -08002351#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002352 case PSA_ALG_RIPEMD160:
2353 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2354 break;
2355#endif
John Durkopee4e6602020-11-27 08:48:46 -08002356#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002357 case PSA_ALG_SHA_1:
2358 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2359 break;
2360#endif
John Durkop6ca23272020-12-03 06:01:32 -08002361#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002362 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002363 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2364 break;
2365#endif
2366#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002367 case PSA_ALG_SHA_256:
2368 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2369 break;
2370#endif
John Durkop6ca23272020-12-03 06:01:32 -08002371#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002372 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002373 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2374 break;
2375#endif
2376#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002377 case PSA_ALG_SHA_512:
2378 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2379 break;
2380#endif
2381 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002382 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002383 }
itayzafrir40835d42018-08-02 13:14:17 +03002384 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002385
itayzafrir40835d42018-08-02 13:14:17 +03002386exit:
2387 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002388 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002389 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002390 return( psa_hash_abort( operation ) );
2391 }
2392 else
2393 {
2394 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002395 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002396 }
2397}
2398
Gilles Peskine2d277862018-06-18 15:41:12 +02002399psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2400 const uint8_t *hash,
2401 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002402{
2403 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2404 size_t actual_hash_length;
2405 psa_status_t status = psa_hash_finish( operation,
2406 actual_hash, sizeof( actual_hash ),
2407 &actual_hash_length );
2408 if( status != PSA_SUCCESS )
2409 return( status );
2410 if( actual_hash_length != hash_length )
2411 return( PSA_ERROR_INVALID_SIGNATURE );
2412 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2413 return( PSA_ERROR_INVALID_SIGNATURE );
2414 return( PSA_SUCCESS );
2415}
2416
Gilles Peskine0a749c82019-11-28 19:33:58 +01002417psa_status_t psa_hash_compute( psa_algorithm_t alg,
2418 const uint8_t *input, size_t input_length,
2419 uint8_t *hash, size_t hash_size,
2420 size_t *hash_length )
2421{
2422 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2424
2425 *hash_length = hash_size;
2426 status = psa_hash_setup( &operation, alg );
2427 if( status != PSA_SUCCESS )
2428 goto exit;
2429 status = psa_hash_update( &operation, input, input_length );
2430 if( status != PSA_SUCCESS )
2431 goto exit;
2432 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2433 if( status != PSA_SUCCESS )
2434 goto exit;
2435
2436exit:
2437 if( status == PSA_SUCCESS )
2438 status = psa_hash_abort( &operation );
2439 else
2440 psa_hash_abort( &operation );
2441 return( status );
2442}
2443
2444psa_status_t psa_hash_compare( psa_algorithm_t alg,
2445 const uint8_t *input, size_t input_length,
2446 const uint8_t *hash, size_t hash_length )
2447{
2448 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2449 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2450
2451 status = psa_hash_setup( &operation, alg );
2452 if( status != PSA_SUCCESS )
2453 goto exit;
2454 status = psa_hash_update( &operation, input, input_length );
2455 if( status != PSA_SUCCESS )
2456 goto exit;
2457 status = psa_hash_verify( &operation, hash, hash_length );
2458 if( status != PSA_SUCCESS )
2459 goto exit;
2460
2461exit:
2462 if( status == PSA_SUCCESS )
2463 status = psa_hash_abort( &operation );
2464 else
2465 psa_hash_abort( &operation );
2466 return( status );
2467}
2468
Gilles Peskineeb35d782019-01-22 17:56:16 +01002469psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2470 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002471{
2472 if( target_operation->alg != 0 )
2473 return( PSA_ERROR_BAD_STATE );
2474
2475 switch( source_operation->alg )
2476 {
2477 case 0:
2478 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002479#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002480 case PSA_ALG_MD2:
2481 mbedtls_md2_clone( &target_operation->ctx.md2,
2482 &source_operation->ctx.md2 );
2483 break;
2484#endif
John Durkopee4e6602020-11-27 08:48:46 -08002485#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002486 case PSA_ALG_MD4:
2487 mbedtls_md4_clone( &target_operation->ctx.md4,
2488 &source_operation->ctx.md4 );
2489 break;
2490#endif
John Durkopee4e6602020-11-27 08:48:46 -08002491#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002492 case PSA_ALG_MD5:
2493 mbedtls_md5_clone( &target_operation->ctx.md5,
2494 &source_operation->ctx.md5 );
2495 break;
2496#endif
John Durkopee4e6602020-11-27 08:48:46 -08002497#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002498 case PSA_ALG_RIPEMD160:
2499 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2500 &source_operation->ctx.ripemd160 );
2501 break;
2502#endif
John Durkopee4e6602020-11-27 08:48:46 -08002503#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002504 case PSA_ALG_SHA_1:
2505 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2506 &source_operation->ctx.sha1 );
2507 break;
2508#endif
John Durkop6ca23272020-12-03 06:01:32 -08002509#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002510 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002511 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2512 &source_operation->ctx.sha256 );
2513 break;
2514#endif
2515#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002516 case PSA_ALG_SHA_256:
2517 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2518 &source_operation->ctx.sha256 );
2519 break;
2520#endif
John Durkop6ca23272020-12-03 06:01:32 -08002521#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002522 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002523 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2524 &source_operation->ctx.sha512 );
2525 break;
2526#endif
2527#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002528 case PSA_ALG_SHA_512:
2529 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2530 &source_operation->ctx.sha512 );
2531 break;
2532#endif
2533 default:
2534 return( PSA_ERROR_NOT_SUPPORTED );
2535 }
2536
2537 target_operation->alg = source_operation->alg;
2538 return( PSA_SUCCESS );
2539}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002540
2541
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002542/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002543/* MAC */
2544/****************************************************************/
2545
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002546static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002547 psa_algorithm_t alg,
2548 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002549 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002550 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002552 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002553 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002554
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002555 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002556 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002557
Gilles Peskine8c9def32018-02-08 10:02:12 +01002558 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2559 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002560 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002562 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002563 mode = MBEDTLS_MODE_STREAM;
2564 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002565 case PSA_ALG_CTR:
2566 mode = MBEDTLS_MODE_CTR;
2567 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002568 case PSA_ALG_CFB:
2569 mode = MBEDTLS_MODE_CFB;
2570 break;
2571 case PSA_ALG_OFB:
2572 mode = MBEDTLS_MODE_OFB;
2573 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002574 case PSA_ALG_ECB_NO_PADDING:
2575 mode = MBEDTLS_MODE_ECB;
2576 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002577 case PSA_ALG_CBC_NO_PADDING:
2578 mode = MBEDTLS_MODE_CBC;
2579 break;
2580 case PSA_ALG_CBC_PKCS7:
2581 mode = MBEDTLS_MODE_CBC;
2582 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002583 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002584 mode = MBEDTLS_MODE_CCM;
2585 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002586 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002587 mode = MBEDTLS_MODE_GCM;
2588 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002589 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2590 mode = MBEDTLS_MODE_CHACHAPOLY;
2591 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002592 default:
2593 return( NULL );
2594 }
2595 }
2596 else if( alg == PSA_ALG_CMAC )
2597 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002598 else
2599 return( NULL );
2600
2601 switch( key_type )
2602 {
2603 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002604 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605 break;
2606 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002607 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2608 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002609 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002610 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002612 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002613 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2614 * but two-key Triple-DES is functionally three-key Triple-DES
2615 * with K1=K3, so that's how we present it to mbedtls. */
2616 if( key_bits == 128 )
2617 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002618 break;
2619 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002620 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002621 break;
2622 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002623 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002624 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002625 case PSA_KEY_TYPE_CHACHA20:
2626 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2627 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628 default:
2629 return( NULL );
2630 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002631 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002632 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002633
Jaeden Amero23bbb752018-06-26 14:16:54 +01002634 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2635 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002636}
2637
John Durkop6ba40d12020-11-10 08:50:04 -08002638#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002639static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002640{
Gilles Peskine2d277862018-06-18 15:41:12 +02002641 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002642 {
2643 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002644 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002645 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002646 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002647 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002648 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002649 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002650 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002651 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002652 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002653 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002654 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002655 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002656 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002657 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002658 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002659 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002660 return( 128 );
2661 default:
2662 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002663 }
2664}
John Durkop07cc04a2020-11-16 22:08:34 -08002665#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002666
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002667/* Initialize the MAC operation structure. Once this function has been
2668 * called, psa_mac_abort can run and will do the right thing. */
2669static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2670 psa_algorithm_t alg )
2671{
2672 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2673
2674 operation->alg = alg;
2675 operation->key_set = 0;
2676 operation->iv_set = 0;
2677 operation->iv_required = 0;
2678 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002679 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002680
2681#if defined(MBEDTLS_CMAC_C)
2682 if( alg == PSA_ALG_CMAC )
2683 {
2684 operation->iv_required = 0;
2685 mbedtls_cipher_init( &operation->ctx.cmac );
2686 status = PSA_SUCCESS;
2687 }
2688 else
2689#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002690#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002691 if( PSA_ALG_IS_HMAC( operation->alg ) )
2692 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002693 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2694 operation->ctx.hmac.hash_ctx.alg = 0;
2695 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002696 }
2697 else
John Durkopd0321952020-10-29 21:37:36 -07002698#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002699 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002700 if( ! PSA_ALG_IS_MAC( alg ) )
2701 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002702 }
2703
2704 if( status != PSA_SUCCESS )
2705 memset( operation, 0, sizeof( *operation ) );
2706 return( status );
2707}
2708
John Durkop6ba40d12020-11-10 08:50:04 -08002709#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002710static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2711{
Gilles Peskine3f108122018-12-07 18:14:53 +01002712 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002713 return( psa_hash_abort( &hmac->hash_ctx ) );
2714}
John Durkop6ba40d12020-11-10 08:50:04 -08002715#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002716
Gilles Peskine8c9def32018-02-08 10:02:12 +01002717psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2718{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002719 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002720 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002721 /* The object has (apparently) been initialized but it is not
2722 * in use. It's ok to call abort on such an object, and there's
2723 * nothing to do. */
2724 return( PSA_SUCCESS );
2725 }
2726 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002728 if( operation->alg == PSA_ALG_CMAC )
2729 {
2730 mbedtls_cipher_free( &operation->ctx.cmac );
2731 }
2732 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002734#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002735 if( PSA_ALG_IS_HMAC( operation->alg ) )
2736 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002737 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002738 }
2739 else
John Durkopd0321952020-10-29 21:37:36 -07002740#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002741 {
2742 /* Sanity check (shouldn't happen: operation->alg should
2743 * always have been initialized to a valid value). */
2744 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745 }
Moran Peker41deec42018-04-04 15:43:05 +03002746
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747 operation->alg = 0;
2748 operation->key_set = 0;
2749 operation->iv_set = 0;
2750 operation->iv_required = 0;
2751 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002752 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002753
Gilles Peskine8c9def32018-02-08 10:02:12 +01002754 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002755
2756bad_state:
2757 /* If abort is called on an uninitialized object, we can't trust
2758 * anything. Wipe the object in case it contains confidential data.
2759 * This may result in a memory leak if a pointer gets overwritten,
2760 * but it's too late to do anything about this. */
2761 memset( operation, 0, sizeof( *operation ) );
2762 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002763}
2764
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002765#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002766static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002767 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002768 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002769 const mbedtls_cipher_info_t *cipher_info )
2770{
Janos Follath24eed8d2019-11-22 13:21:35 +00002771 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002772
2773 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002774
2775 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2776 if( ret != 0 )
2777 return( ret );
2778
2779 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002780 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002781 key_bits );
2782 return( ret );
2783}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002784#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002785
John Durkop6ba40d12020-11-10 08:50:04 -08002786#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002787static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2788 const uint8_t *key,
2789 size_t key_length,
2790 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002791{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002792 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002793 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002794 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002795 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002796 psa_status_t status;
2797
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002798 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2799 * overflow below. This should never trigger if the hash algorithm
2800 * is implemented correctly. */
2801 /* The size checks against the ipad and opad buffers cannot be written
2802 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2803 * because that triggers -Wlogical-op on GCC 7.3. */
2804 if( block_size > sizeof( ipad ) )
2805 return( PSA_ERROR_NOT_SUPPORTED );
2806 if( block_size > sizeof( hmac->opad ) )
2807 return( PSA_ERROR_NOT_SUPPORTED );
2808 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002809 return( PSA_ERROR_NOT_SUPPORTED );
2810
Gilles Peskined223b522018-06-11 18:12:58 +02002811 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002812 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002813 status = psa_hash_compute( hash_alg, key, key_length,
2814 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002815 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002816 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002817 }
Gilles Peskine96889972018-07-12 17:07:03 +02002818 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2819 * but it is permitted. It is common when HMAC is used in HKDF, for
2820 * example. Don't call `memcpy` in the 0-length because `key` could be
2821 * an invalid pointer which would make the behavior undefined. */
2822 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002823 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002824
Gilles Peskined223b522018-06-11 18:12:58 +02002825 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2826 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002827 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002828 ipad[i] ^= 0x36;
2829 memset( ipad + key_length, 0x36, block_size - key_length );
2830
2831 /* Copy the key material from ipad to opad, flipping the requisite bits,
2832 * and filling the rest of opad with the requisite constant. */
2833 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002834 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2835 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002836
Gilles Peskine01126fa2018-07-12 17:04:55 +02002837 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002838 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002839 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002840
Gilles Peskine01126fa2018-07-12 17:04:55 +02002841 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002842
2843cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002844 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002845
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002846 return( status );
2847}
John Durkop6ba40d12020-11-10 08:50:04 -08002848#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002849
Gilles Peskine89167cb2018-07-08 20:12:23 +02002850static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002851 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002852 psa_algorithm_t alg,
2853 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002854{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002855 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002856 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002857 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002858 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002859 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002860 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002861 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002862 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002863
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002864 /* A context must be freshly initialized before it can be set up. */
2865 if( operation->alg != 0 )
2866 {
2867 return( PSA_ERROR_BAD_STATE );
2868 }
2869
Gilles Peskined911eb72018-08-14 15:18:45 +02002870 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002871 if( status != PSA_SUCCESS )
2872 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002873 if( is_sign )
2874 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002875
Ronald Cron5c522922020-11-14 16:35:34 +01002876 status = psa_get_and_lock_transparent_key_slot_with_policy(
2877 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002878 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002879 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002880 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002881
Gilles Peskine8c9def32018-02-08 10:02:12 +01002882#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002883 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002884 {
2885 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002886 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002887 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002889 if( cipher_info == NULL )
2890 {
2891 status = PSA_ERROR_NOT_SUPPORTED;
2892 goto exit;
2893 }
2894 operation->mac_size = cipher_info->block_size;
2895 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2896 status = mbedtls_to_psa_error( ret );
2897 }
2898 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002899#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002900#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002901 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002902 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002903 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002904 if( hash_alg == 0 )
2905 {
2906 status = PSA_ERROR_NOT_SUPPORTED;
2907 goto exit;
2908 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002909
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002910 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002911 /* Sanity check. This shouldn't fail on a valid configuration. */
2912 if( operation->mac_size == 0 ||
2913 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2914 {
2915 status = PSA_ERROR_NOT_SUPPORTED;
2916 goto exit;
2917 }
2918
Gilles Peskine8e338702019-07-30 20:06:31 +02002919 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002920 {
2921 status = PSA_ERROR_INVALID_ARGUMENT;
2922 goto exit;
2923 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002924
Gilles Peskine01126fa2018-07-12 17:04:55 +02002925 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002926 slot->key.data,
2927 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02002928 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002929 }
2930 else
John Durkopd0321952020-10-29 21:37:36 -07002931#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002932 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002933 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002934 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002935 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002936
Gilles Peskined911eb72018-08-14 15:18:45 +02002937 if( truncated == 0 )
2938 {
2939 /* The "normal" case: untruncated algorithm. Nothing to do. */
2940 }
2941 else if( truncated < 4 )
2942 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002943 /* A very short MAC is too short for security since it can be
2944 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2945 * so we make this our minimum, even though 32 bits is still
2946 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002947 status = PSA_ERROR_NOT_SUPPORTED;
2948 }
2949 else if( truncated > operation->mac_size )
2950 {
2951 /* It's impossible to "truncate" to a larger length. */
2952 status = PSA_ERROR_INVALID_ARGUMENT;
2953 }
2954 else
2955 operation->mac_size = truncated;
2956
Gilles Peskinefbfac682018-07-08 20:51:54 +02002957exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002958 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002959 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002960 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002961 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002962 else
2963 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002964 operation->key_set = 1;
2965 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002966
Ronald Cron5c522922020-11-14 16:35:34 +01002967 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002968
Ronald Cron5c522922020-11-14 16:35:34 +01002969 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002970}
2971
Gilles Peskine89167cb2018-07-08 20:12:23 +02002972psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002973 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002974 psa_algorithm_t alg )
2975{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002976 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002977}
2978
2979psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002980 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002981 psa_algorithm_t alg )
2982{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002983 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002984}
2985
Gilles Peskine8c9def32018-02-08 10:02:12 +01002986psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2987 const uint8_t *input,
2988 size_t input_length )
2989{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002990 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002991 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002992 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002993 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002994 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002995 operation->has_input = 1;
2996
Gilles Peskine8c9def32018-02-08 10:02:12 +01002997#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002998 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002999 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003000 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3001 input, input_length );
3002 status = mbedtls_to_psa_error( ret );
3003 }
3004 else
3005#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003006#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003007 if( PSA_ALG_IS_HMAC( operation->alg ) )
3008 {
3009 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3010 input_length );
3011 }
3012 else
John Durkopd0321952020-10-29 21:37:36 -07003013#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003014 {
3015 /* This shouldn't happen if `operation` was initialized by
3016 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003017 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003018 }
3019
Gilles Peskinefbfac682018-07-08 20:51:54 +02003020 if( status != PSA_SUCCESS )
3021 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003022 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003023}
3024
John Durkop6ba40d12020-11-10 08:50:04 -08003025#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003026static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3027 uint8_t *mac,
3028 size_t mac_size )
3029{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003030 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003031 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3032 size_t hash_size = 0;
3033 size_t block_size = psa_get_hash_block_size( hash_alg );
3034 psa_status_t status;
3035
Gilles Peskine01126fa2018-07-12 17:04:55 +02003036 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3037 if( status != PSA_SUCCESS )
3038 return( status );
3039 /* From here on, tmp needs to be wiped. */
3040
3041 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3042 if( status != PSA_SUCCESS )
3043 goto exit;
3044
3045 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3046 if( status != PSA_SUCCESS )
3047 goto exit;
3048
3049 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3050 if( status != PSA_SUCCESS )
3051 goto exit;
3052
Gilles Peskined911eb72018-08-14 15:18:45 +02003053 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3054 if( status != PSA_SUCCESS )
3055 goto exit;
3056
3057 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003058
3059exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003060 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003061 return( status );
3062}
John Durkop6ba40d12020-11-10 08:50:04 -08003063#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003064
mohammad16036df908f2018-04-02 08:34:15 -07003065static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003066 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003067 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003068{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003069 if( ! operation->key_set )
3070 return( PSA_ERROR_BAD_STATE );
3071 if( operation->iv_required && ! operation->iv_set )
3072 return( PSA_ERROR_BAD_STATE );
3073
Gilles Peskine8c9def32018-02-08 10:02:12 +01003074 if( mac_size < operation->mac_size )
3075 return( PSA_ERROR_BUFFER_TOO_SMALL );
3076
Gilles Peskine8c9def32018-02-08 10:02:12 +01003077#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003078 if( operation->alg == PSA_ALG_CMAC )
3079 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003080 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003081 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3082 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003083 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003084 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003085 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003086 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003087 else
3088#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003089#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003090 if( PSA_ALG_IS_HMAC( operation->alg ) )
3091 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003092 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003093 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003094 }
3095 else
John Durkopd0321952020-10-29 21:37:36 -07003096#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003097 {
3098 /* This shouldn't happen if `operation` was initialized by
3099 * a setup function. */
3100 return( PSA_ERROR_BAD_STATE );
3101 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003102}
3103
Gilles Peskineacd4be32018-07-08 19:56:25 +02003104psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3105 uint8_t *mac,
3106 size_t mac_size,
3107 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003108{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003109 psa_status_t status;
3110
Jaeden Amero252ef282019-02-15 14:05:35 +00003111 if( operation->alg == 0 )
3112 {
3113 return( PSA_ERROR_BAD_STATE );
3114 }
3115
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003116 /* Fill the output buffer with something that isn't a valid mac
3117 * (barring an attack on the mac and deliberately-crafted input),
3118 * in case the caller doesn't check the return status properly. */
3119 *mac_length = mac_size;
3120 /* If mac_size is 0 then mac may be NULL and then the
3121 * call to memset would have undefined behavior. */
3122 if( mac_size != 0 )
3123 memset( mac, '!', mac_size );
3124
Gilles Peskine89167cb2018-07-08 20:12:23 +02003125 if( ! operation->is_sign )
3126 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003127 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003128 }
mohammad16036df908f2018-04-02 08:34:15 -07003129
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003130 status = psa_mac_finish_internal( operation, mac, mac_size );
3131
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003132 if( status == PSA_SUCCESS )
3133 {
3134 status = psa_mac_abort( operation );
3135 if( status == PSA_SUCCESS )
3136 *mac_length = operation->mac_size;
3137 else
3138 memset( mac, '!', mac_size );
3139 }
3140 else
3141 psa_mac_abort( operation );
3142 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003143}
3144
Gilles Peskineacd4be32018-07-08 19:56:25 +02003145psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3146 const uint8_t *mac,
3147 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003148{
Gilles Peskine828ed142018-06-18 23:25:51 +02003149 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003150 psa_status_t status;
3151
Jaeden Amero252ef282019-02-15 14:05:35 +00003152 if( operation->alg == 0 )
3153 {
3154 return( PSA_ERROR_BAD_STATE );
3155 }
3156
Gilles Peskine89167cb2018-07-08 20:12:23 +02003157 if( operation->is_sign )
3158 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003159 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003160 }
3161 if( operation->mac_size != mac_length )
3162 {
3163 status = PSA_ERROR_INVALID_SIGNATURE;
3164 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003165 }
mohammad16036df908f2018-04-02 08:34:15 -07003166
3167 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003168 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003169 if( status != PSA_SUCCESS )
3170 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003171
3172 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3173 status = PSA_ERROR_INVALID_SIGNATURE;
3174
3175cleanup:
3176 if( status == PSA_SUCCESS )
3177 status = psa_mac_abort( operation );
3178 else
3179 psa_mac_abort( operation );
3180
Gilles Peskine3f108122018-12-07 18:14:53 +01003181 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003182
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003183 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003184}
3185
3186
Gilles Peskine20035e32018-02-03 22:44:14 +01003187
Gilles Peskine20035e32018-02-03 22:44:14 +01003188/****************************************************************/
3189/* Asymmetric cryptography */
3190/****************************************************************/
3191
John Durkop6ba40d12020-11-10 08:50:04 -08003192#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3193 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003194/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003195 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003196static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3197 size_t hash_length,
3198 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003199{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003200 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003201 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003202 *md_alg = mbedtls_md_get_type( md_info );
3203
3204 /* The Mbed TLS RSA module uses an unsigned int for hash length
3205 * parameters. Validate that it fits so that we don't risk an
3206 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003207#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003208 if( hash_length > UINT_MAX )
3209 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003210#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003211
John Durkop0e005192020-10-31 22:06:54 -07003212#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003213 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3214 * must be correct. */
3215 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3216 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003217 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003218 if( md_info == NULL )
3219 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003220 if( mbedtls_md_get_size( md_info ) != hash_length )
3221 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003222 }
John Durkop0e005192020-10-31 22:06:54 -07003223#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003224
John Durkop0e005192020-10-31 22:06:54 -07003225#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003226 /* PSS requires a hash internally. */
3227 if( PSA_ALG_IS_RSA_PSS( alg ) )
3228 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003229 if( md_info == NULL )
3230 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003231 }
John Durkop0e005192020-10-31 22:06:54 -07003232#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003233
Gilles Peskine61b91d42018-06-08 16:09:36 +02003234 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003235}
3236
Gilles Peskine2b450e32018-06-27 15:42:46 +02003237static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3238 psa_algorithm_t alg,
3239 const uint8_t *hash,
3240 size_t hash_length,
3241 uint8_t *signature,
3242 size_t signature_size,
3243 size_t *signature_length )
3244{
3245 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003247 mbedtls_md_type_t md_alg;
3248
3249 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3250 if( status != PSA_SUCCESS )
3251 return( status );
3252
Gilles Peskine630a18a2018-06-29 17:49:35 +02003253 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003254 return( PSA_ERROR_BUFFER_TOO_SMALL );
3255
John Durkop0e005192020-10-31 22:06:54 -07003256#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003257 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3258 {
3259 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3260 MBEDTLS_MD_NONE );
3261 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003262 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003263 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003264 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003265 md_alg,
3266 (unsigned int) hash_length,
3267 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003268 signature );
3269 }
3270 else
John Durkop0e005192020-10-31 22:06:54 -07003271#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3272#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003273 if( PSA_ALG_IS_RSA_PSS( alg ) )
3274 {
3275 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3276 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003277 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003278 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003279 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003280 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003281 (unsigned int) hash_length,
3282 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003283 signature );
3284 }
3285 else
John Durkop0e005192020-10-31 22:06:54 -07003286#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003287 {
3288 return( PSA_ERROR_INVALID_ARGUMENT );
3289 }
3290
3291 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003292 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003293 return( mbedtls_to_psa_error( ret ) );
3294}
3295
3296static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3297 psa_algorithm_t alg,
3298 const uint8_t *hash,
3299 size_t hash_length,
3300 const uint8_t *signature,
3301 size_t signature_length )
3302{
3303 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003304 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003305 mbedtls_md_type_t md_alg;
3306
3307 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3308 if( status != PSA_SUCCESS )
3309 return( status );
3310
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003311 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3312 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003313
John Durkop0e005192020-10-31 22:06:54 -07003314#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003315 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3316 {
3317 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3318 MBEDTLS_MD_NONE );
3319 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003320 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003321 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003322 MBEDTLS_RSA_PUBLIC,
3323 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003324 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003325 hash,
3326 signature );
3327 }
3328 else
John Durkop0e005192020-10-31 22:06:54 -07003329#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3330#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003331 if( PSA_ALG_IS_RSA_PSS( alg ) )
3332 {
3333 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3334 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003335 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003336 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003337 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003338 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003339 (unsigned int) hash_length,
3340 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003341 signature );
3342 }
3343 else
John Durkop0e005192020-10-31 22:06:54 -07003344#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003345 {
3346 return( PSA_ERROR_INVALID_ARGUMENT );
3347 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003348
3349 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3350 * the rest of the signature is invalid". This has little use in
3351 * practice and PSA doesn't report this distinction. */
3352 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3353 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003354 return( mbedtls_to_psa_error( ret ) );
3355}
John Durkop6ba40d12020-11-10 08:50:04 -08003356#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3357 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003358
John Durkop6ba40d12020-11-10 08:50:04 -08003359#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3360 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003361/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3362 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3363 * (even though these functions don't modify it). */
3364static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3365 psa_algorithm_t alg,
3366 const uint8_t *hash,
3367 size_t hash_length,
3368 uint8_t *signature,
3369 size_t signature_size,
3370 size_t *signature_length )
3371{
Janos Follath24eed8d2019-11-22 13:21:35 +00003372 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003373 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003374 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003375 mbedtls_mpi_init( &r );
3376 mbedtls_mpi_init( &s );
3377
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003378 if( signature_size < 2 * curve_bytes )
3379 {
3380 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3381 goto cleanup;
3382 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003383
John Durkop0ea39e02020-10-13 19:58:20 -07003384#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003385 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3386 {
3387 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3388 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3389 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003390 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3391 &ecp->d, hash,
3392 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003393 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003394 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003395 }
3396 else
John Durkop0ea39e02020-10-13 19:58:20 -07003397#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003398 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003399 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003400 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3401 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003402 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003403 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003404 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003405
3406 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3407 signature,
3408 curve_bytes ) );
3409 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3410 signature + curve_bytes,
3411 curve_bytes ) );
3412
3413cleanup:
3414 mbedtls_mpi_free( &r );
3415 mbedtls_mpi_free( &s );
3416 if( ret == 0 )
3417 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003418 return( mbedtls_to_psa_error( ret ) );
3419}
3420
3421static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3422 const uint8_t *hash,
3423 size_t hash_length,
3424 const uint8_t *signature,
3425 size_t signature_length )
3426{
Janos Follath24eed8d2019-11-22 13:21:35 +00003427 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003428 mbedtls_mpi r, s;
3429 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3430 mbedtls_mpi_init( &r );
3431 mbedtls_mpi_init( &s );
3432
3433 if( signature_length != 2 * curve_bytes )
3434 return( PSA_ERROR_INVALID_SIGNATURE );
3435
3436 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3437 signature,
3438 curve_bytes ) );
3439 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3440 signature + curve_bytes,
3441 curve_bytes ) );
3442
Steven Cooremanacda8342020-07-24 23:09:52 +02003443 /* Check whether the public part is loaded. If not, load it. */
3444 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3445 {
3446 MBEDTLS_MPI_CHK(
3447 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003448 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003449 }
3450
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003451 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3452 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003453
3454cleanup:
3455 mbedtls_mpi_free( &r );
3456 mbedtls_mpi_free( &s );
3457 return( mbedtls_to_psa_error( ret ) );
3458}
John Durkop6ba40d12020-11-10 08:50:04 -08003459#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3460 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003461
Ronald Croncf56a0a2020-08-04 09:51:30 +02003462psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003463 psa_algorithm_t alg,
3464 const uint8_t *hash,
3465 size_t hash_length,
3466 uint8_t *signature,
3467 size_t signature_size,
3468 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003469{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003470 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003471 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003472 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003473
3474 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003475 /* Immediately reject a zero-length signature buffer. This guarantees
3476 * that signature must be a valid pointer. (On the other hand, the hash
3477 * buffer can in principle be empty since it doesn't actually have
3478 * to be a hash.) */
3479 if( signature_size == 0 )
3480 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003481
Ronald Cron5c522922020-11-14 16:35:34 +01003482 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3483 PSA_KEY_USAGE_SIGN_HASH,
3484 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003485 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003486 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003487 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003488 {
3489 status = PSA_ERROR_INVALID_ARGUMENT;
3490 goto exit;
3491 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003492
Steven Cooremancd84cb42020-07-16 20:28:36 +02003493 /* Try any of the available accelerators first */
3494 status = psa_driver_wrapper_sign_hash( slot,
3495 alg,
3496 hash,
3497 hash_length,
3498 signature,
3499 signature_size,
3500 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003501 if( status != PSA_ERROR_NOT_SUPPORTED ||
3502 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003503 goto exit;
3504
Steven Cooreman7a250572020-07-17 16:43:05 +02003505 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003506#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3507 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003508 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003509 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003510 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003511
Ronald Cron90857082020-11-25 14:58:33 +01003512 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3513 slot->key.data,
3514 slot->key.bytes,
3515 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003516 if( status != PSA_SUCCESS )
3517 goto exit;
3518
Steven Cooremana2371e52020-07-28 14:30:39 +02003519 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003520 alg,
3521 hash, hash_length,
3522 signature, signature_size,
3523 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003524
Steven Cooremana2371e52020-07-28 14:30:39 +02003525 mbedtls_rsa_free( rsa );
3526 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003527 }
3528 else
John Durkop6ba40d12020-11-10 08:50:04 -08003529#endif /* 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( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003532 {
John Durkop9814fa22020-11-04 12:28:15 -08003533#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3534 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003535 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003536#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003537 PSA_ALG_IS_ECDSA( alg )
3538#else
3539 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3540#endif
3541 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003542 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003543 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003544 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3545 slot->key.data,
3546 slot->key.bytes,
3547 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003548 if( status != PSA_SUCCESS )
3549 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003550 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003551 alg,
3552 hash, hash_length,
3553 signature, signature_size,
3554 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003555 mbedtls_ecp_keypair_free( ecp );
3556 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003557 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003558 else
John Durkop9814fa22020-11-04 12:28:15 -08003559#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3560 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003561 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003562 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003563 }
itayzafrir5c753392018-05-08 11:18:38 +03003564 }
3565 else
itayzafrir5c753392018-05-08 11:18:38 +03003566 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003567 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003568 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003569
3570exit:
3571 /* Fill the unused part of the output buffer (the whole buffer on error,
3572 * the trailing part on success) with something that isn't a valid mac
3573 * (barring an attack on the mac and deliberately-crafted input),
3574 * in case the caller doesn't check the return status properly. */
3575 if( status == PSA_SUCCESS )
3576 memset( signature + *signature_length, '!',
3577 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003578 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003579 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003580 /* If signature_size is 0 then we have nothing to do. We must not call
3581 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003582
Ronald Cron5c522922020-11-14 16:35:34 +01003583 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003584
Ronald Cron5c522922020-11-14 16:35:34 +01003585 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003586}
3587
Ronald Croncf56a0a2020-08-04 09:51:30 +02003588psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003589 psa_algorithm_t alg,
3590 const uint8_t *hash,
3591 size_t hash_length,
3592 const uint8_t *signature,
3593 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003594{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003596 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003597 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003598
Ronald Cron5c522922020-11-14 16:35:34 +01003599 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3600 PSA_KEY_USAGE_VERIFY_HASH,
3601 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003602 if( status != PSA_SUCCESS )
3603 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003604
Steven Cooreman55ae2172020-07-17 19:46:15 +02003605 /* Try any of the available accelerators first */
3606 status = psa_driver_wrapper_verify_hash( slot,
3607 alg,
3608 hash,
3609 hash_length,
3610 signature,
3611 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003612 if( status != PSA_ERROR_NOT_SUPPORTED ||
3613 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003614 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003615
John Durkop6ba40d12020-11-10 08:50:04 -08003616#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3617 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003618 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003619 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003620 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003621
Ronald Cron90857082020-11-25 14:58:33 +01003622 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3623 slot->key.data,
3624 slot->key.bytes,
3625 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003626 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003627 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003628
Steven Cooremana2371e52020-07-28 14:30:39 +02003629 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003630 alg,
3631 hash, hash_length,
3632 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003633 mbedtls_rsa_free( rsa );
3634 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003635 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003636 }
3637 else
John Durkop6ba40d12020-11-10 08:50:04 -08003638#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3639 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003640 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003641 {
John Durkop9814fa22020-11-04 12:28:15 -08003642#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3643 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003644 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003645 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003646 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003647 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3648 slot->key.data,
3649 slot->key.bytes,
3650 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003651 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003652 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003653 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003654 hash, hash_length,
3655 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003656 mbedtls_ecp_keypair_free( ecp );
3657 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003658 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003659 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003660 else
John Durkop9814fa22020-11-04 12:28:15 -08003661#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3662 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003663 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003664 status = PSA_ERROR_INVALID_ARGUMENT;
3665 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003666 }
itayzafrir5c753392018-05-08 11:18:38 +03003667 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003668 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003669 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003670 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003671 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003672
3673exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003674 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003675
Ronald Cron5c522922020-11-14 16:35:34 +01003676 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003677}
3678
John Durkop0e005192020-10-31 22:06:54 -07003679#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003680static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3681 mbedtls_rsa_context *rsa )
3682{
3683 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3684 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3685 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3686 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3687}
John Durkop0e005192020-10-31 22:06:54 -07003688#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003689
Ronald Croncf56a0a2020-08-04 09:51:30 +02003690psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003691 psa_algorithm_t alg,
3692 const uint8_t *input,
3693 size_t input_length,
3694 const uint8_t *salt,
3695 size_t salt_length,
3696 uint8_t *output,
3697 size_t output_size,
3698 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003699{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003700 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003701 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003702 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003703
Darryl Green5cc689a2018-07-24 15:34:10 +01003704 (void) input;
3705 (void) input_length;
3706 (void) salt;
3707 (void) output;
3708 (void) output_size;
3709
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003710 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003711
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003712 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3713 return( PSA_ERROR_INVALID_ARGUMENT );
3714
Ronald Cron5c522922020-11-14 16:35:34 +01003715 status = psa_get_and_lock_transparent_key_slot_with_policy(
3716 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003717 if( status != PSA_SUCCESS )
3718 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003719 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3720 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003721 {
3722 status = PSA_ERROR_INVALID_ARGUMENT;
3723 goto exit;
3724 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003725
John Durkop6ba40d12020-11-10 08:50:04 -08003726#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3727 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003728 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003729 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003730 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003731 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3732 slot->key.data,
3733 slot->key.bytes,
3734 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003735 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003736 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003737
3738 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003739 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003740 status = PSA_ERROR_BUFFER_TOO_SMALL;
3741 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003742 }
John Durkop0e005192020-10-31 22:06:54 -07003743#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003744 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003745 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003746 status = mbedtls_to_psa_error(
3747 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003748 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003749 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003750 MBEDTLS_RSA_PUBLIC,
3751 input_length,
3752 input,
3753 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003754 }
3755 else
John Durkop0e005192020-10-31 22:06:54 -07003756#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3757#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003758 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003759 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003760 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003761 status = mbedtls_to_psa_error(
3762 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003763 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003764 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003765 MBEDTLS_RSA_PUBLIC,
3766 salt, salt_length,
3767 input_length,
3768 input,
3769 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003770 }
3771 else
John Durkop0e005192020-10-31 22:06:54 -07003772#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003773 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003774 status = PSA_ERROR_INVALID_ARGUMENT;
3775 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003776 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003777rsa_exit:
3778 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003779 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003780
Steven Cooremana2371e52020-07-28 14:30:39 +02003781 mbedtls_rsa_free( rsa );
3782 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003783 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003784 else
John Durkop9814fa22020-11-04 12:28:15 -08003785#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003786 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003787 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003788 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003789 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003790
3791exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003792 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003793
Ronald Cron5c522922020-11-14 16:35:34 +01003794 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003795}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003796
Ronald Croncf56a0a2020-08-04 09:51:30 +02003797psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003798 psa_algorithm_t alg,
3799 const uint8_t *input,
3800 size_t input_length,
3801 const uint8_t *salt,
3802 size_t salt_length,
3803 uint8_t *output,
3804 size_t output_size,
3805 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003806{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003808 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003809 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003810
Darryl Green5cc689a2018-07-24 15:34:10 +01003811 (void) input;
3812 (void) input_length;
3813 (void) salt;
3814 (void) output;
3815 (void) output_size;
3816
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003817 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003818
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003819 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3820 return( PSA_ERROR_INVALID_ARGUMENT );
3821
Ronald Cron5c522922020-11-14 16:35:34 +01003822 status = psa_get_and_lock_transparent_key_slot_with_policy(
3823 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003824 if( status != PSA_SUCCESS )
3825 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003826 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003827 {
3828 status = PSA_ERROR_INVALID_ARGUMENT;
3829 goto exit;
3830 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003831
John Durkop6ba40d12020-11-10 08:50:04 -08003832#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3833 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003834 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003835 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003836 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003837 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3838 slot->key.data,
3839 slot->key.bytes,
3840 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003841 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003842 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003843
Steven Cooremana2371e52020-07-28 14:30:39 +02003844 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003845 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003846 status = PSA_ERROR_INVALID_ARGUMENT;
3847 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003848 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003849
John Durkop0e005192020-10-31 22:06:54 -07003850#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003851 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003852 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003853 status = mbedtls_to_psa_error(
3854 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003855 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003856 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003857 MBEDTLS_RSA_PRIVATE,
3858 output_length,
3859 input,
3860 output,
3861 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003862 }
3863 else
John Durkop0e005192020-10-31 22:06:54 -07003864#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3865#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003866 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003867 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003868 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003869 status = mbedtls_to_psa_error(
3870 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003871 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003872 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003873 MBEDTLS_RSA_PRIVATE,
3874 salt, salt_length,
3875 output_length,
3876 input,
3877 output,
3878 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003879 }
3880 else
John Durkop0e005192020-10-31 22:06:54 -07003881#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003882 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003883 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003884 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003885
Steven Cooreman4fed4552020-08-03 14:46:03 +02003886rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003887 mbedtls_rsa_free( rsa );
3888 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003889 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003890 else
John Durkop6ba40d12020-11-10 08:50:04 -08003891#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3892 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003893 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003894 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003895 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003896
3897exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003898 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003899
Ronald Cron5c522922020-11-14 16:35:34 +01003900 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003901}
Gilles Peskine20035e32018-02-03 22:44:14 +01003902
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003903
3904
mohammad1603503973b2018-03-12 15:59:30 +02003905/****************************************************************/
3906/* Symmetric cryptography */
3907/****************************************************************/
3908
Gilles Peskinee553c652018-06-04 16:22:46 +02003909static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003910 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003911 psa_algorithm_t alg,
3912 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003913{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003914 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003915 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003916 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003917 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003918 size_t key_bits;
3919 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003920 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3921 PSA_KEY_USAGE_ENCRYPT :
3922 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003923
Steven Cooremand3feccd2020-09-01 15:56:14 +02003924 /* A context must be freshly initialized before it can be set up. */
3925 if( operation->alg != 0 )
3926 return( PSA_ERROR_BAD_STATE );
3927
Steven Cooremana07b9972020-09-10 14:54:14 +02003928 /* The requested algorithm must be one that can be processed by cipher. */
3929 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003930 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003931
Steven Cooremanef8575e2020-09-11 11:44:50 +02003932 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003933 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003934 if( status != PSA_SUCCESS )
3935 goto exit;
3936
3937 /* Initialize the operation struct members, except for alg. The alg member
3938 * is used to indicate to psa_cipher_abort that there are resources to free,
3939 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003940 operation->key_set = 0;
3941 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003942 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003943 operation->iv_size = 0;
3944 operation->block_size = 0;
3945 if( alg == PSA_ALG_ECB_NO_PADDING )
3946 operation->iv_required = 0;
3947 else
3948 operation->iv_required = 1;
3949
Steven Cooremana07b9972020-09-10 14:54:14 +02003950 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003951 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003952 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003953 slot,
3954 alg );
3955 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003956 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003957 slot,
3958 alg );
3959
Steven Cooremanef8575e2020-09-11 11:44:50 +02003960 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003961 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003962 /* Once the driver context is initialised, it needs to be freed using
3963 * psa_cipher_abort. Indicate this through setting alg. */
3964 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003965 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003966
Steven Cooremand3feccd2020-09-01 15:56:14 +02003967 if( status != PSA_ERROR_NOT_SUPPORTED ||
3968 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3969 goto exit;
3970
Steven Cooremana07b9972020-09-10 14:54:14 +02003971 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003972 * available for the given algorithm & key. */
3973 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003974
Steven Cooremana07b9972020-09-10 14:54:14 +02003975 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003976 * psa_cipher_abort. Indicate there is something to be freed through setting
3977 * alg, and indicate the operation is being done using mbedtls crypto through
3978 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003979 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003980 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003981
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003982 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003983 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003984 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003985 {
3986 status = PSA_ERROR_NOT_SUPPORTED;
3987 goto exit;
3988 }
mohammad1603503973b2018-03-12 15:59:30 +02003989
mohammad1603503973b2018-03-12 15:59:30 +02003990 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003991 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003992 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003993
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003994#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003995 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003996 {
3997 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003998 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003999 memcpy( keys, slot->key.data, 16 );
4000 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004001 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4002 keys,
4003 192, cipher_operation );
4004 }
4005 else
4006#endif
4007 {
4008 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004009 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004010 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004011 }
Moran Peker41deec42018-04-04 15:43:05 +03004012 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004013 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004014
mohammad16038481e742018-03-18 13:57:31 +02004015#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004016 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004017 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004018 case PSA_ALG_CBC_NO_PADDING:
4019 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4020 MBEDTLS_PADDING_NONE );
4021 break;
4022 case PSA_ALG_CBC_PKCS7:
4023 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4024 MBEDTLS_PADDING_PKCS7 );
4025 break;
4026 default:
4027 /* The algorithm doesn't involve padding. */
4028 ret = 0;
4029 break;
4030 }
4031 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004032 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004033#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4034
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004035 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004036 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004037 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4038 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004039 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004040 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004041 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004042#if defined(MBEDTLS_CHACHA20_C)
4043 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004044 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004045 operation->iv_size = 12;
4046#endif
mohammad1603503973b2018-03-12 15:59:30 +02004047
Steven Cooreman7df02922020-09-09 15:28:49 +02004048 status = PSA_SUCCESS;
4049
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004050exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004051 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004052 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004053 if( status == PSA_SUCCESS )
4054 {
4055 /* Update operation flags for both driver and software implementations */
4056 operation->key_set = 1;
4057 }
4058 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004059 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004060
Ronald Cron5c522922020-11-14 16:35:34 +01004061 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004062
Ronald Cron5c522922020-11-14 16:35:34 +01004063 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004064}
4065
Gilles Peskinefe119512018-07-08 21:39:34 +02004066psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004067 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004068 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004069{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004070 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004071}
4072
Gilles Peskinefe119512018-07-08 21:39:34 +02004073psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004074 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004075 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004076{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004077 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004078}
4079
Gilles Peskinefe119512018-07-08 21:39:34 +02004080psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004081 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004082 size_t iv_size,
4083 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004084{
itayzafrir534bd7c2018-08-02 13:56:32 +03004085 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004086 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004087 if( operation->iv_set || ! operation->iv_required )
4088 {
4089 return( PSA_ERROR_BAD_STATE );
4090 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004091
Steven Cooremanef8575e2020-09-11 11:44:50 +02004092 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004093 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004094 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004095 iv,
4096 iv_size,
4097 iv_length );
4098 goto exit;
4099 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004100
Moran Peker41deec42018-04-04 15:43:05 +03004101 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004102 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004103 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004104 goto exit;
4105 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004106 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004107 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004108 if( ret != 0 )
4109 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004110 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004111 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004112 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004113
mohammad16038481e742018-03-18 13:57:31 +02004114 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004115 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004116
Moran Peker395db872018-05-31 14:07:14 +03004117exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004118 if( status == PSA_SUCCESS )
4119 operation->iv_set = 1;
4120 else
Moran Peker395db872018-05-31 14:07:14 +03004121 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004122 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004123}
4124
Gilles Peskinefe119512018-07-08 21:39:34 +02004125psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004126 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004127 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004128{
itayzafrir534bd7c2018-08-02 13:56:32 +03004129 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004130 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004131 if( operation->iv_set || ! operation->iv_required )
4132 {
4133 return( PSA_ERROR_BAD_STATE );
4134 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004135
Steven Cooremanef8575e2020-09-11 11:44:50 +02004136 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004137 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004138 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004139 iv,
4140 iv_length );
4141 goto exit;
4142 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004143
Moran Pekera28258c2018-05-29 16:25:04 +03004144 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004145 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004146 status = PSA_ERROR_INVALID_ARGUMENT;
4147 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004148 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004149 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4150 status = mbedtls_to_psa_error( ret );
4151exit:
4152 if( status == PSA_SUCCESS )
4153 operation->iv_set = 1;
4154 else
mohammad1603503973b2018-03-12 15:59:30 +02004155 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004156 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004157}
4158
Steven Cooreman177deba2020-09-07 17:14:14 +02004159/* Process input for which the algorithm is set to ECB mode. This requires
4160 * manual processing, since the PSA API is defined as being able to process
4161 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4162 * underlying mbedtls_cipher_update only takes full blocks. */
4163static psa_status_t psa_cipher_update_ecb_internal(
4164 mbedtls_cipher_context_t *ctx,
4165 const uint8_t *input,
4166 size_t input_length,
4167 uint8_t *output,
4168 size_t output_size,
4169 size_t *output_length )
4170{
4171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4172 size_t block_size = ctx->cipher_info->block_size;
4173 size_t internal_output_length = 0;
4174 *output_length = 0;
4175
4176 if( input_length == 0 )
4177 {
4178 status = PSA_SUCCESS;
4179 goto exit;
4180 }
4181
4182 if( ctx->unprocessed_len > 0 )
4183 {
4184 /* Fill up to block size, and run the block if there's a full one. */
4185 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4186
4187 if( input_length < bytes_to_copy )
4188 bytes_to_copy = input_length;
4189
4190 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4191 input, bytes_to_copy );
4192 input_length -= bytes_to_copy;
4193 input += bytes_to_copy;
4194 ctx->unprocessed_len += bytes_to_copy;
4195
4196 if( ctx->unprocessed_len == block_size )
4197 {
4198 status = mbedtls_to_psa_error(
4199 mbedtls_cipher_update( ctx,
4200 ctx->unprocessed_data,
4201 block_size,
4202 output, &internal_output_length ) );
4203
4204 if( status != PSA_SUCCESS )
4205 goto exit;
4206
4207 output += internal_output_length;
4208 output_size -= internal_output_length;
4209 *output_length += internal_output_length;
4210 ctx->unprocessed_len = 0;
4211 }
4212 }
4213
4214 while( input_length >= block_size )
4215 {
4216 /* Run all full blocks we have, one by one */
4217 status = mbedtls_to_psa_error(
4218 mbedtls_cipher_update( ctx, input,
4219 block_size,
4220 output, &internal_output_length ) );
4221
4222 if( status != PSA_SUCCESS )
4223 goto exit;
4224
4225 input_length -= block_size;
4226 input += block_size;
4227
4228 output += internal_output_length;
4229 output_size -= internal_output_length;
4230 *output_length += internal_output_length;
4231 }
4232
4233 if( input_length > 0 )
4234 {
4235 /* Save unprocessed bytes for later processing */
4236 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4237 input, input_length );
4238 ctx->unprocessed_len += input_length;
4239 }
4240
4241 status = PSA_SUCCESS;
4242
4243exit:
4244 return( status );
4245}
4246
Gilles Peskinee553c652018-06-04 16:22:46 +02004247psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4248 const uint8_t *input,
4249 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004250 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004251 size_t output_size,
4252 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004253{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004255 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004256 if( operation->alg == 0 )
4257 {
4258 return( PSA_ERROR_BAD_STATE );
4259 }
4260 if( operation->iv_required && ! operation->iv_set )
4261 {
4262 return( PSA_ERROR_BAD_STATE );
4263 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004264
Steven Cooremanef8575e2020-09-11 11:44:50 +02004265 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004266 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004267 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004268 input,
4269 input_length,
4270 output,
4271 output_size,
4272 output_length );
4273 goto exit;
4274 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004275
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004276 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004277 {
4278 /* Take the unprocessed partial block left over from previous
4279 * update calls, if any, plus the input to this call. Remove
4280 * the last partial block, if any. You get the data that will be
4281 * output in this call. */
4282 expected_output_size =
4283 ( operation->ctx.cipher.unprocessed_len + input_length )
4284 / operation->block_size * operation->block_size;
4285 }
4286 else
4287 {
4288 expected_output_size = input_length;
4289 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004290
Gilles Peskine89d789c2018-06-04 17:17:16 +02004291 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004292 {
4293 status = PSA_ERROR_BUFFER_TOO_SMALL;
4294 goto exit;
4295 }
mohammad160382759612018-03-12 18:16:40 +02004296
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004297 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4298 {
4299 /* mbedtls_cipher_update has an API inconsistency: it will only
4300 * process a single block at a time in ECB mode. Abstract away that
4301 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004302 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4303 input,
4304 input_length,
4305 output,
4306 output_size,
4307 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004308 }
4309 else
4310 {
4311 status = mbedtls_to_psa_error(
4312 mbedtls_cipher_update( &operation->ctx.cipher, input,
4313 input_length, output, output_length ) );
4314 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004315exit:
4316 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004317 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004318 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004319}
4320
Gilles Peskinee553c652018-06-04 16:22:46 +02004321psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4322 uint8_t *output,
4323 size_t output_size,
4324 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004325{
David Saadab4ecc272019-02-14 13:48:10 +02004326 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004327 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004328 if( operation->alg == 0 )
4329 {
4330 return( PSA_ERROR_BAD_STATE );
4331 }
4332 if( operation->iv_required && ! operation->iv_set )
4333 {
4334 return( PSA_ERROR_BAD_STATE );
4335 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004336
Steven Cooremanef8575e2020-09-11 11:44:50 +02004337 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004338 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004339 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004340 output,
4341 output_size,
4342 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004343 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004344 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004345
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004346 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004347 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004348 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004349 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004350 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004351 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004352 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004353 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004354 }
4355
Steven Cooremanef8575e2020-09-11 11:44:50 +02004356 status = mbedtls_to_psa_error(
4357 mbedtls_cipher_finish( &operation->ctx.cipher,
4358 temp_output_buffer,
4359 output_length ) );
4360 if( status != PSA_SUCCESS )
4361 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004362
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004363 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004364 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004365 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004366 memcpy( output, temp_output_buffer, *output_length );
4367 else
Janos Follath315b51c2018-07-09 16:04:51 +01004368 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004369
Steven Cooremanef8575e2020-09-11 11:44:50 +02004370exit:
4371 if( operation->mbedtls_in_use == 1 )
4372 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004373
Steven Cooremanef8575e2020-09-11 11:44:50 +02004374 if( status == PSA_SUCCESS )
4375 return( psa_cipher_abort( operation ) );
4376 else
4377 {
4378 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004379 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004380
Steven Cooremanef8575e2020-09-11 11:44:50 +02004381 return( status );
4382 }
mohammad1603503973b2018-03-12 15:59:30 +02004383}
4384
Gilles Peskinee553c652018-06-04 16:22:46 +02004385psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4386{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004387 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004388 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004389 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004390 * in use. It's ok to call abort on such an object, and there's
4391 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004392 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004393 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004394
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004395 /* Sanity check (shouldn't happen: operation->alg should
4396 * always have been initialized to a valid value). */
4397 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4398 return( PSA_ERROR_BAD_STATE );
4399
Steven Cooremanef8575e2020-09-11 11:44:50 +02004400 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004401 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004402 else
4403 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004404
Moran Peker41deec42018-04-04 15:43:05 +03004405 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004406 operation->key_set = 0;
4407 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004408 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004409 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004410 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004411 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004412
Moran Peker395db872018-05-31 14:07:14 +03004413 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004414}
4415
Gilles Peskinea0655c32018-04-30 17:06:50 +02004416
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004417
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004418
mohammad16035955c982018-04-26 00:53:03 +03004419/****************************************************************/
4420/* AEAD */
4421/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004422
Gilles Peskineedf9a652018-08-17 18:11:56 +02004423typedef struct
4424{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004425 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004426 const mbedtls_cipher_info_t *cipher_info;
4427 union
4428 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004429 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004430#if defined(MBEDTLS_CCM_C)
4431 mbedtls_ccm_context ccm;
4432#endif /* MBEDTLS_CCM_C */
4433#if defined(MBEDTLS_GCM_C)
4434 mbedtls_gcm_context gcm;
4435#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004436#if defined(MBEDTLS_CHACHAPOLY_C)
4437 mbedtls_chachapoly_context chachapoly;
4438#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004439 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004440 psa_algorithm_t core_alg;
4441 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004442 uint8_t tag_length;
4443} aead_operation_t;
4444
Ronald Cronf95a2b12020-10-22 15:24:49 +02004445#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4446
Gilles Peskine30a9e412019-01-14 18:36:12 +01004447static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004448{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004449 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004450 {
4451#if defined(MBEDTLS_CCM_C)
4452 case PSA_ALG_CCM:
4453 mbedtls_ccm_free( &operation->ctx.ccm );
4454 break;
4455#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004456#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004457 case PSA_ALG_GCM:
4458 mbedtls_gcm_free( &operation->ctx.gcm );
4459 break;
4460#endif /* MBEDTLS_GCM_C */
4461 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004462
Ronald Cron5c522922020-11-14 16:35:34 +01004463 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004464}
4465
4466static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004467 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004468 psa_key_usage_t usage,
4469 psa_algorithm_t alg )
4470{
4471 psa_status_t status;
4472 size_t key_bits;
4473 mbedtls_cipher_id_t cipher_id;
4474
Ronald Cron5c522922020-11-14 16:35:34 +01004475 status = psa_get_and_lock_transparent_key_slot_with_policy(
4476 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004477 if( status != PSA_SUCCESS )
4478 return( status );
4479
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004480 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004481
4482 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004483 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004484 &cipher_id );
4485 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004486 {
4487 status = PSA_ERROR_NOT_SUPPORTED;
4488 goto cleanup;
4489 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004490
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004491 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004492 {
4493#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004494 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4495 operation->core_alg = PSA_ALG_CCM;
4496 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004497 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4498 * The call to mbedtls_ccm_encrypt_and_tag or
4499 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004500 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004501 {
4502 status = PSA_ERROR_INVALID_ARGUMENT;
4503 goto cleanup;
4504 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004505 mbedtls_ccm_init( &operation->ctx.ccm );
4506 status = mbedtls_to_psa_error(
4507 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004508 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004509 (unsigned int) key_bits ) );
4510 if( status != 0 )
4511 goto cleanup;
4512 break;
4513#endif /* MBEDTLS_CCM_C */
4514
4515#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004516 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4517 operation->core_alg = PSA_ALG_GCM;
4518 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004519 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4520 * The call to mbedtls_gcm_crypt_and_tag or
4521 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004522 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004523 {
4524 status = PSA_ERROR_INVALID_ARGUMENT;
4525 goto cleanup;
4526 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004527 mbedtls_gcm_init( &operation->ctx.gcm );
4528 status = mbedtls_to_psa_error(
4529 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004530 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004531 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004532 if( status != 0 )
4533 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004534 break;
4535#endif /* MBEDTLS_GCM_C */
4536
Gilles Peskine26869f22019-05-06 15:25:00 +02004537#if defined(MBEDTLS_CHACHAPOLY_C)
4538 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4539 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4540 operation->full_tag_length = 16;
4541 /* We only support the default tag length. */
4542 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004543 {
4544 status = PSA_ERROR_NOT_SUPPORTED;
4545 goto cleanup;
4546 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004547 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4548 status = mbedtls_to_psa_error(
4549 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004550 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004551 if( status != 0 )
4552 goto cleanup;
4553 break;
4554#endif /* MBEDTLS_CHACHAPOLY_C */
4555
Gilles Peskineedf9a652018-08-17 18:11:56 +02004556 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004557 status = PSA_ERROR_NOT_SUPPORTED;
4558 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004559 }
4560
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004561 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4562 {
4563 status = PSA_ERROR_INVALID_ARGUMENT;
4564 goto cleanup;
4565 }
4566 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004567
Gilles Peskineedf9a652018-08-17 18:11:56 +02004568 return( PSA_SUCCESS );
4569
4570cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004571 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004572 return( status );
4573}
4574
Ronald Croncf56a0a2020-08-04 09:51:30 +02004575psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004576 psa_algorithm_t alg,
4577 const uint8_t *nonce,
4578 size_t nonce_length,
4579 const uint8_t *additional_data,
4580 size_t additional_data_length,
4581 const uint8_t *plaintext,
4582 size_t plaintext_length,
4583 uint8_t *ciphertext,
4584 size_t ciphertext_size,
4585 size_t *ciphertext_length )
4586{
mohammad16035955c982018-04-26 00:53:03 +03004587 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004588 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004589 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004590
mohammad1603f08a5502018-06-03 15:05:47 +03004591 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004592
Ronald Croncf56a0a2020-08-04 09:51:30 +02004593 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004594 if( status != PSA_SUCCESS )
4595 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004596
Gilles Peskineedf9a652018-08-17 18:11:56 +02004597 /* For all currently supported modes, the tag is at the end of the
4598 * ciphertext. */
4599 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4600 {
4601 status = PSA_ERROR_BUFFER_TOO_SMALL;
4602 goto exit;
4603 }
4604 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004605
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004606#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004607 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004608 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004609 status = mbedtls_to_psa_error(
4610 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4611 MBEDTLS_GCM_ENCRYPT,
4612 plaintext_length,
4613 nonce, nonce_length,
4614 additional_data, additional_data_length,
4615 plaintext, ciphertext,
4616 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004617 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004618 else
4619#endif /* MBEDTLS_GCM_C */
4620#if defined(MBEDTLS_CCM_C)
4621 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004622 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004623 status = mbedtls_to_psa_error(
4624 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4625 plaintext_length,
4626 nonce, nonce_length,
4627 additional_data,
4628 additional_data_length,
4629 plaintext, ciphertext,
4630 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004631 }
mohammad16035c8845f2018-05-09 05:40:09 -07004632 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004633#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004634#if defined(MBEDTLS_CHACHAPOLY_C)
4635 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4636 {
4637 if( nonce_length != 12 || operation.tag_length != 16 )
4638 {
4639 status = PSA_ERROR_NOT_SUPPORTED;
4640 goto exit;
4641 }
4642 status = mbedtls_to_psa_error(
4643 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4644 plaintext_length,
4645 nonce,
4646 additional_data,
4647 additional_data_length,
4648 plaintext,
4649 ciphertext,
4650 tag ) );
4651 }
4652 else
4653#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004654 {
mohammad1603554faad2018-06-03 15:07:38 +03004655 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004656 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004657
Gilles Peskineedf9a652018-08-17 18:11:56 +02004658 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4659 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004660
Gilles Peskineedf9a652018-08-17 18:11:56 +02004661exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004662 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004663 if( status == PSA_SUCCESS )
4664 *ciphertext_length = plaintext_length + operation.tag_length;
4665 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004666}
4667
Gilles Peskineee652a32018-06-01 19:23:52 +02004668/* Locate the tag in a ciphertext buffer containing the encrypted data
4669 * followed by the tag. Return the length of the part preceding the tag in
4670 * *plaintext_length. This is the size of the plaintext in modes where
4671 * the encrypted data has the same size as the plaintext, such as
4672 * CCM and GCM. */
4673static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4674 const uint8_t *ciphertext,
4675 size_t ciphertext_length,
4676 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004677 const uint8_t **p_tag )
4678{
4679 size_t payload_length;
4680 if( tag_length > ciphertext_length )
4681 return( PSA_ERROR_INVALID_ARGUMENT );
4682 payload_length = ciphertext_length - tag_length;
4683 if( payload_length > plaintext_size )
4684 return( PSA_ERROR_BUFFER_TOO_SMALL );
4685 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004686 return( PSA_SUCCESS );
4687}
4688
Ronald Croncf56a0a2020-08-04 09:51:30 +02004689psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004690 psa_algorithm_t alg,
4691 const uint8_t *nonce,
4692 size_t nonce_length,
4693 const uint8_t *additional_data,
4694 size_t additional_data_length,
4695 const uint8_t *ciphertext,
4696 size_t ciphertext_length,
4697 uint8_t *plaintext,
4698 size_t plaintext_size,
4699 size_t *plaintext_length )
4700{
mohammad16035955c982018-04-26 00:53:03 +03004701 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004702 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004703 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004704
Gilles Peskineee652a32018-06-01 19:23:52 +02004705 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004706
Ronald Croncf56a0a2020-08-04 09:51:30 +02004707 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004708 if( status != PSA_SUCCESS )
4709 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004710
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004711 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4712 ciphertext, ciphertext_length,
4713 plaintext_size, &tag );
4714 if( status != PSA_SUCCESS )
4715 goto exit;
4716
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004717#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004718 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004719 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004720 status = mbedtls_to_psa_error(
4721 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4722 ciphertext_length - operation.tag_length,
4723 nonce, nonce_length,
4724 additional_data,
4725 additional_data_length,
4726 tag, operation.tag_length,
4727 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004728 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004729 else
4730#endif /* MBEDTLS_GCM_C */
4731#if defined(MBEDTLS_CCM_C)
4732 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004733 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004734 status = mbedtls_to_psa_error(
4735 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4736 ciphertext_length - operation.tag_length,
4737 nonce, nonce_length,
4738 additional_data,
4739 additional_data_length,
4740 ciphertext, plaintext,
4741 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004742 }
mohammad160339574652018-06-01 04:39:53 -07004743 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004744#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004745#if defined(MBEDTLS_CHACHAPOLY_C)
4746 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4747 {
4748 if( nonce_length != 12 || operation.tag_length != 16 )
4749 {
4750 status = PSA_ERROR_NOT_SUPPORTED;
4751 goto exit;
4752 }
4753 status = mbedtls_to_psa_error(
4754 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4755 ciphertext_length - operation.tag_length,
4756 nonce,
4757 additional_data,
4758 additional_data_length,
4759 tag,
4760 ciphertext,
4761 plaintext ) );
4762 }
4763 else
4764#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004765 {
mohammad1603554faad2018-06-03 15:07:38 +03004766 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004767 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004768
Gilles Peskineedf9a652018-08-17 18:11:56 +02004769 if( status != PSA_SUCCESS && plaintext_size != 0 )
4770 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004771
Gilles Peskineedf9a652018-08-17 18:11:56 +02004772exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004773 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004774 if( status == PSA_SUCCESS )
4775 *plaintext_length = ciphertext_length - operation.tag_length;
4776 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004777}
4778
Gilles Peskinea0655c32018-04-30 17:06:50 +02004779
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004780
Gilles Peskine20035e32018-02-03 22:44:14 +01004781/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004782/* Generators */
4783/****************************************************************/
4784
John Durkop07cc04a2020-11-16 22:08:34 -08004785#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4786 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4787 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4788#define AT_LEAST_ONE_BUILTIN_KDF
4789#endif
4790
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004791#define HKDF_STATE_INIT 0 /* no input yet */
4792#define HKDF_STATE_STARTED 1 /* got salt */
4793#define HKDF_STATE_KEYED 2 /* got key */
4794#define HKDF_STATE_OUTPUT 3 /* output started */
4795
Gilles Peskinecbe66502019-05-16 16:59:18 +02004796static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004797 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004798{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004799 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4800 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004801 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004802 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004803}
4804
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004805psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004806{
4807 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004808 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004809 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004810 {
4811 /* The object has (apparently) been initialized but it is not
4812 * in use. It's ok to call abort on such an object, and there's
4813 * nothing to do. */
4814 }
4815 else
John Durkopd0321952020-10-29 21:37:36 -07004816#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004817 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004818 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004819 mbedtls_free( operation->ctx.hkdf.info );
4820 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004821 }
John Durkop07cc04a2020-11-16 22:08:34 -08004822 else
4823#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4824#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4825 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4826 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004827 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004828 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004829 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004830 if( operation->ctx.tls12_prf.seed != NULL )
4831 {
4832 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4833 operation->ctx.tls12_prf.seed_length );
4834 mbedtls_free( operation->ctx.tls12_prf.seed );
4835 }
4836
4837 if( operation->ctx.tls12_prf.label != NULL )
4838 {
4839 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4840 operation->ctx.tls12_prf.label_length );
4841 mbedtls_free( operation->ctx.tls12_prf.label );
4842 }
4843
4844 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4845
4846 /* We leave the fields Ai and output_block to be erased safely by the
4847 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004848 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004849 else
John Durkop07cc04a2020-11-16 22:08:34 -08004850#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4851 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004852 {
4853 status = PSA_ERROR_BAD_STATE;
4854 }
Janos Follath083036a2019-06-11 10:22:26 +01004855 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004856 return( status );
4857}
4858
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004859psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004860 size_t *capacity)
4861{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004862 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004863 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004864 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004865 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004866 }
4867
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004868 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004869 return( PSA_SUCCESS );
4870}
4871
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004872psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004873 size_t capacity )
4874{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004875 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004876 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004877 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004878 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004879 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004880 return( PSA_SUCCESS );
4881}
4882
John Durkopd0321952020-10-29 21:37:36 -07004883#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004884/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004885 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004886static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004887 psa_algorithm_t hash_alg,
4888 uint8_t *output,
4889 size_t output_length )
4890{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004891 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004892 psa_status_t status;
4893
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004894 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4895 return( PSA_ERROR_BAD_STATE );
4896 hkdf->state = HKDF_STATE_OUTPUT;
4897
Gilles Peskinebef7f142018-07-12 17:22:21 +02004898 while( output_length != 0 )
4899 {
4900 /* Copy what remains of the current block */
4901 uint8_t n = hash_length - hkdf->offset_in_block;
4902 if( n > output_length )
4903 n = (uint8_t) output_length;
4904 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4905 output += n;
4906 output_length -= n;
4907 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004908 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004909 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004910 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004911 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004912 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004913 * object was corrupted or if this function is called directly
4914 * inside the library. */
4915 if( hkdf->block_number == 0xff )
4916 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004917
4918 /* We need a new block */
4919 ++hkdf->block_number;
4920 hkdf->offset_in_block = 0;
4921 status = psa_hmac_setup_internal( &hkdf->hmac,
4922 hkdf->prk, hash_length,
4923 hash_alg );
4924 if( status != PSA_SUCCESS )
4925 return( status );
4926 if( hkdf->block_number != 1 )
4927 {
4928 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4929 hkdf->output_block,
4930 hash_length );
4931 if( status != PSA_SUCCESS )
4932 return( status );
4933 }
4934 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4935 hkdf->info,
4936 hkdf->info_length );
4937 if( status != PSA_SUCCESS )
4938 return( status );
4939 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4940 &hkdf->block_number, 1 );
4941 if( status != PSA_SUCCESS )
4942 return( status );
4943 status = psa_hmac_finish_internal( &hkdf->hmac,
4944 hkdf->output_block,
4945 sizeof( hkdf->output_block ) );
4946 if( status != PSA_SUCCESS )
4947 return( status );
4948 }
4949
4950 return( PSA_SUCCESS );
4951}
John Durkop07cc04a2020-11-16 22:08:34 -08004952#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004953
John Durkop07cc04a2020-11-16 22:08:34 -08004954#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4955 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004956static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4957 psa_tls12_prf_key_derivation_t *tls12_prf,
4958 psa_algorithm_t alg )
4959{
4960 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004961 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004962 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4963 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004964
Janos Follath7742fee2019-06-17 12:58:10 +01004965 /* We can't be wanting more output after block 0xff, otherwise
4966 * the capacity check in psa_key_derivation_output_bytes() would have
4967 * prevented this call. It could happen only if the operation
4968 * object was corrupted or if this function is called directly
4969 * inside the library. */
4970 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004971 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004972
4973 /* We need a new block */
4974 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004975 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004976
4977 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4978 *
4979 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4980 *
4981 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4982 * HMAC_hash(secret, A(2) + seed) +
4983 * HMAC_hash(secret, A(3) + seed) + ...
4984 *
4985 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004986 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004987 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004988 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004989 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004990 * is currently extracted as `output_block` and where i is
4991 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004992 */
4993
Janos Follathea29bfb2019-06-19 12:21:20 +01004994 /* Save the hash context before using it, to preserve the hash state with
4995 * only the inner padding in it. We need this, because inner padding depends
4996 * on the key (secret in the RFC's terminology). */
4997 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4998 if( status != PSA_SUCCESS )
4999 goto cleanup;
5000
5001 /* Calculate A(i) where i = tls12_prf->block_number. */
5002 if( tls12_prf->block_number == 1 )
5003 {
5004 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5005 * the variable seed and in this instance means it in the context of the
5006 * P_hash function, where seed = label + seed.) */
5007 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5008 tls12_prf->label, tls12_prf->label_length );
5009 if( status != PSA_SUCCESS )
5010 goto cleanup;
5011 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5012 tls12_prf->seed, tls12_prf->seed_length );
5013 if( status != PSA_SUCCESS )
5014 goto cleanup;
5015 }
5016 else
5017 {
5018 /* A(i) = HMAC_hash(secret, A(i-1)) */
5019 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5020 tls12_prf->Ai, hash_length );
5021 if( status != PSA_SUCCESS )
5022 goto cleanup;
5023 }
5024
5025 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5026 tls12_prf->Ai, hash_length );
5027 if( status != PSA_SUCCESS )
5028 goto cleanup;
5029 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5030 if( status != PSA_SUCCESS )
5031 goto cleanup;
5032
5033 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5034 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5035 tls12_prf->Ai, hash_length );
5036 if( status != PSA_SUCCESS )
5037 goto cleanup;
5038 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5039 tls12_prf->label, tls12_prf->label_length );
5040 if( status != PSA_SUCCESS )
5041 goto cleanup;
5042 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5043 tls12_prf->seed, tls12_prf->seed_length );
5044 if( status != PSA_SUCCESS )
5045 goto cleanup;
5046 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5047 tls12_prf->output_block, hash_length );
5048 if( status != PSA_SUCCESS )
5049 goto cleanup;
5050 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5051 if( status != PSA_SUCCESS )
5052 goto cleanup;
5053
Janos Follath7742fee2019-06-17 12:58:10 +01005054
5055cleanup:
5056
Janos Follathea29bfb2019-06-19 12:21:20 +01005057 cleanup_status = psa_hash_abort( &backup );
5058 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5059 status = cleanup_status;
5060
5061 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005062}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005063
Janos Follath844eb0e2019-06-19 12:10:49 +01005064static psa_status_t psa_key_derivation_tls12_prf_read(
5065 psa_tls12_prf_key_derivation_t *tls12_prf,
5066 psa_algorithm_t alg,
5067 uint8_t *output,
5068 size_t output_length )
5069{
5070 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005071 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005072 psa_status_t status;
5073 uint8_t offset, length;
5074
5075 while( output_length != 0 )
5076 {
5077 /* Check if we have fully processed the current block. */
5078 if( tls12_prf->left_in_block == 0 )
5079 {
5080 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5081 alg );
5082 if( status != PSA_SUCCESS )
5083 return( status );
5084
5085 continue;
5086 }
5087
5088 if( tls12_prf->left_in_block > output_length )
5089 length = (uint8_t) output_length;
5090 else
5091 length = tls12_prf->left_in_block;
5092
5093 offset = hash_length - tls12_prf->left_in_block;
5094 memcpy( output, tls12_prf->output_block + offset, length );
5095 output += length;
5096 output_length -= length;
5097 tls12_prf->left_in_block -= length;
5098 }
5099
5100 return( PSA_SUCCESS );
5101}
John Durkop07cc04a2020-11-16 22:08:34 -08005102#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5103 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005104
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005105psa_status_t psa_key_derivation_output_bytes(
5106 psa_key_derivation_operation_t *operation,
5107 uint8_t *output,
5108 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005109{
5110 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005111 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005112
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005113 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005114 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005115 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005116 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005117 }
5118
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005119 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005120 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005121 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005122 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005123 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005124 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005125 goto exit;
5126 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005127 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005128 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005129 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005130 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005131 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5132 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005133 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005134 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005135 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005136 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005137 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005138
John Durkopd0321952020-10-29 21:37:36 -07005139#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005140 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005141 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005142 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005143 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005144 output, output_length );
5145 }
Janos Follathadbec812019-06-14 11:05:39 +01005146 else
John Durkop07cc04a2020-11-16 22:08:34 -08005147#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5148#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5149 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005150 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005151 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005152 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005153 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005154 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005155 output_length );
5156 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005157 else
John Durkop07cc04a2020-11-16 22:08:34 -08005158#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5159 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005160 {
5161 return( PSA_ERROR_BAD_STATE );
5162 }
5163
5164exit:
5165 if( status != PSA_SUCCESS )
5166 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005167 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005168 * This allows us to differentiate between exhausted operations and
5169 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5170 * operations. */
5171 psa_algorithm_t alg = operation->alg;
5172 psa_key_derivation_abort( operation );
5173 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005174 memset( output, '!', output_length );
5175 }
5176 return( status );
5177}
5178
Gilles Peskine08542d82018-07-19 17:05:42 +02005179#if defined(MBEDTLS_DES_C)
5180static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5181{
5182 if( data_size >= 8 )
5183 mbedtls_des_key_set_parity( data );
5184 if( data_size >= 16 )
5185 mbedtls_des_key_set_parity( data + 8 );
5186 if( data_size >= 24 )
5187 mbedtls_des_key_set_parity( data + 16 );
5188}
5189#endif /* MBEDTLS_DES_C */
5190
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005191static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005192 psa_key_slot_t *slot,
5193 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005194 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005195{
5196 uint8_t *data = NULL;
5197 size_t bytes = PSA_BITS_TO_BYTES( bits );
5198 psa_status_t status;
5199
Gilles Peskine8e338702019-07-30 20:06:31 +02005200 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005201 return( PSA_ERROR_INVALID_ARGUMENT );
5202 if( bits % 8 != 0 )
5203 return( PSA_ERROR_INVALID_ARGUMENT );
5204 data = mbedtls_calloc( 1, bytes );
5205 if( data == NULL )
5206 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5207
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005208 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005209 if( status != PSA_SUCCESS )
5210 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005211#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005212 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005213 psa_des_set_key_parity( data, bytes );
5214#endif /* MBEDTLS_DES_C */
Ronald Crondd04d422020-11-28 15:14:42 +01005215
5216 status = psa_allocate_buffer_to_slot( slot, bytes );
5217 if( status != PSA_SUCCESS )
5218 return( status );
5219
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005220 psa_key_attributes_t attributes = {
5221 .core = slot->attr
5222 };
5223
5224 status = psa_import_key_into_slot( &attributes,
5225 data, bytes,
Ronald Crondd04d422020-11-28 15:14:42 +01005226 slot->key.data, slot->key.bytes,
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005227 &slot->key.bytes,
5228 &bits );
5229 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005230
5231exit:
5232 mbedtls_free( data );
5233 return( status );
5234}
5235
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005236psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005237 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005238 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005239{
5240 psa_status_t status;
5241 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005242 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005243
Ronald Cron81709fc2020-11-14 12:10:32 +01005244 *key = MBEDTLS_SVC_KEY_ID_INIT;
5245
Gilles Peskine0f84d622019-09-12 19:03:13 +02005246 /* Reject any attempt to create a zero-length key so that we don't
5247 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5248 if( psa_get_key_bits( attributes ) == 0 )
5249 return( PSA_ERROR_INVALID_ARGUMENT );
5250
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005251 if( ! operation->can_output_key )
5252 return( PSA_ERROR_NOT_PERMITTED );
5253
Ronald Cron81709fc2020-11-14 12:10:32 +01005254 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5255 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005256#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5257 if( driver != NULL )
5258 {
5259 /* Deriving a key in a secure element is not implemented yet. */
5260 status = PSA_ERROR_NOT_SUPPORTED;
5261 }
5262#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005263 if( status == PSA_SUCCESS )
5264 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005265 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005266 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005267 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005268 }
5269 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005270 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005271 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005272 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005273
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005274 return( status );
5275}
5276
Gilles Peskineeab56e42018-07-12 17:12:33 +02005277
5278
5279/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005280/* Key derivation */
5281/****************************************************************/
5282
John Durkop07cc04a2020-11-16 22:08:34 -08005283#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005284static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005285 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005286 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005287{
John Durkop07cc04a2020-11-16 22:08:34 -08005288 int is_kdf_alg_supported;
5289
Janos Follath5fe19732019-06-20 15:09:30 +01005290 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5291 * initialisers for this union leave some bytes unspecified.) */
5292 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5293
Gilles Peskine969c5d62019-01-16 15:53:06 +01005294 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005295#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005296 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5297 is_kdf_alg_supported = 1;
5298 else
5299#endif
5300#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5301 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5302 is_kdf_alg_supported = 1;
5303 else
5304#endif
5305#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5306 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5307 is_kdf_alg_supported = 1;
5308 else
5309#endif
5310 is_kdf_alg_supported = 0;
5311
5312 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005313 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005314 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005315 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005316 if( hash_size == 0 )
5317 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005318 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5319 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005320 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005321 {
5322 return( PSA_ERROR_NOT_SUPPORTED );
5323 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005324 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005325 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005326 }
John Durkop07cc04a2020-11-16 22:08:34 -08005327
5328 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005329}
John Durkop07cc04a2020-11-16 22:08:34 -08005330#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005331
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005332psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005333 psa_algorithm_t alg )
5334{
5335 psa_status_t status;
5336
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005337 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005338 return( PSA_ERROR_BAD_STATE );
5339
Gilles Peskine6843c292019-01-18 16:44:49 +01005340 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5341 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005342#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005343 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005344 {
5345 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005346 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005347 }
5348 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5349 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005350 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005351 }
John Durkop07cc04a2020-11-16 22:08:34 -08005352#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005353 else
5354 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005355
5356 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005357 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005358 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005359}
5360
John Durkopd0321952020-10-29 21:37:36 -07005361#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005362static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005363 psa_algorithm_t hash_alg,
5364 psa_key_derivation_step_t step,
5365 const uint8_t *data,
5366 size_t data_length )
5367{
5368 psa_status_t status;
5369 switch( step )
5370 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005371 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005372 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005373 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005374 status = psa_hmac_setup_internal( &hkdf->hmac,
5375 data, data_length,
5376 hash_alg );
5377 if( status != PSA_SUCCESS )
5378 return( status );
5379 hkdf->state = HKDF_STATE_STARTED;
5380 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005381 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005382 /* If no salt was provided, use an empty salt. */
5383 if( hkdf->state == HKDF_STATE_INIT )
5384 {
5385 status = psa_hmac_setup_internal( &hkdf->hmac,
5386 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005387 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005388 if( status != PSA_SUCCESS )
5389 return( status );
5390 hkdf->state = HKDF_STATE_STARTED;
5391 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005392 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005393 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005394 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5395 data, data_length );
5396 if( status != PSA_SUCCESS )
5397 return( status );
5398 status = psa_hmac_finish_internal( &hkdf->hmac,
5399 hkdf->prk,
5400 sizeof( hkdf->prk ) );
5401 if( status != PSA_SUCCESS )
5402 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005403 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005404 hkdf->block_number = 0;
5405 hkdf->state = HKDF_STATE_KEYED;
5406 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005407 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005408 if( hkdf->state == HKDF_STATE_OUTPUT )
5409 return( PSA_ERROR_BAD_STATE );
5410 if( hkdf->info_set )
5411 return( PSA_ERROR_BAD_STATE );
5412 hkdf->info_length = data_length;
5413 if( data_length != 0 )
5414 {
5415 hkdf->info = mbedtls_calloc( 1, data_length );
5416 if( hkdf->info == NULL )
5417 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5418 memcpy( hkdf->info, data, data_length );
5419 }
5420 hkdf->info_set = 1;
5421 return( PSA_SUCCESS );
5422 default:
5423 return( PSA_ERROR_INVALID_ARGUMENT );
5424 }
5425}
John Durkop07cc04a2020-11-16 22:08:34 -08005426#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005427
John Durkop07cc04a2020-11-16 22:08:34 -08005428#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5429 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005430static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5431 const uint8_t *data,
5432 size_t data_length )
5433{
5434 if( prf->state != TLS12_PRF_STATE_INIT )
5435 return( PSA_ERROR_BAD_STATE );
5436
Janos Follathd6dce9f2019-07-04 09:11:38 +01005437 if( data_length != 0 )
5438 {
5439 prf->seed = mbedtls_calloc( 1, data_length );
5440 if( prf->seed == NULL )
5441 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005442
Janos Follathd6dce9f2019-07-04 09:11:38 +01005443 memcpy( prf->seed, data, data_length );
5444 prf->seed_length = data_length;
5445 }
Janos Follathf08e2652019-06-13 09:05:41 +01005446
5447 prf->state = TLS12_PRF_STATE_SEED_SET;
5448
5449 return( PSA_SUCCESS );
5450}
5451
Janos Follath81550542019-06-13 14:26:34 +01005452static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5453 psa_algorithm_t hash_alg,
5454 const uint8_t *data,
5455 size_t data_length )
5456{
5457 psa_status_t status;
5458 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5459 return( PSA_ERROR_BAD_STATE );
5460
5461 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5462 if( status != PSA_SUCCESS )
5463 return( status );
5464
5465 prf->state = TLS12_PRF_STATE_KEY_SET;
5466
5467 return( PSA_SUCCESS );
5468}
5469
Janos Follath63028dd2019-06-13 09:15:47 +01005470static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5471 const uint8_t *data,
5472 size_t data_length )
5473{
5474 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5475 return( PSA_ERROR_BAD_STATE );
5476
Janos Follathd6dce9f2019-07-04 09:11:38 +01005477 if( data_length != 0 )
5478 {
5479 prf->label = mbedtls_calloc( 1, data_length );
5480 if( prf->label == NULL )
5481 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005482
Janos Follathd6dce9f2019-07-04 09:11:38 +01005483 memcpy( prf->label, data, data_length );
5484 prf->label_length = data_length;
5485 }
Janos Follath63028dd2019-06-13 09:15:47 +01005486
5487 prf->state = TLS12_PRF_STATE_LABEL_SET;
5488
5489 return( PSA_SUCCESS );
5490}
5491
Janos Follathb03233e2019-06-11 15:30:30 +01005492static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5493 psa_algorithm_t hash_alg,
5494 psa_key_derivation_step_t step,
5495 const uint8_t *data,
5496 size_t data_length )
5497{
Janos Follathb03233e2019-06-11 15:30:30 +01005498 switch( step )
5499 {
Janos Follathf08e2652019-06-13 09:05:41 +01005500 case PSA_KEY_DERIVATION_INPUT_SEED:
5501 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005502 case PSA_KEY_DERIVATION_INPUT_SECRET:
5503 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005504 case PSA_KEY_DERIVATION_INPUT_LABEL:
5505 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005506 default:
5507 return( PSA_ERROR_INVALID_ARGUMENT );
5508 }
5509}
John Durkop07cc04a2020-11-16 22:08:34 -08005510#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5511 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5512
5513#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5514static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5515 psa_tls12_prf_key_derivation_t *prf,
5516 psa_algorithm_t hash_alg,
5517 const uint8_t *data,
5518 size_t data_length )
5519{
5520 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005521 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005522 uint8_t *cur = pms;
5523
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005524 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005525 return( PSA_ERROR_INVALID_ARGUMENT );
5526
5527 /* Quoting RFC 4279, Section 2:
5528 *
5529 * The premaster secret is formed as follows: if the PSK is N octets
5530 * long, concatenate a uint16 with the value N, N zero octets, a second
5531 * uint16 with the value N, and the PSK itself.
5532 */
5533
5534 *cur++ = ( data_length >> 8 ) & 0xff;
5535 *cur++ = ( data_length >> 0 ) & 0xff;
5536 memset( cur, 0, data_length );
5537 cur += data_length;
5538 *cur++ = pms[0];
5539 *cur++ = pms[1];
5540 memcpy( cur, data, data_length );
5541 cur += data_length;
5542
5543 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5544
5545 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5546 return( status );
5547}
Janos Follath6660f0e2019-06-17 08:44:03 +01005548
5549static psa_status_t psa_tls12_prf_psk_to_ms_input(
5550 psa_tls12_prf_key_derivation_t *prf,
5551 psa_algorithm_t hash_alg,
5552 psa_key_derivation_step_t step,
5553 const uint8_t *data,
5554 size_t data_length )
5555{
5556 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005557 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005558 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5559 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005560 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005561
5562 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5563}
John Durkop07cc04a2020-11-16 22:08:34 -08005564#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005565
Gilles Peskineb8965192019-09-24 16:21:10 +02005566/** Check whether the given key type is acceptable for the given
5567 * input step of a key derivation.
5568 *
5569 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5570 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5571 * Both secret and non-secret inputs can alternatively have the type
5572 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5573 * that the input was passed as a buffer rather than via a key object.
5574 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005575static int psa_key_derivation_check_input_type(
5576 psa_key_derivation_step_t step,
5577 psa_key_type_t key_type )
5578{
5579 switch( step )
5580 {
5581 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005582 if( key_type == PSA_KEY_TYPE_DERIVE )
5583 return( PSA_SUCCESS );
5584 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005585 return( PSA_SUCCESS );
5586 break;
5587 case PSA_KEY_DERIVATION_INPUT_LABEL:
5588 case PSA_KEY_DERIVATION_INPUT_SALT:
5589 case PSA_KEY_DERIVATION_INPUT_INFO:
5590 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005591 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5592 return( PSA_SUCCESS );
5593 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005594 return( PSA_SUCCESS );
5595 break;
5596 }
5597 return( PSA_ERROR_INVALID_ARGUMENT );
5598}
5599
Janos Follathb80a94e2019-06-12 15:54:46 +01005600static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005601 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005602 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005603 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005604 const uint8_t *data,
5605 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005606{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005607 psa_status_t status;
5608 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5609
5610 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005611 if( status != PSA_SUCCESS )
5612 goto exit;
5613
John Durkopd0321952020-10-29 21:37:36 -07005614#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005615 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005616 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005617 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005618 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005619 step, data, data_length );
5620 }
John Durkop07cc04a2020-11-16 22:08:34 -08005621 else
5622#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5623#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5624 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005625 {
Janos Follathb03233e2019-06-11 15:30:30 +01005626 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5627 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5628 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005629 }
John Durkop07cc04a2020-11-16 22:08:34 -08005630 else
5631#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5632#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5633 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005634 {
5635 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5636 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5637 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005638 }
5639 else
John Durkop07cc04a2020-11-16 22:08:34 -08005640#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005641 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005642 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005643 return( PSA_ERROR_BAD_STATE );
5644 }
5645
Gilles Peskine224b0d62019-09-23 18:13:17 +02005646exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005647 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005648 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005649 return( status );
5650}
5651
Janos Follath51f4a0f2019-06-14 11:35:55 +01005652psa_status_t psa_key_derivation_input_bytes(
5653 psa_key_derivation_operation_t *operation,
5654 psa_key_derivation_step_t step,
5655 const uint8_t *data,
5656 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005657{
Gilles Peskineb8965192019-09-24 16:21:10 +02005658 return( psa_key_derivation_input_internal( operation, step,
5659 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005660 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005661}
5662
Janos Follath51f4a0f2019-06-14 11:35:55 +01005663psa_status_t psa_key_derivation_input_key(
5664 psa_key_derivation_operation_t *operation,
5665 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005666 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005667{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005669 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005670 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005671
Ronald Cron5c522922020-11-14 16:35:34 +01005672 status = psa_get_and_lock_transparent_key_slot_with_policy(
5673 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005674 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005675 {
5676 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005677 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005678 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005679
5680 /* Passing a key object as a SECRET input unlocks the permission
5681 * to output to a key object. */
5682 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5683 operation->can_output_key = 1;
5684
Ronald Cronf95a2b12020-10-22 15:24:49 +02005685 status = psa_key_derivation_input_internal( operation,
5686 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005687 slot->key.data,
5688 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005689
Ronald Cron5c522922020-11-14 16:35:34 +01005690 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005691
Ronald Cron5c522922020-11-14 16:35:34 +01005692 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005693}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005694
5695
5696
5697/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005698/* Key agreement */
5699/****************************************************************/
5700
John Durkop6ba40d12020-11-10 08:50:04 -08005701#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005702static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5703 size_t peer_key_length,
5704 const mbedtls_ecp_keypair *our_key,
5705 uint8_t *shared_secret,
5706 size_t shared_secret_size,
5707 size_t *shared_secret_length )
5708{
Steven Cooremand4867872020-08-05 16:31:39 +02005709 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005710 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005711 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005712 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005713 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005714 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005715
Ronald Cron90857082020-11-25 14:58:33 +01005716 status = mbedtls_psa_ecp_load_representation(
5717 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5718 peer_key,
5719 peer_key_length,
5720 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005721 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005722 goto exit;
5723
Jaeden Amero97271b32019-01-10 19:38:51 +00005724 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005725 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005726 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005727 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005728 status = mbedtls_to_psa_error(
5729 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5730 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005731 goto exit;
5732
Jaeden Amero97271b32019-01-10 19:38:51 +00005733 status = mbedtls_to_psa_error(
5734 mbedtls_ecdh_calc_secret( &ecdh,
5735 shared_secret_length,
5736 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005737 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005738 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005739 if( status != PSA_SUCCESS )
5740 goto exit;
5741 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5742 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005743
5744exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005745 if( status != PSA_SUCCESS )
5746 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005747 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005748 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005749 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005750
Jaeden Amero97271b32019-01-10 19:38:51 +00005751 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005752}
John Durkop6ba40d12020-11-10 08:50:04 -08005753#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005754
Gilles Peskine01d718c2018-09-18 12:01:02 +02005755#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5756
Gilles Peskine0216fe12019-04-11 21:23:21 +02005757static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5758 psa_key_slot_t *private_key,
5759 const uint8_t *peer_key,
5760 size_t peer_key_length,
5761 uint8_t *shared_secret,
5762 size_t shared_secret_size,
5763 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005764{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005765 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005766 {
John Durkop6ba40d12020-11-10 08:50:04 -08005767#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005768 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005769 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005770 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005771 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005772 psa_status_t status = mbedtls_psa_ecp_load_representation(
5773 private_key->attr.type,
5774 private_key->key.data,
5775 private_key->key.bytes,
5776 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005777 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005778 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005779 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005780 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005781 shared_secret, shared_secret_size,
5782 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005783 mbedtls_ecp_keypair_free( ecp );
5784 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005785 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005786#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005787 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005788 (void) private_key;
5789 (void) peer_key;
5790 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005791 (void) shared_secret;
5792 (void) shared_secret_size;
5793 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005794 return( PSA_ERROR_NOT_SUPPORTED );
5795 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005796}
5797
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005798/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005799 * to potentially free embedded data structures and wipe confidential data.
5800 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005801static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005802 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005803 psa_key_slot_t *private_key,
5804 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005805 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005806{
5807 psa_status_t status;
5808 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5809 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005810 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005811
5812 /* Step 1: run the secret agreement algorithm to generate the shared
5813 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005814 status = psa_key_agreement_raw_internal( ka_alg,
5815 private_key,
5816 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005817 shared_secret,
5818 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005819 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005820 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005821 goto exit;
5822
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005823 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005824 * the shared secret. A shared secret is permitted wherever a key
5825 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005826 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005827 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005828 shared_secret,
5829 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005830exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005831 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005832 return( status );
5833}
5834
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005835psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005836 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005837 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005838 const uint8_t *peer_key,
5839 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005840{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005841 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005842 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005843 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005844
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005845 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005846 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005847 status = psa_get_and_lock_transparent_key_slot_with_policy(
5848 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005849 if( status != PSA_SUCCESS )
5850 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005851 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005852 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005853 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005854 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005855 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005856 else
5857 {
5858 /* If a private key has been added as SECRET, we allow the derived
5859 * key material to be used as a key in PSA Crypto. */
5860 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5861 operation->can_output_key = 1;
5862 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005863
Ronald Cron5c522922020-11-14 16:35:34 +01005864 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005865
Ronald Cron5c522922020-11-14 16:35:34 +01005866 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005867}
5868
Gilles Peskinebe697d82019-05-16 18:00:41 +02005869psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005870 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005871 const uint8_t *peer_key,
5872 size_t peer_key_length,
5873 uint8_t *output,
5874 size_t output_size,
5875 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005876{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005878 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005879 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005880
5881 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5882 {
5883 status = PSA_ERROR_INVALID_ARGUMENT;
5884 goto exit;
5885 }
Ronald Cron5c522922020-11-14 16:35:34 +01005886 status = psa_get_and_lock_transparent_key_slot_with_policy(
5887 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005888 if( status != PSA_SUCCESS )
5889 goto exit;
5890
5891 status = psa_key_agreement_raw_internal( alg, slot,
5892 peer_key, peer_key_length,
5893 output, output_size,
5894 output_length );
5895
5896exit:
5897 if( status != PSA_SUCCESS )
5898 {
5899 /* If an error happens and is not handled properly, the output
5900 * may be used as a key to protect sensitive data. Arrange for such
5901 * a key to be random, which is likely to result in decryption or
5902 * verification errors. This is better than filling the buffer with
5903 * some constant data such as zeros, which would result in the data
5904 * being protected with a reproducible, easily knowable key.
5905 */
5906 psa_generate_random( output, output_size );
5907 *output_length = output_size;
5908 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005909
Ronald Cron5c522922020-11-14 16:35:34 +01005910 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005911
Ronald Cron5c522922020-11-14 16:35:34 +01005912 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005913}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005914
5915
Gilles Peskine30524eb2020-11-13 17:02:26 +01005916
Gilles Peskine86a440b2018-11-12 18:39:40 +01005917/****************************************************************/
5918/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005919/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005920
Gilles Peskine30524eb2020-11-13 17:02:26 +01005921/** Initialize the PSA random generator.
5922 */
5923static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5924{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005925#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5926 memset( rng, 0, sizeof( *rng ) );
5927#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5928
Gilles Peskine30524eb2020-11-13 17:02:26 +01005929 /* Set default configuration if
5930 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5931 if( rng->entropy_init == NULL )
5932 rng->entropy_init = mbedtls_entropy_init;
5933 if( rng->entropy_free == NULL )
5934 rng->entropy_free = mbedtls_entropy_free;
5935
5936 rng->entropy_init( &rng->entropy );
5937#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5938 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5939 /* The PSA entropy injection feature depends on using NV seed as an entropy
5940 * source. Add NV seed as an entropy source for PSA entropy injection. */
5941 mbedtls_entropy_add_source( &rng->entropy,
5942 mbedtls_nv_seed_poll, NULL,
5943 MBEDTLS_ENTROPY_BLOCK_SIZE,
5944 MBEDTLS_ENTROPY_SOURCE_STRONG );
5945#endif
5946
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005947 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005948#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005949}
5950
5951/** Deinitialize the PSA random generator.
5952 */
5953static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5954{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005955#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5956 memset( rng, 0, sizeof( *rng ) );
5957#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005958 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005959 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005960#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005961}
5962
5963/** Seed the PSA random generator.
5964 */
5965static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5966{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005967#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5968 /* Do nothing: the external RNG seeds itself. */
5969 (void) rng;
5970 return( PSA_SUCCESS );
5971#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005972 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005973 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5974 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005975 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005976#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005977}
5978
Gilles Peskinee59236f2018-01-27 23:32:46 +01005979psa_status_t psa_generate_random( uint8_t *output,
5980 size_t output_size )
5981{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005982 GUARD_MODULE_INITIALIZED;
5983
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005984#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5985
5986 size_t output_length = 0;
5987 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5988 output, output_size,
5989 &output_length );
5990 if( status != PSA_SUCCESS )
5991 return( status );
5992 /* Breaking up a request into smaller chunks is currently not supported
5993 * for the extrernal RNG interface. */
5994 if( output_length != output_size )
5995 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5996 return( PSA_SUCCESS );
5997
5998#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5999
Gilles Peskine71ddab92021-01-04 21:01:07 +01006000 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006001 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006002 size_t request_size =
6003 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6004 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6005 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006006 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6007 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006008 if( ret != 0 )
6009 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006010 output_size -= request_size;
6011 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006012 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006013 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006014#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006015}
6016
Gilles Peskine8814fc42020-12-14 15:33:44 +01006017/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006018 *
6019 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6020 * `psa_generate_random(...)`. The state parameter is ignored since the
6021 * PSA API doesn't support passing an explicit state.
6022 *
6023 * In the non-external case, psa_generate_random() calls an
6024 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6025 * and semantics as mbedtls_psa_get_random(). As an optimization,
6026 * instead of doing this back-and-forth between the PSA API and the
6027 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6028 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006029 */
6030#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6031int mbedtls_psa_get_random( void *p_rng,
6032 unsigned char *output,
6033 size_t output_size )
6034{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006035 /* This function takes a pointer to the RNG state because that's what
6036 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6037 * its own state internally and doesn't let the caller access that state.
6038 * So we just ignore the state parameter, and in practice we'll pass
6039 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006040 (void) p_rng;
6041 psa_status_t status = psa_generate_random( output, output_size );
6042 if( status == PSA_SUCCESS )
6043 return( 0 );
6044 else
6045 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6046}
6047#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6048
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006049#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6050#include "mbedtls/entropy_poll.h"
6051
Gilles Peskine7228da22019-07-15 11:06:15 +02006052psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006053 size_t seed_size )
6054{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006055 if( global_data.initialized )
6056 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006057
6058 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6059 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6060 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6061 return( PSA_ERROR_INVALID_ARGUMENT );
6062
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006063 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006064}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006065#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006066
John Durkop07cc04a2020-11-16 22:08:34 -08006067#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006068static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6069 size_t domain_parameters_size,
6070 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006071{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006072 size_t i;
6073 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006074
Gilles Peskinee56e8782019-04-26 17:34:02 +02006075 if( domain_parameters_size == 0 )
6076 {
6077 *exponent = 65537;
6078 return( PSA_SUCCESS );
6079 }
6080
6081 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6082 * support values that fit in a 32-bit integer, which is larger than
6083 * int on just about every platform anyway. */
6084 if( domain_parameters_size > sizeof( acc ) )
6085 return( PSA_ERROR_NOT_SUPPORTED );
6086 for( i = 0; i < domain_parameters_size; i++ )
6087 acc = ( acc << 8 ) | domain_parameters[i];
6088 if( acc > INT_MAX )
6089 return( PSA_ERROR_NOT_SUPPORTED );
6090 *exponent = acc;
6091 return( PSA_SUCCESS );
6092}
John Durkop07cc04a2020-11-16 22:08:34 -08006093#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006094
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006095static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006096 psa_key_slot_t *slot, size_t bits,
6097 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006098{
Gilles Peskine8e338702019-07-30 20:06:31 +02006099 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006100
Gilles Peskinee56e8782019-04-26 17:34:02 +02006101 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006102 return( PSA_ERROR_INVALID_ARGUMENT );
6103
Gilles Peskinee59236f2018-01-27 23:32:46 +01006104 if( key_type_is_raw_bytes( type ) )
6105 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006106 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006107
6108 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006109 if( status != PSA_SUCCESS )
6110 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006111
6112 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006113 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6114 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006115 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006116
Ronald Cronea0f8a62020-11-25 17:52:23 +01006117 status = psa_generate_random( slot->key.data,
6118 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006119 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006120 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006121
6122 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006123#if defined(MBEDTLS_DES_C)
6124 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006125 psa_des_set_key_parity( slot->key.data,
6126 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006127#endif /* MBEDTLS_DES_C */
6128 }
6129 else
6130
John Durkop07cc04a2020-11-16 22:08:34 -08006131#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006132 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006133 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006134 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006136 int exponent;
6137 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006138 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6139 return( PSA_ERROR_NOT_SUPPORTED );
6140 /* Accept only byte-aligned keys, for the same reasons as
Ronald Cronb6420e32020-11-22 16:15:38 +01006141 * in mbedtls_psa_rsa_import_key(). */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006142 if( bits % 8 != 0 )
6143 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006144 status = psa_read_rsa_exponent( domain_parameters,
6145 domain_parameters_size,
6146 &exponent );
6147 if( status != PSA_SUCCESS )
6148 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006149 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6150 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006151 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006152 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006153 (unsigned int) bits,
6154 exponent );
6155 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006156 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006157
6158 /* Make sure to always have an export representation available */
6159 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6160
Steven Cooreman75b74362020-07-28 14:30:13 +02006161 status = psa_allocate_buffer_to_slot( slot, bytes );
6162 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006163 {
6164 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006165 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006166 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006167
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006168 status = mbedtls_psa_rsa_export_key( type,
6169 &rsa,
6170 slot->key.data,
6171 bytes,
6172 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006173 mbedtls_rsa_free( &rsa );
6174 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006175 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006176 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006177 }
6178 else
John Durkop07cc04a2020-11-16 22:08:34 -08006179#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006180
John Durkop9814fa22020-11-04 12:28:15 -08006181#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006182 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006183 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006184 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006185 mbedtls_ecp_group_id grp_id =
6186 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006187 const mbedtls_ecp_curve_info *curve_info =
6188 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006189 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006190 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006191 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006192 return( PSA_ERROR_NOT_SUPPORTED );
6193 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6194 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006195 mbedtls_ecp_keypair_init( &ecp );
6196 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006197 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006198 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006199 if( ret != 0 )
6200 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006201 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006202 return( mbedtls_to_psa_error( ret ) );
6203 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006204
6205
6206 /* Make sure to always have an export representation available */
6207 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006208 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6209 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006210 {
6211 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006212 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006213 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006214
6215 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006216 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006217
6218 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006219 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006220 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006221 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006222 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006223 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006224 }
6225 else
John Durkop9814fa22020-11-04 12:28:15 -08006226#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006227 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006228 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006229 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006230
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006231 return( PSA_SUCCESS );
6232}
Darryl Green0c6575a2018-11-07 16:05:30 +00006233
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006234psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006235 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006236{
6237 psa_status_t status;
6238 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006239 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006240
Ronald Cron81709fc2020-11-14 12:10:32 +01006241 *key = MBEDTLS_SVC_KEY_ID_INIT;
6242
Gilles Peskine0f84d622019-09-12 19:03:13 +02006243 /* Reject any attempt to create a zero-length key so that we don't
6244 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6245 if( psa_get_key_bits( attributes ) == 0 )
6246 return( PSA_ERROR_INVALID_ARGUMENT );
6247
Ronald Cron81709fc2020-11-14 12:10:32 +01006248 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6249 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006250 if( status != PSA_SUCCESS )
6251 goto exit;
6252
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006253 status = psa_driver_wrapper_generate_key( attributes,
6254 slot );
6255 if( status != PSA_ERROR_NOT_SUPPORTED ||
6256 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6257 goto exit;
6258
6259 status = psa_generate_key_internal(
6260 slot, attributes->core.bits,
6261 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006262
6263exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006264 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006265 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006266 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006267 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006268
Darryl Green0c6575a2018-11-07 16:05:30 +00006269 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006270}
6271
6272
Gilles Peskinee59236f2018-01-27 23:32:46 +01006273
6274/****************************************************************/
6275/* Module setup */
6276/****************************************************************/
6277
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006278#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006279psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6280 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6281 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6282{
6283 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6284 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006285 global_data.rng.entropy_init = entropy_init;
6286 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006287 return( PSA_SUCCESS );
6288}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006289#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006290
Gilles Peskinee59236f2018-01-27 23:32:46 +01006291void mbedtls_psa_crypto_free( void )
6292{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006293 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006294 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6295 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006296 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006297 }
6298 /* Wipe all remaining data, including configuration.
6299 * In particular, this sets all state indicator to the value
6300 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006301 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006302#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006303 /* Unregister all secure element drivers, so that we restart from
6304 * a pristine state. */
6305 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006306#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006307}
6308
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006309#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6310/** Recover a transaction that was interrupted by a power failure.
6311 *
6312 * This function is called during initialization, before psa_crypto_init()
6313 * returns. If this function returns a failure status, the initialization
6314 * fails.
6315 */
6316static psa_status_t psa_crypto_recover_transaction(
6317 const psa_crypto_transaction_t *transaction )
6318{
6319 switch( transaction->unknown.type )
6320 {
6321 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6322 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006323 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006324 * is implemented.
6325 * https://github.com/ARMmbed/mbed-crypto/issues/218
6326 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006327 default:
6328 /* We found an unsupported transaction in the storage.
6329 * We don't know what state the storage is in. Give up. */
6330 return( PSA_ERROR_STORAGE_FAILURE );
6331 }
6332}
6333#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6334
Gilles Peskinee59236f2018-01-27 23:32:46 +01006335psa_status_t psa_crypto_init( void )
6336{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006337 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006338
Gilles Peskinec6b69072018-11-20 21:42:52 +01006339 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006340 if( global_data.initialized != 0 )
6341 return( PSA_SUCCESS );
6342
Gilles Peskine30524eb2020-11-13 17:02:26 +01006343 /* Initialize and seed the random generator. */
6344 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006345 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006346 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006347 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006348 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006349 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006350
Gilles Peskine66fb1262018-12-10 16:29:04 +01006351 status = psa_initialize_key_slots( );
6352 if( status != PSA_SUCCESS )
6353 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006354
Gilles Peskined9348f22019-10-01 15:22:29 +02006355#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6356 status = psa_init_all_se_drivers( );
6357 if( status != PSA_SUCCESS )
6358 goto exit;
6359#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6360
Gilles Peskine4b734222019-07-24 15:56:31 +02006361#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006362 status = psa_crypto_load_transaction( );
6363 if( status == PSA_SUCCESS )
6364 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006365 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6366 if( status != PSA_SUCCESS )
6367 goto exit;
6368 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006369 }
6370 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6371 {
6372 /* There's no transaction to complete. It's all good. */
6373 status = PSA_SUCCESS;
6374 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006375#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006376
Gilles Peskinec6b69072018-11-20 21:42:52 +01006377 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006378 global_data.initialized = 1;
6379
6380exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006381 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006382 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006383 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006384}
6385
6386#endif /* MBEDTLS_PSA_CRYPTO_C */