blob: d65be17ed587a0c31f595609bb952292f6ce5ce4 [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 Durkop6ba40d12020-11-10 08:50:04 -0800536#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
537 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
538
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100539/** Import an RSA key in binary format.
Steven Cooremana01795d2020-07-24 22:48:15 +0200540 *
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100541 * \note The signature of this function is that of a PSA driver
542 * import_key entry point. This function behaves as an import_key
543 * entry point as defined in the PSA driver interface specification for
544 * transparent drivers.
545 *
546 * \param[in] attributes The attributes for the key to import.
547 * \param[in] data The buffer containing the key data in import
548 * format.
549 * \param[in] data_length Size of the \p data buffer in bytes.
550 * \param[out] key_buffer The buffer containing the key data in output
551 * format.
552 * \param[in] key_buffer_size Size of the \p key_buffer buffer in bytes. This
553 * size is greater or equal to \p data_length.
554 * \param[out] key_buffer_length The length of the data written in \p
555 * key_buffer in bytes.
556 * \param[out] bits The key size in number of bits.
557 *
558 * \retval #PSA_SUCCESS The RSA key was imported successfully.
559 * \retval #PSA_ERROR_INVALID_ARGUMENT
560 * The key data is not correctly formatted.
561 * \retval #PSA_ERROR_NOT_SUPPORTED
562 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
563 * \retval #PSA_ERROR_CORRUPTION_DETECTED
Steven Cooremana01795d2020-07-24 22:48:15 +0200564 */
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100565static psa_status_t psa_import_rsa_key(
566 const psa_key_attributes_t *attributes,
567 const uint8_t *data, size_t data_length,
568 uint8_t *key_buffer, size_t key_buffer_size,
569 size_t *key_buffer_length, size_t *bits )
Steven Cooremana01795d2020-07-24 22:48:15 +0200570{
571 psa_status_t status;
Steven Cooremana2371e52020-07-28 14:30:39 +0200572 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200573
Steven Cooremana01795d2020-07-24 22:48:15 +0200574 /* Parse input */
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100575 status = mbedtls_psa_rsa_load_representation( attributes->core.type,
Ronald Cron90857082020-11-25 14:58:33 +0100576 data,
577 data_length,
578 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200579 if( status != PSA_SUCCESS )
580 goto exit;
581
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100582 *bits = (psa_key_bits_t) PSA_BYTES_TO_BITS( mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200583
Steven Cooreman75b74362020-07-28 14:30:13 +0200584 /* Re-export the data to PSA export format, such that we can store export
585 * representation in the key slot. Export representation in case of RSA is
586 * the smallest representation that's allowed as input, so a straight-up
587 * allocation of the same size as the input buffer will be large enough. */
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100588 status = mbedtls_psa_rsa_export_key( attributes->core.type,
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100589 rsa,
Ronald Cron8f813ee2020-11-07 18:22:09 +0100590 key_buffer,
591 key_buffer_size,
592 key_buffer_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200593exit:
594 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200595 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200596 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200597
Ronald Cron8f813ee2020-11-07 18:22:09 +0100598 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200599}
John Durkop6ba40d12020-11-10 08:50:04 -0800600
601#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -0800602 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200603
John Durkop9814fa22020-11-04 12:28:15 -0800604#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800605 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200606
Steven Cooreman4fed4552020-08-03 14:46:03 +0200607/** Import an ECP key from import representation to a slot
608 *
609 * \param[in,out] slot The slot where to store the export representation to
610 * \param[in] data The buffer containing the import representation
611 * \param[in] data_length The amount of bytes in \p data
612 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200613static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
614 const uint8_t *data,
615 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100616{
Steven Cooremanacda8342020-07-24 23:09:52 +0200617 psa_status_t status;
618 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200619 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100620
Steven Cooremanacda8342020-07-24 23:09:52 +0200621 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100622 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
623 data,
624 data_length,
625 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100626 if( status != PSA_SUCCESS )
627 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100628
Steven Cooremanacda8342020-07-24 23:09:52 +0200629 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200630 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200631 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200632 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200633
Steven Cooremanacda8342020-07-24 23:09:52 +0200634 /* Re-export the data to PSA export format. There is currently no support
635 * for other input formats then the export format, so this is a 1-1
636 * copy operation. */
637 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200638 if( output == NULL )
639 {
640 status = PSA_ERROR_INSUFFICIENT_MEMORY;
641 goto exit;
642 }
643
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100644 status = mbedtls_psa_ecp_export_key( slot->attr.type,
645 ecp,
646 output,
647 data_length,
648 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100649exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200650 /* Always free the PK object (will also free contained ECP context) */
651 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200652 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200653
654 /* Free the allocated buffer only on error. */
655 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100656 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200657 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200658 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100659 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200660
661 /* On success, store the allocated export-formatted key. */
Ronald Cronea0f8a62020-11-25 17:52:23 +0100662 slot->key.data = output;
663 slot->key.bytes = data_length;
Steven Cooremanacda8342020-07-24 23:09:52 +0200664
665 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100666}
John Durkop9814fa22020-11-04 12:28:15 -0800667#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
668 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100669
Gilles Peskineb46bef22019-07-30 21:32:04 +0200670/** Return the size of the key in the given slot, in bits.
671 *
672 * \param[in] slot A key slot.
673 *
674 * \return The key size in bits, read from the metadata in the slot.
675 */
676static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
677{
678 return( slot->attr.bits );
679}
680
Steven Cooreman75b74362020-07-28 14:30:13 +0200681/** Try to allocate a buffer to an empty key slot.
682 *
683 * \param[in,out] slot Key slot to attach buffer to.
684 * \param[in] buffer_length Requested size of the buffer.
685 *
686 * \retval #PSA_SUCCESS
687 * The buffer has been successfully allocated.
688 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
689 * Not enough memory was available for allocation.
690 * \retval #PSA_ERROR_ALREADY_EXISTS
691 * Trying to allocate a buffer to a non-empty key slot.
692 */
693static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
694 size_t buffer_length )
695{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100696 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200697 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200698
Ronald Cronea0f8a62020-11-25 17:52:23 +0100699 slot->key.data = mbedtls_calloc( 1, buffer_length );
700 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200701 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200702
Ronald Cronea0f8a62020-11-25 17:52:23 +0100703 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200704 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200705}
706
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200707psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
708 const uint8_t* data,
709 size_t data_length )
710{
711 psa_status_t status = psa_allocate_buffer_to_slot( slot,
712 data_length );
713 if( status != PSA_SUCCESS )
714 return( status );
715
Ronald Cronea0f8a62020-11-25 17:52:23 +0100716 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200717 return( PSA_SUCCESS );
718}
719
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200720/** Import key data into a slot.
721 *
722 * `slot->type` must have been set previously.
723 * This function assumes that the slot does not contain any key material yet.
724 * On failure, the slot content is unchanged.
725 *
726 * Persistent storage is not affected.
727 *
728 * \param[in,out] slot The key slot to import data into.
729 * Its `type` field must have previously been set to
730 * the desired key type.
731 * It must not contain any key material yet.
732 * \param[in] data Buffer containing the key material to parse and import.
733 * \param data_length Size of \p data in bytes.
734 *
735 * \retval #PSA_SUCCESS
736 * \retval #PSA_ERROR_INVALID_ARGUMENT
737 * \retval #PSA_ERROR_NOT_SUPPORTED
738 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
739 */
740static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
741 const uint8_t *data,
742 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200744 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200745 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100746
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200747 /* zero-length keys are never supported. */
748 if( data_length == 0 )
749 return( PSA_ERROR_NOT_SUPPORTED );
750
Gilles Peskine8e338702019-07-30 20:06:31 +0200751 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100752 {
Steven Cooreman04524762020-10-13 17:43:44 +0200753 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200754
Steven Cooreman75b74362020-07-28 14:30:13 +0200755 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
756 if( data_length > SIZE_MAX / 8 )
757 return( PSA_ERROR_NOT_SUPPORTED );
758
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200759 /* Enforce a size limit, and in particular ensure that the bit
760 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200761 if( bit_size > PSA_MAX_KEY_BITS )
762 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200763
764 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200765 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200766 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200767
768 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200769 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +0200770 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200771 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200772
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200773 /* Write the actual key size to the slot.
774 * psa_start_key_creation() wrote the size declared by the
775 * caller, which may be 0 (meaning unspecified) or wrong. */
776 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +0100777
778 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100779 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200780 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200781 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200782 /* Try validation through accelerators first. */
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200783 psa_key_attributes_t attributes = {
784 .core = slot->attr
785 };
Ronald Cron83282872020-11-22 14:02:39 +0100786
787 status = psa_allocate_buffer_to_slot( slot, data_length );
788 if( status != PSA_SUCCESS )
789 return( status );
790
791 bit_size = slot->attr.bits;
792 status = psa_driver_wrapper_import_key( &attributes,
793 data, data_length,
794 slot->key.data,
795 slot->key.bytes,
796 &slot->key.bytes,
797 &bit_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200798 if( status == PSA_SUCCESS )
799 {
Ronald Cron83282872020-11-22 14:02:39 +0100800 if( slot->attr.bits == 0 )
801 slot->attr.bits = (psa_key_bits_t) bit_size;
802 else if( bit_size != slot->attr.bits )
803 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200804
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200805 return( PSA_SUCCESS );
806 }
Ronald Cron83282872020-11-22 14:02:39 +0100807 else
808 {
809 if( status != PSA_ERROR_NOT_SUPPORTED )
810 return( status );
811 }
812
813 mbedtls_platform_zeroize( slot->key.data, data_length );
814 mbedtls_free( slot->key.data );
815 slot->key.data = NULL;
816 slot->key.bytes = 0;
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200817
818 /* Key format is not supported by any accelerator, try software fallback
819 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800820#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
821 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200822 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
823 {
Steven Cooreman40120f62020-10-29 11:42:22 +0100824 return( psa_import_ecp_key( slot, data, data_length ) );
825 }
John Durkop9814fa22020-11-04 12:28:15 -0800826#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
827 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700828#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
829 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +0100830 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200831 {
Ronald Cron8f813ee2020-11-07 18:22:09 +0100832 status = psa_allocate_buffer_to_slot( slot, data_length );
833 if( status != PSA_SUCCESS )
834 return( status );
835
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100836 status = psa_import_rsa_key( &attributes,
Ronald Cron8f813ee2020-11-07 18:22:09 +0100837 data, data_length,
838 slot->key.data, data_length,
Ronald Cron4f2a7f02020-11-08 14:09:44 +0100839 &slot->key.bytes,
840 &bit_size );
841 slot->attr.bits = (psa_key_bits_t) bit_size;
Ronald Cron8f813ee2020-11-07 18:22:09 +0100842 return( status );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200843 }
John Durkop9814fa22020-11-04 12:28:15 -0800844#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
845 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +0100846
847 /* Fell through the fallback as well, so have nothing else to try. */
848 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100849 }
850 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +0100851 {
Steven Cooreman19fd5742020-07-24 23:31:01 +0200852 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100853 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +0100854 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100855}
856
Gilles Peskinef603c712019-01-19 13:40:11 +0100857/** Calculate the intersection of two algorithm usage policies.
858 *
859 * Return 0 (which allows no operation) on incompatibility.
860 */
861static psa_algorithm_t psa_key_policy_algorithm_intersection(
862 psa_algorithm_t alg1,
863 psa_algorithm_t alg2 )
864{
Gilles Peskine549ea862019-05-22 11:45:59 +0200865 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100866 if( alg1 == alg2 )
867 return( alg1 );
868 /* If the policies are from the same hash-and-sign family, check
869 * if one is a wildcard. If so the other has the specific algorithm. */
870 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
871 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
872 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
873 {
874 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
875 return( alg2 );
876 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
877 return( alg1 );
878 }
879 /* If the policies are incompatible, allow nothing. */
880 return( 0 );
881}
882
Gilles Peskined6f371b2019-05-10 19:33:38 +0200883static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
884 psa_algorithm_t requested_alg )
885{
Gilles Peskine549ea862019-05-22 11:45:59 +0200886 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200887 if( requested_alg == policy_alg )
888 return( 1 );
889 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200890 * and requested_alg is the same hash-and-sign family with any hash,
891 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200892 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
893 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
894 {
895 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
896 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
897 }
Steven Cooremance48e852020-10-05 16:02:45 +0200898 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200899 * a key derivation with that key agreement should also be allowed. This
900 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200901 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
902 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
903 {
904 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
905 policy_alg );
906 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200907 /* If it isn't permitted, it's forbidden. */
908 return( 0 );
909}
910
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100911/** Test whether a policy permits an algorithm.
912 *
913 * The caller must test usage flags separately.
914 */
915static int psa_key_policy_permits( const psa_key_policy_t *policy,
916 psa_algorithm_t alg )
917{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200918 return( psa_key_algorithm_permits( policy->alg, alg ) ||
919 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100920}
921
Gilles Peskinef603c712019-01-19 13:40:11 +0100922/** Restrict a key policy based on a constraint.
923 *
924 * \param[in,out] policy The policy to restrict.
925 * \param[in] constraint The policy constraint to apply.
926 *
927 * \retval #PSA_SUCCESS
928 * \c *policy contains the intersection of the original value of
929 * \c *policy and \c *constraint.
930 * \retval #PSA_ERROR_INVALID_ARGUMENT
931 * \c *policy and \c *constraint are incompatible.
932 * \c *policy is unchanged.
933 */
934static psa_status_t psa_restrict_key_policy(
935 psa_key_policy_t *policy,
936 const psa_key_policy_t *constraint )
937{
938 psa_algorithm_t intersection_alg =
939 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200940 psa_algorithm_t intersection_alg2 =
941 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100942 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
943 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200944 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
945 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100946 policy->usage &= constraint->usage;
947 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200948 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100949 return( PSA_SUCCESS );
950}
951
Ronald Cron5c522922020-11-14 16:35:34 +0100952/** Get the description of a key given its identifier and policy constraints
953 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200954 *
Ronald Cron5c522922020-11-14 16:35:34 +0100955 * The key must have allow all the usage flags set in \p usage. If \p alg is
956 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100957 *
Ronald Cron5c522922020-11-14 16:35:34 +0100958 * In case of a persistent key, the function loads the description of the key
959 * into a key slot if not already done.
960 *
961 * On success, the returned key slot is locked. It is the responsibility of
962 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200963 */
Ronald Cron5c522922020-11-14 16:35:34 +0100964static psa_status_t psa_get_and_lock_key_slot_with_policy(
965 mbedtls_svc_key_id_t key,
966 psa_key_slot_t **p_slot,
967 psa_key_usage_t usage,
968 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100969{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200970 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
971 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100972
Ronald Cron5c522922020-11-14 16:35:34 +0100973 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100974 if( status != PSA_SUCCESS )
975 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200976 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100977
978 /* Enforce that usage policy for the key slot contains all the flags
979 * required by the usage parameter. There is one exception: public
980 * keys can always be exported, so we treat public key objects as
981 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200982 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100983 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200984
985 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200986 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100988
989 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200990 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200991 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100992
Darryl Green06fd18d2018-07-16 11:21:11 +0100993 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200994
995error:
996 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100997 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200998
999 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001000}
Darryl Green940d72c2018-07-13 13:18:51 +01001001
Ronald Cron5c522922020-11-14 16:35:34 +01001002/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001003 *
1004 * A transparent key is a key for which the key material is directly
1005 * available, as opposed to a key in a secure element.
1006 *
Ronald Cron5c522922020-11-14 16:35:34 +01001007 * This is a temporary function to use instead of
1008 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1009 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001010 *
Ronald Cron5c522922020-11-14 16:35:34 +01001011 * On success, the returned key slot is locked. It is the responsibility of the
1012 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001013 */
1014#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001015static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1016 mbedtls_svc_key_id_t key,
1017 psa_key_slot_t **p_slot,
1018 psa_key_usage_t usage,
1019 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001020{
Ronald Cron5c522922020-11-14 16:35:34 +01001021 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1022 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001023 if( status != PSA_SUCCESS )
1024 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001025
Gilles Peskineadad8132019-07-25 11:31:23 +02001026 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001027 {
Ronald Cron5c522922020-11-14 16:35:34 +01001028 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001029 *p_slot = NULL;
1030 return( PSA_ERROR_NOT_SUPPORTED );
1031 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001032
Gilles Peskine28f8f302019-07-24 13:30:31 +02001033 return( PSA_SUCCESS );
1034}
1035#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1036/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001037#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1038 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001039#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1040
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001041/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001042static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001043{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001044 /* Data pointer will always be either a valid pointer or NULL in an
1045 * initialized slot, so we can just free it. */
1046 if( slot->key.data != NULL )
1047 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1048
1049 mbedtls_free( slot->key.data );
1050 slot->key.data = NULL;
1051 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001052
1053 return( PSA_SUCCESS );
1054}
1055
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001056/** Completely wipe a slot in memory, including its policy.
1057 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001058psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001059{
1060 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001061
1062 /*
1063 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001064 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001065 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1066 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001067 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001068 */
Ronald Cron5c522922020-11-14 16:35:34 +01001069 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001070 {
1071#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001072 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001073#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001074 status = PSA_ERROR_CORRUPTION_DETECTED;
1075 }
1076
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001077 /* Multipart operations may still be using the key. This is safe
1078 * because all multipart operation objects are independent from
1079 * the key slot: if they need to access the key after the setup
1080 * phase, they have a copy of the key. Note that this means that
1081 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001082 /* At this point, key material and other type-specific content has
1083 * been wiped. Clear remaining metadata. We can call memset and not
1084 * zeroize because the metadata is not particularly sensitive. */
1085 memset( slot, 0, sizeof( *slot ) );
1086 return( status );
1087}
1088
Ronald Croncf56a0a2020-08-04 09:51:30 +02001089psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001090{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001091 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001092 psa_status_t status; /* status of the last operation */
1093 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001094#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1095 psa_se_drv_table_entry_t *driver;
1096#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001097
Ronald Croncf56a0a2020-08-04 09:51:30 +02001098 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001099 return( PSA_SUCCESS );
1100
Ronald Cronf2911112020-10-29 17:51:10 +01001101 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001102 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001103 * key, this will load the key description from persistent memory if not
1104 * done yet. We cannot avoid this loading as without it we don't know if
1105 * the key is operated by an SE or not and this information is needed by
1106 * the current implementation.
1107 */
Ronald Cron5c522922020-11-14 16:35:34 +01001108 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001109 if( status != PSA_SUCCESS )
1110 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001111
Ronald Cronf2911112020-10-29 17:51:10 +01001112 /*
1113 * If the key slot containing the key description is under access by the
1114 * library (apart from the present access), the key cannot be destroyed
1115 * yet. For the time being, just return in error. Eventually (to be
1116 * implemented), the key should be destroyed when all accesses have
1117 * stopped.
1118 */
Ronald Cron5c522922020-11-14 16:35:34 +01001119 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001120 {
Ronald Cron5c522922020-11-14 16:35:34 +01001121 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001122 return( PSA_ERROR_GENERIC_ERROR );
1123 }
1124
Gilles Peskine354f7672019-07-12 23:46:38 +02001125#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001126 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001127 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001128 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001129 /* For a key in a secure element, we need to do three things:
1130 * remove the key file in internal storage, destroy the
1131 * key inside the secure element, and update the driver's
1132 * persistent data. Start a transaction that will encompass these
1133 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001134 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001135 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001136 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001137 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001138 status = psa_crypto_save_transaction( );
1139 if( status != PSA_SUCCESS )
1140 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001141 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001142 /* We should still try to destroy the key in the secure
1143 * element and the key metadata in storage. This is especially
1144 * important if the error is that the storage is full.
1145 * But how to do it exactly without risking an inconsistent
1146 * state after a reset?
1147 * https://github.com/ARMmbed/mbed-crypto/issues/215
1148 */
1149 overall_status = status;
1150 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001151 }
1152
Ronald Cronea0f8a62020-11-25 17:52:23 +01001153 status = psa_destroy_se_key( driver,
1154 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001155 if( overall_status == PSA_SUCCESS )
1156 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001157 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001158#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1159
Darryl Greend49a4992018-06-18 17:27:26 +01001160#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001161 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001162 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001163 status = psa_destroy_persistent_key( slot->attr.id );
1164 if( overall_status == PSA_SUCCESS )
1165 overall_status = status;
1166
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001167 /* TODO: other slots may have a copy of the same key. We should
1168 * invalidate them.
1169 * https://github.com/ARMmbed/mbed-crypto/issues/214
1170 */
Darryl Greend49a4992018-06-18 17:27:26 +01001171 }
1172#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001173
Gilles Peskinefc762652019-07-22 19:30:34 +02001174#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1175 if( driver != NULL )
1176 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001177 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001178 if( overall_status == PSA_SUCCESS )
1179 overall_status = status;
1180 status = psa_crypto_stop_transaction( );
1181 if( overall_status == PSA_SUCCESS )
1182 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001183 }
1184#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1185
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001186#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1187exit:
1188#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001189 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001190 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1191 if( overall_status == PSA_SUCCESS )
1192 overall_status = status;
1193 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001194}
1195
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001196void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001197{
Gilles Peskineb699f072019-04-26 16:06:02 +02001198 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001199 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001200}
1201
Gilles Peskineb699f072019-04-26 16:06:02 +02001202psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1203 psa_key_type_t type,
1204 const uint8_t *data,
1205 size_t data_length )
1206{
1207 uint8_t *copy = NULL;
1208
1209 if( data_length != 0 )
1210 {
1211 copy = mbedtls_calloc( 1, data_length );
1212 if( copy == NULL )
1213 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1214 memcpy( copy, data, data_length );
1215 }
1216 /* After this point, this function is guaranteed to succeed, so it
1217 * can start modifying `*attributes`. */
1218
1219 if( attributes->domain_parameters != NULL )
1220 {
1221 mbedtls_free( attributes->domain_parameters );
1222 attributes->domain_parameters = NULL;
1223 attributes->domain_parameters_size = 0;
1224 }
1225
1226 attributes->domain_parameters = copy;
1227 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001228 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 return( PSA_SUCCESS );
1230}
1231
1232psa_status_t psa_get_key_domain_parameters(
1233 const psa_key_attributes_t *attributes,
1234 uint8_t *data, size_t data_size, size_t *data_length )
1235{
1236 if( attributes->domain_parameters_size > data_size )
1237 return( PSA_ERROR_BUFFER_TOO_SMALL );
1238 *data_length = attributes->domain_parameters_size;
1239 if( attributes->domain_parameters_size != 0 )
1240 memcpy( data, attributes->domain_parameters,
1241 attributes->domain_parameters_size );
1242 return( PSA_SUCCESS );
1243}
1244
John Durkop07cc04a2020-11-16 22:08:34 -08001245#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001246 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001247static psa_status_t psa_get_rsa_public_exponent(
1248 const mbedtls_rsa_context *rsa,
1249 psa_key_attributes_t *attributes )
1250{
1251 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001252 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001253 uint8_t *buffer = NULL;
1254 size_t buflen;
1255 mbedtls_mpi_init( &mpi );
1256
1257 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1258 if( ret != 0 )
1259 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001260 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1261 {
1262 /* It's the default value, which is reported as an empty string,
1263 * so there's nothing to do. */
1264 goto exit;
1265 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001266
1267 buflen = mbedtls_mpi_size( &mpi );
1268 buffer = mbedtls_calloc( 1, buflen );
1269 if( buffer == NULL )
1270 {
1271 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1272 goto exit;
1273 }
1274 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1275 if( ret != 0 )
1276 goto exit;
1277 attributes->domain_parameters = buffer;
1278 attributes->domain_parameters_size = buflen;
1279
1280exit:
1281 mbedtls_mpi_free( &mpi );
1282 if( ret != 0 )
1283 mbedtls_free( buffer );
1284 return( mbedtls_to_psa_error( ret ) );
1285}
John Durkop07cc04a2020-11-16 22:08:34 -08001286#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001287 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001288
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001289/** Retrieve all the publicly-accessible attributes of a key.
1290 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001291psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001292 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001293{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001295 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001296 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001297
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001298 psa_reset_key_attributes( attributes );
1299
Ronald Cron5c522922020-11-14 16:35:34 +01001300 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001301 if( status != PSA_SUCCESS )
1302 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001303
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001304 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001305 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1306 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1307
1308#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1309 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001310 psa_set_key_slot_number( attributes,
1311 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001312#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001313
Gilles Peskine8e338702019-07-30 20:06:31 +02001314 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001315 {
John Durkop07cc04a2020-11-16 22:08:34 -08001316#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001317 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001318 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001319 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001320#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001321 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001322 * is not yet implemented.
1323 * https://github.com/ARMmbed/mbed-crypto/issues/216
1324 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001325 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001326 break;
1327#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001328 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001329 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001330
Ronald Cron90857082020-11-25 14:58:33 +01001331 status = mbedtls_psa_rsa_load_representation(
1332 slot->attr.type,
1333 slot->key.data,
1334 slot->key.bytes,
1335 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001336 if( status != PSA_SUCCESS )
1337 break;
1338
Steven Cooremana2371e52020-07-28 14:30:39 +02001339 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001340 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001341 mbedtls_rsa_free( rsa );
1342 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001343 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001344 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001345#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001346 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001347 default:
1348 /* Nothing else to do. */
1349 break;
1350 }
1351
1352 if( status != PSA_SUCCESS )
1353 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001354
Ronald Cron5c522922020-11-14 16:35:34 +01001355 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001356
Ronald Cron5c522922020-11-14 16:35:34 +01001357 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001358}
1359
Gilles Peskinec8000c02019-08-02 20:15:51 +02001360#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1361psa_status_t psa_get_key_slot_number(
1362 const psa_key_attributes_t *attributes,
1363 psa_key_slot_number_t *slot_number )
1364{
1365 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1366 {
1367 *slot_number = attributes->slot_number;
1368 return( PSA_SUCCESS );
1369 }
1370 else
1371 return( PSA_ERROR_INVALID_ARGUMENT );
1372}
1373#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1374
Ronald Crond18b5f82020-11-25 16:46:05 +01001375static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1376 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001377 uint8_t *data,
1378 size_t data_size,
1379 size_t *data_length )
1380{
Ronald Crond18b5f82020-11-25 16:46:05 +01001381 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001382 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001383 memcpy( data, key_buffer, key_buffer_size );
1384 memset( data + key_buffer_size, 0,
1385 data_size - key_buffer_size );
1386 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001387 return( PSA_SUCCESS );
1388}
1389
Ronald Cron7285cda2020-11-26 14:46:37 +01001390psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001391 const psa_key_attributes_t *attributes,
1392 const uint8_t *key_buffer, size_t key_buffer_size,
1393 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001394{
Ronald Crond18b5f82020-11-25 16:46:05 +01001395 psa_key_type_t type = attributes->core.type;
1396
Ronald Crond18b5f82020-11-25 16:46:05 +01001397 if( key_type_is_raw_bytes( type ) ||
1398 PSA_KEY_TYPE_IS_RSA( type ) ||
1399 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001400 {
1401 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001402 key_buffer, key_buffer_size,
1403 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001404 }
1405 else
1406 {
1407 /* This shouldn't happen in the reference implementation, but
1408 it is valid for a special-purpose implementation to omit
1409 support for exporting certain key types. */
1410 return( PSA_ERROR_NOT_SUPPORTED );
1411 }
1412}
1413
1414psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1415 uint8_t *data,
1416 size_t data_size,
1417 size_t *data_length )
1418{
1419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1420 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1421 psa_key_slot_t *slot;
1422
1423 /* Set the key to empty now, so that even when there are errors, we always
1424 * set data_length to a value between 0 and data_size. On error, setting
1425 * the key to empty is a good choice because an empty key representation is
1426 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001427 *data_length = 0;
1428
Ronald Cron9486f9d2020-11-26 13:36:23 +01001429 /* Export requires the EXPORT flag. There is an exception for public keys,
1430 * which don't require any flag, but
1431 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1432 */
1433 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1434 PSA_KEY_USAGE_EXPORT, 0 );
1435 if( status != PSA_SUCCESS )
1436 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001437
Gilles Peskinef9168942019-09-12 19:20:29 +02001438 /* Reject a zero-length output buffer now, since this can never be a
1439 * valid key representation. This way we know that data must be a valid
1440 * pointer and we can do things like memset(data, ..., data_size). */
1441 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001442 {
1443 status = PSA_ERROR_BUFFER_TOO_SMALL;
1444 goto exit;
1445 }
1446
Ronald Crond18b5f82020-11-25 16:46:05 +01001447 psa_key_attributes_t attributes = {
1448 .core = slot->attr
1449 };
Ronald Cron67227982020-11-26 15:16:05 +01001450 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001451 slot->key.data, slot->key.bytes,
1452 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001453
1454exit:
1455 unlock_status = psa_unlock_key_slot( slot );
1456
1457 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1458}
1459
Ronald Cron7285cda2020-11-26 14:46:37 +01001460psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001461 const psa_key_attributes_t *attributes,
1462 const uint8_t *key_buffer,
1463 size_t key_buffer_size,
1464 uint8_t *data,
1465 size_t data_size,
1466 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001467{
Ronald Crond18b5f82020-11-25 16:46:05 +01001468 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001469
Ronald Crond18b5f82020-11-25 16:46:05 +01001470 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001471 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001472 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001473 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001474 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001475 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001476 key_buffer, key_buffer_size,
1477 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001478 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001479
Ronald Crond18b5f82020-11-25 16:46:05 +01001480 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001481 {
John Durkop0e005192020-10-31 22:06:54 -07001482#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1483 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001484 return( mbedtls_psa_rsa_export_public_key( attributes,
1485 key_buffer,
1486 key_buffer_size,
1487 data,
1488 data_size,
1489 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001490#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001491 /* We don't know how to convert a private RSA key to public. */
1492 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001493#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1494 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001495 }
1496 else
Moran Pekera998bc62018-04-16 18:16:20 +03001497 {
John Durkop6ba40d12020-11-10 08:50:04 -08001498#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1499 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001500 return( mbedtls_psa_ecp_export_public_key( attributes,
1501 key_buffer,
1502 key_buffer_size,
1503 data,
1504 data_size,
1505 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001506#else
1507 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001508 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001509#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1510 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001511 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001512 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001513 else
1514 {
1515 /* This shouldn't happen in the reference implementation, but
1516 it is valid for a special-purpose implementation to omit
1517 support for exporting certain key types. */
1518 return( PSA_ERROR_NOT_SUPPORTED );
1519 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001520}
Ronald Crond18b5f82020-11-25 16:46:05 +01001521
Ronald Croncf56a0a2020-08-04 09:51:30 +02001522psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001523 uint8_t *data,
1524 size_t data_size,
1525 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001526{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001528 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001529 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001530
1531 /* Set the key to empty now, so that even when there are errors, we always
1532 * set data_length to a value between 0 and data_size. On error, setting
1533 * the key to empty is a good choice because an empty key representation is
1534 * unlikely to be accepted anywhere. */
1535 *data_length = 0;
1536
1537 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001538 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001539 if( status != PSA_SUCCESS )
1540 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001541
Ronald Cron9486f9d2020-11-26 13:36:23 +01001542 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1543 {
1544 status = PSA_ERROR_INVALID_ARGUMENT;
1545 goto exit;
1546 }
1547
1548 /* Reject a zero-length output buffer now, since this can never be a
1549 * valid key representation. This way we know that data must be a valid
1550 * pointer and we can do things like memset(data, ..., data_size). */
1551 if( data_size == 0 )
1552 {
1553 status = PSA_ERROR_BUFFER_TOO_SMALL;
1554 goto exit;
1555 }
1556
Ronald Crond18b5f82020-11-25 16:46:05 +01001557 psa_key_attributes_t attributes = {
1558 .core = slot->attr
1559 };
Ronald Cron67227982020-11-26 15:16:05 +01001560 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001561 &attributes, slot->key.data, slot->key.bytes,
1562 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001563
1564exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001565 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001566
Ronald Cron5c522922020-11-14 16:35:34 +01001567 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001568}
1569
Gilles Peskine91e8c332019-08-02 19:19:39 +02001570#if defined(static_assert)
1571static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1572 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001573static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001574 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001575static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001576 "One or more key attribute flag is listed as both internal-only and external-only" );
1577#endif
1578
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001579/** Validate that a key policy is internally well-formed.
1580 *
1581 * This function only rejects invalid policies. It does not validate the
1582 * consistency of the policy with respect to other attributes of the key
1583 * such as the key type.
1584 */
1585static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001586{
1587 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001588 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001589 PSA_KEY_USAGE_ENCRYPT |
1590 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001591 PSA_KEY_USAGE_SIGN_HASH |
1592 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001593 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1594 return( PSA_ERROR_INVALID_ARGUMENT );
1595
Gilles Peskine4747d192019-04-17 15:05:45 +02001596 return( PSA_SUCCESS );
1597}
1598
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001599/** Validate the internal consistency of key attributes.
1600 *
1601 * This function only rejects invalid attribute values. If does not
1602 * validate the consistency of the attributes with any key data that may
1603 * be involved in the creation of the key.
1604 *
1605 * Call this function early in the key creation process.
1606 *
1607 * \param[in] attributes Key attributes for the new key.
1608 * \param[out] p_drv On any return, the driver for the key, if any.
1609 * NULL for a transparent key.
1610 *
1611 */
1612static psa_status_t psa_validate_key_attributes(
1613 const psa_key_attributes_t *attributes,
1614 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001615{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001616 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001617 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001618 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001619
Ronald Cron54b90082020-10-29 15:26:43 +01001620 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001621 if( status != PSA_SUCCESS )
1622 return( status );
1623
Ronald Crond2ed4812020-07-17 16:11:30 +02001624 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001625 if( status != PSA_SUCCESS )
1626 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001627
Ronald Cron65f38a32020-10-23 17:11:13 +02001628 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1629 {
1630 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1631 return( PSA_ERROR_INVALID_ARGUMENT );
1632 }
1633 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001634 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001635 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001636 if( status != PSA_SUCCESS )
1637 return( status );
1638 }
1639
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001640 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001641 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001642 return( status );
1643
1644 /* Refuse to create overly large keys.
1645 * Note that this doesn't trigger on import if the attributes don't
1646 * explicitly specify a size (so psa_get_key_bits returns 0), so
1647 * psa_import_key() needs its own checks. */
1648 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1649 return( PSA_ERROR_NOT_SUPPORTED );
1650
Gilles Peskine91e8c332019-08-02 19:19:39 +02001651 /* Reject invalid flags. These should not be reachable through the API. */
1652 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1653 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1654 return( PSA_ERROR_INVALID_ARGUMENT );
1655
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001656 return( PSA_SUCCESS );
1657}
1658
Gilles Peskine4747d192019-04-17 15:05:45 +02001659/** Prepare a key slot to receive key material.
1660 *
1661 * This function allocates a key slot and sets its metadata.
1662 *
1663 * If this function fails, call psa_fail_key_creation().
1664 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001665 * This function is intended to be used as follows:
1666 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001667 * it with the specified attributes, and in case of a volatile key assign it
1668 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001669 * -# Populate the slot with the key material.
1670 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1671 * In case of failure at any step, stop the sequence and call
1672 * psa_fail_key_creation().
1673 *
Ronald Cron5c522922020-11-14 16:35:34 +01001674 * On success, the key slot is locked. It is the responsibility of the caller
1675 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001676 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001677 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001678 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001679 * \param[out] p_slot On success, a pointer to the prepared slot.
1680 * \param[out] p_drv On any return, the driver for the key, if any.
1681 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001682 *
1683 * \retval #PSA_SUCCESS
1684 * The key slot is ready to receive key material.
1685 * \return If this function fails, the key slot is an invalid state.
1686 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001687 */
1688static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001689 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001690 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001691 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001692 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001693{
1694 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001695 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001696 psa_key_slot_t *slot;
1697
Gilles Peskinedf179142019-07-15 22:02:14 +02001698 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001699 *p_drv = NULL;
1700
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001701 status = psa_validate_key_attributes( attributes, p_drv );
1702 if( status != PSA_SUCCESS )
1703 return( status );
1704
Ronald Cronc4d1b512020-07-31 11:26:37 +02001705 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001706 if( status != PSA_SUCCESS )
1707 return( status );
1708 slot = *p_slot;
1709
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001710 /* We're storing the declared bit-size of the key. It's up to each
1711 * creation mechanism to verify that this information is correct.
1712 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001713 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001714 * is optional (import, copy). In case of a volatile key, assign it the
1715 * volatile key identifier associated to the slot returned to contain its
1716 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001717
1718 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001719 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1720 {
1721#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1722 slot->attr.id = volatile_key_id;
1723#else
1724 slot->attr.id.key_id = volatile_key_id;
1725#endif
1726 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001727
Gilles Peskine91e8c332019-08-02 19:19:39 +02001728 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001729 * external-only flags, query `attributes`. Thanks to the check
1730 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001731 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001732 * may have set. */
1733 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001734
Gilles Peskinecbaff462019-07-12 23:46:04 +02001735#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001736 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001737 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001738 * create the key file in internal storage, create the
1739 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001740 * persistent data. This is done by starting a transaction that will
1741 * encompass these three actions.
1742 * For registering a volatile key, we just need to find an appropriate
1743 * slot number inside the SE. Since the key is designated volatile, creating
1744 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001745 /* The first thing to do is to find a slot number for the new key.
1746 * We save the slot number in persistent storage as part of the
1747 * transaction data. It will be needed to recover if the power
1748 * fails during the key creation process, to clean up on the secure
1749 * element side after restarting. Obtaining a slot number from the
1750 * secure element driver updates its persistent state, but we do not yet
1751 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001752 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001753 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001754 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001755 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001756 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001757 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001758 if( status != PSA_SUCCESS )
1759 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001760
1761 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001762 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001763 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1764 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001765 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001766 psa_crypto_transaction.key.id = slot->attr.id;
1767 status = psa_crypto_save_transaction( );
1768 if( status != PSA_SUCCESS )
1769 {
1770 (void) psa_crypto_stop_transaction( );
1771 return( status );
1772 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001773 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001774
1775 status = psa_copy_key_material_into_slot(
1776 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001777 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001778
1779 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1780 {
1781 /* Key registration only makes sense with a secure element. */
1782 return( PSA_ERROR_INVALID_ARGUMENT );
1783 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001784#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1785
Ronald Cronc4d1b512020-07-31 11:26:37 +02001786 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001787}
Gilles Peskine4747d192019-04-17 15:05:45 +02001788
1789/** Finalize the creation of a key once its key material has been set.
1790 *
1791 * This entails writing the key to persistent storage.
1792 *
1793 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001794 * See the documentation of psa_start_key_creation() for the intended use
1795 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001796 *
Ronald Cron5c522922020-11-14 16:35:34 +01001797 * If the finalization succeeds, the function unlocks the key slot (it was
1798 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1799 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001800 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001801 * \param[in,out] slot Pointer to the slot with key material.
1802 * \param[in] driver The secure element driver for the key,
1803 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001804 * \param[out] key On success, identifier of the key. Note that the
1805 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001806 *
1807 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001808 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001809 * \return If this function fails, the key slot is an invalid state.
1810 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001811 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001812static psa_status_t psa_finish_key_creation(
1813 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001814 psa_se_drv_table_entry_t *driver,
1815 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001816{
1817 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001818 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001819 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001820
1821#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001822 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001823 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001824#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1825 if( driver != NULL )
1826 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001827 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001828 psa_key_slot_number_t slot_number =
1829 psa_key_slot_get_slot_number( slot ) ;
1830
Gilles Peskineb46bef22019-07-30 21:32:04 +02001831#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001832 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001833 sizeof( data.slot_number ),
1834 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001835#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001836 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001837 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001838 (uint8_t*) &data,
1839 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001840 }
1841 else
1842#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1843 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001844 /* Key material is saved in export representation in the slot, so
1845 * just pass the slot buffer for storage. */
1846 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001847 slot->key.data,
1848 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001849 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001850 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001851#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1852
Gilles Peskinecbaff462019-07-12 23:46:04 +02001853#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001854 /* Finish the transaction for a key creation. This does not
1855 * happen when registering an existing key. Detect this case
1856 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001857 * creation of a persistent key in a secure element requires a transaction,
1858 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001859 if( driver != NULL &&
1860 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001861 {
1862 status = psa_save_se_persistent_data( driver );
1863 if( status != PSA_SUCCESS )
1864 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001865 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001866 return( status );
1867 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001868 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001869 }
1870#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1871
Ronald Cron50972942020-11-14 11:28:25 +01001872 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001873 {
1874 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001875 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001876 if( status != PSA_SUCCESS )
1877 *key = MBEDTLS_SVC_KEY_ID_INIT;
1878 }
Ronald Cron50972942020-11-14 11:28:25 +01001879
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 return( status );
1881}
1882
1883/** Abort the creation of a key.
1884 *
1885 * You may call this function after calling psa_start_key_creation(),
1886 * or after psa_finish_key_creation() fails. In other circumstances, this
1887 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001888 * See the documentation of psa_start_key_creation() for the intended use
1889 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001890 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001891 * \param[in,out] slot Pointer to the slot with key material.
1892 * \param[in] driver The secure element driver for the key,
1893 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001894 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001895static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001896 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001897{
Gilles Peskine011e4282019-06-26 18:34:38 +02001898 (void) driver;
1899
Gilles Peskine4747d192019-04-17 15:05:45 +02001900 if( slot == NULL )
1901 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001902
1903#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001904 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001905 * element, and the failure happened later (when saving metadata
1906 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001907 * element.
1908 * https://github.com/ARMmbed/mbed-crypto/issues/217
1909 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001910
Gilles Peskined7729582019-08-05 15:55:54 +02001911 /* Abort the ongoing transaction if any (there may not be one if
1912 * the creation process failed before starting one, or if the
1913 * key creation is a registration of a key in a secure element).
1914 * Earlier functions must already have done what it takes to undo any
1915 * partial creation. All that's left is to update the transaction data
1916 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001917 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001918#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1919
Gilles Peskine4747d192019-04-17 15:05:45 +02001920 psa_wipe_key_slot( slot );
1921}
1922
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001923/** Validate optional attributes during key creation.
1924 *
1925 * Some key attributes are optional during key creation. If they are
1926 * specified in the attributes structure, check that they are consistent
1927 * with the data in the slot.
1928 *
1929 * This function should be called near the end of key creation, after
1930 * the slot in memory is fully populated but before saving persistent data.
1931 */
1932static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001933 const psa_key_slot_t *slot,
1934 const psa_key_attributes_t *attributes )
1935{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001936 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001938 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001939 return( PSA_ERROR_INVALID_ARGUMENT );
1940 }
1941
1942 if( attributes->domain_parameters_size != 0 )
1943 {
John Durkop0e005192020-10-31 22:06:54 -07001944#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1945 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001946 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001947 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001948 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001949 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001950 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001951
Ronald Cron90857082020-11-25 14:58:33 +01001952 psa_status_t status = mbedtls_psa_rsa_load_representation(
1953 slot->attr.type,
1954 slot->key.data,
1955 slot->key.bytes,
1956 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001957 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001958 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001959
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960 mbedtls_mpi_init( &actual );
1961 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001962 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001963 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001964 mbedtls_rsa_free( rsa );
1965 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001966 if( ret != 0 )
1967 goto rsa_exit;
1968 ret = mbedtls_mpi_read_binary( &required,
1969 attributes->domain_parameters,
1970 attributes->domain_parameters_size );
1971 if( ret != 0 )
1972 goto rsa_exit;
1973 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1974 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1975 rsa_exit:
1976 mbedtls_mpi_free( &actual );
1977 mbedtls_mpi_free( &required );
1978 if( ret != 0)
1979 return( mbedtls_to_psa_error( ret ) );
1980 }
1981 else
John Durkop9814fa22020-11-04 12:28:15 -08001982#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1983 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001984 {
1985 return( PSA_ERROR_INVALID_ARGUMENT );
1986 }
1987 }
1988
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001989 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001990 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001991 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001992 return( PSA_ERROR_INVALID_ARGUMENT );
1993 }
1994
1995 return( PSA_SUCCESS );
1996}
1997
Gilles Peskine4747d192019-04-17 15:05:45 +02001998psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001999 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002000 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002001 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002002{
2003 psa_status_t status;
2004 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002005 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006
Ronald Cron81709fc2020-11-14 12:10:32 +01002007 *key = MBEDTLS_SVC_KEY_ID_INIT;
2008
Gilles Peskine0f84d622019-09-12 19:03:13 +02002009 /* Reject zero-length symmetric keys (including raw data key objects).
2010 * This also rejects any key which might be encoded as an empty string,
2011 * which is never valid. */
2012 if( data_length == 0 )
2013 return( PSA_ERROR_INVALID_ARGUMENT );
2014
Gilles Peskinedf179142019-07-15 22:02:14 +02002015 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 if( status != PSA_SUCCESS )
2018 goto exit;
2019
Gilles Peskine5d309672019-07-12 23:47:28 +02002020#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2021 if( driver != NULL )
2022 {
2023 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002024 /* The driver should set the number of key bits, however in
2025 * case it doesn't, we initialize bits to an invalid value. */
2026 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002027 if( drv->key_management == NULL ||
2028 drv->key_management->p_import == NULL )
2029 {
2030 status = PSA_ERROR_NOT_SUPPORTED;
2031 goto exit;
2032 }
2033 status = drv->key_management->p_import(
2034 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01002035 psa_key_slot_get_slot_number( slot ),
2036 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002037 if( status != PSA_SUCCESS )
2038 goto exit;
2039 if( bits > PSA_MAX_KEY_BITS )
2040 {
2041 status = PSA_ERROR_NOT_SUPPORTED;
2042 goto exit;
2043 }
2044 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002045 }
2046 else
2047#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01002048 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
2049 {
2050 /* Importing a key with external lifetime through the driver wrapper
2051 * interface is not yet supported. Return as if this was an invalid
2052 * lifetime. */
2053 status = PSA_ERROR_INVALID_ARGUMENT;
2054 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002055 }
2056 else
Gilles Peskine5d309672019-07-12 23:47:28 +02002057 {
2058 status = psa_import_key_into_slot( slot, data, data_length );
2059 if( status != PSA_SUCCESS )
2060 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002061 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002062 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002063 if( status != PSA_SUCCESS )
2064 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002065
Ronald Cron81709fc2020-11-14 12:10:32 +01002066 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002067exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002068 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002069 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002070
Gilles Peskine4747d192019-04-17 15:05:45 +02002071 return( status );
2072}
2073
Gilles Peskined7729582019-08-05 15:55:54 +02002074#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2075psa_status_t mbedtls_psa_register_se_key(
2076 const psa_key_attributes_t *attributes )
2077{
2078 psa_status_t status;
2079 psa_key_slot_t *slot = NULL;
2080 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002081 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002082
2083 /* Leaving attributes unspecified is not currently supported.
2084 * It could make sense to query the key type and size from the
2085 * secure element, but not all secure elements support this
2086 * and the driver HAL doesn't currently support it. */
2087 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2088 return( PSA_ERROR_NOT_SUPPORTED );
2089 if( psa_get_key_bits( attributes ) == 0 )
2090 return( PSA_ERROR_NOT_SUPPORTED );
2091
2092 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002093 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002094 if( status != PSA_SUCCESS )
2095 goto exit;
2096
Ronald Cron81709fc2020-11-14 12:10:32 +01002097 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002098
2099exit:
2100 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002101 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002102
Gilles Peskined7729582019-08-05 15:55:54 +02002103 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002104 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002105 return( status );
2106}
2107#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2108
Gilles Peskinef603c712019-01-19 13:40:11 +01002109static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002110 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002111{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002112 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002113 source->key.data,
2114 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002115 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002116 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002117
Steven Cooreman398aee52020-10-13 14:35:45 +02002118 target->attr.type = source->attr.type;
2119 target->attr.bits = source->attr.bits;
2120
2121 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002122}
2123
Ronald Croncf56a0a2020-08-04 09:51:30 +02002124psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002125 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002126 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002127{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002128 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002129 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002130 psa_key_slot_t *source_slot = NULL;
2131 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002132 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002133 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002134
Ronald Cron81709fc2020-11-14 12:10:32 +01002135 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2136
Ronald Cron5c522922020-11-14 16:35:34 +01002137 status = psa_get_and_lock_transparent_key_slot_with_policy(
2138 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002139 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002140 goto exit;
2141
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002142 status = psa_validate_optional_attributes( source_slot,
2143 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002144 if( status != PSA_SUCCESS )
2145 goto exit;
2146
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002147 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002148 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002149 if( status != PSA_SUCCESS )
2150 goto exit;
2151
Ronald Cron81709fc2020-11-14 12:10:32 +01002152 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2153 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002154 if( status != PSA_SUCCESS )
2155 goto exit;
2156
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002157#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2158 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002159 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002160 /* Copying to a secure element is not implemented yet. */
2161 status = PSA_ERROR_NOT_SUPPORTED;
2162 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002163 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002164#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002165
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002166 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002167 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002168 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002169
Ronald Cron81709fc2020-11-14 12:10:32 +01002170 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002171exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002172 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002173 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002174
Ronald Cron5c522922020-11-14 16:35:34 +01002175 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002176
Ronald Cron5c522922020-11-14 16:35:34 +01002177 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002178}
2179
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002180
2181
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002182/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002183/* Message digests */
2184/****************************************************************/
2185
John Durkop07cc04a2020-11-16 22:08:34 -08002186#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002187 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2188 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002189 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002190static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002191{
2192 switch( alg )
2193 {
John Durkopee4e6602020-11-27 08:48:46 -08002194#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002195 case PSA_ALG_MD2:
2196 return( &mbedtls_md2_info );
2197#endif
John Durkopee4e6602020-11-27 08:48:46 -08002198#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002199 case PSA_ALG_MD4:
2200 return( &mbedtls_md4_info );
2201#endif
John Durkopee4e6602020-11-27 08:48:46 -08002202#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002203 case PSA_ALG_MD5:
2204 return( &mbedtls_md5_info );
2205#endif
John Durkopee4e6602020-11-27 08:48:46 -08002206#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002207 case PSA_ALG_RIPEMD160:
2208 return( &mbedtls_ripemd160_info );
2209#endif
John Durkopee4e6602020-11-27 08:48:46 -08002210#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002211 case PSA_ALG_SHA_1:
2212 return( &mbedtls_sha1_info );
2213#endif
John Durkopee4e6602020-11-27 08:48:46 -08002214#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002215 case PSA_ALG_SHA_224:
2216 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002217#endif
2218#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002219 case PSA_ALG_SHA_256:
2220 return( &mbedtls_sha256_info );
2221#endif
John Durkopee4e6602020-11-27 08:48:46 -08002222#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002223 case PSA_ALG_SHA_384:
2224 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002225#endif
John Durkopee4e6602020-11-27 08:48:46 -08002226#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002227 case PSA_ALG_SHA_512:
2228 return( &mbedtls_sha512_info );
2229#endif
2230 default:
2231 return( NULL );
2232 }
2233}
John Durkop07cc04a2020-11-16 22:08:34 -08002234#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002235 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2236 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2237 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002238
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002239psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2240{
2241 switch( operation->alg )
2242 {
Gilles Peskine81736312018-06-26 15:04:31 +02002243 case 0:
2244 /* The object has (apparently) been initialized but it is not
2245 * in use. It's ok to call abort on such an object, and there's
2246 * nothing to do. */
2247 break;
John Durkopee4e6602020-11-27 08:48:46 -08002248#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002249 case PSA_ALG_MD2:
2250 mbedtls_md2_free( &operation->ctx.md2 );
2251 break;
2252#endif
John Durkopee4e6602020-11-27 08:48:46 -08002253#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002254 case PSA_ALG_MD4:
2255 mbedtls_md4_free( &operation->ctx.md4 );
2256 break;
2257#endif
John Durkopee4e6602020-11-27 08:48:46 -08002258#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259 case PSA_ALG_MD5:
2260 mbedtls_md5_free( &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_free( &operation->ctx.ripemd160 );
2266 break;
2267#endif
John Durkopee4e6602020-11-27 08:48:46 -08002268#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002269 case PSA_ALG_SHA_1:
2270 mbedtls_sha1_free( &operation->ctx.sha1 );
2271 break;
2272#endif
John Durkop6ca23272020-12-03 06:01:32 -08002273#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002274 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002275 mbedtls_sha256_free( &operation->ctx.sha256 );
2276 break;
2277#endif
2278#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002279 case PSA_ALG_SHA_256:
2280 mbedtls_sha256_free( &operation->ctx.sha256 );
2281 break;
2282#endif
John Durkop6ca23272020-12-03 06:01:32 -08002283#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002285 mbedtls_sha512_free( &operation->ctx.sha512 );
2286 break;
2287#endif
2288#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002289 case PSA_ALG_SHA_512:
2290 mbedtls_sha512_free( &operation->ctx.sha512 );
2291 break;
2292#endif
2293 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002294 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002295 }
2296 operation->alg = 0;
2297 return( PSA_SUCCESS );
2298}
2299
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002300psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002301 psa_algorithm_t alg )
2302{
Janos Follath24eed8d2019-11-22 13:21:35 +00002303 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002304
2305 /* A context must be freshly initialized before it can be set up. */
2306 if( operation->alg != 0 )
2307 {
2308 return( PSA_ERROR_BAD_STATE );
2309 }
2310
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002311 switch( alg )
2312 {
John Durkopee4e6602020-11-27 08:48:46 -08002313#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002314 case PSA_ALG_MD2:
2315 mbedtls_md2_init( &operation->ctx.md2 );
2316 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2317 break;
2318#endif
John Durkopee4e6602020-11-27 08:48:46 -08002319#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320 case PSA_ALG_MD4:
2321 mbedtls_md4_init( &operation->ctx.md4 );
2322 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2323 break;
2324#endif
John Durkopee4e6602020-11-27 08:48:46 -08002325#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326 case PSA_ALG_MD5:
2327 mbedtls_md5_init( &operation->ctx.md5 );
2328 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2329 break;
2330#endif
John Durkopee4e6602020-11-27 08:48:46 -08002331#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332 case PSA_ALG_RIPEMD160:
2333 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2334 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2335 break;
2336#endif
John Durkopee4e6602020-11-27 08:48:46 -08002337#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002338 case PSA_ALG_SHA_1:
2339 mbedtls_sha1_init( &operation->ctx.sha1 );
2340 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2341 break;
2342#endif
John Durkopee4e6602020-11-27 08:48:46 -08002343#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002344 case PSA_ALG_SHA_224:
2345 mbedtls_sha256_init( &operation->ctx.sha256 );
2346 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2347 break;
John Durkopee4e6602020-11-27 08:48:46 -08002348#endif
2349#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002350 case PSA_ALG_SHA_256:
2351 mbedtls_sha256_init( &operation->ctx.sha256 );
2352 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2353 break;
2354#endif
John Durkopee4e6602020-11-27 08:48:46 -08002355#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356 case PSA_ALG_SHA_384:
2357 mbedtls_sha512_init( &operation->ctx.sha512 );
2358 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2359 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002360#endif
John Durkopee4e6602020-11-27 08:48:46 -08002361#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002362 case PSA_ALG_SHA_512:
2363 mbedtls_sha512_init( &operation->ctx.sha512 );
2364 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2365 break;
2366#endif
2367 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002368 return( PSA_ALG_IS_HASH( alg ) ?
2369 PSA_ERROR_NOT_SUPPORTED :
2370 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371 }
2372 if( ret == 0 )
2373 operation->alg = alg;
2374 else
2375 psa_hash_abort( operation );
2376 return( mbedtls_to_psa_error( ret ) );
2377}
2378
2379psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2380 const uint8_t *input,
2381 size_t input_length )
2382{
Janos Follath24eed8d2019-11-22 13:21:35 +00002383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002384
2385 /* Don't require hash implementations to behave correctly on a
2386 * zero-length input, which may have an invalid pointer. */
2387 if( input_length == 0 )
2388 return( PSA_SUCCESS );
2389
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002390 switch( operation->alg )
2391 {
John Durkopee4e6602020-11-27 08:48:46 -08002392#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393 case PSA_ALG_MD2:
2394 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2395 input, input_length );
2396 break;
2397#endif
John Durkopee4e6602020-11-27 08:48:46 -08002398#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399 case PSA_ALG_MD4:
2400 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2401 input, input_length );
2402 break;
2403#endif
John Durkopee4e6602020-11-27 08:48:46 -08002404#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002405 case PSA_ALG_MD5:
2406 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2407 input, input_length );
2408 break;
2409#endif
John Durkopee4e6602020-11-27 08:48:46 -08002410#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411 case PSA_ALG_RIPEMD160:
2412 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2413 input, input_length );
2414 break;
2415#endif
John Durkopee4e6602020-11-27 08:48:46 -08002416#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002417 case PSA_ALG_SHA_1:
2418 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2419 input, input_length );
2420 break;
2421#endif
John Durkop6ca23272020-12-03 06:01:32 -08002422#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002423 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002424 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2425 input, input_length );
2426 break;
2427#endif
2428#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002429 case PSA_ALG_SHA_256:
2430 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2431 input, input_length );
2432 break;
2433#endif
John Durkop6ca23272020-12-03 06:01:32 -08002434#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002435 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002436 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2437 input, input_length );
2438 break;
2439#endif
2440#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002441 case PSA_ALG_SHA_512:
2442 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2443 input, input_length );
2444 break;
2445#endif
2446 default:
John Durkopee4e6602020-11-27 08:48:46 -08002447 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002448 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002449 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002450
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002451 if( ret != 0 )
2452 psa_hash_abort( operation );
2453 return( mbedtls_to_psa_error( ret ) );
2454}
2455
2456psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2457 uint8_t *hash,
2458 size_t hash_size,
2459 size_t *hash_length )
2460{
itayzafrir40835d42018-08-02 13:14:17 +03002461 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002463 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002464
2465 /* Fill the output buffer with something that isn't a valid hash
2466 * (barring an attack on the hash and deliberately-crafted input),
2467 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002468 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002469 /* If hash_size is 0 then hash may be NULL and then the
2470 * call to memset would have undefined behavior. */
2471 if( hash_size != 0 )
2472 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002473
2474 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002475 {
2476 status = PSA_ERROR_BUFFER_TOO_SMALL;
2477 goto exit;
2478 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002479
2480 switch( operation->alg )
2481 {
John Durkopee4e6602020-11-27 08:48:46 -08002482#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002483 case PSA_ALG_MD2:
2484 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2485 break;
2486#endif
John Durkopee4e6602020-11-27 08:48:46 -08002487#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002488 case PSA_ALG_MD4:
2489 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2490 break;
2491#endif
John Durkopee4e6602020-11-27 08:48:46 -08002492#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002493 case PSA_ALG_MD5:
2494 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2495 break;
2496#endif
John Durkopee4e6602020-11-27 08:48:46 -08002497#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002498 case PSA_ALG_RIPEMD160:
2499 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2500 break;
2501#endif
John Durkopee4e6602020-11-27 08:48:46 -08002502#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002503 case PSA_ALG_SHA_1:
2504 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2505 break;
2506#endif
John Durkop6ca23272020-12-03 06:01:32 -08002507#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002508 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002509 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2510 break;
2511#endif
2512#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002513 case PSA_ALG_SHA_256:
2514 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2515 break;
2516#endif
John Durkop6ca23272020-12-03 06:01:32 -08002517#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002518 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002519 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2520 break;
2521#endif
2522#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002523 case PSA_ALG_SHA_512:
2524 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2525 break;
2526#endif
2527 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002528 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002529 }
itayzafrir40835d42018-08-02 13:14:17 +03002530 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002531
itayzafrir40835d42018-08-02 13:14:17 +03002532exit:
2533 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002534 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002535 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002536 return( psa_hash_abort( operation ) );
2537 }
2538 else
2539 {
2540 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002541 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002542 }
2543}
2544
Gilles Peskine2d277862018-06-18 15:41:12 +02002545psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2546 const uint8_t *hash,
2547 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002548{
2549 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2550 size_t actual_hash_length;
2551 psa_status_t status = psa_hash_finish( operation,
2552 actual_hash, sizeof( actual_hash ),
2553 &actual_hash_length );
2554 if( status != PSA_SUCCESS )
2555 return( status );
2556 if( actual_hash_length != hash_length )
2557 return( PSA_ERROR_INVALID_SIGNATURE );
2558 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2559 return( PSA_ERROR_INVALID_SIGNATURE );
2560 return( PSA_SUCCESS );
2561}
2562
Gilles Peskine0a749c82019-11-28 19:33:58 +01002563psa_status_t psa_hash_compute( psa_algorithm_t alg,
2564 const uint8_t *input, size_t input_length,
2565 uint8_t *hash, size_t hash_size,
2566 size_t *hash_length )
2567{
2568 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2570
2571 *hash_length = hash_size;
2572 status = psa_hash_setup( &operation, alg );
2573 if( status != PSA_SUCCESS )
2574 goto exit;
2575 status = psa_hash_update( &operation, input, input_length );
2576 if( status != PSA_SUCCESS )
2577 goto exit;
2578 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2579 if( status != PSA_SUCCESS )
2580 goto exit;
2581
2582exit:
2583 if( status == PSA_SUCCESS )
2584 status = psa_hash_abort( &operation );
2585 else
2586 psa_hash_abort( &operation );
2587 return( status );
2588}
2589
2590psa_status_t psa_hash_compare( psa_algorithm_t alg,
2591 const uint8_t *input, size_t input_length,
2592 const uint8_t *hash, size_t hash_length )
2593{
2594 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2596
2597 status = psa_hash_setup( &operation, alg );
2598 if( status != PSA_SUCCESS )
2599 goto exit;
2600 status = psa_hash_update( &operation, input, input_length );
2601 if( status != PSA_SUCCESS )
2602 goto exit;
2603 status = psa_hash_verify( &operation, hash, hash_length );
2604 if( status != PSA_SUCCESS )
2605 goto exit;
2606
2607exit:
2608 if( status == PSA_SUCCESS )
2609 status = psa_hash_abort( &operation );
2610 else
2611 psa_hash_abort( &operation );
2612 return( status );
2613}
2614
Gilles Peskineeb35d782019-01-22 17:56:16 +01002615psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2616 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002617{
2618 if( target_operation->alg != 0 )
2619 return( PSA_ERROR_BAD_STATE );
2620
2621 switch( source_operation->alg )
2622 {
2623 case 0:
2624 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002625#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002626 case PSA_ALG_MD2:
2627 mbedtls_md2_clone( &target_operation->ctx.md2,
2628 &source_operation->ctx.md2 );
2629 break;
2630#endif
John Durkopee4e6602020-11-27 08:48:46 -08002631#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002632 case PSA_ALG_MD4:
2633 mbedtls_md4_clone( &target_operation->ctx.md4,
2634 &source_operation->ctx.md4 );
2635 break;
2636#endif
John Durkopee4e6602020-11-27 08:48:46 -08002637#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002638 case PSA_ALG_MD5:
2639 mbedtls_md5_clone( &target_operation->ctx.md5,
2640 &source_operation->ctx.md5 );
2641 break;
2642#endif
John Durkopee4e6602020-11-27 08:48:46 -08002643#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002644 case PSA_ALG_RIPEMD160:
2645 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2646 &source_operation->ctx.ripemd160 );
2647 break;
2648#endif
John Durkopee4e6602020-11-27 08:48:46 -08002649#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002650 case PSA_ALG_SHA_1:
2651 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2652 &source_operation->ctx.sha1 );
2653 break;
2654#endif
John Durkop6ca23272020-12-03 06:01:32 -08002655#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002656 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002657 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2658 &source_operation->ctx.sha256 );
2659 break;
2660#endif
2661#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002662 case PSA_ALG_SHA_256:
2663 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2664 &source_operation->ctx.sha256 );
2665 break;
2666#endif
John Durkop6ca23272020-12-03 06:01:32 -08002667#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002668 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002669 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2670 &source_operation->ctx.sha512 );
2671 break;
2672#endif
2673#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002674 case PSA_ALG_SHA_512:
2675 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2676 &source_operation->ctx.sha512 );
2677 break;
2678#endif
2679 default:
2680 return( PSA_ERROR_NOT_SUPPORTED );
2681 }
2682
2683 target_operation->alg = source_operation->alg;
2684 return( PSA_SUCCESS );
2685}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002686
2687
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002688/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002689/* MAC */
2690/****************************************************************/
2691
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002692static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002693 psa_algorithm_t alg,
2694 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002695 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002696 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002697{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002698 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002699 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002700
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002701 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002702 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002703
Gilles Peskine8c9def32018-02-08 10:02:12 +01002704 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2705 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002706 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002707 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002708 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002709 mode = MBEDTLS_MODE_STREAM;
2710 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002711 case PSA_ALG_CTR:
2712 mode = MBEDTLS_MODE_CTR;
2713 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002714 case PSA_ALG_CFB:
2715 mode = MBEDTLS_MODE_CFB;
2716 break;
2717 case PSA_ALG_OFB:
2718 mode = MBEDTLS_MODE_OFB;
2719 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002720 case PSA_ALG_ECB_NO_PADDING:
2721 mode = MBEDTLS_MODE_ECB;
2722 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002723 case PSA_ALG_CBC_NO_PADDING:
2724 mode = MBEDTLS_MODE_CBC;
2725 break;
2726 case PSA_ALG_CBC_PKCS7:
2727 mode = MBEDTLS_MODE_CBC;
2728 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002729 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002730 mode = MBEDTLS_MODE_CCM;
2731 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002732 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733 mode = MBEDTLS_MODE_GCM;
2734 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002735 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2736 mode = MBEDTLS_MODE_CHACHAPOLY;
2737 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002738 default:
2739 return( NULL );
2740 }
2741 }
2742 else if( alg == PSA_ALG_CMAC )
2743 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002744 else
2745 return( NULL );
2746
2747 switch( key_type )
2748 {
2749 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002750 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002751 break;
2752 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002753 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2754 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002755 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002756 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002757 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002758 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002759 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2760 * but two-key Triple-DES is functionally three-key Triple-DES
2761 * with K1=K3, so that's how we present it to mbedtls. */
2762 if( key_bits == 128 )
2763 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764 break;
2765 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002766 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002767 break;
2768 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002769 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002770 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002771 case PSA_KEY_TYPE_CHACHA20:
2772 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2773 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774 default:
2775 return( NULL );
2776 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002777 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002778 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002779
Jaeden Amero23bbb752018-06-26 14:16:54 +01002780 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2781 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002782}
2783
John Durkop6ba40d12020-11-10 08:50:04 -08002784#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002785static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002786{
Gilles Peskine2d277862018-06-18 15:41:12 +02002787 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002788 {
2789 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002790 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002791 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002792 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002793 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002794 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002795 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002796 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002797 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002798 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002799 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002800 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002801 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002802 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002803 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002804 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002805 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002806 return( 128 );
2807 default:
2808 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002809 }
2810}
John Durkop07cc04a2020-11-16 22:08:34 -08002811#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002812
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002813/* Initialize the MAC operation structure. Once this function has been
2814 * called, psa_mac_abort can run and will do the right thing. */
2815static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2816 psa_algorithm_t alg )
2817{
2818 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2819
2820 operation->alg = alg;
2821 operation->key_set = 0;
2822 operation->iv_set = 0;
2823 operation->iv_required = 0;
2824 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002825 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002826
2827#if defined(MBEDTLS_CMAC_C)
2828 if( alg == PSA_ALG_CMAC )
2829 {
2830 operation->iv_required = 0;
2831 mbedtls_cipher_init( &operation->ctx.cmac );
2832 status = PSA_SUCCESS;
2833 }
2834 else
2835#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002836#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002837 if( PSA_ALG_IS_HMAC( operation->alg ) )
2838 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002839 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2840 operation->ctx.hmac.hash_ctx.alg = 0;
2841 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002842 }
2843 else
John Durkopd0321952020-10-29 21:37:36 -07002844#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002845 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002846 if( ! PSA_ALG_IS_MAC( alg ) )
2847 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002848 }
2849
2850 if( status != PSA_SUCCESS )
2851 memset( operation, 0, sizeof( *operation ) );
2852 return( status );
2853}
2854
John Durkop6ba40d12020-11-10 08:50:04 -08002855#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002856static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2857{
Gilles Peskine3f108122018-12-07 18:14:53 +01002858 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002859 return( psa_hash_abort( &hmac->hash_ctx ) );
2860}
John Durkop6ba40d12020-11-10 08:50:04 -08002861#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002862
Gilles Peskine8c9def32018-02-08 10:02:12 +01002863psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2864{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002865 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002866 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002867 /* The object has (apparently) been initialized but it is not
2868 * in use. It's ok to call abort on such an object, and there's
2869 * nothing to do. */
2870 return( PSA_SUCCESS );
2871 }
2872 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002873#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002874 if( operation->alg == PSA_ALG_CMAC )
2875 {
2876 mbedtls_cipher_free( &operation->ctx.cmac );
2877 }
2878 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002880#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002881 if( PSA_ALG_IS_HMAC( operation->alg ) )
2882 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002883 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002884 }
2885 else
John Durkopd0321952020-10-29 21:37:36 -07002886#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002887 {
2888 /* Sanity check (shouldn't happen: operation->alg should
2889 * always have been initialized to a valid value). */
2890 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002891 }
Moran Peker41deec42018-04-04 15:43:05 +03002892
Gilles Peskine8c9def32018-02-08 10:02:12 +01002893 operation->alg = 0;
2894 operation->key_set = 0;
2895 operation->iv_set = 0;
2896 operation->iv_required = 0;
2897 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002898 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002899
Gilles Peskine8c9def32018-02-08 10:02:12 +01002900 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002901
2902bad_state:
2903 /* If abort is called on an uninitialized object, we can't trust
2904 * anything. Wipe the object in case it contains confidential data.
2905 * This may result in a memory leak if a pointer gets overwritten,
2906 * but it's too late to do anything about this. */
2907 memset( operation, 0, sizeof( *operation ) );
2908 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002909}
2910
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002911#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002912static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002913 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002914 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002915 const mbedtls_cipher_info_t *cipher_info )
2916{
Janos Follath24eed8d2019-11-22 13:21:35 +00002917 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002918
2919 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002920
2921 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2922 if( ret != 0 )
2923 return( ret );
2924
2925 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002926 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002927 key_bits );
2928 return( ret );
2929}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002930#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002931
John Durkop6ba40d12020-11-10 08:50:04 -08002932#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002933static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2934 const uint8_t *key,
2935 size_t key_length,
2936 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002937{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002938 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002939 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002940 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002941 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002942 psa_status_t status;
2943
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002944 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2945 * overflow below. This should never trigger if the hash algorithm
2946 * is implemented correctly. */
2947 /* The size checks against the ipad and opad buffers cannot be written
2948 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2949 * because that triggers -Wlogical-op on GCC 7.3. */
2950 if( block_size > sizeof( ipad ) )
2951 return( PSA_ERROR_NOT_SUPPORTED );
2952 if( block_size > sizeof( hmac->opad ) )
2953 return( PSA_ERROR_NOT_SUPPORTED );
2954 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002955 return( PSA_ERROR_NOT_SUPPORTED );
2956
Gilles Peskined223b522018-06-11 18:12:58 +02002957 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002958 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002959 status = psa_hash_compute( hash_alg, key, key_length,
2960 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002961 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002962 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002963 }
Gilles Peskine96889972018-07-12 17:07:03 +02002964 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2965 * but it is permitted. It is common when HMAC is used in HKDF, for
2966 * example. Don't call `memcpy` in the 0-length because `key` could be
2967 * an invalid pointer which would make the behavior undefined. */
2968 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002969 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002970
Gilles Peskined223b522018-06-11 18:12:58 +02002971 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2972 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002973 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002974 ipad[i] ^= 0x36;
2975 memset( ipad + key_length, 0x36, block_size - key_length );
2976
2977 /* Copy the key material from ipad to opad, flipping the requisite bits,
2978 * and filling the rest of opad with the requisite constant. */
2979 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002980 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2981 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002982
Gilles Peskine01126fa2018-07-12 17:04:55 +02002983 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002984 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002985 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002986
Gilles Peskine01126fa2018-07-12 17:04:55 +02002987 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002988
2989cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002990 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002991
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002992 return( status );
2993}
John Durkop6ba40d12020-11-10 08:50:04 -08002994#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002995
Gilles Peskine89167cb2018-07-08 20:12:23 +02002996static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002997 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002998 psa_algorithm_t alg,
2999 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003000{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003001 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003002 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003003 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003004 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003005 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003006 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003007 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003008 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003010 /* A context must be freshly initialized before it can be set up. */
3011 if( operation->alg != 0 )
3012 {
3013 return( PSA_ERROR_BAD_STATE );
3014 }
3015
Gilles Peskined911eb72018-08-14 15:18:45 +02003016 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003017 if( status != PSA_SUCCESS )
3018 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003019 if( is_sign )
3020 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003021
Ronald Cron5c522922020-11-14 16:35:34 +01003022 status = psa_get_and_lock_transparent_key_slot_with_policy(
3023 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003024 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003025 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003026 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003027
Gilles Peskine8c9def32018-02-08 10:02:12 +01003028#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003029 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003030 {
3031 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003032 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003033 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003034 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003035 if( cipher_info == NULL )
3036 {
3037 status = PSA_ERROR_NOT_SUPPORTED;
3038 goto exit;
3039 }
3040 operation->mac_size = cipher_info->block_size;
3041 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3042 status = mbedtls_to_psa_error( ret );
3043 }
3044 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003045#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003046#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003047 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003048 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003049 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003050 if( hash_alg == 0 )
3051 {
3052 status = PSA_ERROR_NOT_SUPPORTED;
3053 goto exit;
3054 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003055
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003056 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003057 /* Sanity check. This shouldn't fail on a valid configuration. */
3058 if( operation->mac_size == 0 ||
3059 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3060 {
3061 status = PSA_ERROR_NOT_SUPPORTED;
3062 goto exit;
3063 }
3064
Gilles Peskine8e338702019-07-30 20:06:31 +02003065 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003066 {
3067 status = PSA_ERROR_INVALID_ARGUMENT;
3068 goto exit;
3069 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003070
Gilles Peskine01126fa2018-07-12 17:04:55 +02003071 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003072 slot->key.data,
3073 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003074 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003075 }
3076 else
John Durkopd0321952020-10-29 21:37:36 -07003077#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003078 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003079 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003080 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003081 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003082
Gilles Peskined911eb72018-08-14 15:18:45 +02003083 if( truncated == 0 )
3084 {
3085 /* The "normal" case: untruncated algorithm. Nothing to do. */
3086 }
3087 else if( truncated < 4 )
3088 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003089 /* A very short MAC is too short for security since it can be
3090 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3091 * so we make this our minimum, even though 32 bits is still
3092 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003093 status = PSA_ERROR_NOT_SUPPORTED;
3094 }
3095 else if( truncated > operation->mac_size )
3096 {
3097 /* It's impossible to "truncate" to a larger length. */
3098 status = PSA_ERROR_INVALID_ARGUMENT;
3099 }
3100 else
3101 operation->mac_size = truncated;
3102
Gilles Peskinefbfac682018-07-08 20:51:54 +02003103exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003104 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003105 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003106 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003107 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003108 else
3109 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003110 operation->key_set = 1;
3111 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003112
Ronald Cron5c522922020-11-14 16:35:34 +01003113 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003114
Ronald Cron5c522922020-11-14 16:35:34 +01003115 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003116}
3117
Gilles Peskine89167cb2018-07-08 20:12:23 +02003118psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003119 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003120 psa_algorithm_t alg )
3121{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003122 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003123}
3124
3125psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003126 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003127 psa_algorithm_t alg )
3128{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003129 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003130}
3131
Gilles Peskine8c9def32018-02-08 10:02:12 +01003132psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3133 const uint8_t *input,
3134 size_t input_length )
3135{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003136 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003137 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003138 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003139 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003140 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003141 operation->has_input = 1;
3142
Gilles Peskine8c9def32018-02-08 10:02:12 +01003143#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003144 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003145 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003146 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3147 input, input_length );
3148 status = mbedtls_to_psa_error( ret );
3149 }
3150 else
3151#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003152#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003153 if( PSA_ALG_IS_HMAC( operation->alg ) )
3154 {
3155 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3156 input_length );
3157 }
3158 else
John Durkopd0321952020-10-29 21:37:36 -07003159#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003160 {
3161 /* This shouldn't happen if `operation` was initialized by
3162 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003163 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003164 }
3165
Gilles Peskinefbfac682018-07-08 20:51:54 +02003166 if( status != PSA_SUCCESS )
3167 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003168 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003169}
3170
John Durkop6ba40d12020-11-10 08:50:04 -08003171#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003172static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3173 uint8_t *mac,
3174 size_t mac_size )
3175{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003176 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003177 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3178 size_t hash_size = 0;
3179 size_t block_size = psa_get_hash_block_size( hash_alg );
3180 psa_status_t status;
3181
Gilles Peskine01126fa2018-07-12 17:04:55 +02003182 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3183 if( status != PSA_SUCCESS )
3184 return( status );
3185 /* From here on, tmp needs to be wiped. */
3186
3187 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3188 if( status != PSA_SUCCESS )
3189 goto exit;
3190
3191 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3192 if( status != PSA_SUCCESS )
3193 goto exit;
3194
3195 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3196 if( status != PSA_SUCCESS )
3197 goto exit;
3198
Gilles Peskined911eb72018-08-14 15:18:45 +02003199 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3200 if( status != PSA_SUCCESS )
3201 goto exit;
3202
3203 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003204
3205exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003206 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003207 return( status );
3208}
John Durkop6ba40d12020-11-10 08:50:04 -08003209#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003210
mohammad16036df908f2018-04-02 08:34:15 -07003211static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003212 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003213 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003214{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003215 if( ! operation->key_set )
3216 return( PSA_ERROR_BAD_STATE );
3217 if( operation->iv_required && ! operation->iv_set )
3218 return( PSA_ERROR_BAD_STATE );
3219
Gilles Peskine8c9def32018-02-08 10:02:12 +01003220 if( mac_size < operation->mac_size )
3221 return( PSA_ERROR_BUFFER_TOO_SMALL );
3222
Gilles Peskine8c9def32018-02-08 10:02:12 +01003223#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003224 if( operation->alg == PSA_ALG_CMAC )
3225 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003226 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003227 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3228 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003229 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003230 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003231 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003232 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003233 else
3234#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003235#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003236 if( PSA_ALG_IS_HMAC( operation->alg ) )
3237 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003238 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003239 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003240 }
3241 else
John Durkopd0321952020-10-29 21:37:36 -07003242#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003243 {
3244 /* This shouldn't happen if `operation` was initialized by
3245 * a setup function. */
3246 return( PSA_ERROR_BAD_STATE );
3247 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003248}
3249
Gilles Peskineacd4be32018-07-08 19:56:25 +02003250psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3251 uint8_t *mac,
3252 size_t mac_size,
3253 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003254{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003255 psa_status_t status;
3256
Jaeden Amero252ef282019-02-15 14:05:35 +00003257 if( operation->alg == 0 )
3258 {
3259 return( PSA_ERROR_BAD_STATE );
3260 }
3261
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003262 /* Fill the output buffer with something that isn't a valid mac
3263 * (barring an attack on the mac and deliberately-crafted input),
3264 * in case the caller doesn't check the return status properly. */
3265 *mac_length = mac_size;
3266 /* If mac_size is 0 then mac may be NULL and then the
3267 * call to memset would have undefined behavior. */
3268 if( mac_size != 0 )
3269 memset( mac, '!', mac_size );
3270
Gilles Peskine89167cb2018-07-08 20:12:23 +02003271 if( ! operation->is_sign )
3272 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003273 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003274 }
mohammad16036df908f2018-04-02 08:34:15 -07003275
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003276 status = psa_mac_finish_internal( operation, mac, mac_size );
3277
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003278 if( status == PSA_SUCCESS )
3279 {
3280 status = psa_mac_abort( operation );
3281 if( status == PSA_SUCCESS )
3282 *mac_length = operation->mac_size;
3283 else
3284 memset( mac, '!', mac_size );
3285 }
3286 else
3287 psa_mac_abort( operation );
3288 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003289}
3290
Gilles Peskineacd4be32018-07-08 19:56:25 +02003291psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3292 const uint8_t *mac,
3293 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003294{
Gilles Peskine828ed142018-06-18 23:25:51 +02003295 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003296 psa_status_t status;
3297
Jaeden Amero252ef282019-02-15 14:05:35 +00003298 if( operation->alg == 0 )
3299 {
3300 return( PSA_ERROR_BAD_STATE );
3301 }
3302
Gilles Peskine89167cb2018-07-08 20:12:23 +02003303 if( operation->is_sign )
3304 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003305 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003306 }
3307 if( operation->mac_size != mac_length )
3308 {
3309 status = PSA_ERROR_INVALID_SIGNATURE;
3310 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003311 }
mohammad16036df908f2018-04-02 08:34:15 -07003312
3313 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003314 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003315 if( status != PSA_SUCCESS )
3316 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003317
3318 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3319 status = PSA_ERROR_INVALID_SIGNATURE;
3320
3321cleanup:
3322 if( status == PSA_SUCCESS )
3323 status = psa_mac_abort( operation );
3324 else
3325 psa_mac_abort( operation );
3326
Gilles Peskine3f108122018-12-07 18:14:53 +01003327 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003328
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003329 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003330}
3331
3332
Gilles Peskine20035e32018-02-03 22:44:14 +01003333
Gilles Peskine20035e32018-02-03 22:44:14 +01003334/****************************************************************/
3335/* Asymmetric cryptography */
3336/****************************************************************/
3337
John Durkop6ba40d12020-11-10 08:50:04 -08003338#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3339 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003340/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003341 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003342static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3343 size_t hash_length,
3344 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003345{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003346 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003347 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003348 *md_alg = mbedtls_md_get_type( md_info );
3349
3350 /* The Mbed TLS RSA module uses an unsigned int for hash length
3351 * parameters. Validate that it fits so that we don't risk an
3352 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003353#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003354 if( hash_length > UINT_MAX )
3355 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003356#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003357
John Durkop0e005192020-10-31 22:06:54 -07003358#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003359 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3360 * must be correct. */
3361 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3362 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003363 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003364 if( md_info == NULL )
3365 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003366 if( mbedtls_md_get_size( md_info ) != hash_length )
3367 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003368 }
John Durkop0e005192020-10-31 22:06:54 -07003369#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003370
John Durkop0e005192020-10-31 22:06:54 -07003371#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003372 /* PSS requires a hash internally. */
3373 if( PSA_ALG_IS_RSA_PSS( alg ) )
3374 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003375 if( md_info == NULL )
3376 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003377 }
John Durkop0e005192020-10-31 22:06:54 -07003378#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003379
Gilles Peskine61b91d42018-06-08 16:09:36 +02003380 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003381}
3382
Gilles Peskine2b450e32018-06-27 15:42:46 +02003383static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3384 psa_algorithm_t alg,
3385 const uint8_t *hash,
3386 size_t hash_length,
3387 uint8_t *signature,
3388 size_t signature_size,
3389 size_t *signature_length )
3390{
3391 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003392 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003393 mbedtls_md_type_t md_alg;
3394
3395 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3396 if( status != PSA_SUCCESS )
3397 return( status );
3398
Gilles Peskine630a18a2018-06-29 17:49:35 +02003399 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003400 return( PSA_ERROR_BUFFER_TOO_SMALL );
3401
John Durkop0e005192020-10-31 22:06:54 -07003402#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003403 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3404 {
3405 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3406 MBEDTLS_MD_NONE );
3407 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003408 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003409 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003410 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003411 md_alg,
3412 (unsigned int) hash_length,
3413 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003414 signature );
3415 }
3416 else
John Durkop0e005192020-10-31 22:06:54 -07003417#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3418#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003419 if( PSA_ALG_IS_RSA_PSS( alg ) )
3420 {
3421 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3422 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003423 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003424 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003425 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003426 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003427 (unsigned int) hash_length,
3428 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003429 signature );
3430 }
3431 else
John Durkop0e005192020-10-31 22:06:54 -07003432#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003433 {
3434 return( PSA_ERROR_INVALID_ARGUMENT );
3435 }
3436
3437 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003438 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003439 return( mbedtls_to_psa_error( ret ) );
3440}
3441
3442static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3443 psa_algorithm_t alg,
3444 const uint8_t *hash,
3445 size_t hash_length,
3446 const uint8_t *signature,
3447 size_t signature_length )
3448{
3449 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003450 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003451 mbedtls_md_type_t md_alg;
3452
3453 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3454 if( status != PSA_SUCCESS )
3455 return( status );
3456
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003457 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3458 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003459
John Durkop0e005192020-10-31 22:06:54 -07003460#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003461 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3462 {
3463 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3464 MBEDTLS_MD_NONE );
3465 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003466 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003467 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003468 MBEDTLS_RSA_PUBLIC,
3469 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003470 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003471 hash,
3472 signature );
3473 }
3474 else
John Durkop0e005192020-10-31 22:06:54 -07003475#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3476#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003477 if( PSA_ALG_IS_RSA_PSS( alg ) )
3478 {
3479 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3480 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003481 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003482 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003483 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003484 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003485 (unsigned int) hash_length,
3486 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003487 signature );
3488 }
3489 else
John Durkop0e005192020-10-31 22:06:54 -07003490#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003491 {
3492 return( PSA_ERROR_INVALID_ARGUMENT );
3493 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003494
3495 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3496 * the rest of the signature is invalid". This has little use in
3497 * practice and PSA doesn't report this distinction. */
3498 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3499 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003500 return( mbedtls_to_psa_error( ret ) );
3501}
John Durkop6ba40d12020-11-10 08:50:04 -08003502#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3503 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003504
John Durkop6ba40d12020-11-10 08:50:04 -08003505#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3506 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003507/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3508 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3509 * (even though these functions don't modify it). */
3510static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3511 psa_algorithm_t alg,
3512 const uint8_t *hash,
3513 size_t hash_length,
3514 uint8_t *signature,
3515 size_t signature_size,
3516 size_t *signature_length )
3517{
Janos Follath24eed8d2019-11-22 13:21:35 +00003518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003519 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003520 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003521 mbedtls_mpi_init( &r );
3522 mbedtls_mpi_init( &s );
3523
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003524 if( signature_size < 2 * curve_bytes )
3525 {
3526 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3527 goto cleanup;
3528 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003529
John Durkop0ea39e02020-10-13 19:58:20 -07003530#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003531 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3532 {
3533 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3534 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3535 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003536 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3537 &ecp->d, hash,
3538 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003539 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003540 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003541 }
3542 else
John Durkop0ea39e02020-10-13 19:58:20 -07003543#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003544 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003545 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003546 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3547 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003548 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003549 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003550 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003551
3552 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3553 signature,
3554 curve_bytes ) );
3555 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3556 signature + curve_bytes,
3557 curve_bytes ) );
3558
3559cleanup:
3560 mbedtls_mpi_free( &r );
3561 mbedtls_mpi_free( &s );
3562 if( ret == 0 )
3563 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003564 return( mbedtls_to_psa_error( ret ) );
3565}
3566
3567static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3568 const uint8_t *hash,
3569 size_t hash_length,
3570 const uint8_t *signature,
3571 size_t signature_length )
3572{
Janos Follath24eed8d2019-11-22 13:21:35 +00003573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003574 mbedtls_mpi r, s;
3575 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3576 mbedtls_mpi_init( &r );
3577 mbedtls_mpi_init( &s );
3578
3579 if( signature_length != 2 * curve_bytes )
3580 return( PSA_ERROR_INVALID_SIGNATURE );
3581
3582 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3583 signature,
3584 curve_bytes ) );
3585 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3586 signature + curve_bytes,
3587 curve_bytes ) );
3588
Steven Cooremanacda8342020-07-24 23:09:52 +02003589 /* Check whether the public part is loaded. If not, load it. */
3590 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3591 {
3592 MBEDTLS_MPI_CHK(
3593 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003594 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003595 }
3596
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003597 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3598 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003599
3600cleanup:
3601 mbedtls_mpi_free( &r );
3602 mbedtls_mpi_free( &s );
3603 return( mbedtls_to_psa_error( ret ) );
3604}
John Durkop6ba40d12020-11-10 08:50:04 -08003605#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3606 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003607
Ronald Croncf56a0a2020-08-04 09:51:30 +02003608psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003609 psa_algorithm_t alg,
3610 const uint8_t *hash,
3611 size_t hash_length,
3612 uint8_t *signature,
3613 size_t signature_size,
3614 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003615{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003616 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003617 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003618 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003619
3620 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003621 /* Immediately reject a zero-length signature buffer. This guarantees
3622 * that signature must be a valid pointer. (On the other hand, the hash
3623 * buffer can in principle be empty since it doesn't actually have
3624 * to be a hash.) */
3625 if( signature_size == 0 )
3626 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003627
Ronald Cron5c522922020-11-14 16:35:34 +01003628 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3629 PSA_KEY_USAGE_SIGN_HASH,
3630 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003631 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003632 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003633 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003634 {
3635 status = PSA_ERROR_INVALID_ARGUMENT;
3636 goto exit;
3637 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003638
Steven Cooremancd84cb42020-07-16 20:28:36 +02003639 /* Try any of the available accelerators first */
3640 status = psa_driver_wrapper_sign_hash( slot,
3641 alg,
3642 hash,
3643 hash_length,
3644 signature,
3645 signature_size,
3646 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003647 if( status != PSA_ERROR_NOT_SUPPORTED ||
3648 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003649 goto exit;
3650
Steven Cooreman7a250572020-07-17 16:43:05 +02003651 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003652#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3653 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003654 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003655 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003656 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003657
Ronald Cron90857082020-11-25 14:58:33 +01003658 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3659 slot->key.data,
3660 slot->key.bytes,
3661 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003662 if( status != PSA_SUCCESS )
3663 goto exit;
3664
Steven Cooremana2371e52020-07-28 14:30:39 +02003665 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003666 alg,
3667 hash, hash_length,
3668 signature, signature_size,
3669 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003670
Steven Cooremana2371e52020-07-28 14:30:39 +02003671 mbedtls_rsa_free( rsa );
3672 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003673 }
3674 else
John Durkop6ba40d12020-11-10 08:50:04 -08003675#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3676 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003677 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003678 {
John Durkop9814fa22020-11-04 12:28:15 -08003679#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3680 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003681 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003682#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003683 PSA_ALG_IS_ECDSA( alg )
3684#else
3685 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3686#endif
3687 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003688 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003689 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003690 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3691 slot->key.data,
3692 slot->key.bytes,
3693 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003694 if( status != PSA_SUCCESS )
3695 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003696 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003697 alg,
3698 hash, hash_length,
3699 signature, signature_size,
3700 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003701 mbedtls_ecp_keypair_free( ecp );
3702 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003703 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003704 else
John Durkop9814fa22020-11-04 12:28:15 -08003705#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3706 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003707 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003708 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003709 }
itayzafrir5c753392018-05-08 11:18:38 +03003710 }
3711 else
itayzafrir5c753392018-05-08 11:18:38 +03003712 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003713 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003714 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003715
3716exit:
3717 /* Fill the unused part of the output buffer (the whole buffer on error,
3718 * the trailing part on success) with something that isn't a valid mac
3719 * (barring an attack on the mac and deliberately-crafted input),
3720 * in case the caller doesn't check the return status properly. */
3721 if( status == PSA_SUCCESS )
3722 memset( signature + *signature_length, '!',
3723 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003724 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003725 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003726 /* If signature_size is 0 then we have nothing to do. We must not call
3727 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003728
Ronald Cron5c522922020-11-14 16:35:34 +01003729 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003730
Ronald Cron5c522922020-11-14 16:35:34 +01003731 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003732}
3733
Ronald Croncf56a0a2020-08-04 09:51:30 +02003734psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003735 psa_algorithm_t alg,
3736 const uint8_t *hash,
3737 size_t hash_length,
3738 const uint8_t *signature,
3739 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003740{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003741 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003742 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003743 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003744
Ronald Cron5c522922020-11-14 16:35:34 +01003745 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3746 PSA_KEY_USAGE_VERIFY_HASH,
3747 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003748 if( status != PSA_SUCCESS )
3749 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003750
Steven Cooreman55ae2172020-07-17 19:46:15 +02003751 /* Try any of the available accelerators first */
3752 status = psa_driver_wrapper_verify_hash( slot,
3753 alg,
3754 hash,
3755 hash_length,
3756 signature,
3757 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003758 if( status != PSA_ERROR_NOT_SUPPORTED ||
3759 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003760 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003761
John Durkop6ba40d12020-11-10 08:50:04 -08003762#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3763 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003764 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003765 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003766 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003767
Ronald Cron90857082020-11-25 14:58:33 +01003768 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3769 slot->key.data,
3770 slot->key.bytes,
3771 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003772 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003773 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003774
Steven Cooremana2371e52020-07-28 14:30:39 +02003775 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003776 alg,
3777 hash, hash_length,
3778 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003779 mbedtls_rsa_free( rsa );
3780 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003781 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003782 }
3783 else
John Durkop6ba40d12020-11-10 08:50:04 -08003784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3785 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003786 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003787 {
John Durkop9814fa22020-11-04 12:28:15 -08003788#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3789 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003790 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003791 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003792 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003793 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3794 slot->key.data,
3795 slot->key.bytes,
3796 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003797 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003798 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003799 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003800 hash, hash_length,
3801 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003802 mbedtls_ecp_keypair_free( ecp );
3803 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003804 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003805 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003806 else
John Durkop9814fa22020-11-04 12:28:15 -08003807#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3808 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003809 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003810 status = PSA_ERROR_INVALID_ARGUMENT;
3811 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003812 }
itayzafrir5c753392018-05-08 11:18:38 +03003813 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003814 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003815 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003816 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003817 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003818
3819exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003820 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003821
Ronald Cron5c522922020-11-14 16:35:34 +01003822 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003823}
3824
John Durkop0e005192020-10-31 22:06:54 -07003825#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003826static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3827 mbedtls_rsa_context *rsa )
3828{
3829 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3830 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3831 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3832 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3833}
John Durkop0e005192020-10-31 22:06:54 -07003834#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003835
Ronald Croncf56a0a2020-08-04 09:51:30 +02003836psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003837 psa_algorithm_t alg,
3838 const uint8_t *input,
3839 size_t input_length,
3840 const uint8_t *salt,
3841 size_t salt_length,
3842 uint8_t *output,
3843 size_t output_size,
3844 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003845{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003847 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003848 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003849
Darryl Green5cc689a2018-07-24 15:34:10 +01003850 (void) input;
3851 (void) input_length;
3852 (void) salt;
3853 (void) output;
3854 (void) output_size;
3855
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003856 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003857
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003858 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3859 return( PSA_ERROR_INVALID_ARGUMENT );
3860
Ronald Cron5c522922020-11-14 16:35:34 +01003861 status = psa_get_and_lock_transparent_key_slot_with_policy(
3862 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003863 if( status != PSA_SUCCESS )
3864 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003865 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3866 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003867 {
3868 status = PSA_ERROR_INVALID_ARGUMENT;
3869 goto exit;
3870 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003871
John Durkop6ba40d12020-11-10 08:50:04 -08003872#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3873 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003874 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003875 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003876 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003877 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3878 slot->key.data,
3879 slot->key.bytes,
3880 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003881 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003882 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003883
3884 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003885 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003886 status = PSA_ERROR_BUFFER_TOO_SMALL;
3887 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003888 }
John Durkop0e005192020-10-31 22:06:54 -07003889#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003890 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003891 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003892 status = mbedtls_to_psa_error(
3893 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003894 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003895 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003896 MBEDTLS_RSA_PUBLIC,
3897 input_length,
3898 input,
3899 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003900 }
3901 else
John Durkop0e005192020-10-31 22:06:54 -07003902#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3903#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003904 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003905 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003906 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003907 status = mbedtls_to_psa_error(
3908 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003909 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003910 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003911 MBEDTLS_RSA_PUBLIC,
3912 salt, salt_length,
3913 input_length,
3914 input,
3915 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003916 }
3917 else
John Durkop0e005192020-10-31 22:06:54 -07003918#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003919 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003920 status = PSA_ERROR_INVALID_ARGUMENT;
3921 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003922 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003923rsa_exit:
3924 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003925 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003926
Steven Cooremana2371e52020-07-28 14:30:39 +02003927 mbedtls_rsa_free( rsa );
3928 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003929 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003930 else
John Durkop9814fa22020-11-04 12:28:15 -08003931#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003932 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003933 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003934 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003935 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003936
3937exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003938 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003939
Ronald Cron5c522922020-11-14 16:35:34 +01003940 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003941}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003942
Ronald Croncf56a0a2020-08-04 09:51:30 +02003943psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003944 psa_algorithm_t alg,
3945 const uint8_t *input,
3946 size_t input_length,
3947 const uint8_t *salt,
3948 size_t salt_length,
3949 uint8_t *output,
3950 size_t output_size,
3951 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003952{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003953 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003954 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003955 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003956
Darryl Green5cc689a2018-07-24 15:34:10 +01003957 (void) input;
3958 (void) input_length;
3959 (void) salt;
3960 (void) output;
3961 (void) output_size;
3962
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003963 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003964
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003965 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3966 return( PSA_ERROR_INVALID_ARGUMENT );
3967
Ronald Cron5c522922020-11-14 16:35:34 +01003968 status = psa_get_and_lock_transparent_key_slot_with_policy(
3969 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003970 if( status != PSA_SUCCESS )
3971 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003972 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003973 {
3974 status = PSA_ERROR_INVALID_ARGUMENT;
3975 goto exit;
3976 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003977
John Durkop6ba40d12020-11-10 08:50:04 -08003978#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3979 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003980 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003981 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003982 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003983 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3984 slot->key.data,
3985 slot->key.bytes,
3986 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003987 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003988 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003989
Steven Cooremana2371e52020-07-28 14:30:39 +02003990 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003991 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003992 status = PSA_ERROR_INVALID_ARGUMENT;
3993 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003994 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003995
John Durkop0e005192020-10-31 22:06:54 -07003996#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003997 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003998 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003999 status = mbedtls_to_psa_error(
4000 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004001 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004002 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004003 MBEDTLS_RSA_PRIVATE,
4004 output_length,
4005 input,
4006 output,
4007 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004008 }
4009 else
John Durkop0e005192020-10-31 22:06:54 -07004010#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4011#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004012 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004013 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004014 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004015 status = mbedtls_to_psa_error(
4016 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004017 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004018 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004019 MBEDTLS_RSA_PRIVATE,
4020 salt, salt_length,
4021 output_length,
4022 input,
4023 output,
4024 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004025 }
4026 else
John Durkop0e005192020-10-31 22:06:54 -07004027#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004028 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004029 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004030 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004031
Steven Cooreman4fed4552020-08-03 14:46:03 +02004032rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004033 mbedtls_rsa_free( rsa );
4034 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004035 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004036 else
John Durkop6ba40d12020-11-10 08:50:04 -08004037#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4038 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004039 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004040 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004041 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004042
4043exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004044 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004045
Ronald Cron5c522922020-11-14 16:35:34 +01004046 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004047}
Gilles Peskine20035e32018-02-03 22:44:14 +01004048
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004049
4050
mohammad1603503973b2018-03-12 15:59:30 +02004051/****************************************************************/
4052/* Symmetric cryptography */
4053/****************************************************************/
4054
Gilles Peskinee553c652018-06-04 16:22:46 +02004055static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004056 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004057 psa_algorithm_t alg,
4058 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004059{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004060 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004061 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004062 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004063 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004064 size_t key_bits;
4065 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004066 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4067 PSA_KEY_USAGE_ENCRYPT :
4068 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004069
Steven Cooremand3feccd2020-09-01 15:56:14 +02004070 /* A context must be freshly initialized before it can be set up. */
4071 if( operation->alg != 0 )
4072 return( PSA_ERROR_BAD_STATE );
4073
Steven Cooremana07b9972020-09-10 14:54:14 +02004074 /* The requested algorithm must be one that can be processed by cipher. */
4075 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004076 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004077
Steven Cooremanef8575e2020-09-11 11:44:50 +02004078 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004079 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004080 if( status != PSA_SUCCESS )
4081 goto exit;
4082
4083 /* Initialize the operation struct members, except for alg. The alg member
4084 * is used to indicate to psa_cipher_abort that there are resources to free,
4085 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004086 operation->key_set = 0;
4087 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004088 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004089 operation->iv_size = 0;
4090 operation->block_size = 0;
4091 if( alg == PSA_ALG_ECB_NO_PADDING )
4092 operation->iv_required = 0;
4093 else
4094 operation->iv_required = 1;
4095
Steven Cooremana07b9972020-09-10 14:54:14 +02004096 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004097 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004098 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004099 slot,
4100 alg );
4101 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004102 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004103 slot,
4104 alg );
4105
Steven Cooremanef8575e2020-09-11 11:44:50 +02004106 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004107 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004108 /* Once the driver context is initialised, it needs to be freed using
4109 * psa_cipher_abort. Indicate this through setting alg. */
4110 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004111 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004112
Steven Cooremand3feccd2020-09-01 15:56:14 +02004113 if( status != PSA_ERROR_NOT_SUPPORTED ||
4114 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4115 goto exit;
4116
Steven Cooremana07b9972020-09-10 14:54:14 +02004117 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004118 * available for the given algorithm & key. */
4119 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004120
Steven Cooremana07b9972020-09-10 14:54:14 +02004121 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004122 * psa_cipher_abort. Indicate there is something to be freed through setting
4123 * alg, and indicate the operation is being done using mbedtls crypto through
4124 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004125 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004126 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004127
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004128 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004129 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004130 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004131 {
4132 status = PSA_ERROR_NOT_SUPPORTED;
4133 goto exit;
4134 }
mohammad1603503973b2018-03-12 15:59:30 +02004135
mohammad1603503973b2018-03-12 15:59:30 +02004136 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004137 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004138 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004139
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004140#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004141 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004142 {
4143 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004144 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004145 memcpy( keys, slot->key.data, 16 );
4146 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004147 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4148 keys,
4149 192, cipher_operation );
4150 }
4151 else
4152#endif
4153 {
4154 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004155 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004156 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004157 }
Moran Peker41deec42018-04-04 15:43:05 +03004158 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004159 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004160
mohammad16038481e742018-03-18 13:57:31 +02004161#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004162 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004163 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004164 case PSA_ALG_CBC_NO_PADDING:
4165 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4166 MBEDTLS_PADDING_NONE );
4167 break;
4168 case PSA_ALG_CBC_PKCS7:
4169 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4170 MBEDTLS_PADDING_PKCS7 );
4171 break;
4172 default:
4173 /* The algorithm doesn't involve padding. */
4174 ret = 0;
4175 break;
4176 }
4177 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004178 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004179#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4180
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004181 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004182 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004183 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4184 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004185 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004186 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004187 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004188#if defined(MBEDTLS_CHACHA20_C)
4189 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004190 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004191 operation->iv_size = 12;
4192#endif
mohammad1603503973b2018-03-12 15:59:30 +02004193
Steven Cooreman7df02922020-09-09 15:28:49 +02004194 status = PSA_SUCCESS;
4195
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004196exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004197 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004198 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004199 if( status == PSA_SUCCESS )
4200 {
4201 /* Update operation flags for both driver and software implementations */
4202 operation->key_set = 1;
4203 }
4204 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004205 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004206
Ronald Cron5c522922020-11-14 16:35:34 +01004207 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004208
Ronald Cron5c522922020-11-14 16:35:34 +01004209 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004210}
4211
Gilles Peskinefe119512018-07-08 21:39:34 +02004212psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004213 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004214 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004215{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004216 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004217}
4218
Gilles Peskinefe119512018-07-08 21:39:34 +02004219psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004220 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004221 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004222{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004223 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004224}
4225
Gilles Peskinefe119512018-07-08 21:39:34 +02004226psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004227 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004228 size_t iv_size,
4229 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004230{
itayzafrir534bd7c2018-08-02 13:56:32 +03004231 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004232 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004233 if( operation->iv_set || ! operation->iv_required )
4234 {
4235 return( PSA_ERROR_BAD_STATE );
4236 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004237
Steven Cooremanef8575e2020-09-11 11:44:50 +02004238 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004239 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004240 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004241 iv,
4242 iv_size,
4243 iv_length );
4244 goto exit;
4245 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004246
Moran Peker41deec42018-04-04 15:43:05 +03004247 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004248 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004249 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004250 goto exit;
4251 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004252 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004253 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004254 if( ret != 0 )
4255 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004256 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004257 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004258 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004259
mohammad16038481e742018-03-18 13:57:31 +02004260 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004261 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004262
Moran Peker395db872018-05-31 14:07:14 +03004263exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004264 if( status == PSA_SUCCESS )
4265 operation->iv_set = 1;
4266 else
Moran Peker395db872018-05-31 14:07:14 +03004267 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004268 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004269}
4270
Gilles Peskinefe119512018-07-08 21:39:34 +02004271psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004272 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004273 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004274{
itayzafrir534bd7c2018-08-02 13:56:32 +03004275 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004276 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004277 if( operation->iv_set || ! operation->iv_required )
4278 {
4279 return( PSA_ERROR_BAD_STATE );
4280 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004281
Steven Cooremanef8575e2020-09-11 11:44:50 +02004282 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004283 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004284 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004285 iv,
4286 iv_length );
4287 goto exit;
4288 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004289
Moran Pekera28258c2018-05-29 16:25:04 +03004290 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004291 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004292 status = PSA_ERROR_INVALID_ARGUMENT;
4293 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004294 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004295 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4296 status = mbedtls_to_psa_error( ret );
4297exit:
4298 if( status == PSA_SUCCESS )
4299 operation->iv_set = 1;
4300 else
mohammad1603503973b2018-03-12 15:59:30 +02004301 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004302 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004303}
4304
Steven Cooreman177deba2020-09-07 17:14:14 +02004305/* Process input for which the algorithm is set to ECB mode. This requires
4306 * manual processing, since the PSA API is defined as being able to process
4307 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4308 * underlying mbedtls_cipher_update only takes full blocks. */
4309static psa_status_t psa_cipher_update_ecb_internal(
4310 mbedtls_cipher_context_t *ctx,
4311 const uint8_t *input,
4312 size_t input_length,
4313 uint8_t *output,
4314 size_t output_size,
4315 size_t *output_length )
4316{
4317 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4318 size_t block_size = ctx->cipher_info->block_size;
4319 size_t internal_output_length = 0;
4320 *output_length = 0;
4321
4322 if( input_length == 0 )
4323 {
4324 status = PSA_SUCCESS;
4325 goto exit;
4326 }
4327
4328 if( ctx->unprocessed_len > 0 )
4329 {
4330 /* Fill up to block size, and run the block if there's a full one. */
4331 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4332
4333 if( input_length < bytes_to_copy )
4334 bytes_to_copy = input_length;
4335
4336 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4337 input, bytes_to_copy );
4338 input_length -= bytes_to_copy;
4339 input += bytes_to_copy;
4340 ctx->unprocessed_len += bytes_to_copy;
4341
4342 if( ctx->unprocessed_len == block_size )
4343 {
4344 status = mbedtls_to_psa_error(
4345 mbedtls_cipher_update( ctx,
4346 ctx->unprocessed_data,
4347 block_size,
4348 output, &internal_output_length ) );
4349
4350 if( status != PSA_SUCCESS )
4351 goto exit;
4352
4353 output += internal_output_length;
4354 output_size -= internal_output_length;
4355 *output_length += internal_output_length;
4356 ctx->unprocessed_len = 0;
4357 }
4358 }
4359
4360 while( input_length >= block_size )
4361 {
4362 /* Run all full blocks we have, one by one */
4363 status = mbedtls_to_psa_error(
4364 mbedtls_cipher_update( ctx, input,
4365 block_size,
4366 output, &internal_output_length ) );
4367
4368 if( status != PSA_SUCCESS )
4369 goto exit;
4370
4371 input_length -= block_size;
4372 input += block_size;
4373
4374 output += internal_output_length;
4375 output_size -= internal_output_length;
4376 *output_length += internal_output_length;
4377 }
4378
4379 if( input_length > 0 )
4380 {
4381 /* Save unprocessed bytes for later processing */
4382 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4383 input, input_length );
4384 ctx->unprocessed_len += input_length;
4385 }
4386
4387 status = PSA_SUCCESS;
4388
4389exit:
4390 return( status );
4391}
4392
Gilles Peskinee553c652018-06-04 16:22:46 +02004393psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4394 const uint8_t *input,
4395 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004396 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004397 size_t output_size,
4398 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004399{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004401 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004402 if( operation->alg == 0 )
4403 {
4404 return( PSA_ERROR_BAD_STATE );
4405 }
4406 if( operation->iv_required && ! operation->iv_set )
4407 {
4408 return( PSA_ERROR_BAD_STATE );
4409 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004410
Steven Cooremanef8575e2020-09-11 11:44:50 +02004411 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004412 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004413 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004414 input,
4415 input_length,
4416 output,
4417 output_size,
4418 output_length );
4419 goto exit;
4420 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004421
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004422 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004423 {
4424 /* Take the unprocessed partial block left over from previous
4425 * update calls, if any, plus the input to this call. Remove
4426 * the last partial block, if any. You get the data that will be
4427 * output in this call. */
4428 expected_output_size =
4429 ( operation->ctx.cipher.unprocessed_len + input_length )
4430 / operation->block_size * operation->block_size;
4431 }
4432 else
4433 {
4434 expected_output_size = input_length;
4435 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004436
Gilles Peskine89d789c2018-06-04 17:17:16 +02004437 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004438 {
4439 status = PSA_ERROR_BUFFER_TOO_SMALL;
4440 goto exit;
4441 }
mohammad160382759612018-03-12 18:16:40 +02004442
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004443 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4444 {
4445 /* mbedtls_cipher_update has an API inconsistency: it will only
4446 * process a single block at a time in ECB mode. Abstract away that
4447 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004448 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4449 input,
4450 input_length,
4451 output,
4452 output_size,
4453 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004454 }
4455 else
4456 {
4457 status = mbedtls_to_psa_error(
4458 mbedtls_cipher_update( &operation->ctx.cipher, input,
4459 input_length, output, output_length ) );
4460 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004461exit:
4462 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004463 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004464 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004465}
4466
Gilles Peskinee553c652018-06-04 16:22:46 +02004467psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4468 uint8_t *output,
4469 size_t output_size,
4470 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004471{
David Saadab4ecc272019-02-14 13:48:10 +02004472 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004473 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004474 if( operation->alg == 0 )
4475 {
4476 return( PSA_ERROR_BAD_STATE );
4477 }
4478 if( operation->iv_required && ! operation->iv_set )
4479 {
4480 return( PSA_ERROR_BAD_STATE );
4481 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004482
Steven Cooremanef8575e2020-09-11 11:44:50 +02004483 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004484 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004485 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004486 output,
4487 output_size,
4488 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004489 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004490 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004491
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004492 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004493 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004494 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004495 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004496 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004497 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004498 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004499 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004500 }
4501
Steven Cooremanef8575e2020-09-11 11:44:50 +02004502 status = mbedtls_to_psa_error(
4503 mbedtls_cipher_finish( &operation->ctx.cipher,
4504 temp_output_buffer,
4505 output_length ) );
4506 if( status != PSA_SUCCESS )
4507 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004508
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004509 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004510 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004511 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004512 memcpy( output, temp_output_buffer, *output_length );
4513 else
Janos Follath315b51c2018-07-09 16:04:51 +01004514 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004515
Steven Cooremanef8575e2020-09-11 11:44:50 +02004516exit:
4517 if( operation->mbedtls_in_use == 1 )
4518 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004519
Steven Cooremanef8575e2020-09-11 11:44:50 +02004520 if( status == PSA_SUCCESS )
4521 return( psa_cipher_abort( operation ) );
4522 else
4523 {
4524 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004525 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004526
Steven Cooremanef8575e2020-09-11 11:44:50 +02004527 return( status );
4528 }
mohammad1603503973b2018-03-12 15:59:30 +02004529}
4530
Gilles Peskinee553c652018-06-04 16:22:46 +02004531psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4532{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004533 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004534 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004535 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004536 * in use. It's ok to call abort on such an object, and there's
4537 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004538 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004539 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004540
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004541 /* Sanity check (shouldn't happen: operation->alg should
4542 * always have been initialized to a valid value). */
4543 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4544 return( PSA_ERROR_BAD_STATE );
4545
Steven Cooremanef8575e2020-09-11 11:44:50 +02004546 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004547 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004548 else
4549 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004550
Moran Peker41deec42018-04-04 15:43:05 +03004551 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004552 operation->key_set = 0;
4553 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004554 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004555 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004556 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004557 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004558
Moran Peker395db872018-05-31 14:07:14 +03004559 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004560}
4561
Gilles Peskinea0655c32018-04-30 17:06:50 +02004562
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004563
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004564
mohammad16035955c982018-04-26 00:53:03 +03004565/****************************************************************/
4566/* AEAD */
4567/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004568
Gilles Peskineedf9a652018-08-17 18:11:56 +02004569typedef struct
4570{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004571 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004572 const mbedtls_cipher_info_t *cipher_info;
4573 union
4574 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004575 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004576#if defined(MBEDTLS_CCM_C)
4577 mbedtls_ccm_context ccm;
4578#endif /* MBEDTLS_CCM_C */
4579#if defined(MBEDTLS_GCM_C)
4580 mbedtls_gcm_context gcm;
4581#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004582#if defined(MBEDTLS_CHACHAPOLY_C)
4583 mbedtls_chachapoly_context chachapoly;
4584#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004585 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004586 psa_algorithm_t core_alg;
4587 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004588 uint8_t tag_length;
4589} aead_operation_t;
4590
Ronald Cronf95a2b12020-10-22 15:24:49 +02004591#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4592
Gilles Peskine30a9e412019-01-14 18:36:12 +01004593static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004594{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004595 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004596 {
4597#if defined(MBEDTLS_CCM_C)
4598 case PSA_ALG_CCM:
4599 mbedtls_ccm_free( &operation->ctx.ccm );
4600 break;
4601#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004602#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004603 case PSA_ALG_GCM:
4604 mbedtls_gcm_free( &operation->ctx.gcm );
4605 break;
4606#endif /* MBEDTLS_GCM_C */
4607 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004608
Ronald Cron5c522922020-11-14 16:35:34 +01004609 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004610}
4611
4612static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004613 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004614 psa_key_usage_t usage,
4615 psa_algorithm_t alg )
4616{
4617 psa_status_t status;
4618 size_t key_bits;
4619 mbedtls_cipher_id_t cipher_id;
4620
Ronald Cron5c522922020-11-14 16:35:34 +01004621 status = psa_get_and_lock_transparent_key_slot_with_policy(
4622 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004623 if( status != PSA_SUCCESS )
4624 return( status );
4625
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004626 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004627
4628 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004629 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004630 &cipher_id );
4631 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004632 {
4633 status = PSA_ERROR_NOT_SUPPORTED;
4634 goto cleanup;
4635 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004636
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004637 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004638 {
4639#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004640 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4641 operation->core_alg = PSA_ALG_CCM;
4642 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004643 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4644 * The call to mbedtls_ccm_encrypt_and_tag or
4645 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004646 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004647 {
4648 status = PSA_ERROR_INVALID_ARGUMENT;
4649 goto cleanup;
4650 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004651 mbedtls_ccm_init( &operation->ctx.ccm );
4652 status = mbedtls_to_psa_error(
4653 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004654 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004655 (unsigned int) key_bits ) );
4656 if( status != 0 )
4657 goto cleanup;
4658 break;
4659#endif /* MBEDTLS_CCM_C */
4660
4661#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004662 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4663 operation->core_alg = PSA_ALG_GCM;
4664 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004665 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4666 * The call to mbedtls_gcm_crypt_and_tag or
4667 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004668 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004669 {
4670 status = PSA_ERROR_INVALID_ARGUMENT;
4671 goto cleanup;
4672 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004673 mbedtls_gcm_init( &operation->ctx.gcm );
4674 status = mbedtls_to_psa_error(
4675 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004676 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004677 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004678 if( status != 0 )
4679 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004680 break;
4681#endif /* MBEDTLS_GCM_C */
4682
Gilles Peskine26869f22019-05-06 15:25:00 +02004683#if defined(MBEDTLS_CHACHAPOLY_C)
4684 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4685 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4686 operation->full_tag_length = 16;
4687 /* We only support the default tag length. */
4688 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004689 {
4690 status = PSA_ERROR_NOT_SUPPORTED;
4691 goto cleanup;
4692 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004693 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4694 status = mbedtls_to_psa_error(
4695 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004696 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004697 if( status != 0 )
4698 goto cleanup;
4699 break;
4700#endif /* MBEDTLS_CHACHAPOLY_C */
4701
Gilles Peskineedf9a652018-08-17 18:11:56 +02004702 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004703 status = PSA_ERROR_NOT_SUPPORTED;
4704 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004705 }
4706
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004707 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4708 {
4709 status = PSA_ERROR_INVALID_ARGUMENT;
4710 goto cleanup;
4711 }
4712 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004713
Gilles Peskineedf9a652018-08-17 18:11:56 +02004714 return( PSA_SUCCESS );
4715
4716cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004717 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004718 return( status );
4719}
4720
Ronald Croncf56a0a2020-08-04 09:51:30 +02004721psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004722 psa_algorithm_t alg,
4723 const uint8_t *nonce,
4724 size_t nonce_length,
4725 const uint8_t *additional_data,
4726 size_t additional_data_length,
4727 const uint8_t *plaintext,
4728 size_t plaintext_length,
4729 uint8_t *ciphertext,
4730 size_t ciphertext_size,
4731 size_t *ciphertext_length )
4732{
mohammad16035955c982018-04-26 00:53:03 +03004733 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004734 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004735 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004736
mohammad1603f08a5502018-06-03 15:05:47 +03004737 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004738
Ronald Croncf56a0a2020-08-04 09:51:30 +02004739 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004740 if( status != PSA_SUCCESS )
4741 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004742
Gilles Peskineedf9a652018-08-17 18:11:56 +02004743 /* For all currently supported modes, the tag is at the end of the
4744 * ciphertext. */
4745 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4746 {
4747 status = PSA_ERROR_BUFFER_TOO_SMALL;
4748 goto exit;
4749 }
4750 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004751
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004752#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004753 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004754 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004755 status = mbedtls_to_psa_error(
4756 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4757 MBEDTLS_GCM_ENCRYPT,
4758 plaintext_length,
4759 nonce, nonce_length,
4760 additional_data, additional_data_length,
4761 plaintext, ciphertext,
4762 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004763 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004764 else
4765#endif /* MBEDTLS_GCM_C */
4766#if defined(MBEDTLS_CCM_C)
4767 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004768 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004769 status = mbedtls_to_psa_error(
4770 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4771 plaintext_length,
4772 nonce, nonce_length,
4773 additional_data,
4774 additional_data_length,
4775 plaintext, ciphertext,
4776 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004777 }
mohammad16035c8845f2018-05-09 05:40:09 -07004778 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004779#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004780#if defined(MBEDTLS_CHACHAPOLY_C)
4781 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4782 {
4783 if( nonce_length != 12 || operation.tag_length != 16 )
4784 {
4785 status = PSA_ERROR_NOT_SUPPORTED;
4786 goto exit;
4787 }
4788 status = mbedtls_to_psa_error(
4789 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4790 plaintext_length,
4791 nonce,
4792 additional_data,
4793 additional_data_length,
4794 plaintext,
4795 ciphertext,
4796 tag ) );
4797 }
4798 else
4799#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004800 {
mohammad1603554faad2018-06-03 15:07:38 +03004801 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004802 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004803
Gilles Peskineedf9a652018-08-17 18:11:56 +02004804 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4805 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004806
Gilles Peskineedf9a652018-08-17 18:11:56 +02004807exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004808 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004809 if( status == PSA_SUCCESS )
4810 *ciphertext_length = plaintext_length + operation.tag_length;
4811 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004812}
4813
Gilles Peskineee652a32018-06-01 19:23:52 +02004814/* Locate the tag in a ciphertext buffer containing the encrypted data
4815 * followed by the tag. Return the length of the part preceding the tag in
4816 * *plaintext_length. This is the size of the plaintext in modes where
4817 * the encrypted data has the same size as the plaintext, such as
4818 * CCM and GCM. */
4819static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4820 const uint8_t *ciphertext,
4821 size_t ciphertext_length,
4822 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004823 const uint8_t **p_tag )
4824{
4825 size_t payload_length;
4826 if( tag_length > ciphertext_length )
4827 return( PSA_ERROR_INVALID_ARGUMENT );
4828 payload_length = ciphertext_length - tag_length;
4829 if( payload_length > plaintext_size )
4830 return( PSA_ERROR_BUFFER_TOO_SMALL );
4831 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004832 return( PSA_SUCCESS );
4833}
4834
Ronald Croncf56a0a2020-08-04 09:51:30 +02004835psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004836 psa_algorithm_t alg,
4837 const uint8_t *nonce,
4838 size_t nonce_length,
4839 const uint8_t *additional_data,
4840 size_t additional_data_length,
4841 const uint8_t *ciphertext,
4842 size_t ciphertext_length,
4843 uint8_t *plaintext,
4844 size_t plaintext_size,
4845 size_t *plaintext_length )
4846{
mohammad16035955c982018-04-26 00:53:03 +03004847 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004848 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004849 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004850
Gilles Peskineee652a32018-06-01 19:23:52 +02004851 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004852
Ronald Croncf56a0a2020-08-04 09:51:30 +02004853 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004854 if( status != PSA_SUCCESS )
4855 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004856
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004857 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4858 ciphertext, ciphertext_length,
4859 plaintext_size, &tag );
4860 if( status != PSA_SUCCESS )
4861 goto exit;
4862
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004863#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004864 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004865 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004866 status = mbedtls_to_psa_error(
4867 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4868 ciphertext_length - operation.tag_length,
4869 nonce, nonce_length,
4870 additional_data,
4871 additional_data_length,
4872 tag, operation.tag_length,
4873 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004874 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004875 else
4876#endif /* MBEDTLS_GCM_C */
4877#if defined(MBEDTLS_CCM_C)
4878 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004879 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004880 status = mbedtls_to_psa_error(
4881 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4882 ciphertext_length - operation.tag_length,
4883 nonce, nonce_length,
4884 additional_data,
4885 additional_data_length,
4886 ciphertext, plaintext,
4887 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004888 }
mohammad160339574652018-06-01 04:39:53 -07004889 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004890#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004891#if defined(MBEDTLS_CHACHAPOLY_C)
4892 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4893 {
4894 if( nonce_length != 12 || operation.tag_length != 16 )
4895 {
4896 status = PSA_ERROR_NOT_SUPPORTED;
4897 goto exit;
4898 }
4899 status = mbedtls_to_psa_error(
4900 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4901 ciphertext_length - operation.tag_length,
4902 nonce,
4903 additional_data,
4904 additional_data_length,
4905 tag,
4906 ciphertext,
4907 plaintext ) );
4908 }
4909 else
4910#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004911 {
mohammad1603554faad2018-06-03 15:07:38 +03004912 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004913 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004914
Gilles Peskineedf9a652018-08-17 18:11:56 +02004915 if( status != PSA_SUCCESS && plaintext_size != 0 )
4916 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004917
Gilles Peskineedf9a652018-08-17 18:11:56 +02004918exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004919 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004920 if( status == PSA_SUCCESS )
4921 *plaintext_length = ciphertext_length - operation.tag_length;
4922 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004923}
4924
Gilles Peskinea0655c32018-04-30 17:06:50 +02004925
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004926
Gilles Peskine20035e32018-02-03 22:44:14 +01004927/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004928/* Generators */
4929/****************************************************************/
4930
John Durkop07cc04a2020-11-16 22:08:34 -08004931#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4932 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4933 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4934#define AT_LEAST_ONE_BUILTIN_KDF
4935#endif
4936
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004937#define HKDF_STATE_INIT 0 /* no input yet */
4938#define HKDF_STATE_STARTED 1 /* got salt */
4939#define HKDF_STATE_KEYED 2 /* got key */
4940#define HKDF_STATE_OUTPUT 3 /* output started */
4941
Gilles Peskinecbe66502019-05-16 16:59:18 +02004942static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004943 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004944{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004945 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4946 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004947 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004948 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004949}
4950
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004951psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004952{
4953 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004954 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004955 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004956 {
4957 /* The object has (apparently) been initialized but it is not
4958 * in use. It's ok to call abort on such an object, and there's
4959 * nothing to do. */
4960 }
4961 else
John Durkopd0321952020-10-29 21:37:36 -07004962#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004963 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004964 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004965 mbedtls_free( operation->ctx.hkdf.info );
4966 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004967 }
John Durkop07cc04a2020-11-16 22:08:34 -08004968 else
4969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4970#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4971 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4972 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004973 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004974 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004975 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004976 if( operation->ctx.tls12_prf.seed != NULL )
4977 {
4978 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4979 operation->ctx.tls12_prf.seed_length );
4980 mbedtls_free( operation->ctx.tls12_prf.seed );
4981 }
4982
4983 if( operation->ctx.tls12_prf.label != NULL )
4984 {
4985 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4986 operation->ctx.tls12_prf.label_length );
4987 mbedtls_free( operation->ctx.tls12_prf.label );
4988 }
4989
4990 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4991
4992 /* We leave the fields Ai and output_block to be erased safely by the
4993 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004994 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004995 else
John Durkop07cc04a2020-11-16 22:08:34 -08004996#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4997 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004998 {
4999 status = PSA_ERROR_BAD_STATE;
5000 }
Janos Follath083036a2019-06-11 10:22:26 +01005001 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005002 return( status );
5003}
5004
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005005psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005006 size_t *capacity)
5007{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005008 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005009 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005010 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005011 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005012 }
5013
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005014 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005015 return( PSA_SUCCESS );
5016}
5017
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005018psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005019 size_t capacity )
5020{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005021 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005022 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005023 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005024 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005025 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005026 return( PSA_SUCCESS );
5027}
5028
John Durkopd0321952020-10-29 21:37:36 -07005029#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005030/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005031 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005032static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005033 psa_algorithm_t hash_alg,
5034 uint8_t *output,
5035 size_t output_length )
5036{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005037 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005038 psa_status_t status;
5039
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005040 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5041 return( PSA_ERROR_BAD_STATE );
5042 hkdf->state = HKDF_STATE_OUTPUT;
5043
Gilles Peskinebef7f142018-07-12 17:22:21 +02005044 while( output_length != 0 )
5045 {
5046 /* Copy what remains of the current block */
5047 uint8_t n = hash_length - hkdf->offset_in_block;
5048 if( n > output_length )
5049 n = (uint8_t) output_length;
5050 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5051 output += n;
5052 output_length -= n;
5053 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005054 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005055 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005056 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005057 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005058 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005059 * object was corrupted or if this function is called directly
5060 * inside the library. */
5061 if( hkdf->block_number == 0xff )
5062 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005063
5064 /* We need a new block */
5065 ++hkdf->block_number;
5066 hkdf->offset_in_block = 0;
5067 status = psa_hmac_setup_internal( &hkdf->hmac,
5068 hkdf->prk, hash_length,
5069 hash_alg );
5070 if( status != PSA_SUCCESS )
5071 return( status );
5072 if( hkdf->block_number != 1 )
5073 {
5074 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5075 hkdf->output_block,
5076 hash_length );
5077 if( status != PSA_SUCCESS )
5078 return( status );
5079 }
5080 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5081 hkdf->info,
5082 hkdf->info_length );
5083 if( status != PSA_SUCCESS )
5084 return( status );
5085 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5086 &hkdf->block_number, 1 );
5087 if( status != PSA_SUCCESS )
5088 return( status );
5089 status = psa_hmac_finish_internal( &hkdf->hmac,
5090 hkdf->output_block,
5091 sizeof( hkdf->output_block ) );
5092 if( status != PSA_SUCCESS )
5093 return( status );
5094 }
5095
5096 return( PSA_SUCCESS );
5097}
John Durkop07cc04a2020-11-16 22:08:34 -08005098#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005099
John Durkop07cc04a2020-11-16 22:08:34 -08005100#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5101 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005102static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5103 psa_tls12_prf_key_derivation_t *tls12_prf,
5104 psa_algorithm_t alg )
5105{
5106 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005107 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005108 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5109 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005110
Janos Follath7742fee2019-06-17 12:58:10 +01005111 /* We can't be wanting more output after block 0xff, otherwise
5112 * the capacity check in psa_key_derivation_output_bytes() would have
5113 * prevented this call. It could happen only if the operation
5114 * object was corrupted or if this function is called directly
5115 * inside the library. */
5116 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005117 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005118
5119 /* We need a new block */
5120 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005121 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005122
5123 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5124 *
5125 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5126 *
5127 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5128 * HMAC_hash(secret, A(2) + seed) +
5129 * HMAC_hash(secret, A(3) + seed) + ...
5130 *
5131 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005132 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005133 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005134 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005135 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005136 * is currently extracted as `output_block` and where i is
5137 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005138 */
5139
Janos Follathea29bfb2019-06-19 12:21:20 +01005140 /* Save the hash context before using it, to preserve the hash state with
5141 * only the inner padding in it. We need this, because inner padding depends
5142 * on the key (secret in the RFC's terminology). */
5143 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5144 if( status != PSA_SUCCESS )
5145 goto cleanup;
5146
5147 /* Calculate A(i) where i = tls12_prf->block_number. */
5148 if( tls12_prf->block_number == 1 )
5149 {
5150 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5151 * the variable seed and in this instance means it in the context of the
5152 * P_hash function, where seed = label + seed.) */
5153 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5154 tls12_prf->label, tls12_prf->label_length );
5155 if( status != PSA_SUCCESS )
5156 goto cleanup;
5157 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5158 tls12_prf->seed, tls12_prf->seed_length );
5159 if( status != PSA_SUCCESS )
5160 goto cleanup;
5161 }
5162 else
5163 {
5164 /* A(i) = HMAC_hash(secret, A(i-1)) */
5165 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5166 tls12_prf->Ai, hash_length );
5167 if( status != PSA_SUCCESS )
5168 goto cleanup;
5169 }
5170
5171 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5172 tls12_prf->Ai, hash_length );
5173 if( status != PSA_SUCCESS )
5174 goto cleanup;
5175 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5176 if( status != PSA_SUCCESS )
5177 goto cleanup;
5178
5179 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5180 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5181 tls12_prf->Ai, hash_length );
5182 if( status != PSA_SUCCESS )
5183 goto cleanup;
5184 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5185 tls12_prf->label, tls12_prf->label_length );
5186 if( status != PSA_SUCCESS )
5187 goto cleanup;
5188 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5189 tls12_prf->seed, tls12_prf->seed_length );
5190 if( status != PSA_SUCCESS )
5191 goto cleanup;
5192 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5193 tls12_prf->output_block, hash_length );
5194 if( status != PSA_SUCCESS )
5195 goto cleanup;
5196 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5197 if( status != PSA_SUCCESS )
5198 goto cleanup;
5199
Janos Follath7742fee2019-06-17 12:58:10 +01005200
5201cleanup:
5202
Janos Follathea29bfb2019-06-19 12:21:20 +01005203 cleanup_status = psa_hash_abort( &backup );
5204 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5205 status = cleanup_status;
5206
5207 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005208}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005209
Janos Follath844eb0e2019-06-19 12:10:49 +01005210static psa_status_t psa_key_derivation_tls12_prf_read(
5211 psa_tls12_prf_key_derivation_t *tls12_prf,
5212 psa_algorithm_t alg,
5213 uint8_t *output,
5214 size_t output_length )
5215{
5216 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005217 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005218 psa_status_t status;
5219 uint8_t offset, length;
5220
5221 while( output_length != 0 )
5222 {
5223 /* Check if we have fully processed the current block. */
5224 if( tls12_prf->left_in_block == 0 )
5225 {
5226 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5227 alg );
5228 if( status != PSA_SUCCESS )
5229 return( status );
5230
5231 continue;
5232 }
5233
5234 if( tls12_prf->left_in_block > output_length )
5235 length = (uint8_t) output_length;
5236 else
5237 length = tls12_prf->left_in_block;
5238
5239 offset = hash_length - tls12_prf->left_in_block;
5240 memcpy( output, tls12_prf->output_block + offset, length );
5241 output += length;
5242 output_length -= length;
5243 tls12_prf->left_in_block -= length;
5244 }
5245
5246 return( PSA_SUCCESS );
5247}
John Durkop07cc04a2020-11-16 22:08:34 -08005248#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5249 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005250
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005251psa_status_t psa_key_derivation_output_bytes(
5252 psa_key_derivation_operation_t *operation,
5253 uint8_t *output,
5254 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005255{
5256 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005258
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005259 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005260 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005261 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005262 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005263 }
5264
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005265 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005266 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005267 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005268 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005269 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005270 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005271 goto exit;
5272 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005273 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005274 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005276 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005277 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5278 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005279 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005280 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005281 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005282 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005283 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005284
John Durkopd0321952020-10-29 21:37:36 -07005285#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005286 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005287 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005288 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005289 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005290 output, output_length );
5291 }
Janos Follathadbec812019-06-14 11:05:39 +01005292 else
John Durkop07cc04a2020-11-16 22:08:34 -08005293#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5294#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5295 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005296 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005297 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005298 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005299 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005300 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005301 output_length );
5302 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005303 else
John Durkop07cc04a2020-11-16 22:08:34 -08005304#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5305 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005306 {
5307 return( PSA_ERROR_BAD_STATE );
5308 }
5309
5310exit:
5311 if( status != PSA_SUCCESS )
5312 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005313 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005314 * This allows us to differentiate between exhausted operations and
5315 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5316 * operations. */
5317 psa_algorithm_t alg = operation->alg;
5318 psa_key_derivation_abort( operation );
5319 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005320 memset( output, '!', output_length );
5321 }
5322 return( status );
5323}
5324
Gilles Peskine08542d82018-07-19 17:05:42 +02005325#if defined(MBEDTLS_DES_C)
5326static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5327{
5328 if( data_size >= 8 )
5329 mbedtls_des_key_set_parity( data );
5330 if( data_size >= 16 )
5331 mbedtls_des_key_set_parity( data + 8 );
5332 if( data_size >= 24 )
5333 mbedtls_des_key_set_parity( data + 16 );
5334}
5335#endif /* MBEDTLS_DES_C */
5336
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005337static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005338 psa_key_slot_t *slot,
5339 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005340 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005341{
5342 uint8_t *data = NULL;
5343 size_t bytes = PSA_BITS_TO_BYTES( bits );
5344 psa_status_t status;
5345
Gilles Peskine8e338702019-07-30 20:06:31 +02005346 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005347 return( PSA_ERROR_INVALID_ARGUMENT );
5348 if( bits % 8 != 0 )
5349 return( PSA_ERROR_INVALID_ARGUMENT );
5350 data = mbedtls_calloc( 1, bytes );
5351 if( data == NULL )
5352 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5353
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005354 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005355 if( status != PSA_SUCCESS )
5356 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005357#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005358 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005359 psa_des_set_key_parity( data, bytes );
5360#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005361 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005362
5363exit:
5364 mbedtls_free( data );
5365 return( status );
5366}
5367
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005368psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005369 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005370 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005371{
5372 psa_status_t status;
5373 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005374 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005375
Ronald Cron81709fc2020-11-14 12:10:32 +01005376 *key = MBEDTLS_SVC_KEY_ID_INIT;
5377
Gilles Peskine0f84d622019-09-12 19:03:13 +02005378 /* Reject any attempt to create a zero-length key so that we don't
5379 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5380 if( psa_get_key_bits( attributes ) == 0 )
5381 return( PSA_ERROR_INVALID_ARGUMENT );
5382
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005383 if( ! operation->can_output_key )
5384 return( PSA_ERROR_NOT_PERMITTED );
5385
Ronald Cron81709fc2020-11-14 12:10:32 +01005386 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5387 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005388#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5389 if( driver != NULL )
5390 {
5391 /* Deriving a key in a secure element is not implemented yet. */
5392 status = PSA_ERROR_NOT_SUPPORTED;
5393 }
5394#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005395 if( status == PSA_SUCCESS )
5396 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005397 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005398 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005399 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005400 }
5401 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005402 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005403 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005404 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005405
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005406 return( status );
5407}
5408
Gilles Peskineeab56e42018-07-12 17:12:33 +02005409
5410
5411/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005412/* Key derivation */
5413/****************************************************************/
5414
John Durkop07cc04a2020-11-16 22:08:34 -08005415#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005416static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005417 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005418 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005419{
John Durkop07cc04a2020-11-16 22:08:34 -08005420 int is_kdf_alg_supported;
5421
Janos Follath5fe19732019-06-20 15:09:30 +01005422 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5423 * initialisers for this union leave some bytes unspecified.) */
5424 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5425
Gilles Peskine969c5d62019-01-16 15:53:06 +01005426 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005427#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005428 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5429 is_kdf_alg_supported = 1;
5430 else
5431#endif
5432#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5433 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5434 is_kdf_alg_supported = 1;
5435 else
5436#endif
5437#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5438 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5439 is_kdf_alg_supported = 1;
5440 else
5441#endif
5442 is_kdf_alg_supported = 0;
5443
5444 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005445 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005446 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005447 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005448 if( hash_size == 0 )
5449 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005450 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5451 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005452 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005453 {
5454 return( PSA_ERROR_NOT_SUPPORTED );
5455 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005456 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005457 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005458 }
John Durkop07cc04a2020-11-16 22:08:34 -08005459
5460 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005461}
John Durkop07cc04a2020-11-16 22:08:34 -08005462#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005463
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005464psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005465 psa_algorithm_t alg )
5466{
5467 psa_status_t status;
5468
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005469 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005470 return( PSA_ERROR_BAD_STATE );
5471
Gilles Peskine6843c292019-01-18 16:44:49 +01005472 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5473 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005474#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005475 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005476 {
5477 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005478 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005479 }
5480 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5481 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005482 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005483 }
John Durkop07cc04a2020-11-16 22:08:34 -08005484#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005485 else
5486 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005487
5488 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005489 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005490 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005491}
5492
John Durkopd0321952020-10-29 21:37:36 -07005493#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005494static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005495 psa_algorithm_t hash_alg,
5496 psa_key_derivation_step_t step,
5497 const uint8_t *data,
5498 size_t data_length )
5499{
5500 psa_status_t status;
5501 switch( step )
5502 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005503 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005504 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005505 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005506 status = psa_hmac_setup_internal( &hkdf->hmac,
5507 data, data_length,
5508 hash_alg );
5509 if( status != PSA_SUCCESS )
5510 return( status );
5511 hkdf->state = HKDF_STATE_STARTED;
5512 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005513 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005514 /* If no salt was provided, use an empty salt. */
5515 if( hkdf->state == HKDF_STATE_INIT )
5516 {
5517 status = psa_hmac_setup_internal( &hkdf->hmac,
5518 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005519 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005520 if( status != PSA_SUCCESS )
5521 return( status );
5522 hkdf->state = HKDF_STATE_STARTED;
5523 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005524 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005525 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005526 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5527 data, data_length );
5528 if( status != PSA_SUCCESS )
5529 return( status );
5530 status = psa_hmac_finish_internal( &hkdf->hmac,
5531 hkdf->prk,
5532 sizeof( hkdf->prk ) );
5533 if( status != PSA_SUCCESS )
5534 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005535 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005536 hkdf->block_number = 0;
5537 hkdf->state = HKDF_STATE_KEYED;
5538 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005539 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005540 if( hkdf->state == HKDF_STATE_OUTPUT )
5541 return( PSA_ERROR_BAD_STATE );
5542 if( hkdf->info_set )
5543 return( PSA_ERROR_BAD_STATE );
5544 hkdf->info_length = data_length;
5545 if( data_length != 0 )
5546 {
5547 hkdf->info = mbedtls_calloc( 1, data_length );
5548 if( hkdf->info == NULL )
5549 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5550 memcpy( hkdf->info, data, data_length );
5551 }
5552 hkdf->info_set = 1;
5553 return( PSA_SUCCESS );
5554 default:
5555 return( PSA_ERROR_INVALID_ARGUMENT );
5556 }
5557}
John Durkop07cc04a2020-11-16 22:08:34 -08005558#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005559
John Durkop07cc04a2020-11-16 22:08:34 -08005560#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5561 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005562static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5563 const uint8_t *data,
5564 size_t data_length )
5565{
5566 if( prf->state != TLS12_PRF_STATE_INIT )
5567 return( PSA_ERROR_BAD_STATE );
5568
Janos Follathd6dce9f2019-07-04 09:11:38 +01005569 if( data_length != 0 )
5570 {
5571 prf->seed = mbedtls_calloc( 1, data_length );
5572 if( prf->seed == NULL )
5573 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005574
Janos Follathd6dce9f2019-07-04 09:11:38 +01005575 memcpy( prf->seed, data, data_length );
5576 prf->seed_length = data_length;
5577 }
Janos Follathf08e2652019-06-13 09:05:41 +01005578
5579 prf->state = TLS12_PRF_STATE_SEED_SET;
5580
5581 return( PSA_SUCCESS );
5582}
5583
Janos Follath81550542019-06-13 14:26:34 +01005584static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5585 psa_algorithm_t hash_alg,
5586 const uint8_t *data,
5587 size_t data_length )
5588{
5589 psa_status_t status;
5590 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5591 return( PSA_ERROR_BAD_STATE );
5592
5593 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5594 if( status != PSA_SUCCESS )
5595 return( status );
5596
5597 prf->state = TLS12_PRF_STATE_KEY_SET;
5598
5599 return( PSA_SUCCESS );
5600}
5601
Janos Follath63028dd2019-06-13 09:15:47 +01005602static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5603 const uint8_t *data,
5604 size_t data_length )
5605{
5606 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5607 return( PSA_ERROR_BAD_STATE );
5608
Janos Follathd6dce9f2019-07-04 09:11:38 +01005609 if( data_length != 0 )
5610 {
5611 prf->label = mbedtls_calloc( 1, data_length );
5612 if( prf->label == NULL )
5613 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005614
Janos Follathd6dce9f2019-07-04 09:11:38 +01005615 memcpy( prf->label, data, data_length );
5616 prf->label_length = data_length;
5617 }
Janos Follath63028dd2019-06-13 09:15:47 +01005618
5619 prf->state = TLS12_PRF_STATE_LABEL_SET;
5620
5621 return( PSA_SUCCESS );
5622}
5623
Janos Follathb03233e2019-06-11 15:30:30 +01005624static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5625 psa_algorithm_t hash_alg,
5626 psa_key_derivation_step_t step,
5627 const uint8_t *data,
5628 size_t data_length )
5629{
Janos Follathb03233e2019-06-11 15:30:30 +01005630 switch( step )
5631 {
Janos Follathf08e2652019-06-13 09:05:41 +01005632 case PSA_KEY_DERIVATION_INPUT_SEED:
5633 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005634 case PSA_KEY_DERIVATION_INPUT_SECRET:
5635 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005636 case PSA_KEY_DERIVATION_INPUT_LABEL:
5637 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005638 default:
5639 return( PSA_ERROR_INVALID_ARGUMENT );
5640 }
5641}
John Durkop07cc04a2020-11-16 22:08:34 -08005642#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5643 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5644
5645#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5646static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5647 psa_tls12_prf_key_derivation_t *prf,
5648 psa_algorithm_t hash_alg,
5649 const uint8_t *data,
5650 size_t data_length )
5651{
5652 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005653 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005654 uint8_t *cur = pms;
5655
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005656 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005657 return( PSA_ERROR_INVALID_ARGUMENT );
5658
5659 /* Quoting RFC 4279, Section 2:
5660 *
5661 * The premaster secret is formed as follows: if the PSK is N octets
5662 * long, concatenate a uint16 with the value N, N zero octets, a second
5663 * uint16 with the value N, and the PSK itself.
5664 */
5665
5666 *cur++ = ( data_length >> 8 ) & 0xff;
5667 *cur++ = ( data_length >> 0 ) & 0xff;
5668 memset( cur, 0, data_length );
5669 cur += data_length;
5670 *cur++ = pms[0];
5671 *cur++ = pms[1];
5672 memcpy( cur, data, data_length );
5673 cur += data_length;
5674
5675 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5676
5677 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5678 return( status );
5679}
Janos Follath6660f0e2019-06-17 08:44:03 +01005680
5681static psa_status_t psa_tls12_prf_psk_to_ms_input(
5682 psa_tls12_prf_key_derivation_t *prf,
5683 psa_algorithm_t hash_alg,
5684 psa_key_derivation_step_t step,
5685 const uint8_t *data,
5686 size_t data_length )
5687{
5688 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005689 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005690 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5691 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005692 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005693
5694 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5695}
John Durkop07cc04a2020-11-16 22:08:34 -08005696#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005697
Gilles Peskineb8965192019-09-24 16:21:10 +02005698/** Check whether the given key type is acceptable for the given
5699 * input step of a key derivation.
5700 *
5701 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5702 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5703 * Both secret and non-secret inputs can alternatively have the type
5704 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5705 * that the input was passed as a buffer rather than via a key object.
5706 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005707static int psa_key_derivation_check_input_type(
5708 psa_key_derivation_step_t step,
5709 psa_key_type_t key_type )
5710{
5711 switch( step )
5712 {
5713 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005714 if( key_type == PSA_KEY_TYPE_DERIVE )
5715 return( PSA_SUCCESS );
5716 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005717 return( PSA_SUCCESS );
5718 break;
5719 case PSA_KEY_DERIVATION_INPUT_LABEL:
5720 case PSA_KEY_DERIVATION_INPUT_SALT:
5721 case PSA_KEY_DERIVATION_INPUT_INFO:
5722 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005723 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5724 return( PSA_SUCCESS );
5725 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005726 return( PSA_SUCCESS );
5727 break;
5728 }
5729 return( PSA_ERROR_INVALID_ARGUMENT );
5730}
5731
Janos Follathb80a94e2019-06-12 15:54:46 +01005732static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005734 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005735 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005736 const uint8_t *data,
5737 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005738{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005739 psa_status_t status;
5740 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5741
5742 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005743 if( status != PSA_SUCCESS )
5744 goto exit;
5745
John Durkopd0321952020-10-29 21:37:36 -07005746#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005747 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005748 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005749 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005750 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005751 step, data, data_length );
5752 }
John Durkop07cc04a2020-11-16 22:08:34 -08005753 else
5754#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5755#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5756 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005757 {
Janos Follathb03233e2019-06-11 15:30:30 +01005758 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5759 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5760 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005761 }
John Durkop07cc04a2020-11-16 22:08:34 -08005762 else
5763#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5764#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5765 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005766 {
5767 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5768 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5769 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005770 }
5771 else
John Durkop07cc04a2020-11-16 22:08:34 -08005772#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005773 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005774 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005775 return( PSA_ERROR_BAD_STATE );
5776 }
5777
Gilles Peskine224b0d62019-09-23 18:13:17 +02005778exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005779 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005780 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005781 return( status );
5782}
5783
Janos Follath51f4a0f2019-06-14 11:35:55 +01005784psa_status_t psa_key_derivation_input_bytes(
5785 psa_key_derivation_operation_t *operation,
5786 psa_key_derivation_step_t step,
5787 const uint8_t *data,
5788 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005789{
Gilles Peskineb8965192019-09-24 16:21:10 +02005790 return( psa_key_derivation_input_internal( operation, step,
5791 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005792 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005793}
5794
Janos Follath51f4a0f2019-06-14 11:35:55 +01005795psa_status_t psa_key_derivation_input_key(
5796 psa_key_derivation_operation_t *operation,
5797 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005798 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005799{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005800 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005801 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005802 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005803
Ronald Cron5c522922020-11-14 16:35:34 +01005804 status = psa_get_and_lock_transparent_key_slot_with_policy(
5805 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005806 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005807 {
5808 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005809 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005810 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005811
5812 /* Passing a key object as a SECRET input unlocks the permission
5813 * to output to a key object. */
5814 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5815 operation->can_output_key = 1;
5816
Ronald Cronf95a2b12020-10-22 15:24:49 +02005817 status = psa_key_derivation_input_internal( operation,
5818 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005819 slot->key.data,
5820 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005821
Ronald Cron5c522922020-11-14 16:35:34 +01005822 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005823
Ronald Cron5c522922020-11-14 16:35:34 +01005824 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005825}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005826
5827
5828
5829/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005830/* Key agreement */
5831/****************************************************************/
5832
John Durkop6ba40d12020-11-10 08:50:04 -08005833#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005834static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5835 size_t peer_key_length,
5836 const mbedtls_ecp_keypair *our_key,
5837 uint8_t *shared_secret,
5838 size_t shared_secret_size,
5839 size_t *shared_secret_length )
5840{
Steven Cooremand4867872020-08-05 16:31:39 +02005841 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005842 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005843 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005844 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005845 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005846 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005847
Ronald Cron90857082020-11-25 14:58:33 +01005848 status = mbedtls_psa_ecp_load_representation(
5849 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5850 peer_key,
5851 peer_key_length,
5852 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005853 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005854 goto exit;
5855
Jaeden Amero97271b32019-01-10 19:38:51 +00005856 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005857 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005858 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005859 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005860 status = mbedtls_to_psa_error(
5861 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5862 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005863 goto exit;
5864
Jaeden Amero97271b32019-01-10 19:38:51 +00005865 status = mbedtls_to_psa_error(
5866 mbedtls_ecdh_calc_secret( &ecdh,
5867 shared_secret_length,
5868 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005869 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005870 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005871 if( status != PSA_SUCCESS )
5872 goto exit;
5873 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5874 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005875
5876exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005877 if( status != PSA_SUCCESS )
5878 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005879 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005880 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005881 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005882
Jaeden Amero97271b32019-01-10 19:38:51 +00005883 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005884}
John Durkop6ba40d12020-11-10 08:50:04 -08005885#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005886
Gilles Peskine01d718c2018-09-18 12:01:02 +02005887#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5888
Gilles Peskine0216fe12019-04-11 21:23:21 +02005889static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5890 psa_key_slot_t *private_key,
5891 const uint8_t *peer_key,
5892 size_t peer_key_length,
5893 uint8_t *shared_secret,
5894 size_t shared_secret_size,
5895 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005896{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005897 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005898 {
John Durkop6ba40d12020-11-10 08:50:04 -08005899#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005900 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005901 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005902 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005903 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005904 psa_status_t status = mbedtls_psa_ecp_load_representation(
5905 private_key->attr.type,
5906 private_key->key.data,
5907 private_key->key.bytes,
5908 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005909 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005910 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005911 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005912 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005913 shared_secret, shared_secret_size,
5914 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005915 mbedtls_ecp_keypair_free( ecp );
5916 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005917 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005918#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005919 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005920 (void) private_key;
5921 (void) peer_key;
5922 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005923 (void) shared_secret;
5924 (void) shared_secret_size;
5925 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005926 return( PSA_ERROR_NOT_SUPPORTED );
5927 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005928}
5929
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005930/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005931 * to potentially free embedded data structures and wipe confidential data.
5932 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005933static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005934 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005935 psa_key_slot_t *private_key,
5936 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005937 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005938{
5939 psa_status_t status;
5940 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5941 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005942 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005943
5944 /* Step 1: run the secret agreement algorithm to generate the shared
5945 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005946 status = psa_key_agreement_raw_internal( ka_alg,
5947 private_key,
5948 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005949 shared_secret,
5950 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005951 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005952 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005953 goto exit;
5954
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005955 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005956 * the shared secret. A shared secret is permitted wherever a key
5957 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005958 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005959 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005960 shared_secret,
5961 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005962exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005963 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005964 return( status );
5965}
5966
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005967psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005968 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005969 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005970 const uint8_t *peer_key,
5971 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005972{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005973 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005974 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005975 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005976
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005977 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005978 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005979 status = psa_get_and_lock_transparent_key_slot_with_policy(
5980 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005981 if( status != PSA_SUCCESS )
5982 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005983 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005984 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005985 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005986 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005987 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005988 else
5989 {
5990 /* If a private key has been added as SECRET, we allow the derived
5991 * key material to be used as a key in PSA Crypto. */
5992 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5993 operation->can_output_key = 1;
5994 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005995
Ronald Cron5c522922020-11-14 16:35:34 +01005996 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005997
Ronald Cron5c522922020-11-14 16:35:34 +01005998 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005999}
6000
Gilles Peskinebe697d82019-05-16 18:00:41 +02006001psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006002 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006003 const uint8_t *peer_key,
6004 size_t peer_key_length,
6005 uint8_t *output,
6006 size_t output_size,
6007 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006008{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006010 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006011 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006012
6013 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6014 {
6015 status = PSA_ERROR_INVALID_ARGUMENT;
6016 goto exit;
6017 }
Ronald Cron5c522922020-11-14 16:35:34 +01006018 status = psa_get_and_lock_transparent_key_slot_with_policy(
6019 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006020 if( status != PSA_SUCCESS )
6021 goto exit;
6022
6023 status = psa_key_agreement_raw_internal( alg, slot,
6024 peer_key, peer_key_length,
6025 output, output_size,
6026 output_length );
6027
6028exit:
6029 if( status != PSA_SUCCESS )
6030 {
6031 /* If an error happens and is not handled properly, the output
6032 * may be used as a key to protect sensitive data. Arrange for such
6033 * a key to be random, which is likely to result in decryption or
6034 * verification errors. This is better than filling the buffer with
6035 * some constant data such as zeros, which would result in the data
6036 * being protected with a reproducible, easily knowable key.
6037 */
6038 psa_generate_random( output, output_size );
6039 *output_length = output_size;
6040 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006041
Ronald Cron5c522922020-11-14 16:35:34 +01006042 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006043
Ronald Cron5c522922020-11-14 16:35:34 +01006044 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006045}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006046
6047
Gilles Peskine30524eb2020-11-13 17:02:26 +01006048
Gilles Peskine86a440b2018-11-12 18:39:40 +01006049/****************************************************************/
6050/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006051/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006052
Gilles Peskine30524eb2020-11-13 17:02:26 +01006053/** Initialize the PSA random generator.
6054 */
6055static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
6056{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006057#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6058 memset( rng, 0, sizeof( *rng ) );
6059#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6060
Gilles Peskine30524eb2020-11-13 17:02:26 +01006061 /* Set default configuration if
6062 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6063 if( rng->entropy_init == NULL )
6064 rng->entropy_init = mbedtls_entropy_init;
6065 if( rng->entropy_free == NULL )
6066 rng->entropy_free = mbedtls_entropy_free;
6067
6068 rng->entropy_init( &rng->entropy );
6069#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6070 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6071 /* The PSA entropy injection feature depends on using NV seed as an entropy
6072 * source. Add NV seed as an entropy source for PSA entropy injection. */
6073 mbedtls_entropy_add_source( &rng->entropy,
6074 mbedtls_nv_seed_poll, NULL,
6075 MBEDTLS_ENTROPY_BLOCK_SIZE,
6076 MBEDTLS_ENTROPY_SOURCE_STRONG );
6077#endif
6078
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006079 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006080#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006081}
6082
6083/** Deinitialize the PSA random generator.
6084 */
6085static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6086{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006087#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6088 memset( rng, 0, sizeof( *rng ) );
6089#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006090 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006091 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006092#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006093}
6094
6095/** Seed the PSA random generator.
6096 */
6097static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6098{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006099#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6100 /* Do nothing: the external RNG seeds itself. */
6101 (void) rng;
6102 return( PSA_SUCCESS );
6103#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006104 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006105 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6106 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006107 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006108#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006109}
6110
Gilles Peskinee59236f2018-01-27 23:32:46 +01006111psa_status_t psa_generate_random( uint8_t *output,
6112 size_t output_size )
6113{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006114 GUARD_MODULE_INITIALIZED;
6115
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006116#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6117
6118 size_t output_length = 0;
6119 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6120 output, output_size,
6121 &output_length );
6122 if( status != PSA_SUCCESS )
6123 return( status );
6124 /* Breaking up a request into smaller chunks is currently not supported
6125 * for the extrernal RNG interface. */
6126 if( output_length != output_size )
6127 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6128 return( PSA_SUCCESS );
6129
6130#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6131
Gilles Peskine71ddab92021-01-04 21:01:07 +01006132 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006133 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006134 size_t request_size =
6135 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6136 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6137 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006138 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6139 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006140 if( ret != 0 )
6141 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006142 output_size -= request_size;
6143 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006144 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006145 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006146#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006147}
6148
Gilles Peskine8814fc42020-12-14 15:33:44 +01006149/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006150 *
6151 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6152 * `psa_generate_random(...)`. The state parameter is ignored since the
6153 * PSA API doesn't support passing an explicit state.
6154 *
6155 * In the non-external case, psa_generate_random() calls an
6156 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6157 * and semantics as mbedtls_psa_get_random(). As an optimization,
6158 * instead of doing this back-and-forth between the PSA API and the
6159 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6160 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006161 */
6162#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6163int mbedtls_psa_get_random( void *p_rng,
6164 unsigned char *output,
6165 size_t output_size )
6166{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006167 /* This function takes a pointer to the RNG state because that's what
6168 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6169 * its own state internally and doesn't let the caller access that state.
6170 * So we just ignore the state parameter, and in practice we'll pass
6171 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006172 (void) p_rng;
6173 psa_status_t status = psa_generate_random( output, output_size );
6174 if( status == PSA_SUCCESS )
6175 return( 0 );
6176 else
6177 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6178}
6179#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6180
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006181#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6182#include "mbedtls/entropy_poll.h"
6183
Gilles Peskine7228da22019-07-15 11:06:15 +02006184psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006185 size_t seed_size )
6186{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006187 if( global_data.initialized )
6188 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006189
6190 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6191 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6192 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6193 return( PSA_ERROR_INVALID_ARGUMENT );
6194
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006195 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006196}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006197#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006198
John Durkop07cc04a2020-11-16 22:08:34 -08006199#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006200static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6201 size_t domain_parameters_size,
6202 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006203{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006204 size_t i;
6205 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006206
Gilles Peskinee56e8782019-04-26 17:34:02 +02006207 if( domain_parameters_size == 0 )
6208 {
6209 *exponent = 65537;
6210 return( PSA_SUCCESS );
6211 }
6212
6213 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6214 * support values that fit in a 32-bit integer, which is larger than
6215 * int on just about every platform anyway. */
6216 if( domain_parameters_size > sizeof( acc ) )
6217 return( PSA_ERROR_NOT_SUPPORTED );
6218 for( i = 0; i < domain_parameters_size; i++ )
6219 acc = ( acc << 8 ) | domain_parameters[i];
6220 if( acc > INT_MAX )
6221 return( PSA_ERROR_NOT_SUPPORTED );
6222 *exponent = acc;
6223 return( PSA_SUCCESS );
6224}
John Durkop07cc04a2020-11-16 22:08:34 -08006225#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006226
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006227static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006228 psa_key_slot_t *slot, size_t bits,
6229 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006230{
Gilles Peskine8e338702019-07-30 20:06:31 +02006231 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006232
Gilles Peskinee56e8782019-04-26 17:34:02 +02006233 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006234 return( PSA_ERROR_INVALID_ARGUMENT );
6235
Gilles Peskinee59236f2018-01-27 23:32:46 +01006236 if( key_type_is_raw_bytes( type ) )
6237 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006238 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006239
6240 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006241 if( status != PSA_SUCCESS )
6242 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006243
6244 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006245 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6246 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006247 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006248
Ronald Cronea0f8a62020-11-25 17:52:23 +01006249 status = psa_generate_random( slot->key.data,
6250 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006251 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006252 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006253
6254 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006255#if defined(MBEDTLS_DES_C)
6256 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006257 psa_des_set_key_parity( slot->key.data,
6258 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006259#endif /* MBEDTLS_DES_C */
6260 }
6261 else
6262
John Durkop07cc04a2020-11-16 22:08:34 -08006263#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006264 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006265 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006266 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006267 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006268 int exponent;
6269 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006270 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6271 return( PSA_ERROR_NOT_SUPPORTED );
6272 /* Accept only byte-aligned keys, for the same reasons as
6273 * in psa_import_rsa_key(). */
6274 if( bits % 8 != 0 )
6275 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006276 status = psa_read_rsa_exponent( domain_parameters,
6277 domain_parameters_size,
6278 &exponent );
6279 if( status != PSA_SUCCESS )
6280 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006281 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6282 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006283 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006284 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006285 (unsigned int) bits,
6286 exponent );
6287 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006288 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006289
6290 /* Make sure to always have an export representation available */
6291 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6292
Steven Cooreman75b74362020-07-28 14:30:13 +02006293 status = psa_allocate_buffer_to_slot( slot, bytes );
6294 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006295 {
6296 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006297 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006298 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006299
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006300 status = mbedtls_psa_rsa_export_key( type,
6301 &rsa,
6302 slot->key.data,
6303 bytes,
6304 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006305 mbedtls_rsa_free( &rsa );
6306 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006307 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006308 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006309 }
6310 else
John Durkop07cc04a2020-11-16 22:08:34 -08006311#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006312
John Durkop9814fa22020-11-04 12:28:15 -08006313#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006314 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006315 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006316 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006317 mbedtls_ecp_group_id grp_id =
6318 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006319 const mbedtls_ecp_curve_info *curve_info =
6320 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006321 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006322 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006323 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006324 return( PSA_ERROR_NOT_SUPPORTED );
6325 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6326 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006327 mbedtls_ecp_keypair_init( &ecp );
6328 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006329 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006330 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006331 if( ret != 0 )
6332 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006333 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006334 return( mbedtls_to_psa_error( ret ) );
6335 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006336
6337
6338 /* Make sure to always have an export representation available */
6339 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006340 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6341 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006342 {
6343 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006344 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006345 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006346
6347 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006348 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006349
6350 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006351 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006352 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006353 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006354 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006355 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006356 }
6357 else
John Durkop9814fa22020-11-04 12:28:15 -08006358#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006359 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006360 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006361 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006362
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006363 return( PSA_SUCCESS );
6364}
Darryl Green0c6575a2018-11-07 16:05:30 +00006365
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006366psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006367 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006368{
6369 psa_status_t status;
6370 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006371 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006372
Ronald Cron81709fc2020-11-14 12:10:32 +01006373 *key = MBEDTLS_SVC_KEY_ID_INIT;
6374
Gilles Peskine0f84d622019-09-12 19:03:13 +02006375 /* Reject any attempt to create a zero-length key so that we don't
6376 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6377 if( psa_get_key_bits( attributes ) == 0 )
6378 return( PSA_ERROR_INVALID_ARGUMENT );
6379
Ronald Cron81709fc2020-11-14 12:10:32 +01006380 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6381 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006382 if( status != PSA_SUCCESS )
6383 goto exit;
6384
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006385 status = psa_driver_wrapper_generate_key( attributes,
6386 slot );
6387 if( status != PSA_ERROR_NOT_SUPPORTED ||
6388 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6389 goto exit;
6390
6391 status = psa_generate_key_internal(
6392 slot, attributes->core.bits,
6393 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006394
6395exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006396 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006397 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006398 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006399 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006400
Darryl Green0c6575a2018-11-07 16:05:30 +00006401 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006402}
6403
6404
Gilles Peskinee59236f2018-01-27 23:32:46 +01006405
6406/****************************************************************/
6407/* Module setup */
6408/****************************************************************/
6409
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006410#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006411psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6412 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6413 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6414{
6415 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6416 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006417 global_data.rng.entropy_init = entropy_init;
6418 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006419 return( PSA_SUCCESS );
6420}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006421#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006422
Gilles Peskinee59236f2018-01-27 23:32:46 +01006423void mbedtls_psa_crypto_free( void )
6424{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006425 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006426 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6427 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006428 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006429 }
6430 /* Wipe all remaining data, including configuration.
6431 * In particular, this sets all state indicator to the value
6432 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006433 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006434#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006435 /* Unregister all secure element drivers, so that we restart from
6436 * a pristine state. */
6437 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006438#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006439}
6440
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006441#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6442/** Recover a transaction that was interrupted by a power failure.
6443 *
6444 * This function is called during initialization, before psa_crypto_init()
6445 * returns. If this function returns a failure status, the initialization
6446 * fails.
6447 */
6448static psa_status_t psa_crypto_recover_transaction(
6449 const psa_crypto_transaction_t *transaction )
6450{
6451 switch( transaction->unknown.type )
6452 {
6453 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6454 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006455 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006456 * is implemented.
6457 * https://github.com/ARMmbed/mbed-crypto/issues/218
6458 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006459 default:
6460 /* We found an unsupported transaction in the storage.
6461 * We don't know what state the storage is in. Give up. */
6462 return( PSA_ERROR_STORAGE_FAILURE );
6463 }
6464}
6465#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6466
Gilles Peskinee59236f2018-01-27 23:32:46 +01006467psa_status_t psa_crypto_init( void )
6468{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006469 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006470
Gilles Peskinec6b69072018-11-20 21:42:52 +01006471 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006472 if( global_data.initialized != 0 )
6473 return( PSA_SUCCESS );
6474
Gilles Peskine30524eb2020-11-13 17:02:26 +01006475 /* Initialize and seed the random generator. */
6476 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006477 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006478 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006479 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006480 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006481 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006482
Gilles Peskine66fb1262018-12-10 16:29:04 +01006483 status = psa_initialize_key_slots( );
6484 if( status != PSA_SUCCESS )
6485 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006486
Gilles Peskined9348f22019-10-01 15:22:29 +02006487#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6488 status = psa_init_all_se_drivers( );
6489 if( status != PSA_SUCCESS )
6490 goto exit;
6491#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6492
Gilles Peskine4b734222019-07-24 15:56:31 +02006493#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006494 status = psa_crypto_load_transaction( );
6495 if( status == PSA_SUCCESS )
6496 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006497 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6498 if( status != PSA_SUCCESS )
6499 goto exit;
6500 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006501 }
6502 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6503 {
6504 /* There's no transaction to complete. It's all good. */
6505 status = PSA_SUCCESS;
6506 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006507#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006508
Gilles Peskinec6b69072018-11-20 21:42:52 +01006509 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006510 global_data.initialized = 1;
6511
6512exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006513 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006514 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006515 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006516}
6517
6518#endif /* MBEDTLS_PSA_CRYPTO_C */