blob: 26575efc5e2596d91316f0c21a6fa53af7208407 [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
John Durkop9814fa22020-11-04 12:28:15 -0800536#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800537 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200538
Steven Cooreman4fed4552020-08-03 14:46:03 +0200539/** Import an ECP key from import representation to a slot
540 *
541 * \param[in,out] slot The slot where to store the export representation to
542 * \param[in] data The buffer containing the import representation
543 * \param[in] data_length The amount of bytes in \p data
Ronald Cron13f8b092020-11-29 10:48:58 +0100544 * \param[out] key_buffer The buffer containing the export representation
545 * \param[in] key_buffer_size The size of \p key_buffer in bytes
546 * \param[out] key_buffer_length The length of the data written in the key
547 * buffer in bytes.
Steven Cooreman4fed4552020-08-03 14:46:03 +0200548 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200549static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
550 const uint8_t *data,
Ronald Cron13f8b092020-11-29 10:48:58 +0100551 size_t data_length,
552 uint8_t *key_buffer,
553 size_t key_buffer_size,
554 size_t *key_buffer_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100555{
Steven Cooremanacda8342020-07-24 23:09:52 +0200556 psa_status_t status;
Steven Cooremana2371e52020-07-28 14:30:39 +0200557 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100558
Steven Cooremanacda8342020-07-24 23:09:52 +0200559 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100560 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
561 data,
562 data_length,
563 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100564 if( status != PSA_SUCCESS )
565 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100566
Steven Cooremanacda8342020-07-24 23:09:52 +0200567 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200568 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200569 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200570 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200571
Steven Cooremanacda8342020-07-24 23:09:52 +0200572 /* Re-export the data to PSA export format. There is currently no support
573 * for other input formats then the export format, so this is a 1-1
574 * copy operation. */
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100575 status = mbedtls_psa_ecp_export_key( slot->attr.type,
576 ecp,
Ronald Cron13f8b092020-11-29 10:48:58 +0100577 key_buffer,
578 key_buffer_size,
579 key_buffer_length );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100580exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200581 /* Always free the PK object (will also free contained ECP context) */
582 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200583 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200584
Ronald Cron13f8b092020-11-29 10:48:58 +0100585 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100586}
John Durkop9814fa22020-11-04 12:28:15 -0800587#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
588 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100589
Gilles Peskineb46bef22019-07-30 21:32:04 +0200590/** Return the size of the key in the given slot, in bits.
591 *
592 * \param[in] slot A key slot.
593 *
594 * \return The key size in bits, read from the metadata in the slot.
595 */
596static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
597{
598 return( slot->attr.bits );
599}
600
Steven Cooreman75b74362020-07-28 14:30:13 +0200601/** Try to allocate a buffer to an empty key slot.
602 *
603 * \param[in,out] slot Key slot to attach buffer to.
604 * \param[in] buffer_length Requested size of the buffer.
605 *
606 * \retval #PSA_SUCCESS
607 * The buffer has been successfully allocated.
608 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
609 * Not enough memory was available for allocation.
610 * \retval #PSA_ERROR_ALREADY_EXISTS
611 * Trying to allocate a buffer to a non-empty key slot.
612 */
613static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
614 size_t buffer_length )
615{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100616 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200617 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200618
Ronald Cronea0f8a62020-11-25 17:52:23 +0100619 slot->key.data = mbedtls_calloc( 1, buffer_length );
620 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200621 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200622
Ronald Cronea0f8a62020-11-25 17:52:23 +0100623 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200624 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200625}
626
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200627psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
628 const uint8_t* data,
629 size_t data_length )
630{
631 psa_status_t status = psa_allocate_buffer_to_slot( slot,
632 data_length );
633 if( status != PSA_SUCCESS )
634 return( status );
635
Ronald Cronea0f8a62020-11-25 17:52:23 +0100636 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200637 return( PSA_SUCCESS );
638}
639
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200640/** Import key data into a slot.
641 *
642 * `slot->type` must have been set previously.
643 * This function assumes that the slot does not contain any key material yet.
644 * On failure, the slot content is unchanged.
645 *
646 * Persistent storage is not affected.
647 *
648 * \param[in,out] slot The key slot to import data into.
649 * Its `type` field must have previously been set to
650 * the desired key type.
651 * It must not contain any key material yet.
652 * \param[in] data Buffer containing the key material to parse and import.
653 * \param data_length Size of \p data in bytes.
654 *
655 * \retval #PSA_SUCCESS
656 * \retval #PSA_ERROR_INVALID_ARGUMENT
657 * \retval #PSA_ERROR_NOT_SUPPORTED
658 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
659 */
660static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
661 const uint8_t *data,
662 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100663{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200664 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200665 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100666
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200667 /* zero-length keys are never supported. */
668 if( data_length == 0 )
669 return( PSA_ERROR_NOT_SUPPORTED );
670
Gilles Peskine8e338702019-07-30 20:06:31 +0200671 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100672 {
Steven Cooreman04524762020-10-13 17:43:44 +0200673 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200674
Steven Cooreman75b74362020-07-28 14:30:13 +0200675 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
676 if( data_length > SIZE_MAX / 8 )
677 return( PSA_ERROR_NOT_SUPPORTED );
678
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200679 /* Enforce a size limit, and in particular ensure that the bit
680 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200681 if( bit_size > PSA_MAX_KEY_BITS )
682 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200683
684 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200685 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200686 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200687
688 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200689 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +0200690 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200691 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200692
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200693 /* Write the actual key size to the slot.
694 * psa_start_key_creation() wrote the size declared by the
695 * caller, which may be 0 (meaning unspecified) or wrong. */
696 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +0100697
698 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100699 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200700 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200701 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200702 /* Try validation through accelerators first. */
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200703 psa_key_attributes_t attributes = {
704 .core = slot->attr
705 };
Ronald Cron83282872020-11-22 14:02:39 +0100706
707 status = psa_allocate_buffer_to_slot( slot, data_length );
708 if( status != PSA_SUCCESS )
709 return( status );
710
711 bit_size = slot->attr.bits;
712 status = psa_driver_wrapper_import_key( &attributes,
713 data, data_length,
714 slot->key.data,
715 slot->key.bytes,
716 &slot->key.bytes,
717 &bit_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200718 if( status == PSA_SUCCESS )
719 {
Ronald Cron83282872020-11-22 14:02:39 +0100720 if( slot->attr.bits == 0 )
721 slot->attr.bits = (psa_key_bits_t) bit_size;
722 else if( bit_size != slot->attr.bits )
723 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200724
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200725 return( PSA_SUCCESS );
726 }
Ronald Cron83282872020-11-22 14:02:39 +0100727 else
728 {
729 if( status != PSA_ERROR_NOT_SUPPORTED )
730 return( status );
731 }
732
733 mbedtls_platform_zeroize( slot->key.data, data_length );
734 mbedtls_free( slot->key.data );
735 slot->key.data = NULL;
736 slot->key.bytes = 0;
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200737
738 /* Key format is not supported by any accelerator, try software fallback
739 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800740#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
741 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200742 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
743 {
Ronald Cron13f8b092020-11-29 10:48:58 +0100744 status = psa_allocate_buffer_to_slot( slot, data_length );
745 if( status != PSA_SUCCESS )
746 return( status );
747
748 status = psa_import_ecp_key( slot,
749 data, data_length,
750 slot->key.data, data_length,
751 &slot->key.bytes );
752 return( status );
Steven Cooreman40120f62020-10-29 11:42:22 +0100753 }
John Durkop9814fa22020-11-04 12:28:15 -0800754#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
755 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700756#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
757 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +0100758 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200759 {
Ronald Cron8f813ee2020-11-07 18:22:09 +0100760 status = psa_allocate_buffer_to_slot( slot, data_length );
761 if( status != PSA_SUCCESS )
762 return( status );
763
Ronald Cronb6420e32020-11-22 16:15:38 +0100764 status = mbedtls_psa_rsa_import_key( &attributes,
765 data, data_length,
766 slot->key.data, data_length,
767 &slot->key.bytes,
768 &bit_size );
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100769 slot->attr.bits = (psa_key_bits_t) bit_size;
Ronald Cron8f813ee2020-11-07 18:22:09 +0100770 return( status );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200771 }
John Durkop9814fa22020-11-04 12:28:15 -0800772#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
773 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +0100774
775 /* Fell through the fallback as well, so have nothing else to try. */
776 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100777 }
778 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +0100779 {
Steven Cooreman19fd5742020-07-24 23:31:01 +0200780 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100781 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +0100782 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100783}
784
Gilles Peskinef603c712019-01-19 13:40:11 +0100785/** Calculate the intersection of two algorithm usage policies.
786 *
787 * Return 0 (which allows no operation) on incompatibility.
788 */
789static psa_algorithm_t psa_key_policy_algorithm_intersection(
790 psa_algorithm_t alg1,
791 psa_algorithm_t alg2 )
792{
Gilles Peskine549ea862019-05-22 11:45:59 +0200793 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100794 if( alg1 == alg2 )
795 return( alg1 );
796 /* If the policies are from the same hash-and-sign family, check
797 * if one is a wildcard. If so the other has the specific algorithm. */
798 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
799 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
800 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
801 {
802 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
803 return( alg2 );
804 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
805 return( alg1 );
806 }
807 /* If the policies are incompatible, allow nothing. */
808 return( 0 );
809}
810
Gilles Peskined6f371b2019-05-10 19:33:38 +0200811static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
812 psa_algorithm_t requested_alg )
813{
Gilles Peskine549ea862019-05-22 11:45:59 +0200814 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200815 if( requested_alg == policy_alg )
816 return( 1 );
817 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200818 * and requested_alg is the same hash-and-sign family with any hash,
819 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200820 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
821 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
822 {
823 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
824 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
825 }
Steven Cooremance48e852020-10-05 16:02:45 +0200826 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200827 * a key derivation with that key agreement should also be allowed. This
828 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200829 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
830 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
831 {
832 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
833 policy_alg );
834 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200835 /* If it isn't permitted, it's forbidden. */
836 return( 0 );
837}
838
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100839/** Test whether a policy permits an algorithm.
840 *
841 * The caller must test usage flags separately.
842 */
843static int psa_key_policy_permits( const psa_key_policy_t *policy,
844 psa_algorithm_t alg )
845{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200846 return( psa_key_algorithm_permits( policy->alg, alg ) ||
847 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100848}
849
Gilles Peskinef603c712019-01-19 13:40:11 +0100850/** Restrict a key policy based on a constraint.
851 *
852 * \param[in,out] policy The policy to restrict.
853 * \param[in] constraint The policy constraint to apply.
854 *
855 * \retval #PSA_SUCCESS
856 * \c *policy contains the intersection of the original value of
857 * \c *policy and \c *constraint.
858 * \retval #PSA_ERROR_INVALID_ARGUMENT
859 * \c *policy and \c *constraint are incompatible.
860 * \c *policy is unchanged.
861 */
862static psa_status_t psa_restrict_key_policy(
863 psa_key_policy_t *policy,
864 const psa_key_policy_t *constraint )
865{
866 psa_algorithm_t intersection_alg =
867 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200868 psa_algorithm_t intersection_alg2 =
869 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100870 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
871 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
873 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100874 policy->usage &= constraint->usage;
875 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200876 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100877 return( PSA_SUCCESS );
878}
879
Ronald Cron5c522922020-11-14 16:35:34 +0100880/** Get the description of a key given its identifier and policy constraints
881 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200882 *
Ronald Cron5c522922020-11-14 16:35:34 +0100883 * The key must have allow all the usage flags set in \p usage. If \p alg is
884 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100885 *
Ronald Cron5c522922020-11-14 16:35:34 +0100886 * In case of a persistent key, the function loads the description of the key
887 * into a key slot if not already done.
888 *
889 * On success, the returned key slot is locked. It is the responsibility of
890 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200891 */
Ronald Cron5c522922020-11-14 16:35:34 +0100892static psa_status_t psa_get_and_lock_key_slot_with_policy(
893 mbedtls_svc_key_id_t key,
894 psa_key_slot_t **p_slot,
895 psa_key_usage_t usage,
896 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100897{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
899 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100900
Ronald Cron5c522922020-11-14 16:35:34 +0100901 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100902 if( status != PSA_SUCCESS )
903 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200904 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100905
906 /* Enforce that usage policy for the key slot contains all the flags
907 * required by the usage parameter. There is one exception: public
908 * keys can always be exported, so we treat public key objects as
909 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200910 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100911 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200912
913 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200914 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200915 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100916
917 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200918 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200919 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100920
Darryl Green06fd18d2018-07-16 11:21:11 +0100921 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200922
923error:
924 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100925 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926
927 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100928}
Darryl Green940d72c2018-07-13 13:18:51 +0100929
Ronald Cron5c522922020-11-14 16:35:34 +0100930/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200931 *
932 * A transparent key is a key for which the key material is directly
933 * available, as opposed to a key in a secure element.
934 *
Ronald Cron5c522922020-11-14 16:35:34 +0100935 * This is a temporary function to use instead of
936 * psa_get_and_lock_key_slot_with_policy() until secure element support is
937 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200938 *
Ronald Cron5c522922020-11-14 16:35:34 +0100939 * On success, the returned key slot is locked. It is the responsibility of the
940 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200941 */
942#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100943static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
944 mbedtls_svc_key_id_t key,
945 psa_key_slot_t **p_slot,
946 psa_key_usage_t usage,
947 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200948{
Ronald Cron5c522922020-11-14 16:35:34 +0100949 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
950 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200951 if( status != PSA_SUCCESS )
952 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200953
Gilles Peskineadad8132019-07-25 11:31:23 +0200954 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 {
Ronald Cron5c522922020-11-14 16:35:34 +0100956 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200957 *p_slot = NULL;
958 return( PSA_ERROR_NOT_SUPPORTED );
959 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200960
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961 return( PSA_SUCCESS );
962}
963#else /* MBEDTLS_PSA_CRYPTO_SE_C */
964/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100965#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
966 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
968
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100969/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100970static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000971{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100972 /* Data pointer will always be either a valid pointer or NULL in an
973 * initialized slot, so we can just free it. */
974 if( slot->key.data != NULL )
975 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
976
977 mbedtls_free( slot->key.data );
978 slot->key.data = NULL;
979 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000980
981 return( PSA_SUCCESS );
982}
983
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100984/** Completely wipe a slot in memory, including its policy.
985 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100986psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100987{
988 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100989
990 /*
991 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +0100992 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +0100993 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
994 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +0100995 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +0100996 */
Ronald Cron5c522922020-11-14 16:35:34 +0100997 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100998 {
999#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001000 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001001#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001002 status = PSA_ERROR_CORRUPTION_DETECTED;
1003 }
1004
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001005 /* Multipart operations may still be using the key. This is safe
1006 * because all multipart operation objects are independent from
1007 * the key slot: if they need to access the key after the setup
1008 * phase, they have a copy of the key. Note that this means that
1009 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001010 /* At this point, key material and other type-specific content has
1011 * been wiped. Clear remaining metadata. We can call memset and not
1012 * zeroize because the metadata is not particularly sensitive. */
1013 memset( slot, 0, sizeof( *slot ) );
1014 return( status );
1015}
1016
Ronald Croncf56a0a2020-08-04 09:51:30 +02001017psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001018{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001019 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001020 psa_status_t status; /* status of the last operation */
1021 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1023 psa_se_drv_table_entry_t *driver;
1024#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001025
Ronald Croncf56a0a2020-08-04 09:51:30 +02001026 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001027 return( PSA_SUCCESS );
1028
Ronald Cronf2911112020-10-29 17:51:10 +01001029 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001030 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001031 * key, this will load the key description from persistent memory if not
1032 * done yet. We cannot avoid this loading as without it we don't know if
1033 * the key is operated by an SE or not and this information is needed by
1034 * the current implementation.
1035 */
Ronald Cron5c522922020-11-14 16:35:34 +01001036 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001037 if( status != PSA_SUCCESS )
1038 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001039
Ronald Cronf2911112020-10-29 17:51:10 +01001040 /*
1041 * If the key slot containing the key description is under access by the
1042 * library (apart from the present access), the key cannot be destroyed
1043 * yet. For the time being, just return in error. Eventually (to be
1044 * implemented), the key should be destroyed when all accesses have
1045 * stopped.
1046 */
Ronald Cron5c522922020-11-14 16:35:34 +01001047 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001048 {
Ronald Cron5c522922020-11-14 16:35:34 +01001049 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001050 return( PSA_ERROR_GENERIC_ERROR );
1051 }
1052
Gilles Peskine354f7672019-07-12 23:46:38 +02001053#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001054 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001055 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001056 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001057 /* For a key in a secure element, we need to do three things:
1058 * remove the key file in internal storage, destroy the
1059 * key inside the secure element, and update the driver's
1060 * persistent data. Start a transaction that will encompass these
1061 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001062 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001063 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001064 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001065 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001066 status = psa_crypto_save_transaction( );
1067 if( status != PSA_SUCCESS )
1068 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001069 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001070 /* We should still try to destroy the key in the secure
1071 * element and the key metadata in storage. This is especially
1072 * important if the error is that the storage is full.
1073 * But how to do it exactly without risking an inconsistent
1074 * state after a reset?
1075 * https://github.com/ARMmbed/mbed-crypto/issues/215
1076 */
1077 overall_status = status;
1078 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001079 }
1080
Ronald Cronea0f8a62020-11-25 17:52:23 +01001081 status = psa_destroy_se_key( driver,
1082 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001083 if( overall_status == PSA_SUCCESS )
1084 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001085 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001086#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1087
Darryl Greend49a4992018-06-18 17:27:26 +01001088#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001089 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001090 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001091 status = psa_destroy_persistent_key( slot->attr.id );
1092 if( overall_status == PSA_SUCCESS )
1093 overall_status = status;
1094
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001095 /* TODO: other slots may have a copy of the same key. We should
1096 * invalidate them.
1097 * https://github.com/ARMmbed/mbed-crypto/issues/214
1098 */
Darryl Greend49a4992018-06-18 17:27:26 +01001099 }
1100#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001101
Gilles Peskinefc762652019-07-22 19:30:34 +02001102#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1103 if( driver != NULL )
1104 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001105 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001106 if( overall_status == PSA_SUCCESS )
1107 overall_status = status;
1108 status = psa_crypto_stop_transaction( );
1109 if( overall_status == PSA_SUCCESS )
1110 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001111 }
1112#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1113
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001114#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1115exit:
1116#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001117 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1119 if( overall_status == PSA_SUCCESS )
1120 overall_status = status;
1121 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001122}
1123
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001124void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001125{
Gilles Peskineb699f072019-04-26 16:06:02 +02001126 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001127 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001128}
1129
Gilles Peskineb699f072019-04-26 16:06:02 +02001130psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1131 psa_key_type_t type,
1132 const uint8_t *data,
1133 size_t data_length )
1134{
1135 uint8_t *copy = NULL;
1136
1137 if( data_length != 0 )
1138 {
1139 copy = mbedtls_calloc( 1, data_length );
1140 if( copy == NULL )
1141 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1142 memcpy( copy, data, data_length );
1143 }
1144 /* After this point, this function is guaranteed to succeed, so it
1145 * can start modifying `*attributes`. */
1146
1147 if( attributes->domain_parameters != NULL )
1148 {
1149 mbedtls_free( attributes->domain_parameters );
1150 attributes->domain_parameters = NULL;
1151 attributes->domain_parameters_size = 0;
1152 }
1153
1154 attributes->domain_parameters = copy;
1155 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001156 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001157 return( PSA_SUCCESS );
1158}
1159
1160psa_status_t psa_get_key_domain_parameters(
1161 const psa_key_attributes_t *attributes,
1162 uint8_t *data, size_t data_size, size_t *data_length )
1163{
1164 if( attributes->domain_parameters_size > data_size )
1165 return( PSA_ERROR_BUFFER_TOO_SMALL );
1166 *data_length = attributes->domain_parameters_size;
1167 if( attributes->domain_parameters_size != 0 )
1168 memcpy( data, attributes->domain_parameters,
1169 attributes->domain_parameters_size );
1170 return( PSA_SUCCESS );
1171}
1172
John Durkop07cc04a2020-11-16 22:08:34 -08001173#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001174 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001175static psa_status_t psa_get_rsa_public_exponent(
1176 const mbedtls_rsa_context *rsa,
1177 psa_key_attributes_t *attributes )
1178{
1179 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001181 uint8_t *buffer = NULL;
1182 size_t buflen;
1183 mbedtls_mpi_init( &mpi );
1184
1185 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1186 if( ret != 0 )
1187 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001188 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1189 {
1190 /* It's the default value, which is reported as an empty string,
1191 * so there's nothing to do. */
1192 goto exit;
1193 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001194
1195 buflen = mbedtls_mpi_size( &mpi );
1196 buffer = mbedtls_calloc( 1, buflen );
1197 if( buffer == NULL )
1198 {
1199 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1200 goto exit;
1201 }
1202 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1203 if( ret != 0 )
1204 goto exit;
1205 attributes->domain_parameters = buffer;
1206 attributes->domain_parameters_size = buflen;
1207
1208exit:
1209 mbedtls_mpi_free( &mpi );
1210 if( ret != 0 )
1211 mbedtls_free( buffer );
1212 return( mbedtls_to_psa_error( ret ) );
1213}
John Durkop07cc04a2020-11-16 22:08:34 -08001214#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001215 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001216
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001217/** Retrieve all the publicly-accessible attributes of a key.
1218 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001219psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001220 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001221{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001222 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001223 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001224 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001225
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001226 psa_reset_key_attributes( attributes );
1227
Ronald Cron5c522922020-11-14 16:35:34 +01001228 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001229 if( status != PSA_SUCCESS )
1230 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001231
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001232 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001233 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1234 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1235
1236#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1237 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001238 psa_set_key_slot_number( attributes,
1239 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001240#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001241
Gilles Peskine8e338702019-07-30 20:06:31 +02001242 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001243 {
John Durkop07cc04a2020-11-16 22:08:34 -08001244#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001245 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001246 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001247 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001248#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001249 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001250 * is not yet implemented.
1251 * https://github.com/ARMmbed/mbed-crypto/issues/216
1252 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001253 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001254 break;
1255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001256 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001257 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001258
Ronald Cron90857082020-11-25 14:58:33 +01001259 status = mbedtls_psa_rsa_load_representation(
1260 slot->attr.type,
1261 slot->key.data,
1262 slot->key.bytes,
1263 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001264 if( status != PSA_SUCCESS )
1265 break;
1266
Steven Cooremana2371e52020-07-28 14:30:39 +02001267 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001268 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001269 mbedtls_rsa_free( rsa );
1270 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001271 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001272 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001273#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001274 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001275 default:
1276 /* Nothing else to do. */
1277 break;
1278 }
1279
1280 if( status != PSA_SUCCESS )
1281 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001282
Ronald Cron5c522922020-11-14 16:35:34 +01001283 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001284
Ronald Cron5c522922020-11-14 16:35:34 +01001285 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001286}
1287
Gilles Peskinec8000c02019-08-02 20:15:51 +02001288#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1289psa_status_t psa_get_key_slot_number(
1290 const psa_key_attributes_t *attributes,
1291 psa_key_slot_number_t *slot_number )
1292{
1293 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1294 {
1295 *slot_number = attributes->slot_number;
1296 return( PSA_SUCCESS );
1297 }
1298 else
1299 return( PSA_ERROR_INVALID_ARGUMENT );
1300}
1301#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1302
Ronald Crond18b5f82020-11-25 16:46:05 +01001303static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1304 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001305 uint8_t *data,
1306 size_t data_size,
1307 size_t *data_length )
1308{
Ronald Crond18b5f82020-11-25 16:46:05 +01001309 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001310 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001311 memcpy( data, key_buffer, key_buffer_size );
1312 memset( data + key_buffer_size, 0,
1313 data_size - key_buffer_size );
1314 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001315 return( PSA_SUCCESS );
1316}
1317
Ronald Cron7285cda2020-11-26 14:46:37 +01001318psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001319 const psa_key_attributes_t *attributes,
1320 const uint8_t *key_buffer, size_t key_buffer_size,
1321 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001322{
Ronald Crond18b5f82020-11-25 16:46:05 +01001323 psa_key_type_t type = attributes->core.type;
1324
Ronald Crond18b5f82020-11-25 16:46:05 +01001325 if( key_type_is_raw_bytes( type ) ||
1326 PSA_KEY_TYPE_IS_RSA( type ) ||
1327 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001328 {
1329 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001330 key_buffer, key_buffer_size,
1331 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001332 }
1333 else
1334 {
1335 /* This shouldn't happen in the reference implementation, but
1336 it is valid for a special-purpose implementation to omit
1337 support for exporting certain key types. */
1338 return( PSA_ERROR_NOT_SUPPORTED );
1339 }
1340}
1341
1342psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length )
1346{
1347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1348 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1349 psa_key_slot_t *slot;
1350
1351 /* Set the key to empty now, so that even when there are errors, we always
1352 * set data_length to a value between 0 and data_size. On error, setting
1353 * the key to empty is a good choice because an empty key representation is
1354 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001355 *data_length = 0;
1356
Ronald Cron9486f9d2020-11-26 13:36:23 +01001357 /* Export requires the EXPORT flag. There is an exception for public keys,
1358 * which don't require any flag, but
1359 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1360 */
1361 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1362 PSA_KEY_USAGE_EXPORT, 0 );
1363 if( status != PSA_SUCCESS )
1364 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001365
Gilles Peskinef9168942019-09-12 19:20:29 +02001366 /* Reject a zero-length output buffer now, since this can never be a
1367 * valid key representation. This way we know that data must be a valid
1368 * pointer and we can do things like memset(data, ..., data_size). */
1369 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001370 {
1371 status = PSA_ERROR_BUFFER_TOO_SMALL;
1372 goto exit;
1373 }
1374
Ronald Crond18b5f82020-11-25 16:46:05 +01001375 psa_key_attributes_t attributes = {
1376 .core = slot->attr
1377 };
Ronald Cron67227982020-11-26 15:16:05 +01001378 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001379 slot->key.data, slot->key.bytes,
1380 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001381
1382exit:
1383 unlock_status = psa_unlock_key_slot( slot );
1384
1385 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1386}
1387
Ronald Cron7285cda2020-11-26 14:46:37 +01001388psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001389 const psa_key_attributes_t *attributes,
1390 const uint8_t *key_buffer,
1391 size_t key_buffer_size,
1392 uint8_t *data,
1393 size_t data_size,
1394 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395{
Ronald Crond18b5f82020-11-25 16:46:05 +01001396 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001397
Ronald Crond18b5f82020-11-25 16:46:05 +01001398 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001399 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001400 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001401 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001402 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001403 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001404 key_buffer, key_buffer_size,
1405 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001406 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001407
Ronald Crond18b5f82020-11-25 16:46:05 +01001408 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001409 {
John Durkop0e005192020-10-31 22:06:54 -07001410#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1411 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001412 return( mbedtls_psa_rsa_export_public_key( attributes,
1413 key_buffer,
1414 key_buffer_size,
1415 data,
1416 data_size,
1417 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001418#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001419 /* We don't know how to convert a private RSA key to public. */
1420 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001421#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1422 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001423 }
1424 else
Moran Pekera998bc62018-04-16 18:16:20 +03001425 {
John Durkop6ba40d12020-11-10 08:50:04 -08001426#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1427 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001428 return( mbedtls_psa_ecp_export_public_key( attributes,
1429 key_buffer,
1430 key_buffer_size,
1431 data,
1432 data_size,
1433 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001434#else
1435 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001436 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001437#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1438 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001439 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001440 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001441 else
1442 {
1443 /* This shouldn't happen in the reference implementation, but
1444 it is valid for a special-purpose implementation to omit
1445 support for exporting certain key types. */
1446 return( PSA_ERROR_NOT_SUPPORTED );
1447 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001448}
Ronald Crond18b5f82020-11-25 16:46:05 +01001449
Ronald Croncf56a0a2020-08-04 09:51:30 +02001450psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001451 uint8_t *data,
1452 size_t data_size,
1453 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001454{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001456 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001457 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001458
1459 /* Set the key to empty now, so that even when there are errors, we always
1460 * set data_length to a value between 0 and data_size. On error, setting
1461 * the key to empty is a good choice because an empty key representation is
1462 * unlikely to be accepted anywhere. */
1463 *data_length = 0;
1464
1465 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001466 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001467 if( status != PSA_SUCCESS )
1468 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001469
Ronald Cron9486f9d2020-11-26 13:36:23 +01001470 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1471 {
1472 status = PSA_ERROR_INVALID_ARGUMENT;
1473 goto exit;
1474 }
1475
1476 /* Reject a zero-length output buffer now, since this can never be a
1477 * valid key representation. This way we know that data must be a valid
1478 * pointer and we can do things like memset(data, ..., data_size). */
1479 if( data_size == 0 )
1480 {
1481 status = PSA_ERROR_BUFFER_TOO_SMALL;
1482 goto exit;
1483 }
1484
Ronald Crond18b5f82020-11-25 16:46:05 +01001485 psa_key_attributes_t attributes = {
1486 .core = slot->attr
1487 };
Ronald Cron67227982020-11-26 15:16:05 +01001488 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001489 &attributes, slot->key.data, slot->key.bytes,
1490 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001491
1492exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001493 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001494
Ronald Cron5c522922020-11-14 16:35:34 +01001495 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001496}
1497
Gilles Peskine91e8c332019-08-02 19:19:39 +02001498#if defined(static_assert)
1499static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1500 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001501static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001502 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001503static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001504 "One or more key attribute flag is listed as both internal-only and external-only" );
1505#endif
1506
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001507/** Validate that a key policy is internally well-formed.
1508 *
1509 * This function only rejects invalid policies. It does not validate the
1510 * consistency of the policy with respect to other attributes of the key
1511 * such as the key type.
1512 */
1513static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001514{
1515 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001516 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001517 PSA_KEY_USAGE_ENCRYPT |
1518 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001519 PSA_KEY_USAGE_SIGN_HASH |
1520 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001521 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1522 return( PSA_ERROR_INVALID_ARGUMENT );
1523
Gilles Peskine4747d192019-04-17 15:05:45 +02001524 return( PSA_SUCCESS );
1525}
1526
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001527/** Validate the internal consistency of key attributes.
1528 *
1529 * This function only rejects invalid attribute values. If does not
1530 * validate the consistency of the attributes with any key data that may
1531 * be involved in the creation of the key.
1532 *
1533 * Call this function early in the key creation process.
1534 *
1535 * \param[in] attributes Key attributes for the new key.
1536 * \param[out] p_drv On any return, the driver for the key, if any.
1537 * NULL for a transparent key.
1538 *
1539 */
1540static psa_status_t psa_validate_key_attributes(
1541 const psa_key_attributes_t *attributes,
1542 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001543{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001544 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001545 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001546 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001547
Ronald Cron54b90082020-10-29 15:26:43 +01001548 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001549 if( status != PSA_SUCCESS )
1550 return( status );
1551
Ronald Crond2ed4812020-07-17 16:11:30 +02001552 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001553 if( status != PSA_SUCCESS )
1554 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001555
Ronald Cron65f38a32020-10-23 17:11:13 +02001556 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1557 {
1558 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1559 return( PSA_ERROR_INVALID_ARGUMENT );
1560 }
1561 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001562 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001563 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001564 if( status != PSA_SUCCESS )
1565 return( status );
1566 }
1567
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001568 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001569 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001570 return( status );
1571
1572 /* Refuse to create overly large keys.
1573 * Note that this doesn't trigger on import if the attributes don't
1574 * explicitly specify a size (so psa_get_key_bits returns 0), so
1575 * psa_import_key() needs its own checks. */
1576 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1577 return( PSA_ERROR_NOT_SUPPORTED );
1578
Gilles Peskine91e8c332019-08-02 19:19:39 +02001579 /* Reject invalid flags. These should not be reachable through the API. */
1580 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1581 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1582 return( PSA_ERROR_INVALID_ARGUMENT );
1583
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001584 return( PSA_SUCCESS );
1585}
1586
Gilles Peskine4747d192019-04-17 15:05:45 +02001587/** Prepare a key slot to receive key material.
1588 *
1589 * This function allocates a key slot and sets its metadata.
1590 *
1591 * If this function fails, call psa_fail_key_creation().
1592 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001593 * This function is intended to be used as follows:
1594 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001595 * it with the specified attributes, and in case of a volatile key assign it
1596 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001597 * -# Populate the slot with the key material.
1598 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1599 * In case of failure at any step, stop the sequence and call
1600 * psa_fail_key_creation().
1601 *
Ronald Cron5c522922020-11-14 16:35:34 +01001602 * On success, the key slot is locked. It is the responsibility of the caller
1603 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001604 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001605 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001606 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001607 * \param[out] p_slot On success, a pointer to the prepared slot.
1608 * \param[out] p_drv On any return, the driver for the key, if any.
1609 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001610 *
1611 * \retval #PSA_SUCCESS
1612 * The key slot is ready to receive key material.
1613 * \return If this function fails, the key slot is an invalid state.
1614 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001615 */
1616static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001617 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001618 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001619 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001620 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001621{
1622 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001623 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001624 psa_key_slot_t *slot;
1625
Gilles Peskinedf179142019-07-15 22:02:14 +02001626 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001627 *p_drv = NULL;
1628
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001629 status = psa_validate_key_attributes( attributes, p_drv );
1630 if( status != PSA_SUCCESS )
1631 return( status );
1632
Ronald Cronc4d1b512020-07-31 11:26:37 +02001633 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001634 if( status != PSA_SUCCESS )
1635 return( status );
1636 slot = *p_slot;
1637
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001638 /* We're storing the declared bit-size of the key. It's up to each
1639 * creation mechanism to verify that this information is correct.
1640 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001641 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001642 * is optional (import, copy). In case of a volatile key, assign it the
1643 * volatile key identifier associated to the slot returned to contain its
1644 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001645
1646 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001647 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1648 {
1649#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1650 slot->attr.id = volatile_key_id;
1651#else
1652 slot->attr.id.key_id = volatile_key_id;
1653#endif
1654 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001655
Gilles Peskine91e8c332019-08-02 19:19:39 +02001656 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001657 * external-only flags, query `attributes`. Thanks to the check
1658 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001659 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001660 * may have set. */
1661 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001662
Gilles Peskinecbaff462019-07-12 23:46:04 +02001663#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001664 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001665 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001666 * create the key file in internal storage, create the
1667 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001668 * persistent data. This is done by starting a transaction that will
1669 * encompass these three actions.
1670 * For registering a volatile key, we just need to find an appropriate
1671 * slot number inside the SE. Since the key is designated volatile, creating
1672 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001673 /* The first thing to do is to find a slot number for the new key.
1674 * We save the slot number in persistent storage as part of the
1675 * transaction data. It will be needed to recover if the power
1676 * fails during the key creation process, to clean up on the secure
1677 * element side after restarting. Obtaining a slot number from the
1678 * secure element driver updates its persistent state, but we do not yet
1679 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001680 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001681 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001682 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001683 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001684 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001685 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001686 if( status != PSA_SUCCESS )
1687 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001688
1689 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001690 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001691 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1692 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001693 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001694 psa_crypto_transaction.key.id = slot->attr.id;
1695 status = psa_crypto_save_transaction( );
1696 if( status != PSA_SUCCESS )
1697 {
1698 (void) psa_crypto_stop_transaction( );
1699 return( status );
1700 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001701 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001702
1703 status = psa_copy_key_material_into_slot(
1704 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001705 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001706
1707 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1708 {
1709 /* Key registration only makes sense with a secure element. */
1710 return( PSA_ERROR_INVALID_ARGUMENT );
1711 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001712#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1713
Ronald Cronc4d1b512020-07-31 11:26:37 +02001714 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001715}
Gilles Peskine4747d192019-04-17 15:05:45 +02001716
1717/** Finalize the creation of a key once its key material has been set.
1718 *
1719 * This entails writing the key to persistent storage.
1720 *
1721 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001722 * See the documentation of psa_start_key_creation() for the intended use
1723 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001724 *
Ronald Cron5c522922020-11-14 16:35:34 +01001725 * If the finalization succeeds, the function unlocks the key slot (it was
1726 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1727 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001728 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001729 * \param[in,out] slot Pointer to the slot with key material.
1730 * \param[in] driver The secure element driver for the key,
1731 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001732 * \param[out] key On success, identifier of the key. Note that the
1733 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001734 *
1735 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001736 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001737 * \return If this function fails, the key slot is an invalid state.
1738 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001739 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001740static psa_status_t psa_finish_key_creation(
1741 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001742 psa_se_drv_table_entry_t *driver,
1743 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001744{
1745 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001746 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001747 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001748
1749#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001750 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001752#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1753 if( driver != NULL )
1754 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001755 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001756 psa_key_slot_number_t slot_number =
1757 psa_key_slot_get_slot_number( slot ) ;
1758
Gilles Peskineb46bef22019-07-30 21:32:04 +02001759#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001760 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001761 sizeof( data.slot_number ),
1762 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001763#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001764 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001765 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001766 (uint8_t*) &data,
1767 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001768 }
1769 else
1770#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1771 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001772 /* Key material is saved in export representation in the slot, so
1773 * just pass the slot buffer for storage. */
1774 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001775 slot->key.data,
1776 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001777 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001779#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1780
Gilles Peskinecbaff462019-07-12 23:46:04 +02001781#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001782 /* Finish the transaction for a key creation. This does not
1783 * happen when registering an existing key. Detect this case
1784 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001785 * creation of a persistent key in a secure element requires a transaction,
1786 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001787 if( driver != NULL &&
1788 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001789 {
1790 status = psa_save_se_persistent_data( driver );
1791 if( status != PSA_SUCCESS )
1792 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001793 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001794 return( status );
1795 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001796 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001797 }
1798#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1799
Ronald Cron50972942020-11-14 11:28:25 +01001800 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001801 {
1802 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001803 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001804 if( status != PSA_SUCCESS )
1805 *key = MBEDTLS_SVC_KEY_ID_INIT;
1806 }
Ronald Cron50972942020-11-14 11:28:25 +01001807
Gilles Peskine4747d192019-04-17 15:05:45 +02001808 return( status );
1809}
1810
1811/** Abort the creation of a key.
1812 *
1813 * You may call this function after calling psa_start_key_creation(),
1814 * or after psa_finish_key_creation() fails. In other circumstances, this
1815 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001816 * See the documentation of psa_start_key_creation() for the intended use
1817 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001818 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001819 * \param[in,out] slot Pointer to the slot with key material.
1820 * \param[in] driver The secure element driver for the key,
1821 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001823static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001824 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001825{
Gilles Peskine011e4282019-06-26 18:34:38 +02001826 (void) driver;
1827
Gilles Peskine4747d192019-04-17 15:05:45 +02001828 if( slot == NULL )
1829 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001830
1831#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001832 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001833 * element, and the failure happened later (when saving metadata
1834 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001835 * element.
1836 * https://github.com/ARMmbed/mbed-crypto/issues/217
1837 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001838
Gilles Peskined7729582019-08-05 15:55:54 +02001839 /* Abort the ongoing transaction if any (there may not be one if
1840 * the creation process failed before starting one, or if the
1841 * key creation is a registration of a key in a secure element).
1842 * Earlier functions must already have done what it takes to undo any
1843 * partial creation. All that's left is to update the transaction data
1844 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001845 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001846#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1847
Gilles Peskine4747d192019-04-17 15:05:45 +02001848 psa_wipe_key_slot( slot );
1849}
1850
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001851/** Validate optional attributes during key creation.
1852 *
1853 * Some key attributes are optional during key creation. If they are
1854 * specified in the attributes structure, check that they are consistent
1855 * with the data in the slot.
1856 *
1857 * This function should be called near the end of key creation, after
1858 * the slot in memory is fully populated but before saving persistent data.
1859 */
1860static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001861 const psa_key_slot_t *slot,
1862 const psa_key_attributes_t *attributes )
1863{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001864 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001865 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001866 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001867 return( PSA_ERROR_INVALID_ARGUMENT );
1868 }
1869
1870 if( attributes->domain_parameters_size != 0 )
1871 {
John Durkop0e005192020-10-31 22:06:54 -07001872#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1873 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001874 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001875 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001876 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001877 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001879
Ronald Cron90857082020-11-25 14:58:33 +01001880 psa_status_t status = mbedtls_psa_rsa_load_representation(
1881 slot->attr.type,
1882 slot->key.data,
1883 slot->key.bytes,
1884 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001885 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001886 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001887
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001888 mbedtls_mpi_init( &actual );
1889 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001890 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001891 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001892 mbedtls_rsa_free( rsa );
1893 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001894 if( ret != 0 )
1895 goto rsa_exit;
1896 ret = mbedtls_mpi_read_binary( &required,
1897 attributes->domain_parameters,
1898 attributes->domain_parameters_size );
1899 if( ret != 0 )
1900 goto rsa_exit;
1901 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1902 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1903 rsa_exit:
1904 mbedtls_mpi_free( &actual );
1905 mbedtls_mpi_free( &required );
1906 if( ret != 0)
1907 return( mbedtls_to_psa_error( ret ) );
1908 }
1909 else
John Durkop9814fa22020-11-04 12:28:15 -08001910#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1911 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001912 {
1913 return( PSA_ERROR_INVALID_ARGUMENT );
1914 }
1915 }
1916
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001917 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001918 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001919 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001920 return( PSA_ERROR_INVALID_ARGUMENT );
1921 }
1922
1923 return( PSA_SUCCESS );
1924}
1925
Gilles Peskine4747d192019-04-17 15:05:45 +02001926psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001927 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001928 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001929 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001930{
1931 psa_status_t status;
1932 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001933 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934
Ronald Cron81709fc2020-11-14 12:10:32 +01001935 *key = MBEDTLS_SVC_KEY_ID_INIT;
1936
Gilles Peskine0f84d622019-09-12 19:03:13 +02001937 /* Reject zero-length symmetric keys (including raw data key objects).
1938 * This also rejects any key which might be encoded as an empty string,
1939 * which is never valid. */
1940 if( data_length == 0 )
1941 return( PSA_ERROR_INVALID_ARGUMENT );
1942
Gilles Peskinedf179142019-07-15 22:02:14 +02001943 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001944 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945 if( status != PSA_SUCCESS )
1946 goto exit;
1947
Gilles Peskine5d309672019-07-12 23:47:28 +02001948#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1949 if( driver != NULL )
1950 {
1951 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001952 /* The driver should set the number of key bits, however in
1953 * case it doesn't, we initialize bits to an invalid value. */
1954 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001955 if( drv->key_management == NULL ||
1956 drv->key_management->p_import == NULL )
1957 {
1958 status = PSA_ERROR_NOT_SUPPORTED;
1959 goto exit;
1960 }
1961 status = drv->key_management->p_import(
1962 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01001963 psa_key_slot_get_slot_number( slot ),
1964 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001965 if( status != PSA_SUCCESS )
1966 goto exit;
1967 if( bits > PSA_MAX_KEY_BITS )
1968 {
1969 status = PSA_ERROR_NOT_SUPPORTED;
1970 goto exit;
1971 }
1972 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001973 }
1974 else
1975#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01001976 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
1977 {
1978 /* Importing a key with external lifetime through the driver wrapper
1979 * interface is not yet supported. Return as if this was an invalid
1980 * lifetime. */
1981 status = PSA_ERROR_INVALID_ARGUMENT;
1982 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001983 }
1984 else
Gilles Peskine5d309672019-07-12 23:47:28 +02001985 {
1986 status = psa_import_key_into_slot( slot, data, data_length );
1987 if( status != PSA_SUCCESS )
1988 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001989 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001990 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001991 if( status != PSA_SUCCESS )
1992 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001993
Ronald Cron81709fc2020-11-14 12:10:32 +01001994 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001996 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001997 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001998
Gilles Peskine4747d192019-04-17 15:05:45 +02001999 return( status );
2000}
2001
Gilles Peskined7729582019-08-05 15:55:54 +02002002#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2003psa_status_t mbedtls_psa_register_se_key(
2004 const psa_key_attributes_t *attributes )
2005{
2006 psa_status_t status;
2007 psa_key_slot_t *slot = NULL;
2008 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002009 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002010
2011 /* Leaving attributes unspecified is not currently supported.
2012 * It could make sense to query the key type and size from the
2013 * secure element, but not all secure elements support this
2014 * and the driver HAL doesn't currently support it. */
2015 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2016 return( PSA_ERROR_NOT_SUPPORTED );
2017 if( psa_get_key_bits( attributes ) == 0 )
2018 return( PSA_ERROR_NOT_SUPPORTED );
2019
2020 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002021 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002022 if( status != PSA_SUCCESS )
2023 goto exit;
2024
Ronald Cron81709fc2020-11-14 12:10:32 +01002025 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002026
2027exit:
2028 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002029 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002030
Gilles Peskined7729582019-08-05 15:55:54 +02002031 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002032 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002033 return( status );
2034}
2035#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2036
Gilles Peskinef603c712019-01-19 13:40:11 +01002037static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002038 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002039{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002040 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002041 source->key.data,
2042 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002043 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002044 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002045
Steven Cooreman398aee52020-10-13 14:35:45 +02002046 target->attr.type = source->attr.type;
2047 target->attr.bits = source->attr.bits;
2048
2049 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002050}
2051
Ronald Croncf56a0a2020-08-04 09:51:30 +02002052psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002053 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002054 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002055{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002057 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002058 psa_key_slot_t *source_slot = NULL;
2059 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002060 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002061 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002062
Ronald Cron81709fc2020-11-14 12:10:32 +01002063 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2064
Ronald Cron5c522922020-11-14 16:35:34 +01002065 status = psa_get_and_lock_transparent_key_slot_with_policy(
2066 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002067 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002068 goto exit;
2069
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002070 status = psa_validate_optional_attributes( source_slot,
2071 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002072 if( status != PSA_SUCCESS )
2073 goto exit;
2074
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002075 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002076 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002077 if( status != PSA_SUCCESS )
2078 goto exit;
2079
Ronald Cron81709fc2020-11-14 12:10:32 +01002080 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2081 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002082 if( status != PSA_SUCCESS )
2083 goto exit;
2084
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002085#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2086 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002087 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002088 /* Copying to a secure element is not implemented yet. */
2089 status = PSA_ERROR_NOT_SUPPORTED;
2090 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002091 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002092#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002093
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002094 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002095 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002096 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002097
Ronald Cron81709fc2020-11-14 12:10:32 +01002098 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002099exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002100 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002101 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002102
Ronald Cron5c522922020-11-14 16:35:34 +01002103 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002104
Ronald Cron5c522922020-11-14 16:35:34 +01002105 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002106}
2107
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002108
2109
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002110/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002111/* Message digests */
2112/****************************************************************/
2113
John Durkop07cc04a2020-11-16 22:08:34 -08002114#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002115 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2116 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002117 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002118static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002119{
2120 switch( alg )
2121 {
John Durkopee4e6602020-11-27 08:48:46 -08002122#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002123 case PSA_ALG_MD2:
2124 return( &mbedtls_md2_info );
2125#endif
John Durkopee4e6602020-11-27 08:48:46 -08002126#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002127 case PSA_ALG_MD4:
2128 return( &mbedtls_md4_info );
2129#endif
John Durkopee4e6602020-11-27 08:48:46 -08002130#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002131 case PSA_ALG_MD5:
2132 return( &mbedtls_md5_info );
2133#endif
John Durkopee4e6602020-11-27 08:48:46 -08002134#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002135 case PSA_ALG_RIPEMD160:
2136 return( &mbedtls_ripemd160_info );
2137#endif
John Durkopee4e6602020-11-27 08:48:46 -08002138#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002139 case PSA_ALG_SHA_1:
2140 return( &mbedtls_sha1_info );
2141#endif
John Durkopee4e6602020-11-27 08:48:46 -08002142#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002143 case PSA_ALG_SHA_224:
2144 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002145#endif
2146#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002147 case PSA_ALG_SHA_256:
2148 return( &mbedtls_sha256_info );
2149#endif
John Durkopee4e6602020-11-27 08:48:46 -08002150#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002151 case PSA_ALG_SHA_384:
2152 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002153#endif
John Durkopee4e6602020-11-27 08:48:46 -08002154#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002155 case PSA_ALG_SHA_512:
2156 return( &mbedtls_sha512_info );
2157#endif
2158 default:
2159 return( NULL );
2160 }
2161}
John Durkop07cc04a2020-11-16 22:08:34 -08002162#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002163 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2164 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2165 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002166
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2168{
2169 switch( operation->alg )
2170 {
Gilles Peskine81736312018-06-26 15:04:31 +02002171 case 0:
2172 /* The object has (apparently) been initialized but it is not
2173 * in use. It's ok to call abort on such an object, and there's
2174 * nothing to do. */
2175 break;
John Durkopee4e6602020-11-27 08:48:46 -08002176#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 case PSA_ALG_MD2:
2178 mbedtls_md2_free( &operation->ctx.md2 );
2179 break;
2180#endif
John Durkopee4e6602020-11-27 08:48:46 -08002181#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182 case PSA_ALG_MD4:
2183 mbedtls_md4_free( &operation->ctx.md4 );
2184 break;
2185#endif
John Durkopee4e6602020-11-27 08:48:46 -08002186#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002187 case PSA_ALG_MD5:
2188 mbedtls_md5_free( &operation->ctx.md5 );
2189 break;
2190#endif
John Durkopee4e6602020-11-27 08:48:46 -08002191#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002192 case PSA_ALG_RIPEMD160:
2193 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2194 break;
2195#endif
John Durkopee4e6602020-11-27 08:48:46 -08002196#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002197 case PSA_ALG_SHA_1:
2198 mbedtls_sha1_free( &operation->ctx.sha1 );
2199 break;
2200#endif
John Durkop6ca23272020-12-03 06:01:32 -08002201#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002202 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002203 mbedtls_sha256_free( &operation->ctx.sha256 );
2204 break;
2205#endif
2206#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207 case PSA_ALG_SHA_256:
2208 mbedtls_sha256_free( &operation->ctx.sha256 );
2209 break;
2210#endif
John Durkop6ca23272020-12-03 06:01:32 -08002211#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002213 mbedtls_sha512_free( &operation->ctx.sha512 );
2214 break;
2215#endif
2216#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002217 case PSA_ALG_SHA_512:
2218 mbedtls_sha512_free( &operation->ctx.sha512 );
2219 break;
2220#endif
2221 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002222 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002223 }
2224 operation->alg = 0;
2225 return( PSA_SUCCESS );
2226}
2227
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002228psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002229 psa_algorithm_t alg )
2230{
Janos Follath24eed8d2019-11-22 13:21:35 +00002231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002232
2233 /* A context must be freshly initialized before it can be set up. */
2234 if( operation->alg != 0 )
2235 {
2236 return( PSA_ERROR_BAD_STATE );
2237 }
2238
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239 switch( alg )
2240 {
John Durkopee4e6602020-11-27 08:48:46 -08002241#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002242 case PSA_ALG_MD2:
2243 mbedtls_md2_init( &operation->ctx.md2 );
2244 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2245 break;
2246#endif
John Durkopee4e6602020-11-27 08:48:46 -08002247#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248 case PSA_ALG_MD4:
2249 mbedtls_md4_init( &operation->ctx.md4 );
2250 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2251 break;
2252#endif
John Durkopee4e6602020-11-27 08:48:46 -08002253#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254 case PSA_ALG_MD5:
2255 mbedtls_md5_init( &operation->ctx.md5 );
2256 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2257 break;
2258#endif
John Durkopee4e6602020-11-27 08:48:46 -08002259#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002260 case PSA_ALG_RIPEMD160:
2261 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2262 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2263 break;
2264#endif
John Durkopee4e6602020-11-27 08:48:46 -08002265#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002266 case PSA_ALG_SHA_1:
2267 mbedtls_sha1_init( &operation->ctx.sha1 );
2268 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2269 break;
2270#endif
John Durkopee4e6602020-11-27 08:48:46 -08002271#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272 case PSA_ALG_SHA_224:
2273 mbedtls_sha256_init( &operation->ctx.sha256 );
2274 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2275 break;
John Durkopee4e6602020-11-27 08:48:46 -08002276#endif
2277#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278 case PSA_ALG_SHA_256:
2279 mbedtls_sha256_init( &operation->ctx.sha256 );
2280 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2281 break;
2282#endif
John Durkopee4e6602020-11-27 08:48:46 -08002283#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284 case PSA_ALG_SHA_384:
2285 mbedtls_sha512_init( &operation->ctx.sha512 );
2286 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2287 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002288#endif
John Durkopee4e6602020-11-27 08:48:46 -08002289#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290 case PSA_ALG_SHA_512:
2291 mbedtls_sha512_init( &operation->ctx.sha512 );
2292 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2293 break;
2294#endif
2295 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002296 return( PSA_ALG_IS_HASH( alg ) ?
2297 PSA_ERROR_NOT_SUPPORTED :
2298 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002299 }
2300 if( ret == 0 )
2301 operation->alg = alg;
2302 else
2303 psa_hash_abort( operation );
2304 return( mbedtls_to_psa_error( ret ) );
2305}
2306
2307psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2308 const uint8_t *input,
2309 size_t input_length )
2310{
Janos Follath24eed8d2019-11-22 13:21:35 +00002311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002312
2313 /* Don't require hash implementations to behave correctly on a
2314 * zero-length input, which may have an invalid pointer. */
2315 if( input_length == 0 )
2316 return( PSA_SUCCESS );
2317
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002318 switch( operation->alg )
2319 {
John Durkopee4e6602020-11-27 08:48:46 -08002320#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002321 case PSA_ALG_MD2:
2322 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2323 input, input_length );
2324 break;
2325#endif
John Durkopee4e6602020-11-27 08:48:46 -08002326#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002327 case PSA_ALG_MD4:
2328 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2329 input, input_length );
2330 break;
2331#endif
John Durkopee4e6602020-11-27 08:48:46 -08002332#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333 case PSA_ALG_MD5:
2334 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2335 input, input_length );
2336 break;
2337#endif
John Durkopee4e6602020-11-27 08:48:46 -08002338#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002339 case PSA_ALG_RIPEMD160:
2340 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2341 input, input_length );
2342 break;
2343#endif
John Durkopee4e6602020-11-27 08:48:46 -08002344#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002345 case PSA_ALG_SHA_1:
2346 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2347 input, input_length );
2348 break;
2349#endif
John Durkop6ca23272020-12-03 06:01:32 -08002350#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002351 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002352 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2353 input, input_length );
2354 break;
2355#endif
2356#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002357 case PSA_ALG_SHA_256:
2358 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2359 input, input_length );
2360 break;
2361#endif
John Durkop6ca23272020-12-03 06:01:32 -08002362#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002364 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2365 input, input_length );
2366 break;
2367#endif
2368#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002369 case PSA_ALG_SHA_512:
2370 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2371 input, input_length );
2372 break;
2373#endif
2374 default:
John Durkopee4e6602020-11-27 08:48:46 -08002375 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002376 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002377 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002378
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002379 if( ret != 0 )
2380 psa_hash_abort( operation );
2381 return( mbedtls_to_psa_error( ret ) );
2382}
2383
2384psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2385 uint8_t *hash,
2386 size_t hash_size,
2387 size_t *hash_length )
2388{
itayzafrir40835d42018-08-02 13:14:17 +03002389 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002391 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002392
2393 /* Fill the output buffer with something that isn't a valid hash
2394 * (barring an attack on the hash and deliberately-crafted input),
2395 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002396 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002397 /* If hash_size is 0 then hash may be NULL and then the
2398 * call to memset would have undefined behavior. */
2399 if( hash_size != 0 )
2400 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002401
2402 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002403 {
2404 status = PSA_ERROR_BUFFER_TOO_SMALL;
2405 goto exit;
2406 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002407
2408 switch( operation->alg )
2409 {
John Durkopee4e6602020-11-27 08:48:46 -08002410#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411 case PSA_ALG_MD2:
2412 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2413 break;
2414#endif
John Durkopee4e6602020-11-27 08:48:46 -08002415#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002416 case PSA_ALG_MD4:
2417 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2418 break;
2419#endif
John Durkopee4e6602020-11-27 08:48:46 -08002420#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002421 case PSA_ALG_MD5:
2422 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2423 break;
2424#endif
John Durkopee4e6602020-11-27 08:48:46 -08002425#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002426 case PSA_ALG_RIPEMD160:
2427 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2428 break;
2429#endif
John Durkopee4e6602020-11-27 08:48:46 -08002430#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002431 case PSA_ALG_SHA_1:
2432 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2433 break;
2434#endif
John Durkop6ca23272020-12-03 06:01:32 -08002435#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002436 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002437 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2438 break;
2439#endif
2440#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002441 case PSA_ALG_SHA_256:
2442 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2443 break;
2444#endif
John Durkop6ca23272020-12-03 06:01:32 -08002445#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002446 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002447 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2448 break;
2449#endif
2450#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002451 case PSA_ALG_SHA_512:
2452 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2453 break;
2454#endif
2455 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002456 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002457 }
itayzafrir40835d42018-08-02 13:14:17 +03002458 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002459
itayzafrir40835d42018-08-02 13:14:17 +03002460exit:
2461 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002462 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002463 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002464 return( psa_hash_abort( operation ) );
2465 }
2466 else
2467 {
2468 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002469 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002470 }
2471}
2472
Gilles Peskine2d277862018-06-18 15:41:12 +02002473psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2474 const uint8_t *hash,
2475 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002476{
2477 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2478 size_t actual_hash_length;
2479 psa_status_t status = psa_hash_finish( operation,
2480 actual_hash, sizeof( actual_hash ),
2481 &actual_hash_length );
2482 if( status != PSA_SUCCESS )
2483 return( status );
2484 if( actual_hash_length != hash_length )
2485 return( PSA_ERROR_INVALID_SIGNATURE );
2486 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2487 return( PSA_ERROR_INVALID_SIGNATURE );
2488 return( PSA_SUCCESS );
2489}
2490
Gilles Peskine0a749c82019-11-28 19:33:58 +01002491psa_status_t psa_hash_compute( psa_algorithm_t alg,
2492 const uint8_t *input, size_t input_length,
2493 uint8_t *hash, size_t hash_size,
2494 size_t *hash_length )
2495{
2496 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2498
2499 *hash_length = hash_size;
2500 status = psa_hash_setup( &operation, alg );
2501 if( status != PSA_SUCCESS )
2502 goto exit;
2503 status = psa_hash_update( &operation, input, input_length );
2504 if( status != PSA_SUCCESS )
2505 goto exit;
2506 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2507 if( status != PSA_SUCCESS )
2508 goto exit;
2509
2510exit:
2511 if( status == PSA_SUCCESS )
2512 status = psa_hash_abort( &operation );
2513 else
2514 psa_hash_abort( &operation );
2515 return( status );
2516}
2517
2518psa_status_t psa_hash_compare( psa_algorithm_t alg,
2519 const uint8_t *input, size_t input_length,
2520 const uint8_t *hash, size_t hash_length )
2521{
2522 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2524
2525 status = psa_hash_setup( &operation, alg );
2526 if( status != PSA_SUCCESS )
2527 goto exit;
2528 status = psa_hash_update( &operation, input, input_length );
2529 if( status != PSA_SUCCESS )
2530 goto exit;
2531 status = psa_hash_verify( &operation, hash, hash_length );
2532 if( status != PSA_SUCCESS )
2533 goto exit;
2534
2535exit:
2536 if( status == PSA_SUCCESS )
2537 status = psa_hash_abort( &operation );
2538 else
2539 psa_hash_abort( &operation );
2540 return( status );
2541}
2542
Gilles Peskineeb35d782019-01-22 17:56:16 +01002543psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2544 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002545{
2546 if( target_operation->alg != 0 )
2547 return( PSA_ERROR_BAD_STATE );
2548
2549 switch( source_operation->alg )
2550 {
2551 case 0:
2552 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002553#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002554 case PSA_ALG_MD2:
2555 mbedtls_md2_clone( &target_operation->ctx.md2,
2556 &source_operation->ctx.md2 );
2557 break;
2558#endif
John Durkopee4e6602020-11-27 08:48:46 -08002559#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002560 case PSA_ALG_MD4:
2561 mbedtls_md4_clone( &target_operation->ctx.md4,
2562 &source_operation->ctx.md4 );
2563 break;
2564#endif
John Durkopee4e6602020-11-27 08:48:46 -08002565#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002566 case PSA_ALG_MD5:
2567 mbedtls_md5_clone( &target_operation->ctx.md5,
2568 &source_operation->ctx.md5 );
2569 break;
2570#endif
John Durkopee4e6602020-11-27 08:48:46 -08002571#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002572 case PSA_ALG_RIPEMD160:
2573 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2574 &source_operation->ctx.ripemd160 );
2575 break;
2576#endif
John Durkopee4e6602020-11-27 08:48:46 -08002577#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002578 case PSA_ALG_SHA_1:
2579 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2580 &source_operation->ctx.sha1 );
2581 break;
2582#endif
John Durkop6ca23272020-12-03 06:01:32 -08002583#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002584 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002585 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2586 &source_operation->ctx.sha256 );
2587 break;
2588#endif
2589#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002590 case PSA_ALG_SHA_256:
2591 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2592 &source_operation->ctx.sha256 );
2593 break;
2594#endif
John Durkop6ca23272020-12-03 06:01:32 -08002595#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002596 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002597 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2598 &source_operation->ctx.sha512 );
2599 break;
2600#endif
2601#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002602 case PSA_ALG_SHA_512:
2603 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2604 &source_operation->ctx.sha512 );
2605 break;
2606#endif
2607 default:
2608 return( PSA_ERROR_NOT_SUPPORTED );
2609 }
2610
2611 target_operation->alg = source_operation->alg;
2612 return( PSA_SUCCESS );
2613}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002614
2615
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002616/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002617/* MAC */
2618/****************************************************************/
2619
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002620static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002621 psa_algorithm_t alg,
2622 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002623 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002624 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002625{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002626 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002627 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002629 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002630 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002631
Gilles Peskine8c9def32018-02-08 10:02:12 +01002632 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2633 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002634 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002635 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002636 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002637 mode = MBEDTLS_MODE_STREAM;
2638 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002639 case PSA_ALG_CTR:
2640 mode = MBEDTLS_MODE_CTR;
2641 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002642 case PSA_ALG_CFB:
2643 mode = MBEDTLS_MODE_CFB;
2644 break;
2645 case PSA_ALG_OFB:
2646 mode = MBEDTLS_MODE_OFB;
2647 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002648 case PSA_ALG_ECB_NO_PADDING:
2649 mode = MBEDTLS_MODE_ECB;
2650 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002651 case PSA_ALG_CBC_NO_PADDING:
2652 mode = MBEDTLS_MODE_CBC;
2653 break;
2654 case PSA_ALG_CBC_PKCS7:
2655 mode = MBEDTLS_MODE_CBC;
2656 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002657 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658 mode = MBEDTLS_MODE_CCM;
2659 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002660 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002661 mode = MBEDTLS_MODE_GCM;
2662 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002663 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2664 mode = MBEDTLS_MODE_CHACHAPOLY;
2665 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666 default:
2667 return( NULL );
2668 }
2669 }
2670 else if( alg == PSA_ALG_CMAC )
2671 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002672 else
2673 return( NULL );
2674
2675 switch( key_type )
2676 {
2677 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002678 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002679 break;
2680 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002681 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2682 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002684 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002685 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002686 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002687 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2688 * but two-key Triple-DES is functionally three-key Triple-DES
2689 * with K1=K3, so that's how we present it to mbedtls. */
2690 if( key_bits == 128 )
2691 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002692 break;
2693 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002694 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002695 break;
2696 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002697 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002698 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002699 case PSA_KEY_TYPE_CHACHA20:
2700 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2701 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702 default:
2703 return( NULL );
2704 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002705 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002706 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002707
Jaeden Amero23bbb752018-06-26 14:16:54 +01002708 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2709 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002710}
2711
John Durkop6ba40d12020-11-10 08:50:04 -08002712#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002713static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002714{
Gilles Peskine2d277862018-06-18 15:41:12 +02002715 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002716 {
2717 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002718 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002719 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002720 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002721 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002722 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002723 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002724 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002725 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002726 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002727 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002728 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002729 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002730 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002731 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002732 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002733 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002734 return( 128 );
2735 default:
2736 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002737 }
2738}
John Durkop07cc04a2020-11-16 22:08:34 -08002739#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002740
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002741/* Initialize the MAC operation structure. Once this function has been
2742 * called, psa_mac_abort can run and will do the right thing. */
2743static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2744 psa_algorithm_t alg )
2745{
2746 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2747
2748 operation->alg = alg;
2749 operation->key_set = 0;
2750 operation->iv_set = 0;
2751 operation->iv_required = 0;
2752 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002753 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002754
2755#if defined(MBEDTLS_CMAC_C)
2756 if( alg == PSA_ALG_CMAC )
2757 {
2758 operation->iv_required = 0;
2759 mbedtls_cipher_init( &operation->ctx.cmac );
2760 status = PSA_SUCCESS;
2761 }
2762 else
2763#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002764#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002765 if( PSA_ALG_IS_HMAC( operation->alg ) )
2766 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002767 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2768 operation->ctx.hmac.hash_ctx.alg = 0;
2769 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002770 }
2771 else
John Durkopd0321952020-10-29 21:37:36 -07002772#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002773 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002774 if( ! PSA_ALG_IS_MAC( alg ) )
2775 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002776 }
2777
2778 if( status != PSA_SUCCESS )
2779 memset( operation, 0, sizeof( *operation ) );
2780 return( status );
2781}
2782
John Durkop6ba40d12020-11-10 08:50:04 -08002783#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002784static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2785{
Gilles Peskine3f108122018-12-07 18:14:53 +01002786 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002787 return( psa_hash_abort( &hmac->hash_ctx ) );
2788}
John Durkop6ba40d12020-11-10 08:50:04 -08002789#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002790
Gilles Peskine8c9def32018-02-08 10:02:12 +01002791psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2792{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002793 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002794 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002795 /* The object has (apparently) been initialized but it is not
2796 * in use. It's ok to call abort on such an object, and there's
2797 * nothing to do. */
2798 return( PSA_SUCCESS );
2799 }
2800 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002801#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002802 if( operation->alg == PSA_ALG_CMAC )
2803 {
2804 mbedtls_cipher_free( &operation->ctx.cmac );
2805 }
2806 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002807#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002808#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002809 if( PSA_ALG_IS_HMAC( operation->alg ) )
2810 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002811 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002812 }
2813 else
John Durkopd0321952020-10-29 21:37:36 -07002814#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002815 {
2816 /* Sanity check (shouldn't happen: operation->alg should
2817 * always have been initialized to a valid value). */
2818 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002819 }
Moran Peker41deec42018-04-04 15:43:05 +03002820
Gilles Peskine8c9def32018-02-08 10:02:12 +01002821 operation->alg = 0;
2822 operation->key_set = 0;
2823 operation->iv_set = 0;
2824 operation->iv_required = 0;
2825 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002826 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002827
Gilles Peskine8c9def32018-02-08 10:02:12 +01002828 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002829
2830bad_state:
2831 /* If abort is called on an uninitialized object, we can't trust
2832 * anything. Wipe the object in case it contains confidential data.
2833 * This may result in a memory leak if a pointer gets overwritten,
2834 * but it's too late to do anything about this. */
2835 memset( operation, 0, sizeof( *operation ) );
2836 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002837}
2838
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002839#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002840static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002841 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002842 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002843 const mbedtls_cipher_info_t *cipher_info )
2844{
Janos Follath24eed8d2019-11-22 13:21:35 +00002845 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002846
2847 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002848
2849 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2850 if( ret != 0 )
2851 return( ret );
2852
2853 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002854 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002855 key_bits );
2856 return( ret );
2857}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002858#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002859
John Durkop6ba40d12020-11-10 08:50:04 -08002860#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002861static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2862 const uint8_t *key,
2863 size_t key_length,
2864 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002865{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002866 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002867 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002868 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002869 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002870 psa_status_t status;
2871
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002872 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2873 * overflow below. This should never trigger if the hash algorithm
2874 * is implemented correctly. */
2875 /* The size checks against the ipad and opad buffers cannot be written
2876 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2877 * because that triggers -Wlogical-op on GCC 7.3. */
2878 if( block_size > sizeof( ipad ) )
2879 return( PSA_ERROR_NOT_SUPPORTED );
2880 if( block_size > sizeof( hmac->opad ) )
2881 return( PSA_ERROR_NOT_SUPPORTED );
2882 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002883 return( PSA_ERROR_NOT_SUPPORTED );
2884
Gilles Peskined223b522018-06-11 18:12:58 +02002885 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002886 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002887 status = psa_hash_compute( hash_alg, key, key_length,
2888 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002889 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002890 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002891 }
Gilles Peskine96889972018-07-12 17:07:03 +02002892 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2893 * but it is permitted. It is common when HMAC is used in HKDF, for
2894 * example. Don't call `memcpy` in the 0-length because `key` could be
2895 * an invalid pointer which would make the behavior undefined. */
2896 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002897 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002898
Gilles Peskined223b522018-06-11 18:12:58 +02002899 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2900 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002901 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002902 ipad[i] ^= 0x36;
2903 memset( ipad + key_length, 0x36, block_size - key_length );
2904
2905 /* Copy the key material from ipad to opad, flipping the requisite bits,
2906 * and filling the rest of opad with the requisite constant. */
2907 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002908 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2909 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002910
Gilles Peskine01126fa2018-07-12 17:04:55 +02002911 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002912 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002913 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002914
Gilles Peskine01126fa2018-07-12 17:04:55 +02002915 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002916
2917cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002918 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002919
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002920 return( status );
2921}
John Durkop6ba40d12020-11-10 08:50:04 -08002922#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002923
Gilles Peskine89167cb2018-07-08 20:12:23 +02002924static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002925 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002926 psa_algorithm_t alg,
2927 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002928{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002929 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002930 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002931 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002933 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002934 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002935 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002936 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002937
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002938 /* A context must be freshly initialized before it can be set up. */
2939 if( operation->alg != 0 )
2940 {
2941 return( PSA_ERROR_BAD_STATE );
2942 }
2943
Gilles Peskined911eb72018-08-14 15:18:45 +02002944 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002945 if( status != PSA_SUCCESS )
2946 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002947 if( is_sign )
2948 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002949
Ronald Cron5c522922020-11-14 16:35:34 +01002950 status = psa_get_and_lock_transparent_key_slot_with_policy(
2951 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002952 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002953 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002954 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002955
Gilles Peskine8c9def32018-02-08 10:02:12 +01002956#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002957 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002958 {
2959 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002960 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002961 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002963 if( cipher_info == NULL )
2964 {
2965 status = PSA_ERROR_NOT_SUPPORTED;
2966 goto exit;
2967 }
2968 operation->mac_size = cipher_info->block_size;
2969 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2970 status = mbedtls_to_psa_error( ret );
2971 }
2972 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002973#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002974#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002975 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002976 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002977 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002978 if( hash_alg == 0 )
2979 {
2980 status = PSA_ERROR_NOT_SUPPORTED;
2981 goto exit;
2982 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002983
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002984 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002985 /* Sanity check. This shouldn't fail on a valid configuration. */
2986 if( operation->mac_size == 0 ||
2987 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2988 {
2989 status = PSA_ERROR_NOT_SUPPORTED;
2990 goto exit;
2991 }
2992
Gilles Peskine8e338702019-07-30 20:06:31 +02002993 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002994 {
2995 status = PSA_ERROR_INVALID_ARGUMENT;
2996 goto exit;
2997 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002998
Gilles Peskine01126fa2018-07-12 17:04:55 +02002999 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003000 slot->key.data,
3001 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003002 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003003 }
3004 else
John Durkopd0321952020-10-29 21:37:36 -07003005#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003006 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003007 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003008 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003010
Gilles Peskined911eb72018-08-14 15:18:45 +02003011 if( truncated == 0 )
3012 {
3013 /* The "normal" case: untruncated algorithm. Nothing to do. */
3014 }
3015 else if( truncated < 4 )
3016 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003017 /* A very short MAC is too short for security since it can be
3018 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3019 * so we make this our minimum, even though 32 bits is still
3020 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003021 status = PSA_ERROR_NOT_SUPPORTED;
3022 }
3023 else if( truncated > operation->mac_size )
3024 {
3025 /* It's impossible to "truncate" to a larger length. */
3026 status = PSA_ERROR_INVALID_ARGUMENT;
3027 }
3028 else
3029 operation->mac_size = truncated;
3030
Gilles Peskinefbfac682018-07-08 20:51:54 +02003031exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003032 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003033 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003034 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003035 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003036 else
3037 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003038 operation->key_set = 1;
3039 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003040
Ronald Cron5c522922020-11-14 16:35:34 +01003041 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003042
Ronald Cron5c522922020-11-14 16:35:34 +01003043 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003044}
3045
Gilles Peskine89167cb2018-07-08 20:12:23 +02003046psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003047 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003048 psa_algorithm_t alg )
3049{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003050 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003051}
3052
3053psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003054 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003055 psa_algorithm_t alg )
3056{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003057 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003058}
3059
Gilles Peskine8c9def32018-02-08 10:02:12 +01003060psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3061 const uint8_t *input,
3062 size_t input_length )
3063{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003064 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003065 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003066 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003067 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003068 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003069 operation->has_input = 1;
3070
Gilles Peskine8c9def32018-02-08 10:02:12 +01003071#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003072 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003073 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003074 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3075 input, input_length );
3076 status = mbedtls_to_psa_error( ret );
3077 }
3078 else
3079#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003080#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003081 if( PSA_ALG_IS_HMAC( operation->alg ) )
3082 {
3083 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3084 input_length );
3085 }
3086 else
John Durkopd0321952020-10-29 21:37:36 -07003087#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003088 {
3089 /* This shouldn't happen if `operation` was initialized by
3090 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003091 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003092 }
3093
Gilles Peskinefbfac682018-07-08 20:51:54 +02003094 if( status != PSA_SUCCESS )
3095 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003096 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003097}
3098
John Durkop6ba40d12020-11-10 08:50:04 -08003099#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003100static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3101 uint8_t *mac,
3102 size_t mac_size )
3103{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003104 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003105 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3106 size_t hash_size = 0;
3107 size_t block_size = psa_get_hash_block_size( hash_alg );
3108 psa_status_t status;
3109
Gilles Peskine01126fa2018-07-12 17:04:55 +02003110 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3111 if( status != PSA_SUCCESS )
3112 return( status );
3113 /* From here on, tmp needs to be wiped. */
3114
3115 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3116 if( status != PSA_SUCCESS )
3117 goto exit;
3118
3119 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3120 if( status != PSA_SUCCESS )
3121 goto exit;
3122
3123 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3124 if( status != PSA_SUCCESS )
3125 goto exit;
3126
Gilles Peskined911eb72018-08-14 15:18:45 +02003127 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3128 if( status != PSA_SUCCESS )
3129 goto exit;
3130
3131 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003132
3133exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003134 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003135 return( status );
3136}
John Durkop6ba40d12020-11-10 08:50:04 -08003137#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003138
mohammad16036df908f2018-04-02 08:34:15 -07003139static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003140 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003141 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003142{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003143 if( ! operation->key_set )
3144 return( PSA_ERROR_BAD_STATE );
3145 if( operation->iv_required && ! operation->iv_set )
3146 return( PSA_ERROR_BAD_STATE );
3147
Gilles Peskine8c9def32018-02-08 10:02:12 +01003148 if( mac_size < operation->mac_size )
3149 return( PSA_ERROR_BUFFER_TOO_SMALL );
3150
Gilles Peskine8c9def32018-02-08 10:02:12 +01003151#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003152 if( operation->alg == PSA_ALG_CMAC )
3153 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003154 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003155 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3156 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003157 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003158 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003159 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003160 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003161 else
3162#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003163#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003164 if( PSA_ALG_IS_HMAC( operation->alg ) )
3165 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003166 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003167 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003168 }
3169 else
John Durkopd0321952020-10-29 21:37:36 -07003170#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003171 {
3172 /* This shouldn't happen if `operation` was initialized by
3173 * a setup function. */
3174 return( PSA_ERROR_BAD_STATE );
3175 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003176}
3177
Gilles Peskineacd4be32018-07-08 19:56:25 +02003178psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3179 uint8_t *mac,
3180 size_t mac_size,
3181 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003182{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003183 psa_status_t status;
3184
Jaeden Amero252ef282019-02-15 14:05:35 +00003185 if( operation->alg == 0 )
3186 {
3187 return( PSA_ERROR_BAD_STATE );
3188 }
3189
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003190 /* Fill the output buffer with something that isn't a valid mac
3191 * (barring an attack on the mac and deliberately-crafted input),
3192 * in case the caller doesn't check the return status properly. */
3193 *mac_length = mac_size;
3194 /* If mac_size is 0 then mac may be NULL and then the
3195 * call to memset would have undefined behavior. */
3196 if( mac_size != 0 )
3197 memset( mac, '!', mac_size );
3198
Gilles Peskine89167cb2018-07-08 20:12:23 +02003199 if( ! operation->is_sign )
3200 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003201 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003202 }
mohammad16036df908f2018-04-02 08:34:15 -07003203
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003204 status = psa_mac_finish_internal( operation, mac, mac_size );
3205
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003206 if( status == PSA_SUCCESS )
3207 {
3208 status = psa_mac_abort( operation );
3209 if( status == PSA_SUCCESS )
3210 *mac_length = operation->mac_size;
3211 else
3212 memset( mac, '!', mac_size );
3213 }
3214 else
3215 psa_mac_abort( operation );
3216 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003217}
3218
Gilles Peskineacd4be32018-07-08 19:56:25 +02003219psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3220 const uint8_t *mac,
3221 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003222{
Gilles Peskine828ed142018-06-18 23:25:51 +02003223 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003224 psa_status_t status;
3225
Jaeden Amero252ef282019-02-15 14:05:35 +00003226 if( operation->alg == 0 )
3227 {
3228 return( PSA_ERROR_BAD_STATE );
3229 }
3230
Gilles Peskine89167cb2018-07-08 20:12:23 +02003231 if( operation->is_sign )
3232 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003233 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003234 }
3235 if( operation->mac_size != mac_length )
3236 {
3237 status = PSA_ERROR_INVALID_SIGNATURE;
3238 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003239 }
mohammad16036df908f2018-04-02 08:34:15 -07003240
3241 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003242 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003243 if( status != PSA_SUCCESS )
3244 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003245
3246 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3247 status = PSA_ERROR_INVALID_SIGNATURE;
3248
3249cleanup:
3250 if( status == PSA_SUCCESS )
3251 status = psa_mac_abort( operation );
3252 else
3253 psa_mac_abort( operation );
3254
Gilles Peskine3f108122018-12-07 18:14:53 +01003255 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003256
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003257 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003258}
3259
3260
Gilles Peskine20035e32018-02-03 22:44:14 +01003261
Gilles Peskine20035e32018-02-03 22:44:14 +01003262/****************************************************************/
3263/* Asymmetric cryptography */
3264/****************************************************************/
3265
John Durkop6ba40d12020-11-10 08:50:04 -08003266#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3267 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003268/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003269 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003270static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3271 size_t hash_length,
3272 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003273{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003274 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003275 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003276 *md_alg = mbedtls_md_get_type( md_info );
3277
3278 /* The Mbed TLS RSA module uses an unsigned int for hash length
3279 * parameters. Validate that it fits so that we don't risk an
3280 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003281#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003282 if( hash_length > UINT_MAX )
3283 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003284#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003285
John Durkop0e005192020-10-31 22:06:54 -07003286#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003287 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3288 * must be correct. */
3289 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3290 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003291 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003292 if( md_info == NULL )
3293 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003294 if( mbedtls_md_get_size( md_info ) != hash_length )
3295 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003296 }
John Durkop0e005192020-10-31 22:06:54 -07003297#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003298
John Durkop0e005192020-10-31 22:06:54 -07003299#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003300 /* PSS requires a hash internally. */
3301 if( PSA_ALG_IS_RSA_PSS( alg ) )
3302 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003303 if( md_info == NULL )
3304 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003305 }
John Durkop0e005192020-10-31 22:06:54 -07003306#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003307
Gilles Peskine61b91d42018-06-08 16:09:36 +02003308 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003309}
3310
Gilles Peskine2b450e32018-06-27 15:42:46 +02003311static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3312 psa_algorithm_t alg,
3313 const uint8_t *hash,
3314 size_t hash_length,
3315 uint8_t *signature,
3316 size_t signature_size,
3317 size_t *signature_length )
3318{
3319 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003321 mbedtls_md_type_t md_alg;
3322
3323 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3324 if( status != PSA_SUCCESS )
3325 return( status );
3326
Gilles Peskine630a18a2018-06-29 17:49:35 +02003327 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003328 return( PSA_ERROR_BUFFER_TOO_SMALL );
3329
John Durkop0e005192020-10-31 22:06:54 -07003330#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003331 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3332 {
3333 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3334 MBEDTLS_MD_NONE );
3335 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003336 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003337 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003338 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003339 md_alg,
3340 (unsigned int) hash_length,
3341 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003342 signature );
3343 }
3344 else
John Durkop0e005192020-10-31 22:06:54 -07003345#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3346#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003347 if( PSA_ALG_IS_RSA_PSS( alg ) )
3348 {
3349 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3350 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003351 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003352 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003353 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003354 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003355 (unsigned int) hash_length,
3356 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003357 signature );
3358 }
3359 else
John Durkop0e005192020-10-31 22:06:54 -07003360#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003361 {
3362 return( PSA_ERROR_INVALID_ARGUMENT );
3363 }
3364
3365 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003366 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003367 return( mbedtls_to_psa_error( ret ) );
3368}
3369
3370static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3371 psa_algorithm_t alg,
3372 const uint8_t *hash,
3373 size_t hash_length,
3374 const uint8_t *signature,
3375 size_t signature_length )
3376{
3377 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003379 mbedtls_md_type_t md_alg;
3380
3381 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3382 if( status != PSA_SUCCESS )
3383 return( status );
3384
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003385 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3386 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003387
John Durkop0e005192020-10-31 22:06:54 -07003388#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003389 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3390 {
3391 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3392 MBEDTLS_MD_NONE );
3393 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003394 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003395 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003396 MBEDTLS_RSA_PUBLIC,
3397 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003398 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003399 hash,
3400 signature );
3401 }
3402 else
John Durkop0e005192020-10-31 22:06:54 -07003403#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3404#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003405 if( PSA_ALG_IS_RSA_PSS( alg ) )
3406 {
3407 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3408 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003409 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003410 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003411 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003412 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003413 (unsigned int) hash_length,
3414 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003415 signature );
3416 }
3417 else
John Durkop0e005192020-10-31 22:06:54 -07003418#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003419 {
3420 return( PSA_ERROR_INVALID_ARGUMENT );
3421 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003422
3423 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3424 * the rest of the signature is invalid". This has little use in
3425 * practice and PSA doesn't report this distinction. */
3426 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3427 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003428 return( mbedtls_to_psa_error( ret ) );
3429}
John Durkop6ba40d12020-11-10 08:50:04 -08003430#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3431 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003432
John Durkop6ba40d12020-11-10 08:50:04 -08003433#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3434 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003435/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3436 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3437 * (even though these functions don't modify it). */
3438static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3439 psa_algorithm_t alg,
3440 const uint8_t *hash,
3441 size_t hash_length,
3442 uint8_t *signature,
3443 size_t signature_size,
3444 size_t *signature_length )
3445{
Janos Follath24eed8d2019-11-22 13:21:35 +00003446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003447 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003448 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003449 mbedtls_mpi_init( &r );
3450 mbedtls_mpi_init( &s );
3451
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003452 if( signature_size < 2 * curve_bytes )
3453 {
3454 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3455 goto cleanup;
3456 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003457
John Durkop0ea39e02020-10-13 19:58:20 -07003458#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003459 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3460 {
3461 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3462 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3463 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003464 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3465 &ecp->d, hash,
3466 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003467 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003468 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003469 }
3470 else
John Durkop0ea39e02020-10-13 19:58:20 -07003471#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003472 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003473 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003474 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3475 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003476 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003477 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003478 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003479
3480 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3481 signature,
3482 curve_bytes ) );
3483 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3484 signature + curve_bytes,
3485 curve_bytes ) );
3486
3487cleanup:
3488 mbedtls_mpi_free( &r );
3489 mbedtls_mpi_free( &s );
3490 if( ret == 0 )
3491 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003492 return( mbedtls_to_psa_error( ret ) );
3493}
3494
3495static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3496 const uint8_t *hash,
3497 size_t hash_length,
3498 const uint8_t *signature,
3499 size_t signature_length )
3500{
Janos Follath24eed8d2019-11-22 13:21:35 +00003501 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003502 mbedtls_mpi r, s;
3503 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3504 mbedtls_mpi_init( &r );
3505 mbedtls_mpi_init( &s );
3506
3507 if( signature_length != 2 * curve_bytes )
3508 return( PSA_ERROR_INVALID_SIGNATURE );
3509
3510 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3511 signature,
3512 curve_bytes ) );
3513 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3514 signature + curve_bytes,
3515 curve_bytes ) );
3516
Steven Cooremanacda8342020-07-24 23:09:52 +02003517 /* Check whether the public part is loaded. If not, load it. */
3518 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3519 {
3520 MBEDTLS_MPI_CHK(
3521 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003522 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003523 }
3524
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003525 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3526 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003527
3528cleanup:
3529 mbedtls_mpi_free( &r );
3530 mbedtls_mpi_free( &s );
3531 return( mbedtls_to_psa_error( ret ) );
3532}
John Durkop6ba40d12020-11-10 08:50:04 -08003533#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3534 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003535
Ronald Croncf56a0a2020-08-04 09:51:30 +02003536psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003537 psa_algorithm_t alg,
3538 const uint8_t *hash,
3539 size_t hash_length,
3540 uint8_t *signature,
3541 size_t signature_size,
3542 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003543{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003545 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003546 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003547
3548 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003549 /* Immediately reject a zero-length signature buffer. This guarantees
3550 * that signature must be a valid pointer. (On the other hand, the hash
3551 * buffer can in principle be empty since it doesn't actually have
3552 * to be a hash.) */
3553 if( signature_size == 0 )
3554 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003555
Ronald Cron5c522922020-11-14 16:35:34 +01003556 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3557 PSA_KEY_USAGE_SIGN_HASH,
3558 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003559 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003560 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003561 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003562 {
3563 status = PSA_ERROR_INVALID_ARGUMENT;
3564 goto exit;
3565 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003566
Steven Cooremancd84cb42020-07-16 20:28:36 +02003567 /* Try any of the available accelerators first */
3568 status = psa_driver_wrapper_sign_hash( slot,
3569 alg,
3570 hash,
3571 hash_length,
3572 signature,
3573 signature_size,
3574 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003575 if( status != PSA_ERROR_NOT_SUPPORTED ||
3576 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003577 goto exit;
3578
Steven Cooreman7a250572020-07-17 16:43:05 +02003579 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003580#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3581 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003582 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003583 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003584 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003585
Ronald Cron90857082020-11-25 14:58:33 +01003586 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3587 slot->key.data,
3588 slot->key.bytes,
3589 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003590 if( status != PSA_SUCCESS )
3591 goto exit;
3592
Steven Cooremana2371e52020-07-28 14:30:39 +02003593 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003594 alg,
3595 hash, hash_length,
3596 signature, signature_size,
3597 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003598
Steven Cooremana2371e52020-07-28 14:30:39 +02003599 mbedtls_rsa_free( rsa );
3600 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003601 }
3602 else
John Durkop6ba40d12020-11-10 08:50:04 -08003603#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3604 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003605 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003606 {
John Durkop9814fa22020-11-04 12:28:15 -08003607#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3608 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003609 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003610#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003611 PSA_ALG_IS_ECDSA( alg )
3612#else
3613 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3614#endif
3615 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003616 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003617 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003618 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3619 slot->key.data,
3620 slot->key.bytes,
3621 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003622 if( status != PSA_SUCCESS )
3623 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003624 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003625 alg,
3626 hash, hash_length,
3627 signature, signature_size,
3628 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003629 mbedtls_ecp_keypair_free( ecp );
3630 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003631 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003632 else
John Durkop9814fa22020-11-04 12:28:15 -08003633#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3634 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003635 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003636 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003637 }
itayzafrir5c753392018-05-08 11:18:38 +03003638 }
3639 else
itayzafrir5c753392018-05-08 11:18:38 +03003640 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003641 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003642 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003643
3644exit:
3645 /* Fill the unused part of the output buffer (the whole buffer on error,
3646 * the trailing part on success) with something that isn't a valid mac
3647 * (barring an attack on the mac and deliberately-crafted input),
3648 * in case the caller doesn't check the return status properly. */
3649 if( status == PSA_SUCCESS )
3650 memset( signature + *signature_length, '!',
3651 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003652 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003653 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003654 /* If signature_size is 0 then we have nothing to do. We must not call
3655 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003656
Ronald Cron5c522922020-11-14 16:35:34 +01003657 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003658
Ronald Cron5c522922020-11-14 16:35:34 +01003659 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003660}
3661
Ronald Croncf56a0a2020-08-04 09:51:30 +02003662psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003663 psa_algorithm_t alg,
3664 const uint8_t *hash,
3665 size_t hash_length,
3666 const uint8_t *signature,
3667 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003668{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003670 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003671 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003672
Ronald Cron5c522922020-11-14 16:35:34 +01003673 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3674 PSA_KEY_USAGE_VERIFY_HASH,
3675 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003676 if( status != PSA_SUCCESS )
3677 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003678
Steven Cooreman55ae2172020-07-17 19:46:15 +02003679 /* Try any of the available accelerators first */
3680 status = psa_driver_wrapper_verify_hash( slot,
3681 alg,
3682 hash,
3683 hash_length,
3684 signature,
3685 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003686 if( status != PSA_ERROR_NOT_SUPPORTED ||
3687 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003688 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003689
John Durkop6ba40d12020-11-10 08:50:04 -08003690#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3691 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003692 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003693 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003694 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003695
Ronald Cron90857082020-11-25 14:58:33 +01003696 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3697 slot->key.data,
3698 slot->key.bytes,
3699 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003700 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003701 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003702
Steven Cooremana2371e52020-07-28 14:30:39 +02003703 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003704 alg,
3705 hash, hash_length,
3706 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003707 mbedtls_rsa_free( rsa );
3708 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003709 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003710 }
3711 else
John Durkop6ba40d12020-11-10 08:50:04 -08003712#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3713 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003714 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003715 {
John Durkop9814fa22020-11-04 12:28:15 -08003716#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3717 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003718 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003719 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003720 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003721 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3722 slot->key.data,
3723 slot->key.bytes,
3724 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003725 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003726 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003727 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003728 hash, hash_length,
3729 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003730 mbedtls_ecp_keypair_free( ecp );
3731 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003732 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003733 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003734 else
John Durkop9814fa22020-11-04 12:28:15 -08003735#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3736 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003737 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003738 status = PSA_ERROR_INVALID_ARGUMENT;
3739 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003740 }
itayzafrir5c753392018-05-08 11:18:38 +03003741 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003742 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003743 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003744 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003745 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003746
3747exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003748 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003749
Ronald Cron5c522922020-11-14 16:35:34 +01003750 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003751}
3752
John Durkop0e005192020-10-31 22:06:54 -07003753#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003754static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3755 mbedtls_rsa_context *rsa )
3756{
3757 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3758 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3759 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3760 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3761}
John Durkop0e005192020-10-31 22:06:54 -07003762#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003763
Ronald Croncf56a0a2020-08-04 09:51:30 +02003764psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003765 psa_algorithm_t alg,
3766 const uint8_t *input,
3767 size_t input_length,
3768 const uint8_t *salt,
3769 size_t salt_length,
3770 uint8_t *output,
3771 size_t output_size,
3772 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003773{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003775 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003776 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003777
Darryl Green5cc689a2018-07-24 15:34:10 +01003778 (void) input;
3779 (void) input_length;
3780 (void) salt;
3781 (void) output;
3782 (void) output_size;
3783
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003784 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003785
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003786 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3787 return( PSA_ERROR_INVALID_ARGUMENT );
3788
Ronald Cron5c522922020-11-14 16:35:34 +01003789 status = psa_get_and_lock_transparent_key_slot_with_policy(
3790 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003791 if( status != PSA_SUCCESS )
3792 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003793 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3794 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003795 {
3796 status = PSA_ERROR_INVALID_ARGUMENT;
3797 goto exit;
3798 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003799
John Durkop6ba40d12020-11-10 08:50:04 -08003800#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3801 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003802 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003803 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003804 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003805 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3806 slot->key.data,
3807 slot->key.bytes,
3808 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003809 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003810 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003811
3812 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003813 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003814 status = PSA_ERROR_BUFFER_TOO_SMALL;
3815 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003816 }
John Durkop0e005192020-10-31 22:06:54 -07003817#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003818 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003819 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003820 status = mbedtls_to_psa_error(
3821 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003822 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003823 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003824 MBEDTLS_RSA_PUBLIC,
3825 input_length,
3826 input,
3827 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003828 }
3829 else
John Durkop0e005192020-10-31 22:06:54 -07003830#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3831#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003832 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003833 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003834 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003835 status = mbedtls_to_psa_error(
3836 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003837 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003838 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003839 MBEDTLS_RSA_PUBLIC,
3840 salt, salt_length,
3841 input_length,
3842 input,
3843 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003844 }
3845 else
John Durkop0e005192020-10-31 22:06:54 -07003846#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003847 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003848 status = PSA_ERROR_INVALID_ARGUMENT;
3849 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003850 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003851rsa_exit:
3852 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003853 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003854
Steven Cooremana2371e52020-07-28 14:30:39 +02003855 mbedtls_rsa_free( rsa );
3856 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003857 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003858 else
John Durkop9814fa22020-11-04 12:28:15 -08003859#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003860 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003861 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003862 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003863 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003864
3865exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003866 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003867
Ronald Cron5c522922020-11-14 16:35:34 +01003868 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003869}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003870
Ronald Croncf56a0a2020-08-04 09:51:30 +02003871psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003872 psa_algorithm_t alg,
3873 const uint8_t *input,
3874 size_t input_length,
3875 const uint8_t *salt,
3876 size_t salt_length,
3877 uint8_t *output,
3878 size_t output_size,
3879 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003880{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003882 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003883 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003884
Darryl Green5cc689a2018-07-24 15:34:10 +01003885 (void) input;
3886 (void) input_length;
3887 (void) salt;
3888 (void) output;
3889 (void) output_size;
3890
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003891 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003892
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003893 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3894 return( PSA_ERROR_INVALID_ARGUMENT );
3895
Ronald Cron5c522922020-11-14 16:35:34 +01003896 status = psa_get_and_lock_transparent_key_slot_with_policy(
3897 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003898 if( status != PSA_SUCCESS )
3899 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003900 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003901 {
3902 status = PSA_ERROR_INVALID_ARGUMENT;
3903 goto exit;
3904 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003905
John Durkop6ba40d12020-11-10 08:50:04 -08003906#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3907 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003908 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003909 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003910 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003911 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3912 slot->key.data,
3913 slot->key.bytes,
3914 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003915 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003916 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003917
Steven Cooremana2371e52020-07-28 14:30:39 +02003918 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003919 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003920 status = PSA_ERROR_INVALID_ARGUMENT;
3921 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003922 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003923
John Durkop0e005192020-10-31 22:06:54 -07003924#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003925 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003926 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003927 status = mbedtls_to_psa_error(
3928 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003929 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003930 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003931 MBEDTLS_RSA_PRIVATE,
3932 output_length,
3933 input,
3934 output,
3935 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003936 }
3937 else
John Durkop0e005192020-10-31 22:06:54 -07003938#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3939#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003940 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003941 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003942 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003943 status = mbedtls_to_psa_error(
3944 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003945 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003946 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003947 MBEDTLS_RSA_PRIVATE,
3948 salt, salt_length,
3949 output_length,
3950 input,
3951 output,
3952 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003953 }
3954 else
John Durkop0e005192020-10-31 22:06:54 -07003955#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003956 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003957 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003958 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003959
Steven Cooreman4fed4552020-08-03 14:46:03 +02003960rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003961 mbedtls_rsa_free( rsa );
3962 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003963 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003964 else
John Durkop6ba40d12020-11-10 08:50:04 -08003965#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3966 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003967 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003968 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003969 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003970
3971exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003972 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003973
Ronald Cron5c522922020-11-14 16:35:34 +01003974 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003975}
Gilles Peskine20035e32018-02-03 22:44:14 +01003976
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003977
3978
mohammad1603503973b2018-03-12 15:59:30 +02003979/****************************************************************/
3980/* Symmetric cryptography */
3981/****************************************************************/
3982
Gilles Peskinee553c652018-06-04 16:22:46 +02003983static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003984 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003985 psa_algorithm_t alg,
3986 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003987{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003988 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003989 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003990 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003991 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003992 size_t key_bits;
3993 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003994 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3995 PSA_KEY_USAGE_ENCRYPT :
3996 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003997
Steven Cooremand3feccd2020-09-01 15:56:14 +02003998 /* A context must be freshly initialized before it can be set up. */
3999 if( operation->alg != 0 )
4000 return( PSA_ERROR_BAD_STATE );
4001
Steven Cooremana07b9972020-09-10 14:54:14 +02004002 /* The requested algorithm must be one that can be processed by cipher. */
4003 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004004 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004005
Steven Cooremanef8575e2020-09-11 11:44:50 +02004006 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004007 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004008 if( status != PSA_SUCCESS )
4009 goto exit;
4010
4011 /* Initialize the operation struct members, except for alg. The alg member
4012 * is used to indicate to psa_cipher_abort that there are resources to free,
4013 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004014 operation->key_set = 0;
4015 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004016 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004017 operation->iv_size = 0;
4018 operation->block_size = 0;
4019 if( alg == PSA_ALG_ECB_NO_PADDING )
4020 operation->iv_required = 0;
4021 else
4022 operation->iv_required = 1;
4023
Steven Cooremana07b9972020-09-10 14:54:14 +02004024 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004025 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004026 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004027 slot,
4028 alg );
4029 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004030 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004031 slot,
4032 alg );
4033
Steven Cooremanef8575e2020-09-11 11:44:50 +02004034 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004035 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004036 /* Once the driver context is initialised, it needs to be freed using
4037 * psa_cipher_abort. Indicate this through setting alg. */
4038 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004039 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004040
Steven Cooremand3feccd2020-09-01 15:56:14 +02004041 if( status != PSA_ERROR_NOT_SUPPORTED ||
4042 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4043 goto exit;
4044
Steven Cooremana07b9972020-09-10 14:54:14 +02004045 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004046 * available for the given algorithm & key. */
4047 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004048
Steven Cooremana07b9972020-09-10 14:54:14 +02004049 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004050 * psa_cipher_abort. Indicate there is something to be freed through setting
4051 * alg, and indicate the operation is being done using mbedtls crypto through
4052 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004053 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004054 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004055
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004056 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004057 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004058 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004059 {
4060 status = PSA_ERROR_NOT_SUPPORTED;
4061 goto exit;
4062 }
mohammad1603503973b2018-03-12 15:59:30 +02004063
mohammad1603503973b2018-03-12 15:59:30 +02004064 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004065 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004066 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004067
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004068#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004069 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004070 {
4071 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004072 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004073 memcpy( keys, slot->key.data, 16 );
4074 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004075 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4076 keys,
4077 192, cipher_operation );
4078 }
4079 else
4080#endif
4081 {
4082 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004083 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004084 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004085 }
Moran Peker41deec42018-04-04 15:43:05 +03004086 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004087 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004088
mohammad16038481e742018-03-18 13:57:31 +02004089#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004090 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004091 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004092 case PSA_ALG_CBC_NO_PADDING:
4093 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4094 MBEDTLS_PADDING_NONE );
4095 break;
4096 case PSA_ALG_CBC_PKCS7:
4097 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4098 MBEDTLS_PADDING_PKCS7 );
4099 break;
4100 default:
4101 /* The algorithm doesn't involve padding. */
4102 ret = 0;
4103 break;
4104 }
4105 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004106 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004107#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4108
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004109 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004110 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004111 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4112 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004113 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004114 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004115 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004116#if defined(MBEDTLS_CHACHA20_C)
4117 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004118 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004119 operation->iv_size = 12;
4120#endif
mohammad1603503973b2018-03-12 15:59:30 +02004121
Steven Cooreman7df02922020-09-09 15:28:49 +02004122 status = PSA_SUCCESS;
4123
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004124exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004125 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004126 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004127 if( status == PSA_SUCCESS )
4128 {
4129 /* Update operation flags for both driver and software implementations */
4130 operation->key_set = 1;
4131 }
4132 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004133 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004134
Ronald Cron5c522922020-11-14 16:35:34 +01004135 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004136
Ronald Cron5c522922020-11-14 16:35:34 +01004137 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004138}
4139
Gilles Peskinefe119512018-07-08 21:39:34 +02004140psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004141 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004142 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004143{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004144 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004145}
4146
Gilles Peskinefe119512018-07-08 21:39:34 +02004147psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004148 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004149 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004150{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004151 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004152}
4153
Gilles Peskinefe119512018-07-08 21:39:34 +02004154psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004155 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004156 size_t iv_size,
4157 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004158{
itayzafrir534bd7c2018-08-02 13:56:32 +03004159 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004161 if( operation->iv_set || ! operation->iv_required )
4162 {
4163 return( PSA_ERROR_BAD_STATE );
4164 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004165
Steven Cooremanef8575e2020-09-11 11:44:50 +02004166 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004167 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004168 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004169 iv,
4170 iv_size,
4171 iv_length );
4172 goto exit;
4173 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004174
Moran Peker41deec42018-04-04 15:43:05 +03004175 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004176 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004177 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004178 goto exit;
4179 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004180 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004181 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004182 if( ret != 0 )
4183 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004184 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004185 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004186 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004187
mohammad16038481e742018-03-18 13:57:31 +02004188 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004189 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004190
Moran Peker395db872018-05-31 14:07:14 +03004191exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004192 if( status == PSA_SUCCESS )
4193 operation->iv_set = 1;
4194 else
Moran Peker395db872018-05-31 14:07:14 +03004195 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004196 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004197}
4198
Gilles Peskinefe119512018-07-08 21:39:34 +02004199psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004200 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004201 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004202{
itayzafrir534bd7c2018-08-02 13:56:32 +03004203 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004205 if( operation->iv_set || ! operation->iv_required )
4206 {
4207 return( PSA_ERROR_BAD_STATE );
4208 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004209
Steven Cooremanef8575e2020-09-11 11:44:50 +02004210 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004211 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004212 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004213 iv,
4214 iv_length );
4215 goto exit;
4216 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004217
Moran Pekera28258c2018-05-29 16:25:04 +03004218 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004219 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004220 status = PSA_ERROR_INVALID_ARGUMENT;
4221 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004222 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004223 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4224 status = mbedtls_to_psa_error( ret );
4225exit:
4226 if( status == PSA_SUCCESS )
4227 operation->iv_set = 1;
4228 else
mohammad1603503973b2018-03-12 15:59:30 +02004229 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004230 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004231}
4232
Steven Cooreman177deba2020-09-07 17:14:14 +02004233/* Process input for which the algorithm is set to ECB mode. This requires
4234 * manual processing, since the PSA API is defined as being able to process
4235 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4236 * underlying mbedtls_cipher_update only takes full blocks. */
4237static psa_status_t psa_cipher_update_ecb_internal(
4238 mbedtls_cipher_context_t *ctx,
4239 const uint8_t *input,
4240 size_t input_length,
4241 uint8_t *output,
4242 size_t output_size,
4243 size_t *output_length )
4244{
4245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4246 size_t block_size = ctx->cipher_info->block_size;
4247 size_t internal_output_length = 0;
4248 *output_length = 0;
4249
4250 if( input_length == 0 )
4251 {
4252 status = PSA_SUCCESS;
4253 goto exit;
4254 }
4255
4256 if( ctx->unprocessed_len > 0 )
4257 {
4258 /* Fill up to block size, and run the block if there's a full one. */
4259 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4260
4261 if( input_length < bytes_to_copy )
4262 bytes_to_copy = input_length;
4263
4264 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4265 input, bytes_to_copy );
4266 input_length -= bytes_to_copy;
4267 input += bytes_to_copy;
4268 ctx->unprocessed_len += bytes_to_copy;
4269
4270 if( ctx->unprocessed_len == block_size )
4271 {
4272 status = mbedtls_to_psa_error(
4273 mbedtls_cipher_update( ctx,
4274 ctx->unprocessed_data,
4275 block_size,
4276 output, &internal_output_length ) );
4277
4278 if( status != PSA_SUCCESS )
4279 goto exit;
4280
4281 output += internal_output_length;
4282 output_size -= internal_output_length;
4283 *output_length += internal_output_length;
4284 ctx->unprocessed_len = 0;
4285 }
4286 }
4287
4288 while( input_length >= block_size )
4289 {
4290 /* Run all full blocks we have, one by one */
4291 status = mbedtls_to_psa_error(
4292 mbedtls_cipher_update( ctx, input,
4293 block_size,
4294 output, &internal_output_length ) );
4295
4296 if( status != PSA_SUCCESS )
4297 goto exit;
4298
4299 input_length -= block_size;
4300 input += block_size;
4301
4302 output += internal_output_length;
4303 output_size -= internal_output_length;
4304 *output_length += internal_output_length;
4305 }
4306
4307 if( input_length > 0 )
4308 {
4309 /* Save unprocessed bytes for later processing */
4310 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4311 input, input_length );
4312 ctx->unprocessed_len += input_length;
4313 }
4314
4315 status = PSA_SUCCESS;
4316
4317exit:
4318 return( status );
4319}
4320
Gilles Peskinee553c652018-06-04 16:22:46 +02004321psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4322 const uint8_t *input,
4323 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004324 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004325 size_t output_size,
4326 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004327{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004328 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004329 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004330 if( operation->alg == 0 )
4331 {
4332 return( PSA_ERROR_BAD_STATE );
4333 }
4334 if( operation->iv_required && ! operation->iv_set )
4335 {
4336 return( PSA_ERROR_BAD_STATE );
4337 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004338
Steven Cooremanef8575e2020-09-11 11:44:50 +02004339 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004340 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004341 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004342 input,
4343 input_length,
4344 output,
4345 output_size,
4346 output_length );
4347 goto exit;
4348 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004349
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004350 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004351 {
4352 /* Take the unprocessed partial block left over from previous
4353 * update calls, if any, plus the input to this call. Remove
4354 * the last partial block, if any. You get the data that will be
4355 * output in this call. */
4356 expected_output_size =
4357 ( operation->ctx.cipher.unprocessed_len + input_length )
4358 / operation->block_size * operation->block_size;
4359 }
4360 else
4361 {
4362 expected_output_size = input_length;
4363 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004364
Gilles Peskine89d789c2018-06-04 17:17:16 +02004365 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004366 {
4367 status = PSA_ERROR_BUFFER_TOO_SMALL;
4368 goto exit;
4369 }
mohammad160382759612018-03-12 18:16:40 +02004370
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004371 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4372 {
4373 /* mbedtls_cipher_update has an API inconsistency: it will only
4374 * process a single block at a time in ECB mode. Abstract away that
4375 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004376 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4377 input,
4378 input_length,
4379 output,
4380 output_size,
4381 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004382 }
4383 else
4384 {
4385 status = mbedtls_to_psa_error(
4386 mbedtls_cipher_update( &operation->ctx.cipher, input,
4387 input_length, output, output_length ) );
4388 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004389exit:
4390 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004391 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004392 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004393}
4394
Gilles Peskinee553c652018-06-04 16:22:46 +02004395psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4396 uint8_t *output,
4397 size_t output_size,
4398 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004399{
David Saadab4ecc272019-02-14 13:48:10 +02004400 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004401 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004402 if( operation->alg == 0 )
4403 {
4404 return( PSA_ERROR_BAD_STATE );
4405 }
4406 if( operation->iv_required && ! operation->iv_set )
4407 {
4408 return( PSA_ERROR_BAD_STATE );
4409 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004410
Steven Cooremanef8575e2020-09-11 11:44:50 +02004411 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004412 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004413 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004414 output,
4415 output_size,
4416 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004417 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004418 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004419
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004420 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004421 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004422 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004423 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004424 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004425 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004426 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004427 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004428 }
4429
Steven Cooremanef8575e2020-09-11 11:44:50 +02004430 status = mbedtls_to_psa_error(
4431 mbedtls_cipher_finish( &operation->ctx.cipher,
4432 temp_output_buffer,
4433 output_length ) );
4434 if( status != PSA_SUCCESS )
4435 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004436
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004437 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004438 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004439 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004440 memcpy( output, temp_output_buffer, *output_length );
4441 else
Janos Follath315b51c2018-07-09 16:04:51 +01004442 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004443
Steven Cooremanef8575e2020-09-11 11:44:50 +02004444exit:
4445 if( operation->mbedtls_in_use == 1 )
4446 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004447
Steven Cooremanef8575e2020-09-11 11:44:50 +02004448 if( status == PSA_SUCCESS )
4449 return( psa_cipher_abort( operation ) );
4450 else
4451 {
4452 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004453 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004454
Steven Cooremanef8575e2020-09-11 11:44:50 +02004455 return( status );
4456 }
mohammad1603503973b2018-03-12 15:59:30 +02004457}
4458
Gilles Peskinee553c652018-06-04 16:22:46 +02004459psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4460{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004461 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004462 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004463 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004464 * in use. It's ok to call abort on such an object, and there's
4465 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004466 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004467 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004468
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004469 /* Sanity check (shouldn't happen: operation->alg should
4470 * always have been initialized to a valid value). */
4471 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4472 return( PSA_ERROR_BAD_STATE );
4473
Steven Cooremanef8575e2020-09-11 11:44:50 +02004474 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004475 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004476 else
4477 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004478
Moran Peker41deec42018-04-04 15:43:05 +03004479 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004480 operation->key_set = 0;
4481 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004482 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004483 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004484 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004485 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004486
Moran Peker395db872018-05-31 14:07:14 +03004487 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004488}
4489
Gilles Peskinea0655c32018-04-30 17:06:50 +02004490
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004491
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004492
mohammad16035955c982018-04-26 00:53:03 +03004493/****************************************************************/
4494/* AEAD */
4495/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004496
Gilles Peskineedf9a652018-08-17 18:11:56 +02004497typedef struct
4498{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004499 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004500 const mbedtls_cipher_info_t *cipher_info;
4501 union
4502 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004503 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004504#if defined(MBEDTLS_CCM_C)
4505 mbedtls_ccm_context ccm;
4506#endif /* MBEDTLS_CCM_C */
4507#if defined(MBEDTLS_GCM_C)
4508 mbedtls_gcm_context gcm;
4509#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004510#if defined(MBEDTLS_CHACHAPOLY_C)
4511 mbedtls_chachapoly_context chachapoly;
4512#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004513 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004514 psa_algorithm_t core_alg;
4515 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004516 uint8_t tag_length;
4517} aead_operation_t;
4518
Ronald Cronf95a2b12020-10-22 15:24:49 +02004519#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4520
Gilles Peskine30a9e412019-01-14 18:36:12 +01004521static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004522{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004523 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004524 {
4525#if defined(MBEDTLS_CCM_C)
4526 case PSA_ALG_CCM:
4527 mbedtls_ccm_free( &operation->ctx.ccm );
4528 break;
4529#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004530#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004531 case PSA_ALG_GCM:
4532 mbedtls_gcm_free( &operation->ctx.gcm );
4533 break;
4534#endif /* MBEDTLS_GCM_C */
4535 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004536
Ronald Cron5c522922020-11-14 16:35:34 +01004537 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004538}
4539
4540static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004541 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004542 psa_key_usage_t usage,
4543 psa_algorithm_t alg )
4544{
4545 psa_status_t status;
4546 size_t key_bits;
4547 mbedtls_cipher_id_t cipher_id;
4548
Ronald Cron5c522922020-11-14 16:35:34 +01004549 status = psa_get_and_lock_transparent_key_slot_with_policy(
4550 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004551 if( status != PSA_SUCCESS )
4552 return( status );
4553
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004554 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004555
4556 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004557 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004558 &cipher_id );
4559 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004560 {
4561 status = PSA_ERROR_NOT_SUPPORTED;
4562 goto cleanup;
4563 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004564
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004565 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004566 {
4567#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004568 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4569 operation->core_alg = PSA_ALG_CCM;
4570 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004571 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4572 * The call to mbedtls_ccm_encrypt_and_tag or
4573 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004574 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004575 {
4576 status = PSA_ERROR_INVALID_ARGUMENT;
4577 goto cleanup;
4578 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004579 mbedtls_ccm_init( &operation->ctx.ccm );
4580 status = mbedtls_to_psa_error(
4581 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004582 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004583 (unsigned int) key_bits ) );
4584 if( status != 0 )
4585 goto cleanup;
4586 break;
4587#endif /* MBEDTLS_CCM_C */
4588
4589#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004590 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4591 operation->core_alg = PSA_ALG_GCM;
4592 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004593 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4594 * The call to mbedtls_gcm_crypt_and_tag or
4595 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004596 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004597 {
4598 status = PSA_ERROR_INVALID_ARGUMENT;
4599 goto cleanup;
4600 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004601 mbedtls_gcm_init( &operation->ctx.gcm );
4602 status = mbedtls_to_psa_error(
4603 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004604 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004605 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004606 if( status != 0 )
4607 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004608 break;
4609#endif /* MBEDTLS_GCM_C */
4610
Gilles Peskine26869f22019-05-06 15:25:00 +02004611#if defined(MBEDTLS_CHACHAPOLY_C)
4612 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4613 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4614 operation->full_tag_length = 16;
4615 /* We only support the default tag length. */
4616 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004617 {
4618 status = PSA_ERROR_NOT_SUPPORTED;
4619 goto cleanup;
4620 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004621 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4622 status = mbedtls_to_psa_error(
4623 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004624 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004625 if( status != 0 )
4626 goto cleanup;
4627 break;
4628#endif /* MBEDTLS_CHACHAPOLY_C */
4629
Gilles Peskineedf9a652018-08-17 18:11:56 +02004630 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004631 status = PSA_ERROR_NOT_SUPPORTED;
4632 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004633 }
4634
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004635 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4636 {
4637 status = PSA_ERROR_INVALID_ARGUMENT;
4638 goto cleanup;
4639 }
4640 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004641
Gilles Peskineedf9a652018-08-17 18:11:56 +02004642 return( PSA_SUCCESS );
4643
4644cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004645 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004646 return( status );
4647}
4648
Ronald Croncf56a0a2020-08-04 09:51:30 +02004649psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004650 psa_algorithm_t alg,
4651 const uint8_t *nonce,
4652 size_t nonce_length,
4653 const uint8_t *additional_data,
4654 size_t additional_data_length,
4655 const uint8_t *plaintext,
4656 size_t plaintext_length,
4657 uint8_t *ciphertext,
4658 size_t ciphertext_size,
4659 size_t *ciphertext_length )
4660{
mohammad16035955c982018-04-26 00:53:03 +03004661 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004662 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004663 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004664
mohammad1603f08a5502018-06-03 15:05:47 +03004665 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004666
Ronald Croncf56a0a2020-08-04 09:51:30 +02004667 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004668 if( status != PSA_SUCCESS )
4669 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004670
Gilles Peskineedf9a652018-08-17 18:11:56 +02004671 /* For all currently supported modes, the tag is at the end of the
4672 * ciphertext. */
4673 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4674 {
4675 status = PSA_ERROR_BUFFER_TOO_SMALL;
4676 goto exit;
4677 }
4678 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004679
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004680#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004681 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004682 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004683 status = mbedtls_to_psa_error(
4684 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4685 MBEDTLS_GCM_ENCRYPT,
4686 plaintext_length,
4687 nonce, nonce_length,
4688 additional_data, additional_data_length,
4689 plaintext, ciphertext,
4690 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004691 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004692 else
4693#endif /* MBEDTLS_GCM_C */
4694#if defined(MBEDTLS_CCM_C)
4695 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004696 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004697 status = mbedtls_to_psa_error(
4698 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4699 plaintext_length,
4700 nonce, nonce_length,
4701 additional_data,
4702 additional_data_length,
4703 plaintext, ciphertext,
4704 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004705 }
mohammad16035c8845f2018-05-09 05:40:09 -07004706 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004707#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004708#if defined(MBEDTLS_CHACHAPOLY_C)
4709 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4710 {
4711 if( nonce_length != 12 || operation.tag_length != 16 )
4712 {
4713 status = PSA_ERROR_NOT_SUPPORTED;
4714 goto exit;
4715 }
4716 status = mbedtls_to_psa_error(
4717 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4718 plaintext_length,
4719 nonce,
4720 additional_data,
4721 additional_data_length,
4722 plaintext,
4723 ciphertext,
4724 tag ) );
4725 }
4726 else
4727#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004728 {
mohammad1603554faad2018-06-03 15:07:38 +03004729 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004730 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004731
Gilles Peskineedf9a652018-08-17 18:11:56 +02004732 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4733 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004734
Gilles Peskineedf9a652018-08-17 18:11:56 +02004735exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004736 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004737 if( status == PSA_SUCCESS )
4738 *ciphertext_length = plaintext_length + operation.tag_length;
4739 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004740}
4741
Gilles Peskineee652a32018-06-01 19:23:52 +02004742/* Locate the tag in a ciphertext buffer containing the encrypted data
4743 * followed by the tag. Return the length of the part preceding the tag in
4744 * *plaintext_length. This is the size of the plaintext in modes where
4745 * the encrypted data has the same size as the plaintext, such as
4746 * CCM and GCM. */
4747static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4748 const uint8_t *ciphertext,
4749 size_t ciphertext_length,
4750 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004751 const uint8_t **p_tag )
4752{
4753 size_t payload_length;
4754 if( tag_length > ciphertext_length )
4755 return( PSA_ERROR_INVALID_ARGUMENT );
4756 payload_length = ciphertext_length - tag_length;
4757 if( payload_length > plaintext_size )
4758 return( PSA_ERROR_BUFFER_TOO_SMALL );
4759 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004760 return( PSA_SUCCESS );
4761}
4762
Ronald Croncf56a0a2020-08-04 09:51:30 +02004763psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004764 psa_algorithm_t alg,
4765 const uint8_t *nonce,
4766 size_t nonce_length,
4767 const uint8_t *additional_data,
4768 size_t additional_data_length,
4769 const uint8_t *ciphertext,
4770 size_t ciphertext_length,
4771 uint8_t *plaintext,
4772 size_t plaintext_size,
4773 size_t *plaintext_length )
4774{
mohammad16035955c982018-04-26 00:53:03 +03004775 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004776 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004777 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004778
Gilles Peskineee652a32018-06-01 19:23:52 +02004779 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004780
Ronald Croncf56a0a2020-08-04 09:51:30 +02004781 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004782 if( status != PSA_SUCCESS )
4783 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004784
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004785 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4786 ciphertext, ciphertext_length,
4787 plaintext_size, &tag );
4788 if( status != PSA_SUCCESS )
4789 goto exit;
4790
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004791#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004792 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004793 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004794 status = mbedtls_to_psa_error(
4795 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4796 ciphertext_length - operation.tag_length,
4797 nonce, nonce_length,
4798 additional_data,
4799 additional_data_length,
4800 tag, operation.tag_length,
4801 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004802 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004803 else
4804#endif /* MBEDTLS_GCM_C */
4805#if defined(MBEDTLS_CCM_C)
4806 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004807 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004808 status = mbedtls_to_psa_error(
4809 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4810 ciphertext_length - operation.tag_length,
4811 nonce, nonce_length,
4812 additional_data,
4813 additional_data_length,
4814 ciphertext, plaintext,
4815 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004816 }
mohammad160339574652018-06-01 04:39:53 -07004817 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004818#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004819#if defined(MBEDTLS_CHACHAPOLY_C)
4820 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4821 {
4822 if( nonce_length != 12 || operation.tag_length != 16 )
4823 {
4824 status = PSA_ERROR_NOT_SUPPORTED;
4825 goto exit;
4826 }
4827 status = mbedtls_to_psa_error(
4828 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4829 ciphertext_length - operation.tag_length,
4830 nonce,
4831 additional_data,
4832 additional_data_length,
4833 tag,
4834 ciphertext,
4835 plaintext ) );
4836 }
4837 else
4838#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004839 {
mohammad1603554faad2018-06-03 15:07:38 +03004840 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004841 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004842
Gilles Peskineedf9a652018-08-17 18:11:56 +02004843 if( status != PSA_SUCCESS && plaintext_size != 0 )
4844 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004845
Gilles Peskineedf9a652018-08-17 18:11:56 +02004846exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004847 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004848 if( status == PSA_SUCCESS )
4849 *plaintext_length = ciphertext_length - operation.tag_length;
4850 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004851}
4852
Gilles Peskinea0655c32018-04-30 17:06:50 +02004853
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004854
Gilles Peskine20035e32018-02-03 22:44:14 +01004855/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004856/* Generators */
4857/****************************************************************/
4858
John Durkop07cc04a2020-11-16 22:08:34 -08004859#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4860 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4861 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4862#define AT_LEAST_ONE_BUILTIN_KDF
4863#endif
4864
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004865#define HKDF_STATE_INIT 0 /* no input yet */
4866#define HKDF_STATE_STARTED 1 /* got salt */
4867#define HKDF_STATE_KEYED 2 /* got key */
4868#define HKDF_STATE_OUTPUT 3 /* output started */
4869
Gilles Peskinecbe66502019-05-16 16:59:18 +02004870static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004871 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004872{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004873 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4874 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004875 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004876 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004877}
4878
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004879psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004880{
4881 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004882 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004883 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004884 {
4885 /* The object has (apparently) been initialized but it is not
4886 * in use. It's ok to call abort on such an object, and there's
4887 * nothing to do. */
4888 }
4889 else
John Durkopd0321952020-10-29 21:37:36 -07004890#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004891 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004892 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004893 mbedtls_free( operation->ctx.hkdf.info );
4894 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004895 }
John Durkop07cc04a2020-11-16 22:08:34 -08004896 else
4897#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4898#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4899 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4900 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004901 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004902 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004903 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004904 if( operation->ctx.tls12_prf.seed != NULL )
4905 {
4906 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4907 operation->ctx.tls12_prf.seed_length );
4908 mbedtls_free( operation->ctx.tls12_prf.seed );
4909 }
4910
4911 if( operation->ctx.tls12_prf.label != NULL )
4912 {
4913 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4914 operation->ctx.tls12_prf.label_length );
4915 mbedtls_free( operation->ctx.tls12_prf.label );
4916 }
4917
4918 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4919
4920 /* We leave the fields Ai and output_block to be erased safely by the
4921 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004922 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004923 else
John Durkop07cc04a2020-11-16 22:08:34 -08004924#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4925 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004926 {
4927 status = PSA_ERROR_BAD_STATE;
4928 }
Janos Follath083036a2019-06-11 10:22:26 +01004929 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004930 return( status );
4931}
4932
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004933psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004934 size_t *capacity)
4935{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004936 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004937 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004938 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004939 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004940 }
4941
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004942 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004943 return( PSA_SUCCESS );
4944}
4945
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004946psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004947 size_t capacity )
4948{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004949 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004950 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004951 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004952 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004953 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004954 return( PSA_SUCCESS );
4955}
4956
John Durkopd0321952020-10-29 21:37:36 -07004957#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004958/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004959 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004960static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004961 psa_algorithm_t hash_alg,
4962 uint8_t *output,
4963 size_t output_length )
4964{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004965 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004966 psa_status_t status;
4967
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004968 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4969 return( PSA_ERROR_BAD_STATE );
4970 hkdf->state = HKDF_STATE_OUTPUT;
4971
Gilles Peskinebef7f142018-07-12 17:22:21 +02004972 while( output_length != 0 )
4973 {
4974 /* Copy what remains of the current block */
4975 uint8_t n = hash_length - hkdf->offset_in_block;
4976 if( n > output_length )
4977 n = (uint8_t) output_length;
4978 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4979 output += n;
4980 output_length -= n;
4981 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004982 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004983 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004984 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004985 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004986 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004987 * object was corrupted or if this function is called directly
4988 * inside the library. */
4989 if( hkdf->block_number == 0xff )
4990 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004991
4992 /* We need a new block */
4993 ++hkdf->block_number;
4994 hkdf->offset_in_block = 0;
4995 status = psa_hmac_setup_internal( &hkdf->hmac,
4996 hkdf->prk, hash_length,
4997 hash_alg );
4998 if( status != PSA_SUCCESS )
4999 return( status );
5000 if( hkdf->block_number != 1 )
5001 {
5002 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5003 hkdf->output_block,
5004 hash_length );
5005 if( status != PSA_SUCCESS )
5006 return( status );
5007 }
5008 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5009 hkdf->info,
5010 hkdf->info_length );
5011 if( status != PSA_SUCCESS )
5012 return( status );
5013 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5014 &hkdf->block_number, 1 );
5015 if( status != PSA_SUCCESS )
5016 return( status );
5017 status = psa_hmac_finish_internal( &hkdf->hmac,
5018 hkdf->output_block,
5019 sizeof( hkdf->output_block ) );
5020 if( status != PSA_SUCCESS )
5021 return( status );
5022 }
5023
5024 return( PSA_SUCCESS );
5025}
John Durkop07cc04a2020-11-16 22:08:34 -08005026#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005027
John Durkop07cc04a2020-11-16 22:08:34 -08005028#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5029 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005030static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5031 psa_tls12_prf_key_derivation_t *tls12_prf,
5032 psa_algorithm_t alg )
5033{
5034 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005035 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005036 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5037 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005038
Janos Follath7742fee2019-06-17 12:58:10 +01005039 /* We can't be wanting more output after block 0xff, otherwise
5040 * the capacity check in psa_key_derivation_output_bytes() would have
5041 * prevented this call. It could happen only if the operation
5042 * object was corrupted or if this function is called directly
5043 * inside the library. */
5044 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005045 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005046
5047 /* We need a new block */
5048 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005049 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005050
5051 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5052 *
5053 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5054 *
5055 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5056 * HMAC_hash(secret, A(2) + seed) +
5057 * HMAC_hash(secret, A(3) + seed) + ...
5058 *
5059 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005060 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005061 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005062 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005063 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005064 * is currently extracted as `output_block` and where i is
5065 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005066 */
5067
Janos Follathea29bfb2019-06-19 12:21:20 +01005068 /* Save the hash context before using it, to preserve the hash state with
5069 * only the inner padding in it. We need this, because inner padding depends
5070 * on the key (secret in the RFC's terminology). */
5071 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5072 if( status != PSA_SUCCESS )
5073 goto cleanup;
5074
5075 /* Calculate A(i) where i = tls12_prf->block_number. */
5076 if( tls12_prf->block_number == 1 )
5077 {
5078 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5079 * the variable seed and in this instance means it in the context of the
5080 * P_hash function, where seed = label + seed.) */
5081 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5082 tls12_prf->label, tls12_prf->label_length );
5083 if( status != PSA_SUCCESS )
5084 goto cleanup;
5085 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5086 tls12_prf->seed, tls12_prf->seed_length );
5087 if( status != PSA_SUCCESS )
5088 goto cleanup;
5089 }
5090 else
5091 {
5092 /* A(i) = HMAC_hash(secret, A(i-1)) */
5093 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5094 tls12_prf->Ai, hash_length );
5095 if( status != PSA_SUCCESS )
5096 goto cleanup;
5097 }
5098
5099 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5100 tls12_prf->Ai, hash_length );
5101 if( status != PSA_SUCCESS )
5102 goto cleanup;
5103 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5104 if( status != PSA_SUCCESS )
5105 goto cleanup;
5106
5107 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5108 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5109 tls12_prf->Ai, hash_length );
5110 if( status != PSA_SUCCESS )
5111 goto cleanup;
5112 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5113 tls12_prf->label, tls12_prf->label_length );
5114 if( status != PSA_SUCCESS )
5115 goto cleanup;
5116 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5117 tls12_prf->seed, tls12_prf->seed_length );
5118 if( status != PSA_SUCCESS )
5119 goto cleanup;
5120 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5121 tls12_prf->output_block, hash_length );
5122 if( status != PSA_SUCCESS )
5123 goto cleanup;
5124 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5125 if( status != PSA_SUCCESS )
5126 goto cleanup;
5127
Janos Follath7742fee2019-06-17 12:58:10 +01005128
5129cleanup:
5130
Janos Follathea29bfb2019-06-19 12:21:20 +01005131 cleanup_status = psa_hash_abort( &backup );
5132 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5133 status = cleanup_status;
5134
5135 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005136}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005137
Janos Follath844eb0e2019-06-19 12:10:49 +01005138static psa_status_t psa_key_derivation_tls12_prf_read(
5139 psa_tls12_prf_key_derivation_t *tls12_prf,
5140 psa_algorithm_t alg,
5141 uint8_t *output,
5142 size_t output_length )
5143{
5144 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005145 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005146 psa_status_t status;
5147 uint8_t offset, length;
5148
5149 while( output_length != 0 )
5150 {
5151 /* Check if we have fully processed the current block. */
5152 if( tls12_prf->left_in_block == 0 )
5153 {
5154 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5155 alg );
5156 if( status != PSA_SUCCESS )
5157 return( status );
5158
5159 continue;
5160 }
5161
5162 if( tls12_prf->left_in_block > output_length )
5163 length = (uint8_t) output_length;
5164 else
5165 length = tls12_prf->left_in_block;
5166
5167 offset = hash_length - tls12_prf->left_in_block;
5168 memcpy( output, tls12_prf->output_block + offset, length );
5169 output += length;
5170 output_length -= length;
5171 tls12_prf->left_in_block -= length;
5172 }
5173
5174 return( PSA_SUCCESS );
5175}
John Durkop07cc04a2020-11-16 22:08:34 -08005176#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5177 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005178
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005179psa_status_t psa_key_derivation_output_bytes(
5180 psa_key_derivation_operation_t *operation,
5181 uint8_t *output,
5182 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005183{
5184 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005185 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005186
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005187 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005188 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005190 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005191 }
5192
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005194 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005195 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005196 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005197 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005198 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005199 goto exit;
5200 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005201 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005202 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005203 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005204 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005205 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5206 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005207 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005208 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005209 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005210 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005211 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005212
John Durkopd0321952020-10-29 21:37:36 -07005213#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005214 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005215 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005216 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005218 output, output_length );
5219 }
Janos Follathadbec812019-06-14 11:05:39 +01005220 else
John Durkop07cc04a2020-11-16 22:08:34 -08005221#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5222#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5223 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005224 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005225 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005226 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005227 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005228 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005229 output_length );
5230 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005231 else
John Durkop07cc04a2020-11-16 22:08:34 -08005232#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5233 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005234 {
5235 return( PSA_ERROR_BAD_STATE );
5236 }
5237
5238exit:
5239 if( status != PSA_SUCCESS )
5240 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005241 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005242 * This allows us to differentiate between exhausted operations and
5243 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5244 * operations. */
5245 psa_algorithm_t alg = operation->alg;
5246 psa_key_derivation_abort( operation );
5247 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005248 memset( output, '!', output_length );
5249 }
5250 return( status );
5251}
5252
Gilles Peskine08542d82018-07-19 17:05:42 +02005253#if defined(MBEDTLS_DES_C)
5254static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5255{
5256 if( data_size >= 8 )
5257 mbedtls_des_key_set_parity( data );
5258 if( data_size >= 16 )
5259 mbedtls_des_key_set_parity( data + 8 );
5260 if( data_size >= 24 )
5261 mbedtls_des_key_set_parity( data + 16 );
5262}
5263#endif /* MBEDTLS_DES_C */
5264
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005265static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005266 psa_key_slot_t *slot,
5267 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005268 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005269{
5270 uint8_t *data = NULL;
5271 size_t bytes = PSA_BITS_TO_BYTES( bits );
5272 psa_status_t status;
5273
Gilles Peskine8e338702019-07-30 20:06:31 +02005274 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005275 return( PSA_ERROR_INVALID_ARGUMENT );
5276 if( bits % 8 != 0 )
5277 return( PSA_ERROR_INVALID_ARGUMENT );
5278 data = mbedtls_calloc( 1, bytes );
5279 if( data == NULL )
5280 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5281
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005283 if( status != PSA_SUCCESS )
5284 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005285#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005286 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005287 psa_des_set_key_parity( data, bytes );
5288#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005289 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005290
5291exit:
5292 mbedtls_free( data );
5293 return( status );
5294}
5295
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005296psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005297 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005298 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005299{
5300 psa_status_t status;
5301 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005302 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005303
Ronald Cron81709fc2020-11-14 12:10:32 +01005304 *key = MBEDTLS_SVC_KEY_ID_INIT;
5305
Gilles Peskine0f84d622019-09-12 19:03:13 +02005306 /* Reject any attempt to create a zero-length key so that we don't
5307 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5308 if( psa_get_key_bits( attributes ) == 0 )
5309 return( PSA_ERROR_INVALID_ARGUMENT );
5310
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005311 if( ! operation->can_output_key )
5312 return( PSA_ERROR_NOT_PERMITTED );
5313
Ronald Cron81709fc2020-11-14 12:10:32 +01005314 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5315 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005316#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5317 if( driver != NULL )
5318 {
5319 /* Deriving a key in a secure element is not implemented yet. */
5320 status = PSA_ERROR_NOT_SUPPORTED;
5321 }
5322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005323 if( status == PSA_SUCCESS )
5324 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005325 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005326 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005327 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005328 }
5329 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005330 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005331 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005332 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005333
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005334 return( status );
5335}
5336
Gilles Peskineeab56e42018-07-12 17:12:33 +02005337
5338
5339/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005340/* Key derivation */
5341/****************************************************************/
5342
John Durkop07cc04a2020-11-16 22:08:34 -08005343#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005344static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005345 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005346 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005347{
John Durkop07cc04a2020-11-16 22:08:34 -08005348 int is_kdf_alg_supported;
5349
Janos Follath5fe19732019-06-20 15:09:30 +01005350 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5351 * initialisers for this union leave some bytes unspecified.) */
5352 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5353
Gilles Peskine969c5d62019-01-16 15:53:06 +01005354 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005355#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005356 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5357 is_kdf_alg_supported = 1;
5358 else
5359#endif
5360#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5361 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5362 is_kdf_alg_supported = 1;
5363 else
5364#endif
5365#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5366 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5367 is_kdf_alg_supported = 1;
5368 else
5369#endif
5370 is_kdf_alg_supported = 0;
5371
5372 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005373 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005374 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005375 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005376 if( hash_size == 0 )
5377 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005378 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5379 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005380 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005381 {
5382 return( PSA_ERROR_NOT_SUPPORTED );
5383 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005384 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005385 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005386 }
John Durkop07cc04a2020-11-16 22:08:34 -08005387
5388 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005389}
John Durkop07cc04a2020-11-16 22:08:34 -08005390#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005391
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005392psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005393 psa_algorithm_t alg )
5394{
5395 psa_status_t status;
5396
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005397 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005398 return( PSA_ERROR_BAD_STATE );
5399
Gilles Peskine6843c292019-01-18 16:44:49 +01005400 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5401 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005402#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005403 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005404 {
5405 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005406 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005407 }
5408 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5409 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005410 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005411 }
John Durkop07cc04a2020-11-16 22:08:34 -08005412#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005413 else
5414 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005415
5416 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005417 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005418 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005419}
5420
John Durkopd0321952020-10-29 21:37:36 -07005421#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005422static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005423 psa_algorithm_t hash_alg,
5424 psa_key_derivation_step_t step,
5425 const uint8_t *data,
5426 size_t data_length )
5427{
5428 psa_status_t status;
5429 switch( step )
5430 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005431 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005432 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005433 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005434 status = psa_hmac_setup_internal( &hkdf->hmac,
5435 data, data_length,
5436 hash_alg );
5437 if( status != PSA_SUCCESS )
5438 return( status );
5439 hkdf->state = HKDF_STATE_STARTED;
5440 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005441 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005442 /* If no salt was provided, use an empty salt. */
5443 if( hkdf->state == HKDF_STATE_INIT )
5444 {
5445 status = psa_hmac_setup_internal( &hkdf->hmac,
5446 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005447 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005448 if( status != PSA_SUCCESS )
5449 return( status );
5450 hkdf->state = HKDF_STATE_STARTED;
5451 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005452 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005453 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005454 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5455 data, data_length );
5456 if( status != PSA_SUCCESS )
5457 return( status );
5458 status = psa_hmac_finish_internal( &hkdf->hmac,
5459 hkdf->prk,
5460 sizeof( hkdf->prk ) );
5461 if( status != PSA_SUCCESS )
5462 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005463 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005464 hkdf->block_number = 0;
5465 hkdf->state = HKDF_STATE_KEYED;
5466 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005467 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005468 if( hkdf->state == HKDF_STATE_OUTPUT )
5469 return( PSA_ERROR_BAD_STATE );
5470 if( hkdf->info_set )
5471 return( PSA_ERROR_BAD_STATE );
5472 hkdf->info_length = data_length;
5473 if( data_length != 0 )
5474 {
5475 hkdf->info = mbedtls_calloc( 1, data_length );
5476 if( hkdf->info == NULL )
5477 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5478 memcpy( hkdf->info, data, data_length );
5479 }
5480 hkdf->info_set = 1;
5481 return( PSA_SUCCESS );
5482 default:
5483 return( PSA_ERROR_INVALID_ARGUMENT );
5484 }
5485}
John Durkop07cc04a2020-11-16 22:08:34 -08005486#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005487
John Durkop07cc04a2020-11-16 22:08:34 -08005488#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5489 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005490static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5491 const uint8_t *data,
5492 size_t data_length )
5493{
5494 if( prf->state != TLS12_PRF_STATE_INIT )
5495 return( PSA_ERROR_BAD_STATE );
5496
Janos Follathd6dce9f2019-07-04 09:11:38 +01005497 if( data_length != 0 )
5498 {
5499 prf->seed = mbedtls_calloc( 1, data_length );
5500 if( prf->seed == NULL )
5501 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005502
Janos Follathd6dce9f2019-07-04 09:11:38 +01005503 memcpy( prf->seed, data, data_length );
5504 prf->seed_length = data_length;
5505 }
Janos Follathf08e2652019-06-13 09:05:41 +01005506
5507 prf->state = TLS12_PRF_STATE_SEED_SET;
5508
5509 return( PSA_SUCCESS );
5510}
5511
Janos Follath81550542019-06-13 14:26:34 +01005512static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5513 psa_algorithm_t hash_alg,
5514 const uint8_t *data,
5515 size_t data_length )
5516{
5517 psa_status_t status;
5518 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5519 return( PSA_ERROR_BAD_STATE );
5520
5521 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5522 if( status != PSA_SUCCESS )
5523 return( status );
5524
5525 prf->state = TLS12_PRF_STATE_KEY_SET;
5526
5527 return( PSA_SUCCESS );
5528}
5529
Janos Follath63028dd2019-06-13 09:15:47 +01005530static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5531 const uint8_t *data,
5532 size_t data_length )
5533{
5534 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5535 return( PSA_ERROR_BAD_STATE );
5536
Janos Follathd6dce9f2019-07-04 09:11:38 +01005537 if( data_length != 0 )
5538 {
5539 prf->label = mbedtls_calloc( 1, data_length );
5540 if( prf->label == NULL )
5541 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005542
Janos Follathd6dce9f2019-07-04 09:11:38 +01005543 memcpy( prf->label, data, data_length );
5544 prf->label_length = data_length;
5545 }
Janos Follath63028dd2019-06-13 09:15:47 +01005546
5547 prf->state = TLS12_PRF_STATE_LABEL_SET;
5548
5549 return( PSA_SUCCESS );
5550}
5551
Janos Follathb03233e2019-06-11 15:30:30 +01005552static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5553 psa_algorithm_t hash_alg,
5554 psa_key_derivation_step_t step,
5555 const uint8_t *data,
5556 size_t data_length )
5557{
Janos Follathb03233e2019-06-11 15:30:30 +01005558 switch( step )
5559 {
Janos Follathf08e2652019-06-13 09:05:41 +01005560 case PSA_KEY_DERIVATION_INPUT_SEED:
5561 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005562 case PSA_KEY_DERIVATION_INPUT_SECRET:
5563 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005564 case PSA_KEY_DERIVATION_INPUT_LABEL:
5565 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005566 default:
5567 return( PSA_ERROR_INVALID_ARGUMENT );
5568 }
5569}
John Durkop07cc04a2020-11-16 22:08:34 -08005570#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5571 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5572
5573#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5574static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5575 psa_tls12_prf_key_derivation_t *prf,
5576 psa_algorithm_t hash_alg,
5577 const uint8_t *data,
5578 size_t data_length )
5579{
5580 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005581 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005582 uint8_t *cur = pms;
5583
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005584 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005585 return( PSA_ERROR_INVALID_ARGUMENT );
5586
5587 /* Quoting RFC 4279, Section 2:
5588 *
5589 * The premaster secret is formed as follows: if the PSK is N octets
5590 * long, concatenate a uint16 with the value N, N zero octets, a second
5591 * uint16 with the value N, and the PSK itself.
5592 */
5593
5594 *cur++ = ( data_length >> 8 ) & 0xff;
5595 *cur++ = ( data_length >> 0 ) & 0xff;
5596 memset( cur, 0, data_length );
5597 cur += data_length;
5598 *cur++ = pms[0];
5599 *cur++ = pms[1];
5600 memcpy( cur, data, data_length );
5601 cur += data_length;
5602
5603 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5604
5605 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5606 return( status );
5607}
Janos Follath6660f0e2019-06-17 08:44:03 +01005608
5609static psa_status_t psa_tls12_prf_psk_to_ms_input(
5610 psa_tls12_prf_key_derivation_t *prf,
5611 psa_algorithm_t hash_alg,
5612 psa_key_derivation_step_t step,
5613 const uint8_t *data,
5614 size_t data_length )
5615{
5616 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005617 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005618 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5619 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005620 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005621
5622 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5623}
John Durkop07cc04a2020-11-16 22:08:34 -08005624#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005625
Gilles Peskineb8965192019-09-24 16:21:10 +02005626/** Check whether the given key type is acceptable for the given
5627 * input step of a key derivation.
5628 *
5629 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5630 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5631 * Both secret and non-secret inputs can alternatively have the type
5632 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5633 * that the input was passed as a buffer rather than via a key object.
5634 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005635static int psa_key_derivation_check_input_type(
5636 psa_key_derivation_step_t step,
5637 psa_key_type_t key_type )
5638{
5639 switch( step )
5640 {
5641 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005642 if( key_type == PSA_KEY_TYPE_DERIVE )
5643 return( PSA_SUCCESS );
5644 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005645 return( PSA_SUCCESS );
5646 break;
5647 case PSA_KEY_DERIVATION_INPUT_LABEL:
5648 case PSA_KEY_DERIVATION_INPUT_SALT:
5649 case PSA_KEY_DERIVATION_INPUT_INFO:
5650 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005651 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5652 return( PSA_SUCCESS );
5653 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005654 return( PSA_SUCCESS );
5655 break;
5656 }
5657 return( PSA_ERROR_INVALID_ARGUMENT );
5658}
5659
Janos Follathb80a94e2019-06-12 15:54:46 +01005660static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005661 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005662 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005663 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005664 const uint8_t *data,
5665 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005666{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005667 psa_status_t status;
5668 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5669
5670 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005671 if( status != PSA_SUCCESS )
5672 goto exit;
5673
John Durkopd0321952020-10-29 21:37:36 -07005674#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005675 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005676 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005677 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005678 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005679 step, data, data_length );
5680 }
John Durkop07cc04a2020-11-16 22:08:34 -08005681 else
5682#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5683#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5684 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005685 {
Janos Follathb03233e2019-06-11 15:30:30 +01005686 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5687 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5688 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005689 }
John Durkop07cc04a2020-11-16 22:08:34 -08005690 else
5691#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5692#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5693 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005694 {
5695 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5696 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5697 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005698 }
5699 else
John Durkop07cc04a2020-11-16 22:08:34 -08005700#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005701 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005702 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005703 return( PSA_ERROR_BAD_STATE );
5704 }
5705
Gilles Peskine224b0d62019-09-23 18:13:17 +02005706exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005707 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005708 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005709 return( status );
5710}
5711
Janos Follath51f4a0f2019-06-14 11:35:55 +01005712psa_status_t psa_key_derivation_input_bytes(
5713 psa_key_derivation_operation_t *operation,
5714 psa_key_derivation_step_t step,
5715 const uint8_t *data,
5716 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005717{
Gilles Peskineb8965192019-09-24 16:21:10 +02005718 return( psa_key_derivation_input_internal( operation, step,
5719 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005720 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005721}
5722
Janos Follath51f4a0f2019-06-14 11:35:55 +01005723psa_status_t psa_key_derivation_input_key(
5724 psa_key_derivation_operation_t *operation,
5725 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005726 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005727{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005728 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005729 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005730 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005731
Ronald Cron5c522922020-11-14 16:35:34 +01005732 status = psa_get_and_lock_transparent_key_slot_with_policy(
5733 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005734 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005735 {
5736 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005737 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005738 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005739
5740 /* Passing a key object as a SECRET input unlocks the permission
5741 * to output to a key object. */
5742 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5743 operation->can_output_key = 1;
5744
Ronald Cronf95a2b12020-10-22 15:24:49 +02005745 status = psa_key_derivation_input_internal( operation,
5746 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005747 slot->key.data,
5748 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005749
Ronald Cron5c522922020-11-14 16:35:34 +01005750 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005751
Ronald Cron5c522922020-11-14 16:35:34 +01005752 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005753}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005754
5755
5756
5757/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005758/* Key agreement */
5759/****************************************************************/
5760
John Durkop6ba40d12020-11-10 08:50:04 -08005761#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005762static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5763 size_t peer_key_length,
5764 const mbedtls_ecp_keypair *our_key,
5765 uint8_t *shared_secret,
5766 size_t shared_secret_size,
5767 size_t *shared_secret_length )
5768{
Steven Cooremand4867872020-08-05 16:31:39 +02005769 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005770 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005771 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005772 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005773 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005774 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005775
Ronald Cron90857082020-11-25 14:58:33 +01005776 status = mbedtls_psa_ecp_load_representation(
5777 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5778 peer_key,
5779 peer_key_length,
5780 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005781 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005782 goto exit;
5783
Jaeden Amero97271b32019-01-10 19:38:51 +00005784 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005785 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005786 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005787 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005788 status = mbedtls_to_psa_error(
5789 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5790 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005791 goto exit;
5792
Jaeden Amero97271b32019-01-10 19:38:51 +00005793 status = mbedtls_to_psa_error(
5794 mbedtls_ecdh_calc_secret( &ecdh,
5795 shared_secret_length,
5796 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005797 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005798 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005799 if( status != PSA_SUCCESS )
5800 goto exit;
5801 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5802 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005803
5804exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005805 if( status != PSA_SUCCESS )
5806 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005807 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005808 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005809 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005810
Jaeden Amero97271b32019-01-10 19:38:51 +00005811 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005812}
John Durkop6ba40d12020-11-10 08:50:04 -08005813#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005814
Gilles Peskine01d718c2018-09-18 12:01:02 +02005815#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5816
Gilles Peskine0216fe12019-04-11 21:23:21 +02005817static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5818 psa_key_slot_t *private_key,
5819 const uint8_t *peer_key,
5820 size_t peer_key_length,
5821 uint8_t *shared_secret,
5822 size_t shared_secret_size,
5823 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005824{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005825 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005826 {
John Durkop6ba40d12020-11-10 08:50:04 -08005827#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005828 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005829 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005830 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005831 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005832 psa_status_t status = mbedtls_psa_ecp_load_representation(
5833 private_key->attr.type,
5834 private_key->key.data,
5835 private_key->key.bytes,
5836 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005837 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005838 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005839 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005840 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005841 shared_secret, shared_secret_size,
5842 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005843 mbedtls_ecp_keypair_free( ecp );
5844 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005845 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005846#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005847 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005848 (void) private_key;
5849 (void) peer_key;
5850 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005851 (void) shared_secret;
5852 (void) shared_secret_size;
5853 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005854 return( PSA_ERROR_NOT_SUPPORTED );
5855 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005856}
5857
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005858/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005859 * to potentially free embedded data structures and wipe confidential data.
5860 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005861static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005862 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005863 psa_key_slot_t *private_key,
5864 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005865 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005866{
5867 psa_status_t status;
5868 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5869 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005870 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005871
5872 /* Step 1: run the secret agreement algorithm to generate the shared
5873 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005874 status = psa_key_agreement_raw_internal( ka_alg,
5875 private_key,
5876 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005877 shared_secret,
5878 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005879 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005880 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005881 goto exit;
5882
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005883 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005884 * the shared secret. A shared secret is permitted wherever a key
5885 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005886 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005887 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005888 shared_secret,
5889 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005890exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005891 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005892 return( status );
5893}
5894
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005895psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005896 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005897 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005898 const uint8_t *peer_key,
5899 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005900{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005902 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005903 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005904
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005905 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005906 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005907 status = psa_get_and_lock_transparent_key_slot_with_policy(
5908 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005909 if( status != PSA_SUCCESS )
5910 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005911 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005912 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005913 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005914 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005915 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005916 else
5917 {
5918 /* If a private key has been added as SECRET, we allow the derived
5919 * key material to be used as a key in PSA Crypto. */
5920 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5921 operation->can_output_key = 1;
5922 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005923
Ronald Cron5c522922020-11-14 16:35:34 +01005924 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005925
Ronald Cron5c522922020-11-14 16:35:34 +01005926 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005927}
5928
Gilles Peskinebe697d82019-05-16 18:00:41 +02005929psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005930 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005931 const uint8_t *peer_key,
5932 size_t peer_key_length,
5933 uint8_t *output,
5934 size_t output_size,
5935 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005936{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005937 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005938 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005939 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005940
5941 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5942 {
5943 status = PSA_ERROR_INVALID_ARGUMENT;
5944 goto exit;
5945 }
Ronald Cron5c522922020-11-14 16:35:34 +01005946 status = psa_get_and_lock_transparent_key_slot_with_policy(
5947 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005948 if( status != PSA_SUCCESS )
5949 goto exit;
5950
5951 status = psa_key_agreement_raw_internal( alg, slot,
5952 peer_key, peer_key_length,
5953 output, output_size,
5954 output_length );
5955
5956exit:
5957 if( status != PSA_SUCCESS )
5958 {
5959 /* If an error happens and is not handled properly, the output
5960 * may be used as a key to protect sensitive data. Arrange for such
5961 * a key to be random, which is likely to result in decryption or
5962 * verification errors. This is better than filling the buffer with
5963 * some constant data such as zeros, which would result in the data
5964 * being protected with a reproducible, easily knowable key.
5965 */
5966 psa_generate_random( output, output_size );
5967 *output_length = output_size;
5968 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005969
Ronald Cron5c522922020-11-14 16:35:34 +01005970 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005971
Ronald Cron5c522922020-11-14 16:35:34 +01005972 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005973}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005974
5975
Gilles Peskine30524eb2020-11-13 17:02:26 +01005976
Gilles Peskine86a440b2018-11-12 18:39:40 +01005977/****************************************************************/
5978/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005979/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005980
Gilles Peskine30524eb2020-11-13 17:02:26 +01005981/** Initialize the PSA random generator.
5982 */
5983static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5984{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005985#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5986 memset( rng, 0, sizeof( *rng ) );
5987#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5988
Gilles Peskine30524eb2020-11-13 17:02:26 +01005989 /* Set default configuration if
5990 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5991 if( rng->entropy_init == NULL )
5992 rng->entropy_init = mbedtls_entropy_init;
5993 if( rng->entropy_free == NULL )
5994 rng->entropy_free = mbedtls_entropy_free;
5995
5996 rng->entropy_init( &rng->entropy );
5997#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5998 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5999 /* The PSA entropy injection feature depends on using NV seed as an entropy
6000 * source. Add NV seed as an entropy source for PSA entropy injection. */
6001 mbedtls_entropy_add_source( &rng->entropy,
6002 mbedtls_nv_seed_poll, NULL,
6003 MBEDTLS_ENTROPY_BLOCK_SIZE,
6004 MBEDTLS_ENTROPY_SOURCE_STRONG );
6005#endif
6006
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006007 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006008#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006009}
6010
6011/** Deinitialize the PSA random generator.
6012 */
6013static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6014{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006015#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6016 memset( rng, 0, sizeof( *rng ) );
6017#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006018 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006019 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006020#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006021}
6022
6023/** Seed the PSA random generator.
6024 */
6025static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6026{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006027#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6028 /* Do nothing: the external RNG seeds itself. */
6029 (void) rng;
6030 return( PSA_SUCCESS );
6031#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006032 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006033 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6034 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006035 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006036#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006037}
6038
Gilles Peskinee59236f2018-01-27 23:32:46 +01006039psa_status_t psa_generate_random( uint8_t *output,
6040 size_t output_size )
6041{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006042 GUARD_MODULE_INITIALIZED;
6043
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006044#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6045
6046 size_t output_length = 0;
6047 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6048 output, output_size,
6049 &output_length );
6050 if( status != PSA_SUCCESS )
6051 return( status );
6052 /* Breaking up a request into smaller chunks is currently not supported
6053 * for the extrernal RNG interface. */
6054 if( output_length != output_size )
6055 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6056 return( PSA_SUCCESS );
6057
6058#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6059
Gilles Peskine71ddab92021-01-04 21:01:07 +01006060 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006061 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006062 size_t request_size =
6063 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6064 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6065 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006066 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6067 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006068 if( ret != 0 )
6069 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006070 output_size -= request_size;
6071 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006072 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006073 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006074#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006075}
6076
Gilles Peskine8814fc42020-12-14 15:33:44 +01006077/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006078 *
6079 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6080 * `psa_generate_random(...)`. The state parameter is ignored since the
6081 * PSA API doesn't support passing an explicit state.
6082 *
6083 * In the non-external case, psa_generate_random() calls an
6084 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6085 * and semantics as mbedtls_psa_get_random(). As an optimization,
6086 * instead of doing this back-and-forth between the PSA API and the
6087 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6088 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006089 */
6090#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6091int mbedtls_psa_get_random( void *p_rng,
6092 unsigned char *output,
6093 size_t output_size )
6094{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006095 /* This function takes a pointer to the RNG state because that's what
6096 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6097 * its own state internally and doesn't let the caller access that state.
6098 * So we just ignore the state parameter, and in practice we'll pass
6099 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006100 (void) p_rng;
6101 psa_status_t status = psa_generate_random( output, output_size );
6102 if( status == PSA_SUCCESS )
6103 return( 0 );
6104 else
6105 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6106}
6107#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6108
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006109#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6110#include "mbedtls/entropy_poll.h"
6111
Gilles Peskine7228da22019-07-15 11:06:15 +02006112psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006113 size_t seed_size )
6114{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006115 if( global_data.initialized )
6116 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006117
6118 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6119 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6120 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6121 return( PSA_ERROR_INVALID_ARGUMENT );
6122
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006123 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006124}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006125#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006126
John Durkop07cc04a2020-11-16 22:08:34 -08006127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006128static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6129 size_t domain_parameters_size,
6130 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006131{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006132 size_t i;
6133 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006134
Gilles Peskinee56e8782019-04-26 17:34:02 +02006135 if( domain_parameters_size == 0 )
6136 {
6137 *exponent = 65537;
6138 return( PSA_SUCCESS );
6139 }
6140
6141 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6142 * support values that fit in a 32-bit integer, which is larger than
6143 * int on just about every platform anyway. */
6144 if( domain_parameters_size > sizeof( acc ) )
6145 return( PSA_ERROR_NOT_SUPPORTED );
6146 for( i = 0; i < domain_parameters_size; i++ )
6147 acc = ( acc << 8 ) | domain_parameters[i];
6148 if( acc > INT_MAX )
6149 return( PSA_ERROR_NOT_SUPPORTED );
6150 *exponent = acc;
6151 return( PSA_SUCCESS );
6152}
John Durkop07cc04a2020-11-16 22:08:34 -08006153#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006154
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006155static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006156 psa_key_slot_t *slot, size_t bits,
6157 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006158{
Gilles Peskine8e338702019-07-30 20:06:31 +02006159 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006160
Gilles Peskinee56e8782019-04-26 17:34:02 +02006161 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006162 return( PSA_ERROR_INVALID_ARGUMENT );
6163
Gilles Peskinee59236f2018-01-27 23:32:46 +01006164 if( key_type_is_raw_bytes( type ) )
6165 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006166 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006167
6168 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006169 if( status != PSA_SUCCESS )
6170 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006171
6172 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006173 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6174 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006175 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006176
Ronald Cronea0f8a62020-11-25 17:52:23 +01006177 status = psa_generate_random( slot->key.data,
6178 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006179 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006180 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006181
6182 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006183#if defined(MBEDTLS_DES_C)
6184 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006185 psa_des_set_key_parity( slot->key.data,
6186 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006187#endif /* MBEDTLS_DES_C */
6188 }
6189 else
6190
John Durkop07cc04a2020-11-16 22:08:34 -08006191#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006192 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006193 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006194 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006195 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006196 int exponent;
6197 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006198 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6199 return( PSA_ERROR_NOT_SUPPORTED );
6200 /* Accept only byte-aligned keys, for the same reasons as
Ronald Cronb6420e32020-11-22 16:15:38 +01006201 * in mbedtls_psa_rsa_import_key(). */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006202 if( bits % 8 != 0 )
6203 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006204 status = psa_read_rsa_exponent( domain_parameters,
6205 domain_parameters_size,
6206 &exponent );
6207 if( status != PSA_SUCCESS )
6208 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006209 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6210 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006211 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006212 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006213 (unsigned int) bits,
6214 exponent );
6215 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006216 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006217
6218 /* Make sure to always have an export representation available */
6219 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6220
Steven Cooreman75b74362020-07-28 14:30:13 +02006221 status = psa_allocate_buffer_to_slot( slot, bytes );
6222 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006223 {
6224 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006225 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006226 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006227
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006228 status = mbedtls_psa_rsa_export_key( type,
6229 &rsa,
6230 slot->key.data,
6231 bytes,
6232 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006233 mbedtls_rsa_free( &rsa );
6234 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006235 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006236 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006237 }
6238 else
John Durkop07cc04a2020-11-16 22:08:34 -08006239#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006240
John Durkop9814fa22020-11-04 12:28:15 -08006241#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006242 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006243 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006244 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006245 mbedtls_ecp_group_id grp_id =
6246 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006247 const mbedtls_ecp_curve_info *curve_info =
6248 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006249 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006251 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006252 return( PSA_ERROR_NOT_SUPPORTED );
6253 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6254 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006255 mbedtls_ecp_keypair_init( &ecp );
6256 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006257 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006258 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006259 if( ret != 0 )
6260 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006261 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006262 return( mbedtls_to_psa_error( ret ) );
6263 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006264
6265
6266 /* Make sure to always have an export representation available */
6267 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006268 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6269 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006270 {
6271 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006272 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006273 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006274
6275 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006276 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006277
6278 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006279 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006280 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006281 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006282 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006283 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006284 }
6285 else
John Durkop9814fa22020-11-04 12:28:15 -08006286#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006287 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006288 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006289 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006290
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006291 return( PSA_SUCCESS );
6292}
Darryl Green0c6575a2018-11-07 16:05:30 +00006293
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006294psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006295 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006296{
6297 psa_status_t status;
6298 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006299 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006300
Ronald Cron81709fc2020-11-14 12:10:32 +01006301 *key = MBEDTLS_SVC_KEY_ID_INIT;
6302
Gilles Peskine0f84d622019-09-12 19:03:13 +02006303 /* Reject any attempt to create a zero-length key so that we don't
6304 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6305 if( psa_get_key_bits( attributes ) == 0 )
6306 return( PSA_ERROR_INVALID_ARGUMENT );
6307
Ronald Cron81709fc2020-11-14 12:10:32 +01006308 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6309 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006310 if( status != PSA_SUCCESS )
6311 goto exit;
6312
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006313 status = psa_driver_wrapper_generate_key( attributes,
6314 slot );
6315 if( status != PSA_ERROR_NOT_SUPPORTED ||
6316 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6317 goto exit;
6318
6319 status = psa_generate_key_internal(
6320 slot, attributes->core.bits,
6321 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006322
6323exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006324 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006325 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006326 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006327 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006328
Darryl Green0c6575a2018-11-07 16:05:30 +00006329 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006330}
6331
6332
Gilles Peskinee59236f2018-01-27 23:32:46 +01006333
6334/****************************************************************/
6335/* Module setup */
6336/****************************************************************/
6337
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006338#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006339psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6340 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6341 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6342{
6343 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6344 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006345 global_data.rng.entropy_init = entropy_init;
6346 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006347 return( PSA_SUCCESS );
6348}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006349#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006350
Gilles Peskinee59236f2018-01-27 23:32:46 +01006351void mbedtls_psa_crypto_free( void )
6352{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006353 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006354 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6355 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006356 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006357 }
6358 /* Wipe all remaining data, including configuration.
6359 * In particular, this sets all state indicator to the value
6360 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006361 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006362#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006363 /* Unregister all secure element drivers, so that we restart from
6364 * a pristine state. */
6365 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006366#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006367}
6368
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006369#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6370/** Recover a transaction that was interrupted by a power failure.
6371 *
6372 * This function is called during initialization, before psa_crypto_init()
6373 * returns. If this function returns a failure status, the initialization
6374 * fails.
6375 */
6376static psa_status_t psa_crypto_recover_transaction(
6377 const psa_crypto_transaction_t *transaction )
6378{
6379 switch( transaction->unknown.type )
6380 {
6381 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6382 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006383 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006384 * is implemented.
6385 * https://github.com/ARMmbed/mbed-crypto/issues/218
6386 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006387 default:
6388 /* We found an unsupported transaction in the storage.
6389 * We don't know what state the storage is in. Give up. */
6390 return( PSA_ERROR_STORAGE_FAILURE );
6391 }
6392}
6393#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6394
Gilles Peskinee59236f2018-01-27 23:32:46 +01006395psa_status_t psa_crypto_init( void )
6396{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006397 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006398
Gilles Peskinec6b69072018-11-20 21:42:52 +01006399 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006400 if( global_data.initialized != 0 )
6401 return( PSA_SUCCESS );
6402
Gilles Peskine30524eb2020-11-13 17:02:26 +01006403 /* Initialize and seed the random generator. */
6404 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006405 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006406 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006407 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006408 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006409 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006410
Gilles Peskine66fb1262018-12-10 16:29:04 +01006411 status = psa_initialize_key_slots( );
6412 if( status != PSA_SUCCESS )
6413 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006414
Gilles Peskined9348f22019-10-01 15:22:29 +02006415#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6416 status = psa_init_all_se_drivers( );
6417 if( status != PSA_SUCCESS )
6418 goto exit;
6419#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6420
Gilles Peskine4b734222019-07-24 15:56:31 +02006421#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006422 status = psa_crypto_load_transaction( );
6423 if( status == PSA_SUCCESS )
6424 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006425 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6426 if( status != PSA_SUCCESS )
6427 goto exit;
6428 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006429 }
6430 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6431 {
6432 /* There's no transaction to complete. It's all good. */
6433 status = PSA_SUCCESS;
6434 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006435#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006436
Gilles Peskinec6b69072018-11-20 21:42:52 +01006437 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006438 global_data.initialized = 1;
6439
6440exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006441 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006442 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006443 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006444}
6445
6446#endif /* MBEDTLS_PSA_CRYPTO_C */