blob: 2854cd2d68b6eb8f2bae815971e6645b55ffb9fa [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
544 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200545static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
546 const uint8_t *data,
547 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100548{
Steven Cooremanacda8342020-07-24 23:09:52 +0200549 psa_status_t status;
550 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200551 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100552
Steven Cooremanacda8342020-07-24 23:09:52 +0200553 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100554 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
555 data,
556 data_length,
557 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100558 if( status != PSA_SUCCESS )
559 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100560
Steven Cooremanacda8342020-07-24 23:09:52 +0200561 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200562 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200563 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200564 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200565
Steven Cooremanacda8342020-07-24 23:09:52 +0200566 /* Re-export the data to PSA export format. There is currently no support
567 * for other input formats then the export format, so this is a 1-1
568 * copy operation. */
569 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200570 if( output == NULL )
571 {
572 status = PSA_ERROR_INSUFFICIENT_MEMORY;
573 goto exit;
574 }
575
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100576 status = mbedtls_psa_ecp_export_key( slot->attr.type,
577 ecp,
578 output,
579 data_length,
580 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100581exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200582 /* Always free the PK object (will also free contained ECP context) */
583 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200584 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200585
586 /* Free the allocated buffer only on error. */
587 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100588 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200589 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200590 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100591 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200592
593 /* On success, store the allocated export-formatted key. */
Ronald Cronea0f8a62020-11-25 17:52:23 +0100594 slot->key.data = output;
595 slot->key.bytes = data_length;
Steven Cooremanacda8342020-07-24 23:09:52 +0200596
597 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100598}
John Durkop9814fa22020-11-04 12:28:15 -0800599#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
600 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100601
Gilles Peskineb46bef22019-07-30 21:32:04 +0200602/** Return the size of the key in the given slot, in bits.
603 *
604 * \param[in] slot A key slot.
605 *
606 * \return The key size in bits, read from the metadata in the slot.
607 */
608static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
609{
610 return( slot->attr.bits );
611}
612
Steven Cooreman75b74362020-07-28 14:30:13 +0200613/** Try to allocate a buffer to an empty key slot.
614 *
615 * \param[in,out] slot Key slot to attach buffer to.
616 * \param[in] buffer_length Requested size of the buffer.
617 *
618 * \retval #PSA_SUCCESS
619 * The buffer has been successfully allocated.
620 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
621 * Not enough memory was available for allocation.
622 * \retval #PSA_ERROR_ALREADY_EXISTS
623 * Trying to allocate a buffer to a non-empty key slot.
624 */
625static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
626 size_t buffer_length )
627{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100628 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200629 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200630
Ronald Cronea0f8a62020-11-25 17:52:23 +0100631 slot->key.data = mbedtls_calloc( 1, buffer_length );
632 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200633 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200634
Ronald Cronea0f8a62020-11-25 17:52:23 +0100635 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200636 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200637}
638
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200639psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
640 const uint8_t* data,
641 size_t data_length )
642{
643 psa_status_t status = psa_allocate_buffer_to_slot( slot,
644 data_length );
645 if( status != PSA_SUCCESS )
646 return( status );
647
Ronald Cronea0f8a62020-11-25 17:52:23 +0100648 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200649 return( PSA_SUCCESS );
650}
651
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200652/** Import key data into a slot.
653 *
654 * `slot->type` must have been set previously.
655 * This function assumes that the slot does not contain any key material yet.
656 * On failure, the slot content is unchanged.
657 *
658 * Persistent storage is not affected.
659 *
660 * \param[in,out] slot The key slot to import data into.
661 * Its `type` field must have previously been set to
662 * the desired key type.
663 * It must not contain any key material yet.
664 * \param[in] data Buffer containing the key material to parse and import.
665 * \param data_length Size of \p data in bytes.
666 *
667 * \retval #PSA_SUCCESS
668 * \retval #PSA_ERROR_INVALID_ARGUMENT
669 * \retval #PSA_ERROR_NOT_SUPPORTED
670 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
671 */
672static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
673 const uint8_t *data,
674 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100675{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200676 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200677 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100678
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200679 /* zero-length keys are never supported. */
680 if( data_length == 0 )
681 return( PSA_ERROR_NOT_SUPPORTED );
682
Gilles Peskine8e338702019-07-30 20:06:31 +0200683 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100684 {
Steven Cooreman04524762020-10-13 17:43:44 +0200685 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200686
Steven Cooreman75b74362020-07-28 14:30:13 +0200687 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
688 if( data_length > SIZE_MAX / 8 )
689 return( PSA_ERROR_NOT_SUPPORTED );
690
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200691 /* Enforce a size limit, and in particular ensure that the bit
692 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200693 if( bit_size > PSA_MAX_KEY_BITS )
694 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200695
696 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200697 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200698 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200699
700 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200701 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +0200702 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200703 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200704
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200705 /* Write the actual key size to the slot.
706 * psa_start_key_creation() wrote the size declared by the
707 * caller, which may be 0 (meaning unspecified) or wrong. */
708 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +0100709
710 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100711 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200712 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200713 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200714 /* Try validation through accelerators first. */
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200715 psa_key_attributes_t attributes = {
716 .core = slot->attr
717 };
Ronald Cron83282872020-11-22 14:02:39 +0100718
719 status = psa_allocate_buffer_to_slot( slot, data_length );
720 if( status != PSA_SUCCESS )
721 return( status );
722
723 bit_size = slot->attr.bits;
724 status = psa_driver_wrapper_import_key( &attributes,
725 data, data_length,
726 slot->key.data,
727 slot->key.bytes,
728 &slot->key.bytes,
729 &bit_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200730 if( status == PSA_SUCCESS )
731 {
Ronald Cron83282872020-11-22 14:02:39 +0100732 if( slot->attr.bits == 0 )
733 slot->attr.bits = (psa_key_bits_t) bit_size;
734 else if( bit_size != slot->attr.bits )
735 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200736
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200737 return( PSA_SUCCESS );
738 }
Ronald Cron83282872020-11-22 14:02:39 +0100739 else
740 {
741 if( status != PSA_ERROR_NOT_SUPPORTED )
742 return( status );
743 }
744
745 mbedtls_platform_zeroize( slot->key.data, data_length );
746 mbedtls_free( slot->key.data );
747 slot->key.data = NULL;
748 slot->key.bytes = 0;
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200749
750 /* Key format is not supported by any accelerator, try software fallback
751 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800752#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
753 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200754 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
755 {
Steven Cooreman40120f62020-10-29 11:42:22 +0100756 return( psa_import_ecp_key( slot, data, data_length ) );
757 }
John Durkop9814fa22020-11-04 12:28:15 -0800758#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
759 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700760#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
761 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +0100762 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200763 {
Ronald Cron8f813ee2020-11-07 18:22:09 +0100764 status = psa_allocate_buffer_to_slot( slot, data_length );
765 if( status != PSA_SUCCESS )
766 return( status );
767
Ronald Cronb6420e32020-11-22 16:15:38 +0100768 status = mbedtls_psa_rsa_import_key( &attributes,
769 data, data_length,
770 slot->key.data, data_length,
771 &slot->key.bytes,
772 &bit_size );
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100773 slot->attr.bits = (psa_key_bits_t) bit_size;
Ronald Cron8f813ee2020-11-07 18:22:09 +0100774 return( status );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200775 }
John Durkop9814fa22020-11-04 12:28:15 -0800776#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
777 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +0100778
779 /* Fell through the fallback as well, so have nothing else to try. */
780 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100781 }
782 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +0100783 {
Steven Cooreman19fd5742020-07-24 23:31:01 +0200784 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100785 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +0100786 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100787}
788
Gilles Peskinef603c712019-01-19 13:40:11 +0100789/** Calculate the intersection of two algorithm usage policies.
790 *
791 * Return 0 (which allows no operation) on incompatibility.
792 */
793static psa_algorithm_t psa_key_policy_algorithm_intersection(
794 psa_algorithm_t alg1,
795 psa_algorithm_t alg2 )
796{
Gilles Peskine549ea862019-05-22 11:45:59 +0200797 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100798 if( alg1 == alg2 )
799 return( alg1 );
800 /* If the policies are from the same hash-and-sign family, check
801 * if one is a wildcard. If so the other has the specific algorithm. */
802 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
803 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
804 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
805 {
806 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
807 return( alg2 );
808 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
809 return( alg1 );
810 }
811 /* If the policies are incompatible, allow nothing. */
812 return( 0 );
813}
814
Gilles Peskined6f371b2019-05-10 19:33:38 +0200815static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
816 psa_algorithm_t requested_alg )
817{
Gilles Peskine549ea862019-05-22 11:45:59 +0200818 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200819 if( requested_alg == policy_alg )
820 return( 1 );
821 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200822 * and requested_alg is the same hash-and-sign family with any hash,
823 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200824 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
825 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
826 {
827 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
828 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
829 }
Steven Cooremance48e852020-10-05 16:02:45 +0200830 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200831 * a key derivation with that key agreement should also be allowed. This
832 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200833 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
834 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
835 {
836 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
837 policy_alg );
838 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200839 /* If it isn't permitted, it's forbidden. */
840 return( 0 );
841}
842
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100843/** Test whether a policy permits an algorithm.
844 *
845 * The caller must test usage flags separately.
846 */
847static int psa_key_policy_permits( const psa_key_policy_t *policy,
848 psa_algorithm_t alg )
849{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200850 return( psa_key_algorithm_permits( policy->alg, alg ) ||
851 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100852}
853
Gilles Peskinef603c712019-01-19 13:40:11 +0100854/** Restrict a key policy based on a constraint.
855 *
856 * \param[in,out] policy The policy to restrict.
857 * \param[in] constraint The policy constraint to apply.
858 *
859 * \retval #PSA_SUCCESS
860 * \c *policy contains the intersection of the original value of
861 * \c *policy and \c *constraint.
862 * \retval #PSA_ERROR_INVALID_ARGUMENT
863 * \c *policy and \c *constraint are incompatible.
864 * \c *policy is unchanged.
865 */
866static psa_status_t psa_restrict_key_policy(
867 psa_key_policy_t *policy,
868 const psa_key_policy_t *constraint )
869{
870 psa_algorithm_t intersection_alg =
871 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200872 psa_algorithm_t intersection_alg2 =
873 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100874 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
875 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200876 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
877 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100878 policy->usage &= constraint->usage;
879 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200880 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100881 return( PSA_SUCCESS );
882}
883
Ronald Cron5c522922020-11-14 16:35:34 +0100884/** Get the description of a key given its identifier and policy constraints
885 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200886 *
Ronald Cron5c522922020-11-14 16:35:34 +0100887 * The key must have allow all the usage flags set in \p usage. If \p alg is
888 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100889 *
Ronald Cron5c522922020-11-14 16:35:34 +0100890 * In case of a persistent key, the function loads the description of the key
891 * into a key slot if not already done.
892 *
893 * On success, the returned key slot is locked. It is the responsibility of
894 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200895 */
Ronald Cron5c522922020-11-14 16:35:34 +0100896static psa_status_t psa_get_and_lock_key_slot_with_policy(
897 mbedtls_svc_key_id_t key,
898 psa_key_slot_t **p_slot,
899 psa_key_usage_t usage,
900 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100901{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200902 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
903 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100904
Ronald Cron5c522922020-11-14 16:35:34 +0100905 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100906 if( status != PSA_SUCCESS )
907 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200908 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100909
910 /* Enforce that usage policy for the key slot contains all the flags
911 * required by the usage parameter. There is one exception: public
912 * keys can always be exported, so we treat public key objects as
913 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200914 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100915 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200916
917 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200918 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200919 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100920
921 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200922 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200923 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100924
Darryl Green06fd18d2018-07-16 11:21:11 +0100925 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926
927error:
928 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100929 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200930
931 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100932}
Darryl Green940d72c2018-07-13 13:18:51 +0100933
Ronald Cron5c522922020-11-14 16:35:34 +0100934/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200935 *
936 * A transparent key is a key for which the key material is directly
937 * available, as opposed to a key in a secure element.
938 *
Ronald Cron5c522922020-11-14 16:35:34 +0100939 * This is a temporary function to use instead of
940 * psa_get_and_lock_key_slot_with_policy() until secure element support is
941 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200942 *
Ronald Cron5c522922020-11-14 16:35:34 +0100943 * On success, the returned key slot is locked. It is the responsibility of the
944 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200945 */
946#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100947static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
948 mbedtls_svc_key_id_t key,
949 psa_key_slot_t **p_slot,
950 psa_key_usage_t usage,
951 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200952{
Ronald Cron5c522922020-11-14 16:35:34 +0100953 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
954 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200955 if( status != PSA_SUCCESS )
956 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200957
Gilles Peskineadad8132019-07-25 11:31:23 +0200958 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200959 {
Ronald Cron5c522922020-11-14 16:35:34 +0100960 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200961 *p_slot = NULL;
962 return( PSA_ERROR_NOT_SUPPORTED );
963 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200964
Gilles Peskine28f8f302019-07-24 13:30:31 +0200965 return( PSA_SUCCESS );
966}
967#else /* MBEDTLS_PSA_CRYPTO_SE_C */
968/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100969#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
970 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200971#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
972
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100973/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100974static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000975{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100976 /* Data pointer will always be either a valid pointer or NULL in an
977 * initialized slot, so we can just free it. */
978 if( slot->key.data != NULL )
979 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
980
981 mbedtls_free( slot->key.data );
982 slot->key.data = NULL;
983 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000984
985 return( PSA_SUCCESS );
986}
987
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100988/** Completely wipe a slot in memory, including its policy.
989 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100990psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100991{
992 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100993
994 /*
995 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +0100996 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +0100997 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
998 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +0100999 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001000 */
Ronald Cron5c522922020-11-14 16:35:34 +01001001 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001002 {
1003#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001004 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001005#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001006 status = PSA_ERROR_CORRUPTION_DETECTED;
1007 }
1008
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001009 /* Multipart operations may still be using the key. This is safe
1010 * because all multipart operation objects are independent from
1011 * the key slot: if they need to access the key after the setup
1012 * phase, they have a copy of the key. Note that this means that
1013 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001014 /* At this point, key material and other type-specific content has
1015 * been wiped. Clear remaining metadata. We can call memset and not
1016 * zeroize because the metadata is not particularly sensitive. */
1017 memset( slot, 0, sizeof( *slot ) );
1018 return( status );
1019}
1020
Ronald Croncf56a0a2020-08-04 09:51:30 +02001021psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001022{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001023 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001024 psa_status_t status; /* status of the last operation */
1025 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001026#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1027 psa_se_drv_table_entry_t *driver;
1028#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001029
Ronald Croncf56a0a2020-08-04 09:51:30 +02001030 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001031 return( PSA_SUCCESS );
1032
Ronald Cronf2911112020-10-29 17:51:10 +01001033 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001034 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001035 * key, this will load the key description from persistent memory if not
1036 * done yet. We cannot avoid this loading as without it we don't know if
1037 * the key is operated by an SE or not and this information is needed by
1038 * the current implementation.
1039 */
Ronald Cron5c522922020-11-14 16:35:34 +01001040 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001041 if( status != PSA_SUCCESS )
1042 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001043
Ronald Cronf2911112020-10-29 17:51:10 +01001044 /*
1045 * If the key slot containing the key description is under access by the
1046 * library (apart from the present access), the key cannot be destroyed
1047 * yet. For the time being, just return in error. Eventually (to be
1048 * implemented), the key should be destroyed when all accesses have
1049 * stopped.
1050 */
Ronald Cron5c522922020-11-14 16:35:34 +01001051 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001052 {
Ronald Cron5c522922020-11-14 16:35:34 +01001053 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001054 return( PSA_ERROR_GENERIC_ERROR );
1055 }
1056
Gilles Peskine354f7672019-07-12 23:46:38 +02001057#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001058 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001059 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001060 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001061 /* For a key in a secure element, we need to do three things:
1062 * remove the key file in internal storage, destroy the
1063 * key inside the secure element, and update the driver's
1064 * persistent data. Start a transaction that will encompass these
1065 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001066 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001067 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001068 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001069 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001070 status = psa_crypto_save_transaction( );
1071 if( status != PSA_SUCCESS )
1072 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001073 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001074 /* We should still try to destroy the key in the secure
1075 * element and the key metadata in storage. This is especially
1076 * important if the error is that the storage is full.
1077 * But how to do it exactly without risking an inconsistent
1078 * state after a reset?
1079 * https://github.com/ARMmbed/mbed-crypto/issues/215
1080 */
1081 overall_status = status;
1082 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001083 }
1084
Ronald Cronea0f8a62020-11-25 17:52:23 +01001085 status = psa_destroy_se_key( driver,
1086 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001087 if( overall_status == PSA_SUCCESS )
1088 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001089 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001090#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1091
Darryl Greend49a4992018-06-18 17:27:26 +01001092#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001093 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001094 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001095 status = psa_destroy_persistent_key( slot->attr.id );
1096 if( overall_status == PSA_SUCCESS )
1097 overall_status = status;
1098
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001099 /* TODO: other slots may have a copy of the same key. We should
1100 * invalidate them.
1101 * https://github.com/ARMmbed/mbed-crypto/issues/214
1102 */
Darryl Greend49a4992018-06-18 17:27:26 +01001103 }
1104#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001105
Gilles Peskinefc762652019-07-22 19:30:34 +02001106#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1107 if( driver != NULL )
1108 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001109 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001110 if( overall_status == PSA_SUCCESS )
1111 overall_status = status;
1112 status = psa_crypto_stop_transaction( );
1113 if( overall_status == PSA_SUCCESS )
1114 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001115 }
1116#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1117
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001118#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1119exit:
1120#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001121 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001122 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1123 if( overall_status == PSA_SUCCESS )
1124 overall_status = status;
1125 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001126}
1127
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001128void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001129{
Gilles Peskineb699f072019-04-26 16:06:02 +02001130 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001131 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001132}
1133
Gilles Peskineb699f072019-04-26 16:06:02 +02001134psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1135 psa_key_type_t type,
1136 const uint8_t *data,
1137 size_t data_length )
1138{
1139 uint8_t *copy = NULL;
1140
1141 if( data_length != 0 )
1142 {
1143 copy = mbedtls_calloc( 1, data_length );
1144 if( copy == NULL )
1145 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1146 memcpy( copy, data, data_length );
1147 }
1148 /* After this point, this function is guaranteed to succeed, so it
1149 * can start modifying `*attributes`. */
1150
1151 if( attributes->domain_parameters != NULL )
1152 {
1153 mbedtls_free( attributes->domain_parameters );
1154 attributes->domain_parameters = NULL;
1155 attributes->domain_parameters_size = 0;
1156 }
1157
1158 attributes->domain_parameters = copy;
1159 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001160 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001161 return( PSA_SUCCESS );
1162}
1163
1164psa_status_t psa_get_key_domain_parameters(
1165 const psa_key_attributes_t *attributes,
1166 uint8_t *data, size_t data_size, size_t *data_length )
1167{
1168 if( attributes->domain_parameters_size > data_size )
1169 return( PSA_ERROR_BUFFER_TOO_SMALL );
1170 *data_length = attributes->domain_parameters_size;
1171 if( attributes->domain_parameters_size != 0 )
1172 memcpy( data, attributes->domain_parameters,
1173 attributes->domain_parameters_size );
1174 return( PSA_SUCCESS );
1175}
1176
John Durkop07cc04a2020-11-16 22:08:34 -08001177#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001178 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001179static psa_status_t psa_get_rsa_public_exponent(
1180 const mbedtls_rsa_context *rsa,
1181 psa_key_attributes_t *attributes )
1182{
1183 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001184 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001185 uint8_t *buffer = NULL;
1186 size_t buflen;
1187 mbedtls_mpi_init( &mpi );
1188
1189 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1190 if( ret != 0 )
1191 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001192 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1193 {
1194 /* It's the default value, which is reported as an empty string,
1195 * so there's nothing to do. */
1196 goto exit;
1197 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001198
1199 buflen = mbedtls_mpi_size( &mpi );
1200 buffer = mbedtls_calloc( 1, buflen );
1201 if( buffer == NULL )
1202 {
1203 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1204 goto exit;
1205 }
1206 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1207 if( ret != 0 )
1208 goto exit;
1209 attributes->domain_parameters = buffer;
1210 attributes->domain_parameters_size = buflen;
1211
1212exit:
1213 mbedtls_mpi_free( &mpi );
1214 if( ret != 0 )
1215 mbedtls_free( buffer );
1216 return( mbedtls_to_psa_error( ret ) );
1217}
John Durkop07cc04a2020-11-16 22:08:34 -08001218#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001219 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001220
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001221/** Retrieve all the publicly-accessible attributes of a key.
1222 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001223psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001224 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001225{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001226 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001227 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001228 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001229
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001230 psa_reset_key_attributes( attributes );
1231
Ronald Cron5c522922020-11-14 16:35:34 +01001232 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001233 if( status != PSA_SUCCESS )
1234 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001235
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001236 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001237 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1238 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1239
1240#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1241 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001242 psa_set_key_slot_number( attributes,
1243 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001244#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001245
Gilles Peskine8e338702019-07-30 20:06:31 +02001246 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001247 {
John Durkop07cc04a2020-11-16 22:08:34 -08001248#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001249 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001250 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001251 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001252#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001253 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001254 * is not yet implemented.
1255 * https://github.com/ARMmbed/mbed-crypto/issues/216
1256 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001257 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001258 break;
1259#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001260 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001261 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001262
Ronald Cron90857082020-11-25 14:58:33 +01001263 status = mbedtls_psa_rsa_load_representation(
1264 slot->attr.type,
1265 slot->key.data,
1266 slot->key.bytes,
1267 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001268 if( status != PSA_SUCCESS )
1269 break;
1270
Steven Cooremana2371e52020-07-28 14:30:39 +02001271 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001272 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001273 mbedtls_rsa_free( rsa );
1274 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001275 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001276 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001277#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001278 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001279 default:
1280 /* Nothing else to do. */
1281 break;
1282 }
1283
1284 if( status != PSA_SUCCESS )
1285 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001286
Ronald Cron5c522922020-11-14 16:35:34 +01001287 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001288
Ronald Cron5c522922020-11-14 16:35:34 +01001289 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001290}
1291
Gilles Peskinec8000c02019-08-02 20:15:51 +02001292#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1293psa_status_t psa_get_key_slot_number(
1294 const psa_key_attributes_t *attributes,
1295 psa_key_slot_number_t *slot_number )
1296{
1297 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1298 {
1299 *slot_number = attributes->slot_number;
1300 return( PSA_SUCCESS );
1301 }
1302 else
1303 return( PSA_ERROR_INVALID_ARGUMENT );
1304}
1305#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1306
Ronald Crond18b5f82020-11-25 16:46:05 +01001307static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1308 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001309 uint8_t *data,
1310 size_t data_size,
1311 size_t *data_length )
1312{
Ronald Crond18b5f82020-11-25 16:46:05 +01001313 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001314 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001315 memcpy( data, key_buffer, key_buffer_size );
1316 memset( data + key_buffer_size, 0,
1317 data_size - key_buffer_size );
1318 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001319 return( PSA_SUCCESS );
1320}
1321
Ronald Cron7285cda2020-11-26 14:46:37 +01001322psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001323 const psa_key_attributes_t *attributes,
1324 const uint8_t *key_buffer, size_t key_buffer_size,
1325 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001326{
Ronald Crond18b5f82020-11-25 16:46:05 +01001327 psa_key_type_t type = attributes->core.type;
1328
Ronald Crond18b5f82020-11-25 16:46:05 +01001329 if( key_type_is_raw_bytes( type ) ||
1330 PSA_KEY_TYPE_IS_RSA( type ) ||
1331 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001332 {
1333 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001334 key_buffer, key_buffer_size,
1335 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001336 }
1337 else
1338 {
1339 /* This shouldn't happen in the reference implementation, but
1340 it is valid for a special-purpose implementation to omit
1341 support for exporting certain key types. */
1342 return( PSA_ERROR_NOT_SUPPORTED );
1343 }
1344}
1345
1346psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1347 uint8_t *data,
1348 size_t data_size,
1349 size_t *data_length )
1350{
1351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1353 psa_key_slot_t *slot;
1354
1355 /* Set the key to empty now, so that even when there are errors, we always
1356 * set data_length to a value between 0 and data_size. On error, setting
1357 * the key to empty is a good choice because an empty key representation is
1358 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001359 *data_length = 0;
1360
Ronald Cron9486f9d2020-11-26 13:36:23 +01001361 /* Export requires the EXPORT flag. There is an exception for public keys,
1362 * which don't require any flag, but
1363 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1364 */
1365 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1366 PSA_KEY_USAGE_EXPORT, 0 );
1367 if( status != PSA_SUCCESS )
1368 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001369
Gilles Peskinef9168942019-09-12 19:20:29 +02001370 /* Reject a zero-length output buffer now, since this can never be a
1371 * valid key representation. This way we know that data must be a valid
1372 * pointer and we can do things like memset(data, ..., data_size). */
1373 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001374 {
1375 status = PSA_ERROR_BUFFER_TOO_SMALL;
1376 goto exit;
1377 }
1378
Ronald Crond18b5f82020-11-25 16:46:05 +01001379 psa_key_attributes_t attributes = {
1380 .core = slot->attr
1381 };
Ronald Cron67227982020-11-26 15:16:05 +01001382 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001383 slot->key.data, slot->key.bytes,
1384 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001385
1386exit:
1387 unlock_status = psa_unlock_key_slot( slot );
1388
1389 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1390}
1391
Ronald Cron7285cda2020-11-26 14:46:37 +01001392psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001393 const psa_key_attributes_t *attributes,
1394 const uint8_t *key_buffer,
1395 size_t key_buffer_size,
1396 uint8_t *data,
1397 size_t data_size,
1398 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001399{
Ronald Crond18b5f82020-11-25 16:46:05 +01001400 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001401
Ronald Crond18b5f82020-11-25 16:46:05 +01001402 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001403 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001404 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001405 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001406 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001407 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001408 key_buffer, key_buffer_size,
1409 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001410 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001411
Ronald Crond18b5f82020-11-25 16:46:05 +01001412 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001413 {
John Durkop0e005192020-10-31 22:06:54 -07001414#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1415 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001416 return( mbedtls_psa_rsa_export_public_key( attributes,
1417 key_buffer,
1418 key_buffer_size,
1419 data,
1420 data_size,
1421 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001422#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001423 /* We don't know how to convert a private RSA key to public. */
1424 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001425#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1426 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001427 }
1428 else
Moran Pekera998bc62018-04-16 18:16:20 +03001429 {
John Durkop6ba40d12020-11-10 08:50:04 -08001430#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1431 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001432 return( mbedtls_psa_ecp_export_public_key( attributes,
1433 key_buffer,
1434 key_buffer_size,
1435 data,
1436 data_size,
1437 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001438#else
1439 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001440 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001441#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1442 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001443 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001444 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001445 else
1446 {
1447 /* This shouldn't happen in the reference implementation, but
1448 it is valid for a special-purpose implementation to omit
1449 support for exporting certain key types. */
1450 return( PSA_ERROR_NOT_SUPPORTED );
1451 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001452}
Ronald Crond18b5f82020-11-25 16:46:05 +01001453
Ronald Croncf56a0a2020-08-04 09:51:30 +02001454psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001455 uint8_t *data,
1456 size_t data_size,
1457 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001458{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001460 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001461 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001462
1463 /* Set the key to empty now, so that even when there are errors, we always
1464 * set data_length to a value between 0 and data_size. On error, setting
1465 * the key to empty is a good choice because an empty key representation is
1466 * unlikely to be accepted anywhere. */
1467 *data_length = 0;
1468
1469 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001470 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001471 if( status != PSA_SUCCESS )
1472 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001473
Ronald Cron9486f9d2020-11-26 13:36:23 +01001474 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1475 {
1476 status = PSA_ERROR_INVALID_ARGUMENT;
1477 goto exit;
1478 }
1479
1480 /* Reject a zero-length output buffer now, since this can never be a
1481 * valid key representation. This way we know that data must be a valid
1482 * pointer and we can do things like memset(data, ..., data_size). */
1483 if( data_size == 0 )
1484 {
1485 status = PSA_ERROR_BUFFER_TOO_SMALL;
1486 goto exit;
1487 }
1488
Ronald Crond18b5f82020-11-25 16:46:05 +01001489 psa_key_attributes_t attributes = {
1490 .core = slot->attr
1491 };
Ronald Cron67227982020-11-26 15:16:05 +01001492 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001493 &attributes, slot->key.data, slot->key.bytes,
1494 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001495
1496exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001497 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001498
Ronald Cron5c522922020-11-14 16:35:34 +01001499 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001500}
1501
Gilles Peskine91e8c332019-08-02 19:19:39 +02001502#if defined(static_assert)
1503static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1504 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001505static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001506 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001507static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001508 "One or more key attribute flag is listed as both internal-only and external-only" );
1509#endif
1510
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001511/** Validate that a key policy is internally well-formed.
1512 *
1513 * This function only rejects invalid policies. It does not validate the
1514 * consistency of the policy with respect to other attributes of the key
1515 * such as the key type.
1516 */
1517static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001518{
1519 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001520 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001521 PSA_KEY_USAGE_ENCRYPT |
1522 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001523 PSA_KEY_USAGE_SIGN_HASH |
1524 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001525 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1526 return( PSA_ERROR_INVALID_ARGUMENT );
1527
Gilles Peskine4747d192019-04-17 15:05:45 +02001528 return( PSA_SUCCESS );
1529}
1530
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001531/** Validate the internal consistency of key attributes.
1532 *
1533 * This function only rejects invalid attribute values. If does not
1534 * validate the consistency of the attributes with any key data that may
1535 * be involved in the creation of the key.
1536 *
1537 * Call this function early in the key creation process.
1538 *
1539 * \param[in] attributes Key attributes for the new key.
1540 * \param[out] p_drv On any return, the driver for the key, if any.
1541 * NULL for a transparent key.
1542 *
1543 */
1544static psa_status_t psa_validate_key_attributes(
1545 const psa_key_attributes_t *attributes,
1546 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001547{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001548 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001549 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001550 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001551
Ronald Cron54b90082020-10-29 15:26:43 +01001552 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001553 if( status != PSA_SUCCESS )
1554 return( status );
1555
Ronald Crond2ed4812020-07-17 16:11:30 +02001556 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001557 if( status != PSA_SUCCESS )
1558 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001559
Ronald Cron65f38a32020-10-23 17:11:13 +02001560 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1561 {
1562 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1563 return( PSA_ERROR_INVALID_ARGUMENT );
1564 }
1565 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001566 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001567 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001568 if( status != PSA_SUCCESS )
1569 return( status );
1570 }
1571
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001572 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001573 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001574 return( status );
1575
1576 /* Refuse to create overly large keys.
1577 * Note that this doesn't trigger on import if the attributes don't
1578 * explicitly specify a size (so psa_get_key_bits returns 0), so
1579 * psa_import_key() needs its own checks. */
1580 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1581 return( PSA_ERROR_NOT_SUPPORTED );
1582
Gilles Peskine91e8c332019-08-02 19:19:39 +02001583 /* Reject invalid flags. These should not be reachable through the API. */
1584 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1585 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1586 return( PSA_ERROR_INVALID_ARGUMENT );
1587
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001588 return( PSA_SUCCESS );
1589}
1590
Gilles Peskine4747d192019-04-17 15:05:45 +02001591/** Prepare a key slot to receive key material.
1592 *
1593 * This function allocates a key slot and sets its metadata.
1594 *
1595 * If this function fails, call psa_fail_key_creation().
1596 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001597 * This function is intended to be used as follows:
1598 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001599 * it with the specified attributes, and in case of a volatile key assign it
1600 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001601 * -# Populate the slot with the key material.
1602 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1603 * In case of failure at any step, stop the sequence and call
1604 * psa_fail_key_creation().
1605 *
Ronald Cron5c522922020-11-14 16:35:34 +01001606 * On success, the key slot is locked. It is the responsibility of the caller
1607 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001608 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001609 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001610 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001611 * \param[out] p_slot On success, a pointer to the prepared slot.
1612 * \param[out] p_drv On any return, the driver for the key, if any.
1613 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001614 *
1615 * \retval #PSA_SUCCESS
1616 * The key slot is ready to receive key material.
1617 * \return If this function fails, the key slot is an invalid state.
1618 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001619 */
1620static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001621 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001622 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001623 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001624 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001625{
1626 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001627 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001628 psa_key_slot_t *slot;
1629
Gilles Peskinedf179142019-07-15 22:02:14 +02001630 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001631 *p_drv = NULL;
1632
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001633 status = psa_validate_key_attributes( attributes, p_drv );
1634 if( status != PSA_SUCCESS )
1635 return( status );
1636
Ronald Cronc4d1b512020-07-31 11:26:37 +02001637 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001638 if( status != PSA_SUCCESS )
1639 return( status );
1640 slot = *p_slot;
1641
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001642 /* We're storing the declared bit-size of the key. It's up to each
1643 * creation mechanism to verify that this information is correct.
1644 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001645 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001646 * is optional (import, copy). In case of a volatile key, assign it the
1647 * volatile key identifier associated to the slot returned to contain its
1648 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001649
1650 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001651 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1652 {
1653#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1654 slot->attr.id = volatile_key_id;
1655#else
1656 slot->attr.id.key_id = volatile_key_id;
1657#endif
1658 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001659
Gilles Peskine91e8c332019-08-02 19:19:39 +02001660 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001661 * external-only flags, query `attributes`. Thanks to the check
1662 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001663 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001664 * may have set. */
1665 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001666
Gilles Peskinecbaff462019-07-12 23:46:04 +02001667#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001668 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001669 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001670 * create the key file in internal storage, create the
1671 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001672 * persistent data. This is done by starting a transaction that will
1673 * encompass these three actions.
1674 * For registering a volatile key, we just need to find an appropriate
1675 * slot number inside the SE. Since the key is designated volatile, creating
1676 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001677 /* The first thing to do is to find a slot number for the new key.
1678 * We save the slot number in persistent storage as part of the
1679 * transaction data. It will be needed to recover if the power
1680 * fails during the key creation process, to clean up on the secure
1681 * element side after restarting. Obtaining a slot number from the
1682 * secure element driver updates its persistent state, but we do not yet
1683 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001684 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001685 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001686 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001687 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001688 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001689 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001690 if( status != PSA_SUCCESS )
1691 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001692
1693 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001694 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001695 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1696 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001697 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001698 psa_crypto_transaction.key.id = slot->attr.id;
1699 status = psa_crypto_save_transaction( );
1700 if( status != PSA_SUCCESS )
1701 {
1702 (void) psa_crypto_stop_transaction( );
1703 return( status );
1704 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001705 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001706
1707 status = psa_copy_key_material_into_slot(
1708 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001709 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001710
1711 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1712 {
1713 /* Key registration only makes sense with a secure element. */
1714 return( PSA_ERROR_INVALID_ARGUMENT );
1715 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001716#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1717
Ronald Cronc4d1b512020-07-31 11:26:37 +02001718 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001719}
Gilles Peskine4747d192019-04-17 15:05:45 +02001720
1721/** Finalize the creation of a key once its key material has been set.
1722 *
1723 * This entails writing the key to persistent storage.
1724 *
1725 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001726 * See the documentation of psa_start_key_creation() for the intended use
1727 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001728 *
Ronald Cron5c522922020-11-14 16:35:34 +01001729 * If the finalization succeeds, the function unlocks the key slot (it was
1730 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1731 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001732 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001733 * \param[in,out] slot Pointer to the slot with key material.
1734 * \param[in] driver The secure element driver for the key,
1735 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001736 * \param[out] key On success, identifier of the key. Note that the
1737 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001738 *
1739 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001740 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001741 * \return If this function fails, the key slot is an invalid state.
1742 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001743 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001744static psa_status_t psa_finish_key_creation(
1745 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001746 psa_se_drv_table_entry_t *driver,
1747 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001748{
1749 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001750 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001751 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001752
1753#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001754 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001756#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1757 if( driver != NULL )
1758 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001759 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001760 psa_key_slot_number_t slot_number =
1761 psa_key_slot_get_slot_number( slot ) ;
1762
Gilles Peskineb46bef22019-07-30 21:32:04 +02001763#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001764 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001765 sizeof( data.slot_number ),
1766 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001767#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001768 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001769 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001770 (uint8_t*) &data,
1771 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001772 }
1773 else
1774#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1775 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001776 /* Key material is saved in export representation in the slot, so
1777 * just pass the slot buffer for storage. */
1778 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001779 slot->key.data,
1780 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001781 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001782 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001783#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1784
Gilles Peskinecbaff462019-07-12 23:46:04 +02001785#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001786 /* Finish the transaction for a key creation. This does not
1787 * happen when registering an existing key. Detect this case
1788 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001789 * creation of a persistent key in a secure element requires a transaction,
1790 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001791 if( driver != NULL &&
1792 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001793 {
1794 status = psa_save_se_persistent_data( driver );
1795 if( status != PSA_SUCCESS )
1796 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001797 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001798 return( status );
1799 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001800 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001801 }
1802#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1803
Ronald Cron50972942020-11-14 11:28:25 +01001804 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001805 {
1806 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001807 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001808 if( status != PSA_SUCCESS )
1809 *key = MBEDTLS_SVC_KEY_ID_INIT;
1810 }
Ronald Cron50972942020-11-14 11:28:25 +01001811
Gilles Peskine4747d192019-04-17 15:05:45 +02001812 return( status );
1813}
1814
1815/** Abort the creation of a key.
1816 *
1817 * You may call this function after calling psa_start_key_creation(),
1818 * or after psa_finish_key_creation() fails. In other circumstances, this
1819 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001820 * See the documentation of psa_start_key_creation() for the intended use
1821 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001823 * \param[in,out] slot Pointer to the slot with key material.
1824 * \param[in] driver The secure element driver for the key,
1825 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001826 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001827static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001828 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001829{
Gilles Peskine011e4282019-06-26 18:34:38 +02001830 (void) driver;
1831
Gilles Peskine4747d192019-04-17 15:05:45 +02001832 if( slot == NULL )
1833 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001834
1835#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001836 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001837 * element, and the failure happened later (when saving metadata
1838 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001839 * element.
1840 * https://github.com/ARMmbed/mbed-crypto/issues/217
1841 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001842
Gilles Peskined7729582019-08-05 15:55:54 +02001843 /* Abort the ongoing transaction if any (there may not be one if
1844 * the creation process failed before starting one, or if the
1845 * key creation is a registration of a key in a secure element).
1846 * Earlier functions must already have done what it takes to undo any
1847 * partial creation. All that's left is to update the transaction data
1848 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001849 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001850#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1851
Gilles Peskine4747d192019-04-17 15:05:45 +02001852 psa_wipe_key_slot( slot );
1853}
1854
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001855/** Validate optional attributes during key creation.
1856 *
1857 * Some key attributes are optional during key creation. If they are
1858 * specified in the attributes structure, check that they are consistent
1859 * with the data in the slot.
1860 *
1861 * This function should be called near the end of key creation, after
1862 * the slot in memory is fully populated but before saving persistent data.
1863 */
1864static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001865 const psa_key_slot_t *slot,
1866 const psa_key_attributes_t *attributes )
1867{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001868 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001869 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001870 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001871 return( PSA_ERROR_INVALID_ARGUMENT );
1872 }
1873
1874 if( attributes->domain_parameters_size != 0 )
1875 {
John Durkop0e005192020-10-31 22:06:54 -07001876#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1877 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001878 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001879 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001880 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001881 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001882 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001883
Ronald Cron90857082020-11-25 14:58:33 +01001884 psa_status_t status = mbedtls_psa_rsa_load_representation(
1885 slot->attr.type,
1886 slot->key.data,
1887 slot->key.bytes,
1888 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001889 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001890 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001891
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001892 mbedtls_mpi_init( &actual );
1893 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001894 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001895 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001896 mbedtls_rsa_free( rsa );
1897 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001898 if( ret != 0 )
1899 goto rsa_exit;
1900 ret = mbedtls_mpi_read_binary( &required,
1901 attributes->domain_parameters,
1902 attributes->domain_parameters_size );
1903 if( ret != 0 )
1904 goto rsa_exit;
1905 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1906 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1907 rsa_exit:
1908 mbedtls_mpi_free( &actual );
1909 mbedtls_mpi_free( &required );
1910 if( ret != 0)
1911 return( mbedtls_to_psa_error( ret ) );
1912 }
1913 else
John Durkop9814fa22020-11-04 12:28:15 -08001914#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1915 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001916 {
1917 return( PSA_ERROR_INVALID_ARGUMENT );
1918 }
1919 }
1920
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001921 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001922 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001923 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001924 return( PSA_ERROR_INVALID_ARGUMENT );
1925 }
1926
1927 return( PSA_SUCCESS );
1928}
1929
Gilles Peskine4747d192019-04-17 15:05:45 +02001930psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001931 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001932 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001933 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001934{
1935 psa_status_t status;
1936 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001937 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001938
Ronald Cron81709fc2020-11-14 12:10:32 +01001939 *key = MBEDTLS_SVC_KEY_ID_INIT;
1940
Gilles Peskine0f84d622019-09-12 19:03:13 +02001941 /* Reject zero-length symmetric keys (including raw data key objects).
1942 * This also rejects any key which might be encoded as an empty string,
1943 * which is never valid. */
1944 if( data_length == 0 )
1945 return( PSA_ERROR_INVALID_ARGUMENT );
1946
Gilles Peskinedf179142019-07-15 22:02:14 +02001947 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001948 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001949 if( status != PSA_SUCCESS )
1950 goto exit;
1951
Gilles Peskine5d309672019-07-12 23:47:28 +02001952#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1953 if( driver != NULL )
1954 {
1955 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01001956 /* The driver should set the number of key bits, however in
1957 * case it doesn't, we initialize bits to an invalid value. */
1958 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02001959 if( drv->key_management == NULL ||
1960 drv->key_management->p_import == NULL )
1961 {
1962 status = PSA_ERROR_NOT_SUPPORTED;
1963 goto exit;
1964 }
1965 status = drv->key_management->p_import(
1966 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01001967 psa_key_slot_get_slot_number( slot ),
1968 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001969 if( status != PSA_SUCCESS )
1970 goto exit;
1971 if( bits > PSA_MAX_KEY_BITS )
1972 {
1973 status = PSA_ERROR_NOT_SUPPORTED;
1974 goto exit;
1975 }
1976 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02001977 }
1978 else
1979#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01001980 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
1981 {
1982 /* Importing a key with external lifetime through the driver wrapper
1983 * interface is not yet supported. Return as if this was an invalid
1984 * lifetime. */
1985 status = PSA_ERROR_INVALID_ARGUMENT;
1986 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001987 }
1988 else
Gilles Peskine5d309672019-07-12 23:47:28 +02001989 {
1990 status = psa_import_key_into_slot( slot, data, data_length );
1991 if( status != PSA_SUCCESS )
1992 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001993 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001994 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001995 if( status != PSA_SUCCESS )
1996 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001997
Ronald Cron81709fc2020-11-14 12:10:32 +01001998 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001999exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002000 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002001 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002002
Gilles Peskine4747d192019-04-17 15:05:45 +02002003 return( status );
2004}
2005
Gilles Peskined7729582019-08-05 15:55:54 +02002006#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2007psa_status_t mbedtls_psa_register_se_key(
2008 const psa_key_attributes_t *attributes )
2009{
2010 psa_status_t status;
2011 psa_key_slot_t *slot = NULL;
2012 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002013 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002014
2015 /* Leaving attributes unspecified is not currently supported.
2016 * It could make sense to query the key type and size from the
2017 * secure element, but not all secure elements support this
2018 * and the driver HAL doesn't currently support it. */
2019 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2020 return( PSA_ERROR_NOT_SUPPORTED );
2021 if( psa_get_key_bits( attributes ) == 0 )
2022 return( PSA_ERROR_NOT_SUPPORTED );
2023
2024 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002025 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002026 if( status != PSA_SUCCESS )
2027 goto exit;
2028
Ronald Cron81709fc2020-11-14 12:10:32 +01002029 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002030
2031exit:
2032 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002033 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002034
Gilles Peskined7729582019-08-05 15:55:54 +02002035 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002036 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002037 return( status );
2038}
2039#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2040
Gilles Peskinef603c712019-01-19 13:40:11 +01002041static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002042 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002043{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002044 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002045 source->key.data,
2046 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002047 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002048 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002049
Steven Cooreman398aee52020-10-13 14:35:45 +02002050 target->attr.type = source->attr.type;
2051 target->attr.bits = source->attr.bits;
2052
2053 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002054}
2055
Ronald Croncf56a0a2020-08-04 09:51:30 +02002056psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002057 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002058 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002059{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002060 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002061 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002062 psa_key_slot_t *source_slot = NULL;
2063 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002064 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002065 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002066
Ronald Cron81709fc2020-11-14 12:10:32 +01002067 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2068
Ronald Cron5c522922020-11-14 16:35:34 +01002069 status = psa_get_and_lock_transparent_key_slot_with_policy(
2070 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002071 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002072 goto exit;
2073
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002074 status = psa_validate_optional_attributes( source_slot,
2075 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002076 if( status != PSA_SUCCESS )
2077 goto exit;
2078
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002079 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002080 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002081 if( status != PSA_SUCCESS )
2082 goto exit;
2083
Ronald Cron81709fc2020-11-14 12:10:32 +01002084 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2085 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002086 if( status != PSA_SUCCESS )
2087 goto exit;
2088
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002089#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2090 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002091 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002092 /* Copying to a secure element is not implemented yet. */
2093 status = PSA_ERROR_NOT_SUPPORTED;
2094 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002095 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002096#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002097
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002098 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002099 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002100 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002101
Ronald Cron81709fc2020-11-14 12:10:32 +01002102 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002103exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002104 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002105 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002106
Ronald Cron5c522922020-11-14 16:35:34 +01002107 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002108
Ronald Cron5c522922020-11-14 16:35:34 +01002109 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002110}
2111
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002112
2113
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002114/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002115/* Message digests */
2116/****************************************************************/
2117
John Durkop07cc04a2020-11-16 22:08:34 -08002118#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002119 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2120 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002121 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002122static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002123{
2124 switch( alg )
2125 {
John Durkopee4e6602020-11-27 08:48:46 -08002126#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002127 case PSA_ALG_MD2:
2128 return( &mbedtls_md2_info );
2129#endif
John Durkopee4e6602020-11-27 08:48:46 -08002130#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002131 case PSA_ALG_MD4:
2132 return( &mbedtls_md4_info );
2133#endif
John Durkopee4e6602020-11-27 08:48:46 -08002134#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002135 case PSA_ALG_MD5:
2136 return( &mbedtls_md5_info );
2137#endif
John Durkopee4e6602020-11-27 08:48:46 -08002138#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002139 case PSA_ALG_RIPEMD160:
2140 return( &mbedtls_ripemd160_info );
2141#endif
John Durkopee4e6602020-11-27 08:48:46 -08002142#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002143 case PSA_ALG_SHA_1:
2144 return( &mbedtls_sha1_info );
2145#endif
John Durkopee4e6602020-11-27 08:48:46 -08002146#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002147 case PSA_ALG_SHA_224:
2148 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002149#endif
2150#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002151 case PSA_ALG_SHA_256:
2152 return( &mbedtls_sha256_info );
2153#endif
John Durkopee4e6602020-11-27 08:48:46 -08002154#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002155 case PSA_ALG_SHA_384:
2156 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002157#endif
John Durkopee4e6602020-11-27 08:48:46 -08002158#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002159 case PSA_ALG_SHA_512:
2160 return( &mbedtls_sha512_info );
2161#endif
2162 default:
2163 return( NULL );
2164 }
2165}
John Durkop07cc04a2020-11-16 22:08:34 -08002166#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002167 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2168 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2169 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002170
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002171psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2172{
2173 switch( operation->alg )
2174 {
Gilles Peskine81736312018-06-26 15:04:31 +02002175 case 0:
2176 /* The object has (apparently) been initialized but it is not
2177 * in use. It's ok to call abort on such an object, and there's
2178 * nothing to do. */
2179 break;
John Durkopee4e6602020-11-27 08:48:46 -08002180#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002181 case PSA_ALG_MD2:
2182 mbedtls_md2_free( &operation->ctx.md2 );
2183 break;
2184#endif
John Durkopee4e6602020-11-27 08:48:46 -08002185#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002186 case PSA_ALG_MD4:
2187 mbedtls_md4_free( &operation->ctx.md4 );
2188 break;
2189#endif
John Durkopee4e6602020-11-27 08:48:46 -08002190#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002191 case PSA_ALG_MD5:
2192 mbedtls_md5_free( &operation->ctx.md5 );
2193 break;
2194#endif
John Durkopee4e6602020-11-27 08:48:46 -08002195#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002196 case PSA_ALG_RIPEMD160:
2197 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2198 break;
2199#endif
John Durkopee4e6602020-11-27 08:48:46 -08002200#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201 case PSA_ALG_SHA_1:
2202 mbedtls_sha1_free( &operation->ctx.sha1 );
2203 break;
2204#endif
John Durkop6ca23272020-12-03 06:01:32 -08002205#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002206 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002207 mbedtls_sha256_free( &operation->ctx.sha256 );
2208 break;
2209#endif
2210#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002211 case PSA_ALG_SHA_256:
2212 mbedtls_sha256_free( &operation->ctx.sha256 );
2213 break;
2214#endif
John Durkop6ca23272020-12-03 06:01:32 -08002215#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002216 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002217 mbedtls_sha512_free( &operation->ctx.sha512 );
2218 break;
2219#endif
2220#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002221 case PSA_ALG_SHA_512:
2222 mbedtls_sha512_free( &operation->ctx.sha512 );
2223 break;
2224#endif
2225 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002226 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002227 }
2228 operation->alg = 0;
2229 return( PSA_SUCCESS );
2230}
2231
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002232psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233 psa_algorithm_t alg )
2234{
Janos Follath24eed8d2019-11-22 13:21:35 +00002235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002236
2237 /* A context must be freshly initialized before it can be set up. */
2238 if( operation->alg != 0 )
2239 {
2240 return( PSA_ERROR_BAD_STATE );
2241 }
2242
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002243 switch( alg )
2244 {
John Durkopee4e6602020-11-27 08:48:46 -08002245#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002246 case PSA_ALG_MD2:
2247 mbedtls_md2_init( &operation->ctx.md2 );
2248 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2249 break;
2250#endif
John Durkopee4e6602020-11-27 08:48:46 -08002251#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002252 case PSA_ALG_MD4:
2253 mbedtls_md4_init( &operation->ctx.md4 );
2254 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2255 break;
2256#endif
John Durkopee4e6602020-11-27 08:48:46 -08002257#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002258 case PSA_ALG_MD5:
2259 mbedtls_md5_init( &operation->ctx.md5 );
2260 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2261 break;
2262#endif
John Durkopee4e6602020-11-27 08:48:46 -08002263#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002264 case PSA_ALG_RIPEMD160:
2265 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2266 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2267 break;
2268#endif
John Durkopee4e6602020-11-27 08:48:46 -08002269#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270 case PSA_ALG_SHA_1:
2271 mbedtls_sha1_init( &operation->ctx.sha1 );
2272 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2273 break;
2274#endif
John Durkopee4e6602020-11-27 08:48:46 -08002275#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276 case PSA_ALG_SHA_224:
2277 mbedtls_sha256_init( &operation->ctx.sha256 );
2278 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2279 break;
John Durkopee4e6602020-11-27 08:48:46 -08002280#endif
2281#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002282 case PSA_ALG_SHA_256:
2283 mbedtls_sha256_init( &operation->ctx.sha256 );
2284 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2285 break;
2286#endif
John Durkopee4e6602020-11-27 08:48:46 -08002287#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002288 case PSA_ALG_SHA_384:
2289 mbedtls_sha512_init( &operation->ctx.sha512 );
2290 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2291 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002292#endif
John Durkopee4e6602020-11-27 08:48:46 -08002293#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294 case PSA_ALG_SHA_512:
2295 mbedtls_sha512_init( &operation->ctx.sha512 );
2296 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2297 break;
2298#endif
2299 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002300 return( PSA_ALG_IS_HASH( alg ) ?
2301 PSA_ERROR_NOT_SUPPORTED :
2302 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002303 }
2304 if( ret == 0 )
2305 operation->alg = alg;
2306 else
2307 psa_hash_abort( operation );
2308 return( mbedtls_to_psa_error( ret ) );
2309}
2310
2311psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2312 const uint8_t *input,
2313 size_t input_length )
2314{
Janos Follath24eed8d2019-11-22 13:21:35 +00002315 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002316
2317 /* Don't require hash implementations to behave correctly on a
2318 * zero-length input, which may have an invalid pointer. */
2319 if( input_length == 0 )
2320 return( PSA_SUCCESS );
2321
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002322 switch( operation->alg )
2323 {
John Durkopee4e6602020-11-27 08:48:46 -08002324#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325 case PSA_ALG_MD2:
2326 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2327 input, input_length );
2328 break;
2329#endif
John Durkopee4e6602020-11-27 08:48:46 -08002330#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002331 case PSA_ALG_MD4:
2332 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2333 input, input_length );
2334 break;
2335#endif
John Durkopee4e6602020-11-27 08:48:46 -08002336#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337 case PSA_ALG_MD5:
2338 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2339 input, input_length );
2340 break;
2341#endif
John Durkopee4e6602020-11-27 08:48:46 -08002342#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002343 case PSA_ALG_RIPEMD160:
2344 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2345 input, input_length );
2346 break;
2347#endif
John Durkopee4e6602020-11-27 08:48:46 -08002348#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002349 case PSA_ALG_SHA_1:
2350 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2351 input, input_length );
2352 break;
2353#endif
John Durkop6ca23272020-12-03 06:01:32 -08002354#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002355 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002356 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2357 input, input_length );
2358 break;
2359#endif
2360#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002361 case PSA_ALG_SHA_256:
2362 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2363 input, input_length );
2364 break;
2365#endif
John Durkop6ca23272020-12-03 06:01:32 -08002366#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002367 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002368 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2369 input, input_length );
2370 break;
2371#endif
2372#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002373 case PSA_ALG_SHA_512:
2374 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2375 input, input_length );
2376 break;
2377#endif
2378 default:
John Durkopee4e6602020-11-27 08:48:46 -08002379 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002380 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002381 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002382
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002383 if( ret != 0 )
2384 psa_hash_abort( operation );
2385 return( mbedtls_to_psa_error( ret ) );
2386}
2387
2388psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2389 uint8_t *hash,
2390 size_t hash_size,
2391 size_t *hash_length )
2392{
itayzafrir40835d42018-08-02 13:14:17 +03002393 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002394 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002395 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002396
2397 /* Fill the output buffer with something that isn't a valid hash
2398 * (barring an attack on the hash and deliberately-crafted input),
2399 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002400 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002401 /* If hash_size is 0 then hash may be NULL and then the
2402 * call to memset would have undefined behavior. */
2403 if( hash_size != 0 )
2404 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002405
2406 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002407 {
2408 status = PSA_ERROR_BUFFER_TOO_SMALL;
2409 goto exit;
2410 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411
2412 switch( operation->alg )
2413 {
John Durkopee4e6602020-11-27 08:48:46 -08002414#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002415 case PSA_ALG_MD2:
2416 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2417 break;
2418#endif
John Durkopee4e6602020-11-27 08:48:46 -08002419#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002420 case PSA_ALG_MD4:
2421 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2422 break;
2423#endif
John Durkopee4e6602020-11-27 08:48:46 -08002424#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425 case PSA_ALG_MD5:
2426 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2427 break;
2428#endif
John Durkopee4e6602020-11-27 08:48:46 -08002429#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430 case PSA_ALG_RIPEMD160:
2431 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2432 break;
2433#endif
John Durkopee4e6602020-11-27 08:48:46 -08002434#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002435 case PSA_ALG_SHA_1:
2436 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2437 break;
2438#endif
John Durkop6ca23272020-12-03 06:01:32 -08002439#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002440 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002441 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2442 break;
2443#endif
2444#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002445 case PSA_ALG_SHA_256:
2446 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2447 break;
2448#endif
John Durkop6ca23272020-12-03 06:01:32 -08002449#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002450 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002451 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2452 break;
2453#endif
2454#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002455 case PSA_ALG_SHA_512:
2456 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2457 break;
2458#endif
2459 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002460 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461 }
itayzafrir40835d42018-08-02 13:14:17 +03002462 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002463
itayzafrir40835d42018-08-02 13:14:17 +03002464exit:
2465 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002466 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002467 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002468 return( psa_hash_abort( operation ) );
2469 }
2470 else
2471 {
2472 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002473 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002474 }
2475}
2476
Gilles Peskine2d277862018-06-18 15:41:12 +02002477psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2478 const uint8_t *hash,
2479 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002480{
2481 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2482 size_t actual_hash_length;
2483 psa_status_t status = psa_hash_finish( operation,
2484 actual_hash, sizeof( actual_hash ),
2485 &actual_hash_length );
2486 if( status != PSA_SUCCESS )
2487 return( status );
2488 if( actual_hash_length != hash_length )
2489 return( PSA_ERROR_INVALID_SIGNATURE );
2490 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2491 return( PSA_ERROR_INVALID_SIGNATURE );
2492 return( PSA_SUCCESS );
2493}
2494
Gilles Peskine0a749c82019-11-28 19:33:58 +01002495psa_status_t psa_hash_compute( psa_algorithm_t alg,
2496 const uint8_t *input, size_t input_length,
2497 uint8_t *hash, size_t hash_size,
2498 size_t *hash_length )
2499{
2500 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2501 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2502
2503 *hash_length = hash_size;
2504 status = psa_hash_setup( &operation, alg );
2505 if( status != PSA_SUCCESS )
2506 goto exit;
2507 status = psa_hash_update( &operation, input, input_length );
2508 if( status != PSA_SUCCESS )
2509 goto exit;
2510 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2511 if( status != PSA_SUCCESS )
2512 goto exit;
2513
2514exit:
2515 if( status == PSA_SUCCESS )
2516 status = psa_hash_abort( &operation );
2517 else
2518 psa_hash_abort( &operation );
2519 return( status );
2520}
2521
2522psa_status_t psa_hash_compare( psa_algorithm_t alg,
2523 const uint8_t *input, size_t input_length,
2524 const uint8_t *hash, size_t hash_length )
2525{
2526 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2528
2529 status = psa_hash_setup( &operation, alg );
2530 if( status != PSA_SUCCESS )
2531 goto exit;
2532 status = psa_hash_update( &operation, input, input_length );
2533 if( status != PSA_SUCCESS )
2534 goto exit;
2535 status = psa_hash_verify( &operation, hash, hash_length );
2536 if( status != PSA_SUCCESS )
2537 goto exit;
2538
2539exit:
2540 if( status == PSA_SUCCESS )
2541 status = psa_hash_abort( &operation );
2542 else
2543 psa_hash_abort( &operation );
2544 return( status );
2545}
2546
Gilles Peskineeb35d782019-01-22 17:56:16 +01002547psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2548 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002549{
2550 if( target_operation->alg != 0 )
2551 return( PSA_ERROR_BAD_STATE );
2552
2553 switch( source_operation->alg )
2554 {
2555 case 0:
2556 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002557#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002558 case PSA_ALG_MD2:
2559 mbedtls_md2_clone( &target_operation->ctx.md2,
2560 &source_operation->ctx.md2 );
2561 break;
2562#endif
John Durkopee4e6602020-11-27 08:48:46 -08002563#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002564 case PSA_ALG_MD4:
2565 mbedtls_md4_clone( &target_operation->ctx.md4,
2566 &source_operation->ctx.md4 );
2567 break;
2568#endif
John Durkopee4e6602020-11-27 08:48:46 -08002569#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002570 case PSA_ALG_MD5:
2571 mbedtls_md5_clone( &target_operation->ctx.md5,
2572 &source_operation->ctx.md5 );
2573 break;
2574#endif
John Durkopee4e6602020-11-27 08:48:46 -08002575#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002576 case PSA_ALG_RIPEMD160:
2577 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2578 &source_operation->ctx.ripemd160 );
2579 break;
2580#endif
John Durkopee4e6602020-11-27 08:48:46 -08002581#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002582 case PSA_ALG_SHA_1:
2583 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2584 &source_operation->ctx.sha1 );
2585 break;
2586#endif
John Durkop6ca23272020-12-03 06:01:32 -08002587#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002588 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002589 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2590 &source_operation->ctx.sha256 );
2591 break;
2592#endif
2593#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002594 case PSA_ALG_SHA_256:
2595 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2596 &source_operation->ctx.sha256 );
2597 break;
2598#endif
John Durkop6ca23272020-12-03 06:01:32 -08002599#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002600 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002601 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2602 &source_operation->ctx.sha512 );
2603 break;
2604#endif
2605#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002606 case PSA_ALG_SHA_512:
2607 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2608 &source_operation->ctx.sha512 );
2609 break;
2610#endif
2611 default:
2612 return( PSA_ERROR_NOT_SUPPORTED );
2613 }
2614
2615 target_operation->alg = source_operation->alg;
2616 return( PSA_SUCCESS );
2617}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002618
2619
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002620/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002621/* MAC */
2622/****************************************************************/
2623
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002624static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002625 psa_algorithm_t alg,
2626 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002627 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002628 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002629{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002630 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002631 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002632
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002633 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002634 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002635
Gilles Peskine8c9def32018-02-08 10:02:12 +01002636 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2637 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002638 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002639 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002640 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641 mode = MBEDTLS_MODE_STREAM;
2642 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643 case PSA_ALG_CTR:
2644 mode = MBEDTLS_MODE_CTR;
2645 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002646 case PSA_ALG_CFB:
2647 mode = MBEDTLS_MODE_CFB;
2648 break;
2649 case PSA_ALG_OFB:
2650 mode = MBEDTLS_MODE_OFB;
2651 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002652 case PSA_ALG_ECB_NO_PADDING:
2653 mode = MBEDTLS_MODE_ECB;
2654 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002655 case PSA_ALG_CBC_NO_PADDING:
2656 mode = MBEDTLS_MODE_CBC;
2657 break;
2658 case PSA_ALG_CBC_PKCS7:
2659 mode = MBEDTLS_MODE_CBC;
2660 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002661 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002662 mode = MBEDTLS_MODE_CCM;
2663 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002664 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665 mode = MBEDTLS_MODE_GCM;
2666 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002667 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2668 mode = MBEDTLS_MODE_CHACHAPOLY;
2669 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002670 default:
2671 return( NULL );
2672 }
2673 }
2674 else if( alg == PSA_ALG_CMAC )
2675 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002676 else
2677 return( NULL );
2678
2679 switch( key_type )
2680 {
2681 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002682 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683 break;
2684 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002685 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2686 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002687 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002688 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002689 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002690 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002691 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2692 * but two-key Triple-DES is functionally three-key Triple-DES
2693 * with K1=K3, so that's how we present it to mbedtls. */
2694 if( key_bits == 128 )
2695 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002696 break;
2697 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002698 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002699 break;
2700 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002701 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002703 case PSA_KEY_TYPE_CHACHA20:
2704 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2705 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706 default:
2707 return( NULL );
2708 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002709 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002710 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002711
Jaeden Amero23bbb752018-06-26 14:16:54 +01002712 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2713 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002714}
2715
John Durkop6ba40d12020-11-10 08:50:04 -08002716#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002717static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002718{
Gilles Peskine2d277862018-06-18 15:41:12 +02002719 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002720 {
2721 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002722 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002723 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002724 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002725 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002726 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002727 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002728 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002729 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002730 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002731 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002732 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002733 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002734 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002735 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002736 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002737 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002738 return( 128 );
2739 default:
2740 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002741 }
2742}
John Durkop07cc04a2020-11-16 22:08:34 -08002743#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002744
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002745/* Initialize the MAC operation structure. Once this function has been
2746 * called, psa_mac_abort can run and will do the right thing. */
2747static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2748 psa_algorithm_t alg )
2749{
2750 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2751
2752 operation->alg = alg;
2753 operation->key_set = 0;
2754 operation->iv_set = 0;
2755 operation->iv_required = 0;
2756 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002757 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002758
2759#if defined(MBEDTLS_CMAC_C)
2760 if( alg == PSA_ALG_CMAC )
2761 {
2762 operation->iv_required = 0;
2763 mbedtls_cipher_init( &operation->ctx.cmac );
2764 status = PSA_SUCCESS;
2765 }
2766 else
2767#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002768#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002769 if( PSA_ALG_IS_HMAC( operation->alg ) )
2770 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002771 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2772 operation->ctx.hmac.hash_ctx.alg = 0;
2773 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002774 }
2775 else
John Durkopd0321952020-10-29 21:37:36 -07002776#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002777 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002778 if( ! PSA_ALG_IS_MAC( alg ) )
2779 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002780 }
2781
2782 if( status != PSA_SUCCESS )
2783 memset( operation, 0, sizeof( *operation ) );
2784 return( status );
2785}
2786
John Durkop6ba40d12020-11-10 08:50:04 -08002787#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002788static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2789{
Gilles Peskine3f108122018-12-07 18:14:53 +01002790 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002791 return( psa_hash_abort( &hmac->hash_ctx ) );
2792}
John Durkop6ba40d12020-11-10 08:50:04 -08002793#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002794
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2796{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002797 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002799 /* The object has (apparently) been initialized but it is not
2800 * in use. It's ok to call abort on such an object, and there's
2801 * nothing to do. */
2802 return( PSA_SUCCESS );
2803 }
2804 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002805#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002806 if( operation->alg == PSA_ALG_CMAC )
2807 {
2808 mbedtls_cipher_free( &operation->ctx.cmac );
2809 }
2810 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002811#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002812#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002813 if( PSA_ALG_IS_HMAC( operation->alg ) )
2814 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002815 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002816 }
2817 else
John Durkopd0321952020-10-29 21:37:36 -07002818#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002819 {
2820 /* Sanity check (shouldn't happen: operation->alg should
2821 * always have been initialized to a valid value). */
2822 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823 }
Moran Peker41deec42018-04-04 15:43:05 +03002824
Gilles Peskine8c9def32018-02-08 10:02:12 +01002825 operation->alg = 0;
2826 operation->key_set = 0;
2827 operation->iv_set = 0;
2828 operation->iv_required = 0;
2829 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002830 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002831
Gilles Peskine8c9def32018-02-08 10:02:12 +01002832 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002833
2834bad_state:
2835 /* If abort is called on an uninitialized object, we can't trust
2836 * anything. Wipe the object in case it contains confidential data.
2837 * This may result in a memory leak if a pointer gets overwritten,
2838 * but it's too late to do anything about this. */
2839 memset( operation, 0, sizeof( *operation ) );
2840 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002841}
2842
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002843#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002844static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002845 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002846 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002847 const mbedtls_cipher_info_t *cipher_info )
2848{
Janos Follath24eed8d2019-11-22 13:21:35 +00002849 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002850
2851 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002852
2853 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2854 if( ret != 0 )
2855 return( ret );
2856
2857 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002858 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002859 key_bits );
2860 return( ret );
2861}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002862#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002863
John Durkop6ba40d12020-11-10 08:50:04 -08002864#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002865static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2866 const uint8_t *key,
2867 size_t key_length,
2868 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002869{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002870 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002871 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002872 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002873 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002874 psa_status_t status;
2875
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002876 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2877 * overflow below. This should never trigger if the hash algorithm
2878 * is implemented correctly. */
2879 /* The size checks against the ipad and opad buffers cannot be written
2880 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2881 * because that triggers -Wlogical-op on GCC 7.3. */
2882 if( block_size > sizeof( ipad ) )
2883 return( PSA_ERROR_NOT_SUPPORTED );
2884 if( block_size > sizeof( hmac->opad ) )
2885 return( PSA_ERROR_NOT_SUPPORTED );
2886 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002887 return( PSA_ERROR_NOT_SUPPORTED );
2888
Gilles Peskined223b522018-06-11 18:12:58 +02002889 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002890 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002891 status = psa_hash_compute( hash_alg, key, key_length,
2892 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002893 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002894 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002895 }
Gilles Peskine96889972018-07-12 17:07:03 +02002896 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2897 * but it is permitted. It is common when HMAC is used in HKDF, for
2898 * example. Don't call `memcpy` in the 0-length because `key` could be
2899 * an invalid pointer which would make the behavior undefined. */
2900 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002901 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002902
Gilles Peskined223b522018-06-11 18:12:58 +02002903 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2904 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002905 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002906 ipad[i] ^= 0x36;
2907 memset( ipad + key_length, 0x36, block_size - key_length );
2908
2909 /* Copy the key material from ipad to opad, flipping the requisite bits,
2910 * and filling the rest of opad with the requisite constant. */
2911 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002912 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2913 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002914
Gilles Peskine01126fa2018-07-12 17:04:55 +02002915 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002916 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002917 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002918
Gilles Peskine01126fa2018-07-12 17:04:55 +02002919 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002920
2921cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002922 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002923
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002924 return( status );
2925}
John Durkop6ba40d12020-11-10 08:50:04 -08002926#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002927
Gilles Peskine89167cb2018-07-08 20:12:23 +02002928static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002929 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002930 psa_algorithm_t alg,
2931 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002932{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002933 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002934 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002935 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002936 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002937 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002938 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002939 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002940 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002941
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002942 /* A context must be freshly initialized before it can be set up. */
2943 if( operation->alg != 0 )
2944 {
2945 return( PSA_ERROR_BAD_STATE );
2946 }
2947
Gilles Peskined911eb72018-08-14 15:18:45 +02002948 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002949 if( status != PSA_SUCCESS )
2950 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002951 if( is_sign )
2952 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002953
Ronald Cron5c522922020-11-14 16:35:34 +01002954 status = psa_get_and_lock_transparent_key_slot_with_policy(
2955 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002956 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002957 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002958 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002959
Gilles Peskine8c9def32018-02-08 10:02:12 +01002960#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002961 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002962 {
2963 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002964 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002965 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002966 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002967 if( cipher_info == NULL )
2968 {
2969 status = PSA_ERROR_NOT_SUPPORTED;
2970 goto exit;
2971 }
2972 operation->mac_size = cipher_info->block_size;
2973 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2974 status = mbedtls_to_psa_error( ret );
2975 }
2976 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002977#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002978#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002979 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002980 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002981 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002982 if( hash_alg == 0 )
2983 {
2984 status = PSA_ERROR_NOT_SUPPORTED;
2985 goto exit;
2986 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002987
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002988 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002989 /* Sanity check. This shouldn't fail on a valid configuration. */
2990 if( operation->mac_size == 0 ||
2991 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2992 {
2993 status = PSA_ERROR_NOT_SUPPORTED;
2994 goto exit;
2995 }
2996
Gilles Peskine8e338702019-07-30 20:06:31 +02002997 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002998 {
2999 status = PSA_ERROR_INVALID_ARGUMENT;
3000 goto exit;
3001 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003002
Gilles Peskine01126fa2018-07-12 17:04:55 +02003003 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003004 slot->key.data,
3005 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003006 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003007 }
3008 else
John Durkopd0321952020-10-29 21:37:36 -07003009#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003010 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003011 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003012 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003013 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003014
Gilles Peskined911eb72018-08-14 15:18:45 +02003015 if( truncated == 0 )
3016 {
3017 /* The "normal" case: untruncated algorithm. Nothing to do. */
3018 }
3019 else if( truncated < 4 )
3020 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003021 /* A very short MAC is too short for security since it can be
3022 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3023 * so we make this our minimum, even though 32 bits is still
3024 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003025 status = PSA_ERROR_NOT_SUPPORTED;
3026 }
3027 else if( truncated > operation->mac_size )
3028 {
3029 /* It's impossible to "truncate" to a larger length. */
3030 status = PSA_ERROR_INVALID_ARGUMENT;
3031 }
3032 else
3033 operation->mac_size = truncated;
3034
Gilles Peskinefbfac682018-07-08 20:51:54 +02003035exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003036 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003037 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003038 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003039 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003040 else
3041 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003042 operation->key_set = 1;
3043 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003044
Ronald Cron5c522922020-11-14 16:35:34 +01003045 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003046
Ronald Cron5c522922020-11-14 16:35:34 +01003047 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003048}
3049
Gilles Peskine89167cb2018-07-08 20:12:23 +02003050psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003051 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003052 psa_algorithm_t alg )
3053{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003054 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003055}
3056
3057psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003058 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003059 psa_algorithm_t alg )
3060{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003061 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003062}
3063
Gilles Peskine8c9def32018-02-08 10:02:12 +01003064psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3065 const uint8_t *input,
3066 size_t input_length )
3067{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003068 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003069 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003070 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003071 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003072 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003073 operation->has_input = 1;
3074
Gilles Peskine8c9def32018-02-08 10:02:12 +01003075#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003076 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003077 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003078 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3079 input, input_length );
3080 status = mbedtls_to_psa_error( ret );
3081 }
3082 else
3083#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003084#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003085 if( PSA_ALG_IS_HMAC( operation->alg ) )
3086 {
3087 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3088 input_length );
3089 }
3090 else
John Durkopd0321952020-10-29 21:37:36 -07003091#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003092 {
3093 /* This shouldn't happen if `operation` was initialized by
3094 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003095 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003096 }
3097
Gilles Peskinefbfac682018-07-08 20:51:54 +02003098 if( status != PSA_SUCCESS )
3099 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003100 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003101}
3102
John Durkop6ba40d12020-11-10 08:50:04 -08003103#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003104static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3105 uint8_t *mac,
3106 size_t mac_size )
3107{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003108 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003109 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3110 size_t hash_size = 0;
3111 size_t block_size = psa_get_hash_block_size( hash_alg );
3112 psa_status_t status;
3113
Gilles Peskine01126fa2018-07-12 17:04:55 +02003114 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3115 if( status != PSA_SUCCESS )
3116 return( status );
3117 /* From here on, tmp needs to be wiped. */
3118
3119 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3120 if( status != PSA_SUCCESS )
3121 goto exit;
3122
3123 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3124 if( status != PSA_SUCCESS )
3125 goto exit;
3126
3127 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3128 if( status != PSA_SUCCESS )
3129 goto exit;
3130
Gilles Peskined911eb72018-08-14 15:18:45 +02003131 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3132 if( status != PSA_SUCCESS )
3133 goto exit;
3134
3135 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003136
3137exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003138 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003139 return( status );
3140}
John Durkop6ba40d12020-11-10 08:50:04 -08003141#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003142
mohammad16036df908f2018-04-02 08:34:15 -07003143static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003144 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003145 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003146{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003147 if( ! operation->key_set )
3148 return( PSA_ERROR_BAD_STATE );
3149 if( operation->iv_required && ! operation->iv_set )
3150 return( PSA_ERROR_BAD_STATE );
3151
Gilles Peskine8c9def32018-02-08 10:02:12 +01003152 if( mac_size < operation->mac_size )
3153 return( PSA_ERROR_BUFFER_TOO_SMALL );
3154
Gilles Peskine8c9def32018-02-08 10:02:12 +01003155#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003156 if( operation->alg == PSA_ALG_CMAC )
3157 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003158 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003159 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3160 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003161 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003162 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003163 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003164 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003165 else
3166#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003167#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003168 if( PSA_ALG_IS_HMAC( operation->alg ) )
3169 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003170 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003171 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003172 }
3173 else
John Durkopd0321952020-10-29 21:37:36 -07003174#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003175 {
3176 /* This shouldn't happen if `operation` was initialized by
3177 * a setup function. */
3178 return( PSA_ERROR_BAD_STATE );
3179 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003180}
3181
Gilles Peskineacd4be32018-07-08 19:56:25 +02003182psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3183 uint8_t *mac,
3184 size_t mac_size,
3185 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003186{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003187 psa_status_t status;
3188
Jaeden Amero252ef282019-02-15 14:05:35 +00003189 if( operation->alg == 0 )
3190 {
3191 return( PSA_ERROR_BAD_STATE );
3192 }
3193
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003194 /* Fill the output buffer with something that isn't a valid mac
3195 * (barring an attack on the mac and deliberately-crafted input),
3196 * in case the caller doesn't check the return status properly. */
3197 *mac_length = mac_size;
3198 /* If mac_size is 0 then mac may be NULL and then the
3199 * call to memset would have undefined behavior. */
3200 if( mac_size != 0 )
3201 memset( mac, '!', mac_size );
3202
Gilles Peskine89167cb2018-07-08 20:12:23 +02003203 if( ! operation->is_sign )
3204 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003205 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003206 }
mohammad16036df908f2018-04-02 08:34:15 -07003207
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003208 status = psa_mac_finish_internal( operation, mac, mac_size );
3209
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003210 if( status == PSA_SUCCESS )
3211 {
3212 status = psa_mac_abort( operation );
3213 if( status == PSA_SUCCESS )
3214 *mac_length = operation->mac_size;
3215 else
3216 memset( mac, '!', mac_size );
3217 }
3218 else
3219 psa_mac_abort( operation );
3220 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003221}
3222
Gilles Peskineacd4be32018-07-08 19:56:25 +02003223psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3224 const uint8_t *mac,
3225 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003226{
Gilles Peskine828ed142018-06-18 23:25:51 +02003227 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003228 psa_status_t status;
3229
Jaeden Amero252ef282019-02-15 14:05:35 +00003230 if( operation->alg == 0 )
3231 {
3232 return( PSA_ERROR_BAD_STATE );
3233 }
3234
Gilles Peskine89167cb2018-07-08 20:12:23 +02003235 if( operation->is_sign )
3236 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003237 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003238 }
3239 if( operation->mac_size != mac_length )
3240 {
3241 status = PSA_ERROR_INVALID_SIGNATURE;
3242 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003243 }
mohammad16036df908f2018-04-02 08:34:15 -07003244
3245 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003246 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003247 if( status != PSA_SUCCESS )
3248 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003249
3250 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3251 status = PSA_ERROR_INVALID_SIGNATURE;
3252
3253cleanup:
3254 if( status == PSA_SUCCESS )
3255 status = psa_mac_abort( operation );
3256 else
3257 psa_mac_abort( operation );
3258
Gilles Peskine3f108122018-12-07 18:14:53 +01003259 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003260
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003261 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003262}
3263
3264
Gilles Peskine20035e32018-02-03 22:44:14 +01003265
Gilles Peskine20035e32018-02-03 22:44:14 +01003266/****************************************************************/
3267/* Asymmetric cryptography */
3268/****************************************************************/
3269
John Durkop6ba40d12020-11-10 08:50:04 -08003270#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3271 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003272/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003273 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003274static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3275 size_t hash_length,
3276 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003277{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003278 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003279 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003280 *md_alg = mbedtls_md_get_type( md_info );
3281
3282 /* The Mbed TLS RSA module uses an unsigned int for hash length
3283 * parameters. Validate that it fits so that we don't risk an
3284 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003285#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003286 if( hash_length > UINT_MAX )
3287 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003288#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003289
John Durkop0e005192020-10-31 22:06:54 -07003290#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003291 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3292 * must be correct. */
3293 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3294 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003295 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003296 if( md_info == NULL )
3297 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003298 if( mbedtls_md_get_size( md_info ) != hash_length )
3299 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003300 }
John Durkop0e005192020-10-31 22:06:54 -07003301#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003302
John Durkop0e005192020-10-31 22:06:54 -07003303#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003304 /* PSS requires a hash internally. */
3305 if( PSA_ALG_IS_RSA_PSS( alg ) )
3306 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003307 if( md_info == NULL )
3308 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003309 }
John Durkop0e005192020-10-31 22:06:54 -07003310#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003311
Gilles Peskine61b91d42018-06-08 16:09:36 +02003312 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003313}
3314
Gilles Peskine2b450e32018-06-27 15:42:46 +02003315static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3316 psa_algorithm_t alg,
3317 const uint8_t *hash,
3318 size_t hash_length,
3319 uint8_t *signature,
3320 size_t signature_size,
3321 size_t *signature_length )
3322{
3323 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003324 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003325 mbedtls_md_type_t md_alg;
3326
3327 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3328 if( status != PSA_SUCCESS )
3329 return( status );
3330
Gilles Peskine630a18a2018-06-29 17:49:35 +02003331 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003332 return( PSA_ERROR_BUFFER_TOO_SMALL );
3333
John Durkop0e005192020-10-31 22:06:54 -07003334#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003335 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3336 {
3337 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3338 MBEDTLS_MD_NONE );
3339 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003340 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003341 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003342 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003343 md_alg,
3344 (unsigned int) hash_length,
3345 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003346 signature );
3347 }
3348 else
John Durkop0e005192020-10-31 22:06:54 -07003349#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3350#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003351 if( PSA_ALG_IS_RSA_PSS( alg ) )
3352 {
3353 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3354 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003355 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003356 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003357 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003358 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003359 (unsigned int) hash_length,
3360 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003361 signature );
3362 }
3363 else
John Durkop0e005192020-10-31 22:06:54 -07003364#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003365 {
3366 return( PSA_ERROR_INVALID_ARGUMENT );
3367 }
3368
3369 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003370 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003371 return( mbedtls_to_psa_error( ret ) );
3372}
3373
3374static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3375 psa_algorithm_t alg,
3376 const uint8_t *hash,
3377 size_t hash_length,
3378 const uint8_t *signature,
3379 size_t signature_length )
3380{
3381 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003383 mbedtls_md_type_t md_alg;
3384
3385 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3386 if( status != PSA_SUCCESS )
3387 return( status );
3388
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003389 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3390 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003391
John Durkop0e005192020-10-31 22:06:54 -07003392#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003393 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3394 {
3395 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3396 MBEDTLS_MD_NONE );
3397 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003398 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003399 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003400 MBEDTLS_RSA_PUBLIC,
3401 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003402 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003403 hash,
3404 signature );
3405 }
3406 else
John Durkop0e005192020-10-31 22:06:54 -07003407#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3408#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003409 if( PSA_ALG_IS_RSA_PSS( alg ) )
3410 {
3411 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3412 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003413 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003414 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003415 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003416 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003417 (unsigned int) hash_length,
3418 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003419 signature );
3420 }
3421 else
John Durkop0e005192020-10-31 22:06:54 -07003422#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003423 {
3424 return( PSA_ERROR_INVALID_ARGUMENT );
3425 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003426
3427 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3428 * the rest of the signature is invalid". This has little use in
3429 * practice and PSA doesn't report this distinction. */
3430 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3431 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003432 return( mbedtls_to_psa_error( ret ) );
3433}
John Durkop6ba40d12020-11-10 08:50:04 -08003434#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3435 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003436
John Durkop6ba40d12020-11-10 08:50:04 -08003437#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3438 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003439/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3440 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3441 * (even though these functions don't modify it). */
3442static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3443 psa_algorithm_t alg,
3444 const uint8_t *hash,
3445 size_t hash_length,
3446 uint8_t *signature,
3447 size_t signature_size,
3448 size_t *signature_length )
3449{
Janos Follath24eed8d2019-11-22 13:21:35 +00003450 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003451 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003452 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003453 mbedtls_mpi_init( &r );
3454 mbedtls_mpi_init( &s );
3455
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003456 if( signature_size < 2 * curve_bytes )
3457 {
3458 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3459 goto cleanup;
3460 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003461
John Durkop0ea39e02020-10-13 19:58:20 -07003462#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003463 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3464 {
3465 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3466 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3467 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003468 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3469 &ecp->d, hash,
3470 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003471 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003472 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003473 }
3474 else
John Durkop0ea39e02020-10-13 19:58:20 -07003475#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003476 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003477 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003478 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3479 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003480 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003481 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003482 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003483
3484 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3485 signature,
3486 curve_bytes ) );
3487 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3488 signature + curve_bytes,
3489 curve_bytes ) );
3490
3491cleanup:
3492 mbedtls_mpi_free( &r );
3493 mbedtls_mpi_free( &s );
3494 if( ret == 0 )
3495 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003496 return( mbedtls_to_psa_error( ret ) );
3497}
3498
3499static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3500 const uint8_t *hash,
3501 size_t hash_length,
3502 const uint8_t *signature,
3503 size_t signature_length )
3504{
Janos Follath24eed8d2019-11-22 13:21:35 +00003505 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003506 mbedtls_mpi r, s;
3507 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3508 mbedtls_mpi_init( &r );
3509 mbedtls_mpi_init( &s );
3510
3511 if( signature_length != 2 * curve_bytes )
3512 return( PSA_ERROR_INVALID_SIGNATURE );
3513
3514 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3515 signature,
3516 curve_bytes ) );
3517 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3518 signature + curve_bytes,
3519 curve_bytes ) );
3520
Steven Cooremanacda8342020-07-24 23:09:52 +02003521 /* Check whether the public part is loaded. If not, load it. */
3522 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3523 {
3524 MBEDTLS_MPI_CHK(
3525 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003526 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003527 }
3528
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003529 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3530 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003531
3532cleanup:
3533 mbedtls_mpi_free( &r );
3534 mbedtls_mpi_free( &s );
3535 return( mbedtls_to_psa_error( ret ) );
3536}
John Durkop6ba40d12020-11-10 08:50:04 -08003537#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3538 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003539
Ronald Croncf56a0a2020-08-04 09:51:30 +02003540psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003541 psa_algorithm_t alg,
3542 const uint8_t *hash,
3543 size_t hash_length,
3544 uint8_t *signature,
3545 size_t signature_size,
3546 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003547{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003549 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003550 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003551
3552 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003553 /* Immediately reject a zero-length signature buffer. This guarantees
3554 * that signature must be a valid pointer. (On the other hand, the hash
3555 * buffer can in principle be empty since it doesn't actually have
3556 * to be a hash.) */
3557 if( signature_size == 0 )
3558 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003559
Ronald Cron5c522922020-11-14 16:35:34 +01003560 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3561 PSA_KEY_USAGE_SIGN_HASH,
3562 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003563 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003564 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003565 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003566 {
3567 status = PSA_ERROR_INVALID_ARGUMENT;
3568 goto exit;
3569 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003570
Steven Cooremancd84cb42020-07-16 20:28:36 +02003571 /* Try any of the available accelerators first */
3572 status = psa_driver_wrapper_sign_hash( slot,
3573 alg,
3574 hash,
3575 hash_length,
3576 signature,
3577 signature_size,
3578 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003579 if( status != PSA_ERROR_NOT_SUPPORTED ||
3580 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003581 goto exit;
3582
Steven Cooreman7a250572020-07-17 16:43:05 +02003583 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003584#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3585 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003586 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003587 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003588 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003589
Ronald Cron90857082020-11-25 14:58:33 +01003590 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3591 slot->key.data,
3592 slot->key.bytes,
3593 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003594 if( status != PSA_SUCCESS )
3595 goto exit;
3596
Steven Cooremana2371e52020-07-28 14:30:39 +02003597 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003598 alg,
3599 hash, hash_length,
3600 signature, signature_size,
3601 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003602
Steven Cooremana2371e52020-07-28 14:30:39 +02003603 mbedtls_rsa_free( rsa );
3604 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003605 }
3606 else
John Durkop6ba40d12020-11-10 08:50:04 -08003607#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3608 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003609 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003610 {
John Durkop9814fa22020-11-04 12:28:15 -08003611#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3612 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003613 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003614#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003615 PSA_ALG_IS_ECDSA( alg )
3616#else
3617 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3618#endif
3619 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003620 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003621 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003622 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3623 slot->key.data,
3624 slot->key.bytes,
3625 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003626 if( status != PSA_SUCCESS )
3627 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003628 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003629 alg,
3630 hash, hash_length,
3631 signature, signature_size,
3632 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003633 mbedtls_ecp_keypair_free( ecp );
3634 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003635 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003636 else
John Durkop9814fa22020-11-04 12:28:15 -08003637#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3638 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003639 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003640 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003641 }
itayzafrir5c753392018-05-08 11:18:38 +03003642 }
3643 else
itayzafrir5c753392018-05-08 11:18:38 +03003644 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003645 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003646 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003647
3648exit:
3649 /* Fill the unused part of the output buffer (the whole buffer on error,
3650 * the trailing part on success) with something that isn't a valid mac
3651 * (barring an attack on the mac and deliberately-crafted input),
3652 * in case the caller doesn't check the return status properly. */
3653 if( status == PSA_SUCCESS )
3654 memset( signature + *signature_length, '!',
3655 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003656 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003657 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003658 /* If signature_size is 0 then we have nothing to do. We must not call
3659 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003660
Ronald Cron5c522922020-11-14 16:35:34 +01003661 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003662
Ronald Cron5c522922020-11-14 16:35:34 +01003663 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003664}
3665
Ronald Croncf56a0a2020-08-04 09:51:30 +02003666psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003667 psa_algorithm_t alg,
3668 const uint8_t *hash,
3669 size_t hash_length,
3670 const uint8_t *signature,
3671 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003672{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003673 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003674 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003675 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003676
Ronald Cron5c522922020-11-14 16:35:34 +01003677 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3678 PSA_KEY_USAGE_VERIFY_HASH,
3679 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003680 if( status != PSA_SUCCESS )
3681 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003682
Steven Cooreman55ae2172020-07-17 19:46:15 +02003683 /* Try any of the available accelerators first */
3684 status = psa_driver_wrapper_verify_hash( slot,
3685 alg,
3686 hash,
3687 hash_length,
3688 signature,
3689 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003690 if( status != PSA_ERROR_NOT_SUPPORTED ||
3691 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003692 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003693
John Durkop6ba40d12020-11-10 08:50:04 -08003694#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3695 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003696 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003697 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003698 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003699
Ronald Cron90857082020-11-25 14:58:33 +01003700 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3701 slot->key.data,
3702 slot->key.bytes,
3703 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003704 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003705 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003706
Steven Cooremana2371e52020-07-28 14:30:39 +02003707 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003708 alg,
3709 hash, hash_length,
3710 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003711 mbedtls_rsa_free( rsa );
3712 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003713 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003714 }
3715 else
John Durkop6ba40d12020-11-10 08:50:04 -08003716#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3717 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003718 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003719 {
John Durkop9814fa22020-11-04 12:28:15 -08003720#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3721 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003722 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003723 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003724 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003725 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3726 slot->key.data,
3727 slot->key.bytes,
3728 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003729 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003730 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003731 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003732 hash, hash_length,
3733 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003734 mbedtls_ecp_keypair_free( ecp );
3735 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003736 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003737 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003738 else
John Durkop9814fa22020-11-04 12:28:15 -08003739#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3740 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003741 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003742 status = PSA_ERROR_INVALID_ARGUMENT;
3743 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003744 }
itayzafrir5c753392018-05-08 11:18:38 +03003745 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003746 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003747 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003748 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003749 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003750
3751exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003752 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003753
Ronald Cron5c522922020-11-14 16:35:34 +01003754 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003755}
3756
John Durkop0e005192020-10-31 22:06:54 -07003757#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003758static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3759 mbedtls_rsa_context *rsa )
3760{
3761 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3762 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3763 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3764 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3765}
John Durkop0e005192020-10-31 22:06:54 -07003766#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003767
Ronald Croncf56a0a2020-08-04 09:51:30 +02003768psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003769 psa_algorithm_t alg,
3770 const uint8_t *input,
3771 size_t input_length,
3772 const uint8_t *salt,
3773 size_t salt_length,
3774 uint8_t *output,
3775 size_t output_size,
3776 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003777{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003778 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003779 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003780 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003781
Darryl Green5cc689a2018-07-24 15:34:10 +01003782 (void) input;
3783 (void) input_length;
3784 (void) salt;
3785 (void) output;
3786 (void) output_size;
3787
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003788 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003789
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003790 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3791 return( PSA_ERROR_INVALID_ARGUMENT );
3792
Ronald Cron5c522922020-11-14 16:35:34 +01003793 status = psa_get_and_lock_transparent_key_slot_with_policy(
3794 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003795 if( status != PSA_SUCCESS )
3796 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003797 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3798 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003799 {
3800 status = PSA_ERROR_INVALID_ARGUMENT;
3801 goto exit;
3802 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003803
John Durkop6ba40d12020-11-10 08:50:04 -08003804#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3805 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003806 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003807 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003808 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003809 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3810 slot->key.data,
3811 slot->key.bytes,
3812 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003813 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003814 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003815
3816 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003817 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003818 status = PSA_ERROR_BUFFER_TOO_SMALL;
3819 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003820 }
John Durkop0e005192020-10-31 22:06:54 -07003821#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003822 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003823 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003824 status = mbedtls_to_psa_error(
3825 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003826 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003827 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003828 MBEDTLS_RSA_PUBLIC,
3829 input_length,
3830 input,
3831 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003832 }
3833 else
John Durkop0e005192020-10-31 22:06:54 -07003834#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3835#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003836 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003837 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003838 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003839 status = mbedtls_to_psa_error(
3840 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003841 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003842 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003843 MBEDTLS_RSA_PUBLIC,
3844 salt, salt_length,
3845 input_length,
3846 input,
3847 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003848 }
3849 else
John Durkop0e005192020-10-31 22:06:54 -07003850#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003851 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003852 status = PSA_ERROR_INVALID_ARGUMENT;
3853 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003854 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003855rsa_exit:
3856 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003857 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003858
Steven Cooremana2371e52020-07-28 14:30:39 +02003859 mbedtls_rsa_free( rsa );
3860 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003861 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003862 else
John Durkop9814fa22020-11-04 12:28:15 -08003863#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003864 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003865 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003866 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003867 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003868
3869exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003870 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003871
Ronald Cron5c522922020-11-14 16:35:34 +01003872 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003873}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003874
Ronald Croncf56a0a2020-08-04 09:51:30 +02003875psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003876 psa_algorithm_t alg,
3877 const uint8_t *input,
3878 size_t input_length,
3879 const uint8_t *salt,
3880 size_t salt_length,
3881 uint8_t *output,
3882 size_t output_size,
3883 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003884{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003885 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003886 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003887 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003888
Darryl Green5cc689a2018-07-24 15:34:10 +01003889 (void) input;
3890 (void) input_length;
3891 (void) salt;
3892 (void) output;
3893 (void) output_size;
3894
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003895 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003896
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003897 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3898 return( PSA_ERROR_INVALID_ARGUMENT );
3899
Ronald Cron5c522922020-11-14 16:35:34 +01003900 status = psa_get_and_lock_transparent_key_slot_with_policy(
3901 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003902 if( status != PSA_SUCCESS )
3903 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003904 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003905 {
3906 status = PSA_ERROR_INVALID_ARGUMENT;
3907 goto exit;
3908 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003909
John Durkop6ba40d12020-11-10 08:50:04 -08003910#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3911 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003912 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003913 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003914 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003915 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3916 slot->key.data,
3917 slot->key.bytes,
3918 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003919 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003920 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003921
Steven Cooremana2371e52020-07-28 14:30:39 +02003922 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003923 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003924 status = PSA_ERROR_INVALID_ARGUMENT;
3925 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003926 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003927
John Durkop0e005192020-10-31 22:06:54 -07003928#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003929 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003930 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003931 status = mbedtls_to_psa_error(
3932 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003933 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003934 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003935 MBEDTLS_RSA_PRIVATE,
3936 output_length,
3937 input,
3938 output,
3939 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003940 }
3941 else
John Durkop0e005192020-10-31 22:06:54 -07003942#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3943#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003944 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003945 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003946 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003947 status = mbedtls_to_psa_error(
3948 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003949 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003950 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003951 MBEDTLS_RSA_PRIVATE,
3952 salt, salt_length,
3953 output_length,
3954 input,
3955 output,
3956 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003957 }
3958 else
John Durkop0e005192020-10-31 22:06:54 -07003959#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003960 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003961 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003962 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003963
Steven Cooreman4fed4552020-08-03 14:46:03 +02003964rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003965 mbedtls_rsa_free( rsa );
3966 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003967 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003968 else
John Durkop6ba40d12020-11-10 08:50:04 -08003969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3970 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003971 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003972 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003973 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003974
3975exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003976 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003977
Ronald Cron5c522922020-11-14 16:35:34 +01003978 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003979}
Gilles Peskine20035e32018-02-03 22:44:14 +01003980
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003981
3982
mohammad1603503973b2018-03-12 15:59:30 +02003983/****************************************************************/
3984/* Symmetric cryptography */
3985/****************************************************************/
3986
Gilles Peskinee553c652018-06-04 16:22:46 +02003987static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003988 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003989 psa_algorithm_t alg,
3990 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003991{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003993 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003994 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003995 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003996 size_t key_bits;
3997 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003998 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3999 PSA_KEY_USAGE_ENCRYPT :
4000 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004001
Steven Cooremand3feccd2020-09-01 15:56:14 +02004002 /* A context must be freshly initialized before it can be set up. */
4003 if( operation->alg != 0 )
4004 return( PSA_ERROR_BAD_STATE );
4005
Steven Cooremana07b9972020-09-10 14:54:14 +02004006 /* The requested algorithm must be one that can be processed by cipher. */
4007 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004008 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004009
Steven Cooremanef8575e2020-09-11 11:44:50 +02004010 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004011 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004012 if( status != PSA_SUCCESS )
4013 goto exit;
4014
4015 /* Initialize the operation struct members, except for alg. The alg member
4016 * is used to indicate to psa_cipher_abort that there are resources to free,
4017 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004018 operation->key_set = 0;
4019 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004020 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004021 operation->iv_size = 0;
4022 operation->block_size = 0;
4023 if( alg == PSA_ALG_ECB_NO_PADDING )
4024 operation->iv_required = 0;
4025 else
4026 operation->iv_required = 1;
4027
Steven Cooremana07b9972020-09-10 14:54:14 +02004028 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004029 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004030 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004031 slot,
4032 alg );
4033 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004034 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004035 slot,
4036 alg );
4037
Steven Cooremanef8575e2020-09-11 11:44:50 +02004038 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004039 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004040 /* Once the driver context is initialised, it needs to be freed using
4041 * psa_cipher_abort. Indicate this through setting alg. */
4042 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004043 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004044
Steven Cooremand3feccd2020-09-01 15:56:14 +02004045 if( status != PSA_ERROR_NOT_SUPPORTED ||
4046 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4047 goto exit;
4048
Steven Cooremana07b9972020-09-10 14:54:14 +02004049 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004050 * available for the given algorithm & key. */
4051 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004052
Steven Cooremana07b9972020-09-10 14:54:14 +02004053 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004054 * psa_cipher_abort. Indicate there is something to be freed through setting
4055 * alg, and indicate the operation is being done using mbedtls crypto through
4056 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004057 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004058 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004059
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004060 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004061 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004062 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004063 {
4064 status = PSA_ERROR_NOT_SUPPORTED;
4065 goto exit;
4066 }
mohammad1603503973b2018-03-12 15:59:30 +02004067
mohammad1603503973b2018-03-12 15:59:30 +02004068 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004069 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004070 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004071
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004072#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004073 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004074 {
4075 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004076 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004077 memcpy( keys, slot->key.data, 16 );
4078 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004079 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4080 keys,
4081 192, cipher_operation );
4082 }
4083 else
4084#endif
4085 {
4086 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004087 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004088 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004089 }
Moran Peker41deec42018-04-04 15:43:05 +03004090 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004091 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004092
mohammad16038481e742018-03-18 13:57:31 +02004093#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004094 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004095 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004096 case PSA_ALG_CBC_NO_PADDING:
4097 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4098 MBEDTLS_PADDING_NONE );
4099 break;
4100 case PSA_ALG_CBC_PKCS7:
4101 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4102 MBEDTLS_PADDING_PKCS7 );
4103 break;
4104 default:
4105 /* The algorithm doesn't involve padding. */
4106 ret = 0;
4107 break;
4108 }
4109 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004110 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004111#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4112
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004113 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004114 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004115 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4116 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004117 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004118 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004119 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004120#if defined(MBEDTLS_CHACHA20_C)
4121 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004122 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004123 operation->iv_size = 12;
4124#endif
mohammad1603503973b2018-03-12 15:59:30 +02004125
Steven Cooreman7df02922020-09-09 15:28:49 +02004126 status = PSA_SUCCESS;
4127
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004128exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004129 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004130 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004131 if( status == PSA_SUCCESS )
4132 {
4133 /* Update operation flags for both driver and software implementations */
4134 operation->key_set = 1;
4135 }
4136 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004137 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004138
Ronald Cron5c522922020-11-14 16:35:34 +01004139 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004140
Ronald Cron5c522922020-11-14 16:35:34 +01004141 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004142}
4143
Gilles Peskinefe119512018-07-08 21:39:34 +02004144psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004145 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004146 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004147{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004148 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004149}
4150
Gilles Peskinefe119512018-07-08 21:39:34 +02004151psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004152 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004153 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004154{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004155 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004156}
4157
Gilles Peskinefe119512018-07-08 21:39:34 +02004158psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004159 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004160 size_t iv_size,
4161 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004162{
itayzafrir534bd7c2018-08-02 13:56:32 +03004163 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004164 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004165 if( operation->iv_set || ! operation->iv_required )
4166 {
4167 return( PSA_ERROR_BAD_STATE );
4168 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004169
Steven Cooremanef8575e2020-09-11 11:44:50 +02004170 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004171 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004172 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004173 iv,
4174 iv_size,
4175 iv_length );
4176 goto exit;
4177 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004178
Moran Peker41deec42018-04-04 15:43:05 +03004179 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004180 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004181 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004182 goto exit;
4183 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004184 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004185 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004186 if( ret != 0 )
4187 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004188 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004189 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004190 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004191
mohammad16038481e742018-03-18 13:57:31 +02004192 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004193 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004194
Moran Peker395db872018-05-31 14:07:14 +03004195exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004196 if( status == PSA_SUCCESS )
4197 operation->iv_set = 1;
4198 else
Moran Peker395db872018-05-31 14:07:14 +03004199 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004200 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004201}
4202
Gilles Peskinefe119512018-07-08 21:39:34 +02004203psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004204 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004205 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004206{
itayzafrir534bd7c2018-08-02 13:56:32 +03004207 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004209 if( operation->iv_set || ! operation->iv_required )
4210 {
4211 return( PSA_ERROR_BAD_STATE );
4212 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004213
Steven Cooremanef8575e2020-09-11 11:44:50 +02004214 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004215 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004216 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004217 iv,
4218 iv_length );
4219 goto exit;
4220 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004221
Moran Pekera28258c2018-05-29 16:25:04 +03004222 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004223 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004224 status = PSA_ERROR_INVALID_ARGUMENT;
4225 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004226 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004227 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4228 status = mbedtls_to_psa_error( ret );
4229exit:
4230 if( status == PSA_SUCCESS )
4231 operation->iv_set = 1;
4232 else
mohammad1603503973b2018-03-12 15:59:30 +02004233 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004234 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004235}
4236
Steven Cooreman177deba2020-09-07 17:14:14 +02004237/* Process input for which the algorithm is set to ECB mode. This requires
4238 * manual processing, since the PSA API is defined as being able to process
4239 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4240 * underlying mbedtls_cipher_update only takes full blocks. */
4241static psa_status_t psa_cipher_update_ecb_internal(
4242 mbedtls_cipher_context_t *ctx,
4243 const uint8_t *input,
4244 size_t input_length,
4245 uint8_t *output,
4246 size_t output_size,
4247 size_t *output_length )
4248{
4249 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4250 size_t block_size = ctx->cipher_info->block_size;
4251 size_t internal_output_length = 0;
4252 *output_length = 0;
4253
4254 if( input_length == 0 )
4255 {
4256 status = PSA_SUCCESS;
4257 goto exit;
4258 }
4259
4260 if( ctx->unprocessed_len > 0 )
4261 {
4262 /* Fill up to block size, and run the block if there's a full one. */
4263 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4264
4265 if( input_length < bytes_to_copy )
4266 bytes_to_copy = input_length;
4267
4268 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4269 input, bytes_to_copy );
4270 input_length -= bytes_to_copy;
4271 input += bytes_to_copy;
4272 ctx->unprocessed_len += bytes_to_copy;
4273
4274 if( ctx->unprocessed_len == block_size )
4275 {
4276 status = mbedtls_to_psa_error(
4277 mbedtls_cipher_update( ctx,
4278 ctx->unprocessed_data,
4279 block_size,
4280 output, &internal_output_length ) );
4281
4282 if( status != PSA_SUCCESS )
4283 goto exit;
4284
4285 output += internal_output_length;
4286 output_size -= internal_output_length;
4287 *output_length += internal_output_length;
4288 ctx->unprocessed_len = 0;
4289 }
4290 }
4291
4292 while( input_length >= block_size )
4293 {
4294 /* Run all full blocks we have, one by one */
4295 status = mbedtls_to_psa_error(
4296 mbedtls_cipher_update( ctx, input,
4297 block_size,
4298 output, &internal_output_length ) );
4299
4300 if( status != PSA_SUCCESS )
4301 goto exit;
4302
4303 input_length -= block_size;
4304 input += block_size;
4305
4306 output += internal_output_length;
4307 output_size -= internal_output_length;
4308 *output_length += internal_output_length;
4309 }
4310
4311 if( input_length > 0 )
4312 {
4313 /* Save unprocessed bytes for later processing */
4314 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4315 input, input_length );
4316 ctx->unprocessed_len += input_length;
4317 }
4318
4319 status = PSA_SUCCESS;
4320
4321exit:
4322 return( status );
4323}
4324
Gilles Peskinee553c652018-06-04 16:22:46 +02004325psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4326 const uint8_t *input,
4327 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004328 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004329 size_t output_size,
4330 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004331{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004333 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004334 if( operation->alg == 0 )
4335 {
4336 return( PSA_ERROR_BAD_STATE );
4337 }
4338 if( operation->iv_required && ! operation->iv_set )
4339 {
4340 return( PSA_ERROR_BAD_STATE );
4341 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004342
Steven Cooremanef8575e2020-09-11 11:44:50 +02004343 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004344 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004345 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004346 input,
4347 input_length,
4348 output,
4349 output_size,
4350 output_length );
4351 goto exit;
4352 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004353
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004354 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004355 {
4356 /* Take the unprocessed partial block left over from previous
4357 * update calls, if any, plus the input to this call. Remove
4358 * the last partial block, if any. You get the data that will be
4359 * output in this call. */
4360 expected_output_size =
4361 ( operation->ctx.cipher.unprocessed_len + input_length )
4362 / operation->block_size * operation->block_size;
4363 }
4364 else
4365 {
4366 expected_output_size = input_length;
4367 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004368
Gilles Peskine89d789c2018-06-04 17:17:16 +02004369 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004370 {
4371 status = PSA_ERROR_BUFFER_TOO_SMALL;
4372 goto exit;
4373 }
mohammad160382759612018-03-12 18:16:40 +02004374
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004375 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4376 {
4377 /* mbedtls_cipher_update has an API inconsistency: it will only
4378 * process a single block at a time in ECB mode. Abstract away that
4379 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004380 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4381 input,
4382 input_length,
4383 output,
4384 output_size,
4385 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004386 }
4387 else
4388 {
4389 status = mbedtls_to_psa_error(
4390 mbedtls_cipher_update( &operation->ctx.cipher, input,
4391 input_length, output, output_length ) );
4392 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004393exit:
4394 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004395 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004396 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004397}
4398
Gilles Peskinee553c652018-06-04 16:22:46 +02004399psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4400 uint8_t *output,
4401 size_t output_size,
4402 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004403{
David Saadab4ecc272019-02-14 13:48:10 +02004404 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004405 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004406 if( operation->alg == 0 )
4407 {
4408 return( PSA_ERROR_BAD_STATE );
4409 }
4410 if( operation->iv_required && ! operation->iv_set )
4411 {
4412 return( PSA_ERROR_BAD_STATE );
4413 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004414
Steven Cooremanef8575e2020-09-11 11:44:50 +02004415 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004416 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004417 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004418 output,
4419 output_size,
4420 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004421 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004422 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004423
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004424 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004425 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004426 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004427 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004428 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004429 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004430 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004431 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004432 }
4433
Steven Cooremanef8575e2020-09-11 11:44:50 +02004434 status = mbedtls_to_psa_error(
4435 mbedtls_cipher_finish( &operation->ctx.cipher,
4436 temp_output_buffer,
4437 output_length ) );
4438 if( status != PSA_SUCCESS )
4439 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004440
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004441 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004442 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004443 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004444 memcpy( output, temp_output_buffer, *output_length );
4445 else
Janos Follath315b51c2018-07-09 16:04:51 +01004446 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004447
Steven Cooremanef8575e2020-09-11 11:44:50 +02004448exit:
4449 if( operation->mbedtls_in_use == 1 )
4450 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004451
Steven Cooremanef8575e2020-09-11 11:44:50 +02004452 if( status == PSA_SUCCESS )
4453 return( psa_cipher_abort( operation ) );
4454 else
4455 {
4456 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004457 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004458
Steven Cooremanef8575e2020-09-11 11:44:50 +02004459 return( status );
4460 }
mohammad1603503973b2018-03-12 15:59:30 +02004461}
4462
Gilles Peskinee553c652018-06-04 16:22:46 +02004463psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4464{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004465 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004466 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004467 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004468 * in use. It's ok to call abort on such an object, and there's
4469 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004470 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004471 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004472
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004473 /* Sanity check (shouldn't happen: operation->alg should
4474 * always have been initialized to a valid value). */
4475 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4476 return( PSA_ERROR_BAD_STATE );
4477
Steven Cooremanef8575e2020-09-11 11:44:50 +02004478 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004479 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004480 else
4481 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004482
Moran Peker41deec42018-04-04 15:43:05 +03004483 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004484 operation->key_set = 0;
4485 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004486 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004487 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004488 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004489 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004490
Moran Peker395db872018-05-31 14:07:14 +03004491 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004492}
4493
Gilles Peskinea0655c32018-04-30 17:06:50 +02004494
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004495
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004496
mohammad16035955c982018-04-26 00:53:03 +03004497/****************************************************************/
4498/* AEAD */
4499/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004500
Gilles Peskineedf9a652018-08-17 18:11:56 +02004501typedef struct
4502{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004503 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004504 const mbedtls_cipher_info_t *cipher_info;
4505 union
4506 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004507 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004508#if defined(MBEDTLS_CCM_C)
4509 mbedtls_ccm_context ccm;
4510#endif /* MBEDTLS_CCM_C */
4511#if defined(MBEDTLS_GCM_C)
4512 mbedtls_gcm_context gcm;
4513#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004514#if defined(MBEDTLS_CHACHAPOLY_C)
4515 mbedtls_chachapoly_context chachapoly;
4516#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004517 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004518 psa_algorithm_t core_alg;
4519 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004520 uint8_t tag_length;
4521} aead_operation_t;
4522
Ronald Cronf95a2b12020-10-22 15:24:49 +02004523#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4524
Gilles Peskine30a9e412019-01-14 18:36:12 +01004525static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004526{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004527 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004528 {
4529#if defined(MBEDTLS_CCM_C)
4530 case PSA_ALG_CCM:
4531 mbedtls_ccm_free( &operation->ctx.ccm );
4532 break;
4533#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004534#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004535 case PSA_ALG_GCM:
4536 mbedtls_gcm_free( &operation->ctx.gcm );
4537 break;
4538#endif /* MBEDTLS_GCM_C */
4539 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004540
Ronald Cron5c522922020-11-14 16:35:34 +01004541 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004542}
4543
4544static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004545 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004546 psa_key_usage_t usage,
4547 psa_algorithm_t alg )
4548{
4549 psa_status_t status;
4550 size_t key_bits;
4551 mbedtls_cipher_id_t cipher_id;
4552
Ronald Cron5c522922020-11-14 16:35:34 +01004553 status = psa_get_and_lock_transparent_key_slot_with_policy(
4554 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004555 if( status != PSA_SUCCESS )
4556 return( status );
4557
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004558 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004559
4560 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004561 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004562 &cipher_id );
4563 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004564 {
4565 status = PSA_ERROR_NOT_SUPPORTED;
4566 goto cleanup;
4567 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004568
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004569 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004570 {
4571#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004572 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4573 operation->core_alg = PSA_ALG_CCM;
4574 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004575 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4576 * The call to mbedtls_ccm_encrypt_and_tag or
4577 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004578 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004579 {
4580 status = PSA_ERROR_INVALID_ARGUMENT;
4581 goto cleanup;
4582 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004583 mbedtls_ccm_init( &operation->ctx.ccm );
4584 status = mbedtls_to_psa_error(
4585 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004586 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004587 (unsigned int) key_bits ) );
4588 if( status != 0 )
4589 goto cleanup;
4590 break;
4591#endif /* MBEDTLS_CCM_C */
4592
4593#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004594 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4595 operation->core_alg = PSA_ALG_GCM;
4596 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004597 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4598 * The call to mbedtls_gcm_crypt_and_tag or
4599 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004600 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004601 {
4602 status = PSA_ERROR_INVALID_ARGUMENT;
4603 goto cleanup;
4604 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004605 mbedtls_gcm_init( &operation->ctx.gcm );
4606 status = mbedtls_to_psa_error(
4607 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004608 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004609 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004610 if( status != 0 )
4611 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004612 break;
4613#endif /* MBEDTLS_GCM_C */
4614
Gilles Peskine26869f22019-05-06 15:25:00 +02004615#if defined(MBEDTLS_CHACHAPOLY_C)
4616 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4617 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4618 operation->full_tag_length = 16;
4619 /* We only support the default tag length. */
4620 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004621 {
4622 status = PSA_ERROR_NOT_SUPPORTED;
4623 goto cleanup;
4624 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004625 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4626 status = mbedtls_to_psa_error(
4627 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004628 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004629 if( status != 0 )
4630 goto cleanup;
4631 break;
4632#endif /* MBEDTLS_CHACHAPOLY_C */
4633
Gilles Peskineedf9a652018-08-17 18:11:56 +02004634 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004635 status = PSA_ERROR_NOT_SUPPORTED;
4636 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004637 }
4638
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004639 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4640 {
4641 status = PSA_ERROR_INVALID_ARGUMENT;
4642 goto cleanup;
4643 }
4644 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004645
Gilles Peskineedf9a652018-08-17 18:11:56 +02004646 return( PSA_SUCCESS );
4647
4648cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004649 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004650 return( status );
4651}
4652
Ronald Croncf56a0a2020-08-04 09:51:30 +02004653psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004654 psa_algorithm_t alg,
4655 const uint8_t *nonce,
4656 size_t nonce_length,
4657 const uint8_t *additional_data,
4658 size_t additional_data_length,
4659 const uint8_t *plaintext,
4660 size_t plaintext_length,
4661 uint8_t *ciphertext,
4662 size_t ciphertext_size,
4663 size_t *ciphertext_length )
4664{
mohammad16035955c982018-04-26 00:53:03 +03004665 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004666 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004667 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004668
mohammad1603f08a5502018-06-03 15:05:47 +03004669 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004670
Ronald Croncf56a0a2020-08-04 09:51:30 +02004671 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004672 if( status != PSA_SUCCESS )
4673 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004674
Gilles Peskineedf9a652018-08-17 18:11:56 +02004675 /* For all currently supported modes, the tag is at the end of the
4676 * ciphertext. */
4677 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4678 {
4679 status = PSA_ERROR_BUFFER_TOO_SMALL;
4680 goto exit;
4681 }
4682 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004683
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004684#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004685 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004686 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004687 status = mbedtls_to_psa_error(
4688 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4689 MBEDTLS_GCM_ENCRYPT,
4690 plaintext_length,
4691 nonce, nonce_length,
4692 additional_data, additional_data_length,
4693 plaintext, ciphertext,
4694 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004695 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004696 else
4697#endif /* MBEDTLS_GCM_C */
4698#if defined(MBEDTLS_CCM_C)
4699 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004700 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004701 status = mbedtls_to_psa_error(
4702 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4703 plaintext_length,
4704 nonce, nonce_length,
4705 additional_data,
4706 additional_data_length,
4707 plaintext, ciphertext,
4708 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004709 }
mohammad16035c8845f2018-05-09 05:40:09 -07004710 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004711#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004712#if defined(MBEDTLS_CHACHAPOLY_C)
4713 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4714 {
4715 if( nonce_length != 12 || operation.tag_length != 16 )
4716 {
4717 status = PSA_ERROR_NOT_SUPPORTED;
4718 goto exit;
4719 }
4720 status = mbedtls_to_psa_error(
4721 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4722 plaintext_length,
4723 nonce,
4724 additional_data,
4725 additional_data_length,
4726 plaintext,
4727 ciphertext,
4728 tag ) );
4729 }
4730 else
4731#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004732 {
mohammad1603554faad2018-06-03 15:07:38 +03004733 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004734 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004735
Gilles Peskineedf9a652018-08-17 18:11:56 +02004736 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4737 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004738
Gilles Peskineedf9a652018-08-17 18:11:56 +02004739exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004740 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004741 if( status == PSA_SUCCESS )
4742 *ciphertext_length = plaintext_length + operation.tag_length;
4743 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004744}
4745
Gilles Peskineee652a32018-06-01 19:23:52 +02004746/* Locate the tag in a ciphertext buffer containing the encrypted data
4747 * followed by the tag. Return the length of the part preceding the tag in
4748 * *plaintext_length. This is the size of the plaintext in modes where
4749 * the encrypted data has the same size as the plaintext, such as
4750 * CCM and GCM. */
4751static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4752 const uint8_t *ciphertext,
4753 size_t ciphertext_length,
4754 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004755 const uint8_t **p_tag )
4756{
4757 size_t payload_length;
4758 if( tag_length > ciphertext_length )
4759 return( PSA_ERROR_INVALID_ARGUMENT );
4760 payload_length = ciphertext_length - tag_length;
4761 if( payload_length > plaintext_size )
4762 return( PSA_ERROR_BUFFER_TOO_SMALL );
4763 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004764 return( PSA_SUCCESS );
4765}
4766
Ronald Croncf56a0a2020-08-04 09:51:30 +02004767psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004768 psa_algorithm_t alg,
4769 const uint8_t *nonce,
4770 size_t nonce_length,
4771 const uint8_t *additional_data,
4772 size_t additional_data_length,
4773 const uint8_t *ciphertext,
4774 size_t ciphertext_length,
4775 uint8_t *plaintext,
4776 size_t plaintext_size,
4777 size_t *plaintext_length )
4778{
mohammad16035955c982018-04-26 00:53:03 +03004779 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004780 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004781 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004782
Gilles Peskineee652a32018-06-01 19:23:52 +02004783 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004784
Ronald Croncf56a0a2020-08-04 09:51:30 +02004785 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004786 if( status != PSA_SUCCESS )
4787 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004788
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004789 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4790 ciphertext, ciphertext_length,
4791 plaintext_size, &tag );
4792 if( status != PSA_SUCCESS )
4793 goto exit;
4794
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004795#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004796 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004797 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004798 status = mbedtls_to_psa_error(
4799 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4800 ciphertext_length - operation.tag_length,
4801 nonce, nonce_length,
4802 additional_data,
4803 additional_data_length,
4804 tag, operation.tag_length,
4805 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004806 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004807 else
4808#endif /* MBEDTLS_GCM_C */
4809#if defined(MBEDTLS_CCM_C)
4810 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004811 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004812 status = mbedtls_to_psa_error(
4813 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4814 ciphertext_length - operation.tag_length,
4815 nonce, nonce_length,
4816 additional_data,
4817 additional_data_length,
4818 ciphertext, plaintext,
4819 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004820 }
mohammad160339574652018-06-01 04:39:53 -07004821 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004822#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004823#if defined(MBEDTLS_CHACHAPOLY_C)
4824 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4825 {
4826 if( nonce_length != 12 || operation.tag_length != 16 )
4827 {
4828 status = PSA_ERROR_NOT_SUPPORTED;
4829 goto exit;
4830 }
4831 status = mbedtls_to_psa_error(
4832 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4833 ciphertext_length - operation.tag_length,
4834 nonce,
4835 additional_data,
4836 additional_data_length,
4837 tag,
4838 ciphertext,
4839 plaintext ) );
4840 }
4841 else
4842#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004843 {
mohammad1603554faad2018-06-03 15:07:38 +03004844 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004845 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004846
Gilles Peskineedf9a652018-08-17 18:11:56 +02004847 if( status != PSA_SUCCESS && plaintext_size != 0 )
4848 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004849
Gilles Peskineedf9a652018-08-17 18:11:56 +02004850exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004851 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004852 if( status == PSA_SUCCESS )
4853 *plaintext_length = ciphertext_length - operation.tag_length;
4854 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004855}
4856
Gilles Peskinea0655c32018-04-30 17:06:50 +02004857
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004858
Gilles Peskine20035e32018-02-03 22:44:14 +01004859/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004860/* Generators */
4861/****************************************************************/
4862
John Durkop07cc04a2020-11-16 22:08:34 -08004863#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4864 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4865 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4866#define AT_LEAST_ONE_BUILTIN_KDF
4867#endif
4868
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004869#define HKDF_STATE_INIT 0 /* no input yet */
4870#define HKDF_STATE_STARTED 1 /* got salt */
4871#define HKDF_STATE_KEYED 2 /* got key */
4872#define HKDF_STATE_OUTPUT 3 /* output started */
4873
Gilles Peskinecbe66502019-05-16 16:59:18 +02004874static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004875 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004876{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004877 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4878 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004879 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004880 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004881}
4882
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004883psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004884{
4885 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004886 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004887 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004888 {
4889 /* The object has (apparently) been initialized but it is not
4890 * in use. It's ok to call abort on such an object, and there's
4891 * nothing to do. */
4892 }
4893 else
John Durkopd0321952020-10-29 21:37:36 -07004894#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004895 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004896 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004897 mbedtls_free( operation->ctx.hkdf.info );
4898 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004899 }
John Durkop07cc04a2020-11-16 22:08:34 -08004900 else
4901#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4902#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4903 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4904 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004905 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004906 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004907 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004908 if( operation->ctx.tls12_prf.seed != NULL )
4909 {
4910 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4911 operation->ctx.tls12_prf.seed_length );
4912 mbedtls_free( operation->ctx.tls12_prf.seed );
4913 }
4914
4915 if( operation->ctx.tls12_prf.label != NULL )
4916 {
4917 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4918 operation->ctx.tls12_prf.label_length );
4919 mbedtls_free( operation->ctx.tls12_prf.label );
4920 }
4921
4922 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4923
4924 /* We leave the fields Ai and output_block to be erased safely by the
4925 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004926 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004927 else
John Durkop07cc04a2020-11-16 22:08:34 -08004928#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4929 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004930 {
4931 status = PSA_ERROR_BAD_STATE;
4932 }
Janos Follath083036a2019-06-11 10:22:26 +01004933 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004934 return( status );
4935}
4936
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004937psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004938 size_t *capacity)
4939{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004940 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004941 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004942 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004943 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004944 }
4945
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004946 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004947 return( PSA_SUCCESS );
4948}
4949
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004950psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004951 size_t capacity )
4952{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004953 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004954 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004955 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004956 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004957 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004958 return( PSA_SUCCESS );
4959}
4960
John Durkopd0321952020-10-29 21:37:36 -07004961#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004962/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004963 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004964static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004965 psa_algorithm_t hash_alg,
4966 uint8_t *output,
4967 size_t output_length )
4968{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004969 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004970 psa_status_t status;
4971
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004972 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4973 return( PSA_ERROR_BAD_STATE );
4974 hkdf->state = HKDF_STATE_OUTPUT;
4975
Gilles Peskinebef7f142018-07-12 17:22:21 +02004976 while( output_length != 0 )
4977 {
4978 /* Copy what remains of the current block */
4979 uint8_t n = hash_length - hkdf->offset_in_block;
4980 if( n > output_length )
4981 n = (uint8_t) output_length;
4982 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4983 output += n;
4984 output_length -= n;
4985 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004986 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004987 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004988 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004989 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004990 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004991 * object was corrupted or if this function is called directly
4992 * inside the library. */
4993 if( hkdf->block_number == 0xff )
4994 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004995
4996 /* We need a new block */
4997 ++hkdf->block_number;
4998 hkdf->offset_in_block = 0;
4999 status = psa_hmac_setup_internal( &hkdf->hmac,
5000 hkdf->prk, hash_length,
5001 hash_alg );
5002 if( status != PSA_SUCCESS )
5003 return( status );
5004 if( hkdf->block_number != 1 )
5005 {
5006 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5007 hkdf->output_block,
5008 hash_length );
5009 if( status != PSA_SUCCESS )
5010 return( status );
5011 }
5012 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5013 hkdf->info,
5014 hkdf->info_length );
5015 if( status != PSA_SUCCESS )
5016 return( status );
5017 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5018 &hkdf->block_number, 1 );
5019 if( status != PSA_SUCCESS )
5020 return( status );
5021 status = psa_hmac_finish_internal( &hkdf->hmac,
5022 hkdf->output_block,
5023 sizeof( hkdf->output_block ) );
5024 if( status != PSA_SUCCESS )
5025 return( status );
5026 }
5027
5028 return( PSA_SUCCESS );
5029}
John Durkop07cc04a2020-11-16 22:08:34 -08005030#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005031
John Durkop07cc04a2020-11-16 22:08:34 -08005032#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5033 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005034static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5035 psa_tls12_prf_key_derivation_t *tls12_prf,
5036 psa_algorithm_t alg )
5037{
5038 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005039 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005040 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5041 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005042
Janos Follath7742fee2019-06-17 12:58:10 +01005043 /* We can't be wanting more output after block 0xff, otherwise
5044 * the capacity check in psa_key_derivation_output_bytes() would have
5045 * prevented this call. It could happen only if the operation
5046 * object was corrupted or if this function is called directly
5047 * inside the library. */
5048 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005049 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005050
5051 /* We need a new block */
5052 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005053 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005054
5055 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5056 *
5057 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5058 *
5059 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5060 * HMAC_hash(secret, A(2) + seed) +
5061 * HMAC_hash(secret, A(3) + seed) + ...
5062 *
5063 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005064 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005065 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005066 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005067 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005068 * is currently extracted as `output_block` and where i is
5069 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005070 */
5071
Janos Follathea29bfb2019-06-19 12:21:20 +01005072 /* Save the hash context before using it, to preserve the hash state with
5073 * only the inner padding in it. We need this, because inner padding depends
5074 * on the key (secret in the RFC's terminology). */
5075 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5076 if( status != PSA_SUCCESS )
5077 goto cleanup;
5078
5079 /* Calculate A(i) where i = tls12_prf->block_number. */
5080 if( tls12_prf->block_number == 1 )
5081 {
5082 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5083 * the variable seed and in this instance means it in the context of the
5084 * P_hash function, where seed = label + seed.) */
5085 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5086 tls12_prf->label, tls12_prf->label_length );
5087 if( status != PSA_SUCCESS )
5088 goto cleanup;
5089 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5090 tls12_prf->seed, tls12_prf->seed_length );
5091 if( status != PSA_SUCCESS )
5092 goto cleanup;
5093 }
5094 else
5095 {
5096 /* A(i) = HMAC_hash(secret, A(i-1)) */
5097 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5098 tls12_prf->Ai, hash_length );
5099 if( status != PSA_SUCCESS )
5100 goto cleanup;
5101 }
5102
5103 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5104 tls12_prf->Ai, hash_length );
5105 if( status != PSA_SUCCESS )
5106 goto cleanup;
5107 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5108 if( status != PSA_SUCCESS )
5109 goto cleanup;
5110
5111 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5112 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5113 tls12_prf->Ai, hash_length );
5114 if( status != PSA_SUCCESS )
5115 goto cleanup;
5116 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5117 tls12_prf->label, tls12_prf->label_length );
5118 if( status != PSA_SUCCESS )
5119 goto cleanup;
5120 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5121 tls12_prf->seed, tls12_prf->seed_length );
5122 if( status != PSA_SUCCESS )
5123 goto cleanup;
5124 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5125 tls12_prf->output_block, hash_length );
5126 if( status != PSA_SUCCESS )
5127 goto cleanup;
5128 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5129 if( status != PSA_SUCCESS )
5130 goto cleanup;
5131
Janos Follath7742fee2019-06-17 12:58:10 +01005132
5133cleanup:
5134
Janos Follathea29bfb2019-06-19 12:21:20 +01005135 cleanup_status = psa_hash_abort( &backup );
5136 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5137 status = cleanup_status;
5138
5139 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005140}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005141
Janos Follath844eb0e2019-06-19 12:10:49 +01005142static psa_status_t psa_key_derivation_tls12_prf_read(
5143 psa_tls12_prf_key_derivation_t *tls12_prf,
5144 psa_algorithm_t alg,
5145 uint8_t *output,
5146 size_t output_length )
5147{
5148 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005149 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005150 psa_status_t status;
5151 uint8_t offset, length;
5152
5153 while( output_length != 0 )
5154 {
5155 /* Check if we have fully processed the current block. */
5156 if( tls12_prf->left_in_block == 0 )
5157 {
5158 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5159 alg );
5160 if( status != PSA_SUCCESS )
5161 return( status );
5162
5163 continue;
5164 }
5165
5166 if( tls12_prf->left_in_block > output_length )
5167 length = (uint8_t) output_length;
5168 else
5169 length = tls12_prf->left_in_block;
5170
5171 offset = hash_length - tls12_prf->left_in_block;
5172 memcpy( output, tls12_prf->output_block + offset, length );
5173 output += length;
5174 output_length -= length;
5175 tls12_prf->left_in_block -= length;
5176 }
5177
5178 return( PSA_SUCCESS );
5179}
John Durkop07cc04a2020-11-16 22:08:34 -08005180#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5181 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005182
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005183psa_status_t psa_key_derivation_output_bytes(
5184 psa_key_derivation_operation_t *operation,
5185 uint8_t *output,
5186 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005187{
5188 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005190
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005191 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005192 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005194 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005195 }
5196
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005197 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005198 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005199 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005200 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005201 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005202 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005203 goto exit;
5204 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005205 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005206 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005207 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005208 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005209 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5210 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005211 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005212 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005213 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005214 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005215 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005216
John Durkopd0321952020-10-29 21:37:36 -07005217#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005218 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005219 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005220 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005221 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005222 output, output_length );
5223 }
Janos Follathadbec812019-06-14 11:05:39 +01005224 else
John Durkop07cc04a2020-11-16 22:08:34 -08005225#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5226#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5227 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005228 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005229 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005230 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005231 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005232 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005233 output_length );
5234 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005235 else
John Durkop07cc04a2020-11-16 22:08:34 -08005236#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5237 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005238 {
5239 return( PSA_ERROR_BAD_STATE );
5240 }
5241
5242exit:
5243 if( status != PSA_SUCCESS )
5244 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005245 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005246 * This allows us to differentiate between exhausted operations and
5247 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5248 * operations. */
5249 psa_algorithm_t alg = operation->alg;
5250 psa_key_derivation_abort( operation );
5251 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005252 memset( output, '!', output_length );
5253 }
5254 return( status );
5255}
5256
Gilles Peskine08542d82018-07-19 17:05:42 +02005257#if defined(MBEDTLS_DES_C)
5258static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5259{
5260 if( data_size >= 8 )
5261 mbedtls_des_key_set_parity( data );
5262 if( data_size >= 16 )
5263 mbedtls_des_key_set_parity( data + 8 );
5264 if( data_size >= 24 )
5265 mbedtls_des_key_set_parity( data + 16 );
5266}
5267#endif /* MBEDTLS_DES_C */
5268
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005269static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005270 psa_key_slot_t *slot,
5271 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005272 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005273{
5274 uint8_t *data = NULL;
5275 size_t bytes = PSA_BITS_TO_BYTES( bits );
5276 psa_status_t status;
5277
Gilles Peskine8e338702019-07-30 20:06:31 +02005278 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005279 return( PSA_ERROR_INVALID_ARGUMENT );
5280 if( bits % 8 != 0 )
5281 return( PSA_ERROR_INVALID_ARGUMENT );
5282 data = mbedtls_calloc( 1, bytes );
5283 if( data == NULL )
5284 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5285
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005286 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005287 if( status != PSA_SUCCESS )
5288 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005289#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005290 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005291 psa_des_set_key_parity( data, bytes );
5292#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005293 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005294
5295exit:
5296 mbedtls_free( data );
5297 return( status );
5298}
5299
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005300psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005301 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005302 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005303{
5304 psa_status_t status;
5305 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005306 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005307
Ronald Cron81709fc2020-11-14 12:10:32 +01005308 *key = MBEDTLS_SVC_KEY_ID_INIT;
5309
Gilles Peskine0f84d622019-09-12 19:03:13 +02005310 /* Reject any attempt to create a zero-length key so that we don't
5311 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5312 if( psa_get_key_bits( attributes ) == 0 )
5313 return( PSA_ERROR_INVALID_ARGUMENT );
5314
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005315 if( ! operation->can_output_key )
5316 return( PSA_ERROR_NOT_PERMITTED );
5317
Ronald Cron81709fc2020-11-14 12:10:32 +01005318 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5319 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005320#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5321 if( driver != NULL )
5322 {
5323 /* Deriving a key in a secure element is not implemented yet. */
5324 status = PSA_ERROR_NOT_SUPPORTED;
5325 }
5326#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005327 if( status == PSA_SUCCESS )
5328 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005329 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005330 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005331 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005332 }
5333 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005334 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005335 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005336 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005337
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005338 return( status );
5339}
5340
Gilles Peskineeab56e42018-07-12 17:12:33 +02005341
5342
5343/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005344/* Key derivation */
5345/****************************************************************/
5346
John Durkop07cc04a2020-11-16 22:08:34 -08005347#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005348static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005349 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005350 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005351{
John Durkop07cc04a2020-11-16 22:08:34 -08005352 int is_kdf_alg_supported;
5353
Janos Follath5fe19732019-06-20 15:09:30 +01005354 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5355 * initialisers for this union leave some bytes unspecified.) */
5356 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5357
Gilles Peskine969c5d62019-01-16 15:53:06 +01005358 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005359#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005360 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5361 is_kdf_alg_supported = 1;
5362 else
5363#endif
5364#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5365 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5366 is_kdf_alg_supported = 1;
5367 else
5368#endif
5369#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5370 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5371 is_kdf_alg_supported = 1;
5372 else
5373#endif
5374 is_kdf_alg_supported = 0;
5375
5376 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005377 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005378 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005379 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005380 if( hash_size == 0 )
5381 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005382 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5383 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005384 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005385 {
5386 return( PSA_ERROR_NOT_SUPPORTED );
5387 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005388 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005389 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005390 }
John Durkop07cc04a2020-11-16 22:08:34 -08005391
5392 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005393}
John Durkop07cc04a2020-11-16 22:08:34 -08005394#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005395
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005396psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005397 psa_algorithm_t alg )
5398{
5399 psa_status_t status;
5400
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005401 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005402 return( PSA_ERROR_BAD_STATE );
5403
Gilles Peskine6843c292019-01-18 16:44:49 +01005404 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5405 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005406#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005407 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005408 {
5409 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005410 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005411 }
5412 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5413 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005414 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005415 }
John Durkop07cc04a2020-11-16 22:08:34 -08005416#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005417 else
5418 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005419
5420 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005421 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005422 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005423}
5424
John Durkopd0321952020-10-29 21:37:36 -07005425#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005426static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005427 psa_algorithm_t hash_alg,
5428 psa_key_derivation_step_t step,
5429 const uint8_t *data,
5430 size_t data_length )
5431{
5432 psa_status_t status;
5433 switch( step )
5434 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005435 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005436 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005437 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005438 status = psa_hmac_setup_internal( &hkdf->hmac,
5439 data, data_length,
5440 hash_alg );
5441 if( status != PSA_SUCCESS )
5442 return( status );
5443 hkdf->state = HKDF_STATE_STARTED;
5444 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005445 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005446 /* If no salt was provided, use an empty salt. */
5447 if( hkdf->state == HKDF_STATE_INIT )
5448 {
5449 status = psa_hmac_setup_internal( &hkdf->hmac,
5450 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005451 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005452 if( status != PSA_SUCCESS )
5453 return( status );
5454 hkdf->state = HKDF_STATE_STARTED;
5455 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005456 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005457 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005458 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5459 data, data_length );
5460 if( status != PSA_SUCCESS )
5461 return( status );
5462 status = psa_hmac_finish_internal( &hkdf->hmac,
5463 hkdf->prk,
5464 sizeof( hkdf->prk ) );
5465 if( status != PSA_SUCCESS )
5466 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005467 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005468 hkdf->block_number = 0;
5469 hkdf->state = HKDF_STATE_KEYED;
5470 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005471 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005472 if( hkdf->state == HKDF_STATE_OUTPUT )
5473 return( PSA_ERROR_BAD_STATE );
5474 if( hkdf->info_set )
5475 return( PSA_ERROR_BAD_STATE );
5476 hkdf->info_length = data_length;
5477 if( data_length != 0 )
5478 {
5479 hkdf->info = mbedtls_calloc( 1, data_length );
5480 if( hkdf->info == NULL )
5481 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5482 memcpy( hkdf->info, data, data_length );
5483 }
5484 hkdf->info_set = 1;
5485 return( PSA_SUCCESS );
5486 default:
5487 return( PSA_ERROR_INVALID_ARGUMENT );
5488 }
5489}
John Durkop07cc04a2020-11-16 22:08:34 -08005490#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005491
John Durkop07cc04a2020-11-16 22:08:34 -08005492#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5493 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005494static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5495 const uint8_t *data,
5496 size_t data_length )
5497{
5498 if( prf->state != TLS12_PRF_STATE_INIT )
5499 return( PSA_ERROR_BAD_STATE );
5500
Janos Follathd6dce9f2019-07-04 09:11:38 +01005501 if( data_length != 0 )
5502 {
5503 prf->seed = mbedtls_calloc( 1, data_length );
5504 if( prf->seed == NULL )
5505 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005506
Janos Follathd6dce9f2019-07-04 09:11:38 +01005507 memcpy( prf->seed, data, data_length );
5508 prf->seed_length = data_length;
5509 }
Janos Follathf08e2652019-06-13 09:05:41 +01005510
5511 prf->state = TLS12_PRF_STATE_SEED_SET;
5512
5513 return( PSA_SUCCESS );
5514}
5515
Janos Follath81550542019-06-13 14:26:34 +01005516static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5517 psa_algorithm_t hash_alg,
5518 const uint8_t *data,
5519 size_t data_length )
5520{
5521 psa_status_t status;
5522 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5523 return( PSA_ERROR_BAD_STATE );
5524
5525 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5526 if( status != PSA_SUCCESS )
5527 return( status );
5528
5529 prf->state = TLS12_PRF_STATE_KEY_SET;
5530
5531 return( PSA_SUCCESS );
5532}
5533
Janos Follath63028dd2019-06-13 09:15:47 +01005534static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5535 const uint8_t *data,
5536 size_t data_length )
5537{
5538 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5539 return( PSA_ERROR_BAD_STATE );
5540
Janos Follathd6dce9f2019-07-04 09:11:38 +01005541 if( data_length != 0 )
5542 {
5543 prf->label = mbedtls_calloc( 1, data_length );
5544 if( prf->label == NULL )
5545 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005546
Janos Follathd6dce9f2019-07-04 09:11:38 +01005547 memcpy( prf->label, data, data_length );
5548 prf->label_length = data_length;
5549 }
Janos Follath63028dd2019-06-13 09:15:47 +01005550
5551 prf->state = TLS12_PRF_STATE_LABEL_SET;
5552
5553 return( PSA_SUCCESS );
5554}
5555
Janos Follathb03233e2019-06-11 15:30:30 +01005556static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5557 psa_algorithm_t hash_alg,
5558 psa_key_derivation_step_t step,
5559 const uint8_t *data,
5560 size_t data_length )
5561{
Janos Follathb03233e2019-06-11 15:30:30 +01005562 switch( step )
5563 {
Janos Follathf08e2652019-06-13 09:05:41 +01005564 case PSA_KEY_DERIVATION_INPUT_SEED:
5565 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005566 case PSA_KEY_DERIVATION_INPUT_SECRET:
5567 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005568 case PSA_KEY_DERIVATION_INPUT_LABEL:
5569 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005570 default:
5571 return( PSA_ERROR_INVALID_ARGUMENT );
5572 }
5573}
John Durkop07cc04a2020-11-16 22:08:34 -08005574#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5575 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5576
5577#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5578static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5579 psa_tls12_prf_key_derivation_t *prf,
5580 psa_algorithm_t hash_alg,
5581 const uint8_t *data,
5582 size_t data_length )
5583{
5584 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005585 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005586 uint8_t *cur = pms;
5587
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005588 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005589 return( PSA_ERROR_INVALID_ARGUMENT );
5590
5591 /* Quoting RFC 4279, Section 2:
5592 *
5593 * The premaster secret is formed as follows: if the PSK is N octets
5594 * long, concatenate a uint16 with the value N, N zero octets, a second
5595 * uint16 with the value N, and the PSK itself.
5596 */
5597
5598 *cur++ = ( data_length >> 8 ) & 0xff;
5599 *cur++ = ( data_length >> 0 ) & 0xff;
5600 memset( cur, 0, data_length );
5601 cur += data_length;
5602 *cur++ = pms[0];
5603 *cur++ = pms[1];
5604 memcpy( cur, data, data_length );
5605 cur += data_length;
5606
5607 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5608
5609 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5610 return( status );
5611}
Janos Follath6660f0e2019-06-17 08:44:03 +01005612
5613static psa_status_t psa_tls12_prf_psk_to_ms_input(
5614 psa_tls12_prf_key_derivation_t *prf,
5615 psa_algorithm_t hash_alg,
5616 psa_key_derivation_step_t step,
5617 const uint8_t *data,
5618 size_t data_length )
5619{
5620 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005621 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005622 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5623 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005624 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005625
5626 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5627}
John Durkop07cc04a2020-11-16 22:08:34 -08005628#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005629
Gilles Peskineb8965192019-09-24 16:21:10 +02005630/** Check whether the given key type is acceptable for the given
5631 * input step of a key derivation.
5632 *
5633 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5634 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5635 * Both secret and non-secret inputs can alternatively have the type
5636 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5637 * that the input was passed as a buffer rather than via a key object.
5638 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005639static int psa_key_derivation_check_input_type(
5640 psa_key_derivation_step_t step,
5641 psa_key_type_t key_type )
5642{
5643 switch( step )
5644 {
5645 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005646 if( key_type == PSA_KEY_TYPE_DERIVE )
5647 return( PSA_SUCCESS );
5648 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005649 return( PSA_SUCCESS );
5650 break;
5651 case PSA_KEY_DERIVATION_INPUT_LABEL:
5652 case PSA_KEY_DERIVATION_INPUT_SALT:
5653 case PSA_KEY_DERIVATION_INPUT_INFO:
5654 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005655 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5656 return( PSA_SUCCESS );
5657 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005658 return( PSA_SUCCESS );
5659 break;
5660 }
5661 return( PSA_ERROR_INVALID_ARGUMENT );
5662}
5663
Janos Follathb80a94e2019-06-12 15:54:46 +01005664static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005665 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005666 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005667 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005668 const uint8_t *data,
5669 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005670{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005671 psa_status_t status;
5672 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5673
5674 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005675 if( status != PSA_SUCCESS )
5676 goto exit;
5677
John Durkopd0321952020-10-29 21:37:36 -07005678#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005679 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005680 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005681 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005682 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005683 step, data, data_length );
5684 }
John Durkop07cc04a2020-11-16 22:08:34 -08005685 else
5686#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5687#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5688 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005689 {
Janos Follathb03233e2019-06-11 15:30:30 +01005690 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5691 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5692 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005693 }
John Durkop07cc04a2020-11-16 22:08:34 -08005694 else
5695#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5696#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5697 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005698 {
5699 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5700 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5701 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005702 }
5703 else
John Durkop07cc04a2020-11-16 22:08:34 -08005704#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005705 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005706 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005707 return( PSA_ERROR_BAD_STATE );
5708 }
5709
Gilles Peskine224b0d62019-09-23 18:13:17 +02005710exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005711 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005712 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005713 return( status );
5714}
5715
Janos Follath51f4a0f2019-06-14 11:35:55 +01005716psa_status_t psa_key_derivation_input_bytes(
5717 psa_key_derivation_operation_t *operation,
5718 psa_key_derivation_step_t step,
5719 const uint8_t *data,
5720 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005721{
Gilles Peskineb8965192019-09-24 16:21:10 +02005722 return( psa_key_derivation_input_internal( operation, step,
5723 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005724 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005725}
5726
Janos Follath51f4a0f2019-06-14 11:35:55 +01005727psa_status_t psa_key_derivation_input_key(
5728 psa_key_derivation_operation_t *operation,
5729 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005730 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005731{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005732 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005733 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005734 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005735
Ronald Cron5c522922020-11-14 16:35:34 +01005736 status = psa_get_and_lock_transparent_key_slot_with_policy(
5737 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005738 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005739 {
5740 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005741 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005742 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005743
5744 /* Passing a key object as a SECRET input unlocks the permission
5745 * to output to a key object. */
5746 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5747 operation->can_output_key = 1;
5748
Ronald Cronf95a2b12020-10-22 15:24:49 +02005749 status = psa_key_derivation_input_internal( operation,
5750 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005751 slot->key.data,
5752 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005753
Ronald Cron5c522922020-11-14 16:35:34 +01005754 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005755
Ronald Cron5c522922020-11-14 16:35:34 +01005756 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005757}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005758
5759
5760
5761/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005762/* Key agreement */
5763/****************************************************************/
5764
John Durkop6ba40d12020-11-10 08:50:04 -08005765#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005766static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5767 size_t peer_key_length,
5768 const mbedtls_ecp_keypair *our_key,
5769 uint8_t *shared_secret,
5770 size_t shared_secret_size,
5771 size_t *shared_secret_length )
5772{
Steven Cooremand4867872020-08-05 16:31:39 +02005773 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005774 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005775 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005776 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005777 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005778 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005779
Ronald Cron90857082020-11-25 14:58:33 +01005780 status = mbedtls_psa_ecp_load_representation(
5781 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5782 peer_key,
5783 peer_key_length,
5784 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005785 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005786 goto exit;
5787
Jaeden Amero97271b32019-01-10 19:38:51 +00005788 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005789 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005790 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005791 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005792 status = mbedtls_to_psa_error(
5793 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5794 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005795 goto exit;
5796
Jaeden Amero97271b32019-01-10 19:38:51 +00005797 status = mbedtls_to_psa_error(
5798 mbedtls_ecdh_calc_secret( &ecdh,
5799 shared_secret_length,
5800 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005801 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005802 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005803 if( status != PSA_SUCCESS )
5804 goto exit;
5805 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5806 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005807
5808exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005809 if( status != PSA_SUCCESS )
5810 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005811 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005812 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005813 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005814
Jaeden Amero97271b32019-01-10 19:38:51 +00005815 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005816}
John Durkop6ba40d12020-11-10 08:50:04 -08005817#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005818
Gilles Peskine01d718c2018-09-18 12:01:02 +02005819#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5820
Gilles Peskine0216fe12019-04-11 21:23:21 +02005821static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5822 psa_key_slot_t *private_key,
5823 const uint8_t *peer_key,
5824 size_t peer_key_length,
5825 uint8_t *shared_secret,
5826 size_t shared_secret_size,
5827 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005828{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005829 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005830 {
John Durkop6ba40d12020-11-10 08:50:04 -08005831#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005832 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005833 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005834 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005835 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005836 psa_status_t status = mbedtls_psa_ecp_load_representation(
5837 private_key->attr.type,
5838 private_key->key.data,
5839 private_key->key.bytes,
5840 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005841 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005842 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005843 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005844 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005845 shared_secret, shared_secret_size,
5846 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005847 mbedtls_ecp_keypair_free( ecp );
5848 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005849 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005850#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005851 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005852 (void) private_key;
5853 (void) peer_key;
5854 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005855 (void) shared_secret;
5856 (void) shared_secret_size;
5857 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005858 return( PSA_ERROR_NOT_SUPPORTED );
5859 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005860}
5861
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005862/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005863 * to potentially free embedded data structures and wipe confidential data.
5864 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005865static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005866 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005867 psa_key_slot_t *private_key,
5868 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005869 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005870{
5871 psa_status_t status;
5872 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5873 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005874 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005875
5876 /* Step 1: run the secret agreement algorithm to generate the shared
5877 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005878 status = psa_key_agreement_raw_internal( ka_alg,
5879 private_key,
5880 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005881 shared_secret,
5882 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005883 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005884 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005885 goto exit;
5886
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005887 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005888 * the shared secret. A shared secret is permitted wherever a key
5889 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005890 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005891 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005892 shared_secret,
5893 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005894exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005895 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005896 return( status );
5897}
5898
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005899psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005900 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005901 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005902 const uint8_t *peer_key,
5903 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005904{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005906 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005907 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005908
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005909 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005910 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005911 status = psa_get_and_lock_transparent_key_slot_with_policy(
5912 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005913 if( status != PSA_SUCCESS )
5914 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005915 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005916 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005917 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005918 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005919 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005920 else
5921 {
5922 /* If a private key has been added as SECRET, we allow the derived
5923 * key material to be used as a key in PSA Crypto. */
5924 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5925 operation->can_output_key = 1;
5926 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005927
Ronald Cron5c522922020-11-14 16:35:34 +01005928 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005929
Ronald Cron5c522922020-11-14 16:35:34 +01005930 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005931}
5932
Gilles Peskinebe697d82019-05-16 18:00:41 +02005933psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005934 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005935 const uint8_t *peer_key,
5936 size_t peer_key_length,
5937 uint8_t *output,
5938 size_t output_size,
5939 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005940{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005942 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005943 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005944
5945 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5946 {
5947 status = PSA_ERROR_INVALID_ARGUMENT;
5948 goto exit;
5949 }
Ronald Cron5c522922020-11-14 16:35:34 +01005950 status = psa_get_and_lock_transparent_key_slot_with_policy(
5951 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005952 if( status != PSA_SUCCESS )
5953 goto exit;
5954
5955 status = psa_key_agreement_raw_internal( alg, slot,
5956 peer_key, peer_key_length,
5957 output, output_size,
5958 output_length );
5959
5960exit:
5961 if( status != PSA_SUCCESS )
5962 {
5963 /* If an error happens and is not handled properly, the output
5964 * may be used as a key to protect sensitive data. Arrange for such
5965 * a key to be random, which is likely to result in decryption or
5966 * verification errors. This is better than filling the buffer with
5967 * some constant data such as zeros, which would result in the data
5968 * being protected with a reproducible, easily knowable key.
5969 */
5970 psa_generate_random( output, output_size );
5971 *output_length = output_size;
5972 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005973
Ronald Cron5c522922020-11-14 16:35:34 +01005974 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005975
Ronald Cron5c522922020-11-14 16:35:34 +01005976 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005977}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005978
5979
Gilles Peskine30524eb2020-11-13 17:02:26 +01005980
Gilles Peskine86a440b2018-11-12 18:39:40 +01005981/****************************************************************/
5982/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005983/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005984
Gilles Peskine30524eb2020-11-13 17:02:26 +01005985/** Initialize the PSA random generator.
5986 */
5987static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5988{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005989#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5990 memset( rng, 0, sizeof( *rng ) );
5991#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5992
Gilles Peskine30524eb2020-11-13 17:02:26 +01005993 /* Set default configuration if
5994 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5995 if( rng->entropy_init == NULL )
5996 rng->entropy_init = mbedtls_entropy_init;
5997 if( rng->entropy_free == NULL )
5998 rng->entropy_free = mbedtls_entropy_free;
5999
6000 rng->entropy_init( &rng->entropy );
6001#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6002 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6003 /* The PSA entropy injection feature depends on using NV seed as an entropy
6004 * source. Add NV seed as an entropy source for PSA entropy injection. */
6005 mbedtls_entropy_add_source( &rng->entropy,
6006 mbedtls_nv_seed_poll, NULL,
6007 MBEDTLS_ENTROPY_BLOCK_SIZE,
6008 MBEDTLS_ENTROPY_SOURCE_STRONG );
6009#endif
6010
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006011 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006012#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006013}
6014
6015/** Deinitialize the PSA random generator.
6016 */
6017static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6018{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006019#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6020 memset( rng, 0, sizeof( *rng ) );
6021#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006022 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006023 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006024#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006025}
6026
6027/** Seed the PSA random generator.
6028 */
6029static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6030{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006031#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6032 /* Do nothing: the external RNG seeds itself. */
6033 (void) rng;
6034 return( PSA_SUCCESS );
6035#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006036 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006037 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6038 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006039 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006040#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006041}
6042
Gilles Peskinee59236f2018-01-27 23:32:46 +01006043psa_status_t psa_generate_random( uint8_t *output,
6044 size_t output_size )
6045{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006046 GUARD_MODULE_INITIALIZED;
6047
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006048#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6049
6050 size_t output_length = 0;
6051 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6052 output, output_size,
6053 &output_length );
6054 if( status != PSA_SUCCESS )
6055 return( status );
6056 /* Breaking up a request into smaller chunks is currently not supported
6057 * for the extrernal RNG interface. */
6058 if( output_length != output_size )
6059 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6060 return( PSA_SUCCESS );
6061
6062#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6063
Gilles Peskine71ddab92021-01-04 21:01:07 +01006064 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006065 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006066 size_t request_size =
6067 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6068 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6069 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006070 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6071 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006072 if( ret != 0 )
6073 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006074 output_size -= request_size;
6075 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006076 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006077 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006078#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006079}
6080
Gilles Peskine8814fc42020-12-14 15:33:44 +01006081/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006082 *
6083 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6084 * `psa_generate_random(...)`. The state parameter is ignored since the
6085 * PSA API doesn't support passing an explicit state.
6086 *
6087 * In the non-external case, psa_generate_random() calls an
6088 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6089 * and semantics as mbedtls_psa_get_random(). As an optimization,
6090 * instead of doing this back-and-forth between the PSA API and the
6091 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6092 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006093 */
6094#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6095int mbedtls_psa_get_random( void *p_rng,
6096 unsigned char *output,
6097 size_t output_size )
6098{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006099 /* This function takes a pointer to the RNG state because that's what
6100 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6101 * its own state internally and doesn't let the caller access that state.
6102 * So we just ignore the state parameter, and in practice we'll pass
6103 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006104 (void) p_rng;
6105 psa_status_t status = psa_generate_random( output, output_size );
6106 if( status == PSA_SUCCESS )
6107 return( 0 );
6108 else
6109 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6110}
6111#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6112
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006113#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6114#include "mbedtls/entropy_poll.h"
6115
Gilles Peskine7228da22019-07-15 11:06:15 +02006116psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006117 size_t seed_size )
6118{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006119 if( global_data.initialized )
6120 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006121
6122 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6123 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6124 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6125 return( PSA_ERROR_INVALID_ARGUMENT );
6126
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006127 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006128}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006129#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006130
John Durkop07cc04a2020-11-16 22:08:34 -08006131#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006132static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6133 size_t domain_parameters_size,
6134 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006135{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006136 size_t i;
6137 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006138
Gilles Peskinee56e8782019-04-26 17:34:02 +02006139 if( domain_parameters_size == 0 )
6140 {
6141 *exponent = 65537;
6142 return( PSA_SUCCESS );
6143 }
6144
6145 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6146 * support values that fit in a 32-bit integer, which is larger than
6147 * int on just about every platform anyway. */
6148 if( domain_parameters_size > sizeof( acc ) )
6149 return( PSA_ERROR_NOT_SUPPORTED );
6150 for( i = 0; i < domain_parameters_size; i++ )
6151 acc = ( acc << 8 ) | domain_parameters[i];
6152 if( acc > INT_MAX )
6153 return( PSA_ERROR_NOT_SUPPORTED );
6154 *exponent = acc;
6155 return( PSA_SUCCESS );
6156}
John Durkop07cc04a2020-11-16 22:08:34 -08006157#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006158
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006159static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006160 psa_key_slot_t *slot, size_t bits,
6161 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006162{
Gilles Peskine8e338702019-07-30 20:06:31 +02006163 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006164
Gilles Peskinee56e8782019-04-26 17:34:02 +02006165 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006166 return( PSA_ERROR_INVALID_ARGUMENT );
6167
Gilles Peskinee59236f2018-01-27 23:32:46 +01006168 if( key_type_is_raw_bytes( type ) )
6169 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006170 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006171
6172 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006173 if( status != PSA_SUCCESS )
6174 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006175
6176 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006177 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6178 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006179 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006180
Ronald Cronea0f8a62020-11-25 17:52:23 +01006181 status = psa_generate_random( slot->key.data,
6182 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006183 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006184 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006185
6186 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006187#if defined(MBEDTLS_DES_C)
6188 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006189 psa_des_set_key_parity( slot->key.data,
6190 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006191#endif /* MBEDTLS_DES_C */
6192 }
6193 else
6194
John Durkop07cc04a2020-11-16 22:08:34 -08006195#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006196 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006197 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006198 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006199 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006200 int exponent;
6201 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006202 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6203 return( PSA_ERROR_NOT_SUPPORTED );
6204 /* Accept only byte-aligned keys, for the same reasons as
Ronald Cronb6420e32020-11-22 16:15:38 +01006205 * in mbedtls_psa_rsa_import_key(). */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006206 if( bits % 8 != 0 )
6207 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006208 status = psa_read_rsa_exponent( domain_parameters,
6209 domain_parameters_size,
6210 &exponent );
6211 if( status != PSA_SUCCESS )
6212 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006213 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6214 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006215 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006216 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006217 (unsigned int) bits,
6218 exponent );
6219 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006220 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006221
6222 /* Make sure to always have an export representation available */
6223 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6224
Steven Cooreman75b74362020-07-28 14:30:13 +02006225 status = psa_allocate_buffer_to_slot( slot, bytes );
6226 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006227 {
6228 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006229 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006230 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006231
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006232 status = mbedtls_psa_rsa_export_key( type,
6233 &rsa,
6234 slot->key.data,
6235 bytes,
6236 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006237 mbedtls_rsa_free( &rsa );
6238 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006239 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006240 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006241 }
6242 else
John Durkop07cc04a2020-11-16 22:08:34 -08006243#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006244
John Durkop9814fa22020-11-04 12:28:15 -08006245#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006246 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006247 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006248 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006249 mbedtls_ecp_group_id grp_id =
6250 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006251 const mbedtls_ecp_curve_info *curve_info =
6252 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006253 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006255 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006256 return( PSA_ERROR_NOT_SUPPORTED );
6257 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6258 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006259 mbedtls_ecp_keypair_init( &ecp );
6260 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006261 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006262 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006263 if( ret != 0 )
6264 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006265 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006266 return( mbedtls_to_psa_error( ret ) );
6267 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006268
6269
6270 /* Make sure to always have an export representation available */
6271 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006272 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6273 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006274 {
6275 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006276 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006277 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006278
6279 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006280 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006281
6282 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006283 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006284 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006285 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006286 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006287 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006288 }
6289 else
John Durkop9814fa22020-11-04 12:28:15 -08006290#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006291 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006292 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006293 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006294
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006295 return( PSA_SUCCESS );
6296}
Darryl Green0c6575a2018-11-07 16:05:30 +00006297
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006298psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006299 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006300{
6301 psa_status_t status;
6302 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006303 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006304
Ronald Cron81709fc2020-11-14 12:10:32 +01006305 *key = MBEDTLS_SVC_KEY_ID_INIT;
6306
Gilles Peskine0f84d622019-09-12 19:03:13 +02006307 /* Reject any attempt to create a zero-length key so that we don't
6308 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6309 if( psa_get_key_bits( attributes ) == 0 )
6310 return( PSA_ERROR_INVALID_ARGUMENT );
6311
Ronald Cron81709fc2020-11-14 12:10:32 +01006312 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6313 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006314 if( status != PSA_SUCCESS )
6315 goto exit;
6316
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006317 status = psa_driver_wrapper_generate_key( attributes,
6318 slot );
6319 if( status != PSA_ERROR_NOT_SUPPORTED ||
6320 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6321 goto exit;
6322
6323 status = psa_generate_key_internal(
6324 slot, attributes->core.bits,
6325 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006326
6327exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006328 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006329 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006330 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006331 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006332
Darryl Green0c6575a2018-11-07 16:05:30 +00006333 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006334}
6335
6336
Gilles Peskinee59236f2018-01-27 23:32:46 +01006337
6338/****************************************************************/
6339/* Module setup */
6340/****************************************************************/
6341
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006342#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006343psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6344 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6345 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6346{
6347 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6348 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006349 global_data.rng.entropy_init = entropy_init;
6350 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006351 return( PSA_SUCCESS );
6352}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006353#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006354
Gilles Peskinee59236f2018-01-27 23:32:46 +01006355void mbedtls_psa_crypto_free( void )
6356{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006357 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006358 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6359 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006360 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006361 }
6362 /* Wipe all remaining data, including configuration.
6363 * In particular, this sets all state indicator to the value
6364 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006365 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006367 /* Unregister all secure element drivers, so that we restart from
6368 * a pristine state. */
6369 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006370#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006371}
6372
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006373#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6374/** Recover a transaction that was interrupted by a power failure.
6375 *
6376 * This function is called during initialization, before psa_crypto_init()
6377 * returns. If this function returns a failure status, the initialization
6378 * fails.
6379 */
6380static psa_status_t psa_crypto_recover_transaction(
6381 const psa_crypto_transaction_t *transaction )
6382{
6383 switch( transaction->unknown.type )
6384 {
6385 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6386 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006387 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006388 * is implemented.
6389 * https://github.com/ARMmbed/mbed-crypto/issues/218
6390 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006391 default:
6392 /* We found an unsupported transaction in the storage.
6393 * We don't know what state the storage is in. Give up. */
6394 return( PSA_ERROR_STORAGE_FAILURE );
6395 }
6396}
6397#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6398
Gilles Peskinee59236f2018-01-27 23:32:46 +01006399psa_status_t psa_crypto_init( void )
6400{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006401 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006402
Gilles Peskinec6b69072018-11-20 21:42:52 +01006403 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006404 if( global_data.initialized != 0 )
6405 return( PSA_SUCCESS );
6406
Gilles Peskine30524eb2020-11-13 17:02:26 +01006407 /* Initialize and seed the random generator. */
6408 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006409 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006410 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006411 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006412 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006413 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006414
Gilles Peskine66fb1262018-12-10 16:29:04 +01006415 status = psa_initialize_key_slots( );
6416 if( status != PSA_SUCCESS )
6417 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006418
Gilles Peskined9348f22019-10-01 15:22:29 +02006419#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6420 status = psa_init_all_se_drivers( );
6421 if( status != PSA_SUCCESS )
6422 goto exit;
6423#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6424
Gilles Peskine4b734222019-07-24 15:56:31 +02006425#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006426 status = psa_crypto_load_transaction( );
6427 if( status == PSA_SUCCESS )
6428 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006429 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6430 if( status != PSA_SUCCESS )
6431 goto exit;
6432 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006433 }
6434 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6435 {
6436 /* There's no transaction to complete. It's all good. */
6437 status = PSA_SUCCESS;
6438 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006439#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006440
Gilles Peskinec6b69072018-11-20 21:42:52 +01006441 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006442 global_data.initialized = 1;
6443
6444exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006445 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006446 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006447 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006448}
6449
6450#endif /* MBEDTLS_PSA_CRYPTO_C */