blob: 27cc3c4f1a7c6df6f2434e6c96c84d5b7ef08ad4 [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
Steven Cooremana01795d2020-07-24 22:48:15 +0200539/** Export an RSA key to export representation
540 *
541 * \param[in] type The type of key (public/private) to export
542 * \param[in] rsa The internal RSA representation from which to export
543 * \param[out] data The buffer to export to
544 * \param[in] data_size The length of the buffer to export to
545 * \param[out] data_length The amount of bytes written to \p data
546 */
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100547static psa_status_t mbedtls_psa_rsa_export_key( psa_key_type_t type,
548 mbedtls_rsa_context *rsa,
549 uint8_t *data,
550 size_t data_size,
551 size_t *data_length )
Steven Cooremana01795d2020-07-24 22:48:15 +0200552{
553#if defined(MBEDTLS_PK_WRITE_C)
554 int ret;
555 mbedtls_pk_context pk;
556 uint8_t *pos = data + data_size;
557
558 mbedtls_pk_init( &pk );
559 pk.pk_info = &mbedtls_rsa_info;
560 pk.pk_ctx = rsa;
561
562 /* PSA Crypto API defines the format of an RSA key as a DER-encoded
Steven Cooreman75b74362020-07-28 14:30:13 +0200563 * representation of the non-encrypted PKCS#1 RSAPrivateKey for a
564 * private key and of the RFC3279 RSAPublicKey for a public key. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200565 if( PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
566 ret = mbedtls_pk_write_key_der( &pk, data, data_size );
567 else
568 ret = mbedtls_pk_write_pubkey( &pos, data, &pk );
569
570 if( ret < 0 )
Steven Cooreman4fed4552020-08-03 14:46:03 +0200571 {
572 /* Clean up in case pk_write failed halfway through. */
573 memset( data, 0, data_size );
Steven Cooreman29149862020-08-05 15:43:42 +0200574 return( mbedtls_to_psa_error( ret ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200575 }
Steven Cooremana01795d2020-07-24 22:48:15 +0200576
577 /* The mbedtls_pk_xxx functions write to the end of the buffer.
578 * Move the data to the beginning and erase remaining data
579 * at the original location. */
580 if( 2 * (size_t) ret <= data_size )
581 {
582 memcpy( data, data + data_size - ret, ret );
583 memset( data + data_size - ret, 0, ret );
584 }
585 else if( (size_t) ret < data_size )
586 {
587 memmove( data, data + data_size - ret, ret );
588 memset( data + ret, 0, data_size - ret );
589 }
590
591 *data_length = ret;
592 return( PSA_SUCCESS );
593#else
594 (void) type;
595 (void) rsa;
596 (void) data;
597 (void) data_size;
598 (void) data_length;
599 return( PSA_ERROR_NOT_SUPPORTED );
600#endif /* MBEDTLS_PK_WRITE_C */
601}
602
603/** Import an RSA key from import representation to a slot
604 *
605 * \param[in,out] slot The slot where to store the export representation to
606 * \param[in] data The buffer containing the import representation
607 * \param[in] data_length The amount of bytes in \p data
608 */
609static psa_status_t psa_import_rsa_key( psa_key_slot_t *slot,
610 const uint8_t *data,
611 size_t data_length )
612{
613 psa_status_t status;
614 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200615 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +0200616
Steven Cooremana01795d2020-07-24 22:48:15 +0200617 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100618 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
619 data,
620 data_length,
621 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200622 if( status != PSA_SUCCESS )
623 goto exit;
624
625 slot->attr.bits = (psa_key_bits_t) PSA_BYTES_TO_BITS(
Steven Cooremana2371e52020-07-28 14:30:39 +0200626 mbedtls_rsa_get_len( rsa ) );
Steven Cooremana01795d2020-07-24 22:48:15 +0200627
Steven Cooreman75b74362020-07-28 14:30:13 +0200628 /* Re-export the data to PSA export format, such that we can store export
629 * representation in the key slot. Export representation in case of RSA is
630 * the smallest representation that's allowed as input, so a straight-up
631 * allocation of the same size as the input buffer will be large enough. */
Steven Cooremana01795d2020-07-24 22:48:15 +0200632 output = mbedtls_calloc( 1, data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +0200633 if( output == NULL )
634 {
635 status = PSA_ERROR_INSUFFICIENT_MEMORY;
636 goto exit;
637 }
638
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100639 status = mbedtls_psa_rsa_export_key( slot->attr.type,
640 rsa,
641 output,
642 data_length,
643 &data_length);
Steven Cooremana01795d2020-07-24 22:48:15 +0200644exit:
645 /* Always free the RSA object */
Steven Cooremana2371e52020-07-28 14:30:39 +0200646 mbedtls_rsa_free( rsa );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200647 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +0200648
649 /* Free the allocated buffer only on error. */
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000650 if( status != PSA_SUCCESS )
651 {
Steven Cooremana01795d2020-07-24 22:48:15 +0200652 mbedtls_free( output );
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000653 return( status );
654 }
655
Steven Cooremana01795d2020-07-24 22:48:15 +0200656 /* On success, store the allocated export-formatted key. */
Ronald Cronea0f8a62020-11-25 17:52:23 +0100657 slot->key.data = output;
658 slot->key.bytes = data_length;
Jaeden Amerocd09d8c2019-01-11 17:53:05 +0000659
660 return( PSA_SUCCESS );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200661}
John Durkop6ba40d12020-11-10 08:50:04 -0800662
663#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -0800664 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200665
John Durkop9814fa22020-11-04 12:28:15 -0800666#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800667 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman4fed4552020-08-03 14:46:03 +0200668/** Export an ECP key to export representation
669 *
670 * \param[in] type The type of key (public/private) to export
671 * \param[in] ecp The internal ECP representation from which to export
672 * \param[out] data The buffer to export to
673 * \param[in] data_size The length of the buffer to export to
674 * \param[out] data_length The amount of bytes written to \p data
675 */
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100676static psa_status_t mbedtls_psa_ecp_export_key( psa_key_type_t type,
677 mbedtls_ecp_keypair *ecp,
678 uint8_t *data,
679 size_t data_size,
680 size_t *data_length )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200681{
Steven Cooremanacda8342020-07-24 23:09:52 +0200682 psa_status_t status;
Jaeden Ameroccdce902019-01-10 11:42:27 +0000683
Steven Cooremanacda8342020-07-24 23:09:52 +0200684 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200685 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200686 /* Check whether the public part is loaded */
687 if( mbedtls_ecp_is_zero( &ecp->Q ) )
688 {
689 /* Calculate the public key */
690 status = mbedtls_to_psa_error(
691 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100692 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200693 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200694 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +0200695 }
696
Steven Cooreman4fed4552020-08-03 14:46:03 +0200697 status = mbedtls_to_psa_error(
Steven Cooremanacda8342020-07-24 23:09:52 +0200698 mbedtls_ecp_point_write_binary( &ecp->grp, &ecp->Q,
699 MBEDTLS_ECP_PF_UNCOMPRESSED,
700 data_length,
701 data,
Steven Cooreman4fed4552020-08-03 14:46:03 +0200702 data_size ) );
Steven Cooreman4fed4552020-08-03 14:46:03 +0200703 if( status != PSA_SUCCESS )
704 memset( data, 0, data_size );
705
Steven Cooreman29149862020-08-05 15:43:42 +0200706 return( status );
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200707 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200708 else
709 {
Steven Cooreman29149862020-08-05 15:43:42 +0200710 if( data_size < PSA_BITS_TO_BYTES( ecp->grp.nbits ) )
Steven Cooremanacda8342020-07-24 23:09:52 +0200711 return( PSA_ERROR_BUFFER_TOO_SMALL );
712
713 status = mbedtls_to_psa_error(
714 mbedtls_ecp_write_key( ecp,
715 data,
Steven Cooreman29149862020-08-05 15:43:42 +0200716 PSA_BITS_TO_BYTES( ecp->grp.nbits ) ) );
Steven Cooremanacda8342020-07-24 23:09:52 +0200717 if( status == PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200718 *data_length = PSA_BITS_TO_BYTES( ecp->grp.nbits );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +0200719 else
720 memset( data, 0, data_size );
Steven Cooremanacda8342020-07-24 23:09:52 +0200721
722 return( status );
723 }
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200724}
Gilles Peskineaf89fd72018-06-29 19:52:37 +0200725
Steven Cooreman4fed4552020-08-03 14:46:03 +0200726/** Import an ECP key from import representation to a slot
727 *
728 * \param[in,out] slot The slot where to store the export representation to
729 * \param[in] data The buffer containing the import representation
730 * \param[in] data_length The amount of bytes in \p data
731 */
Steven Cooremanacda8342020-07-24 23:09:52 +0200732static psa_status_t psa_import_ecp_key( psa_key_slot_t *slot,
733 const uint8_t *data,
734 size_t data_length )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100735{
Steven Cooremanacda8342020-07-24 23:09:52 +0200736 psa_status_t status;
737 uint8_t* output = NULL;
Steven Cooremana2371e52020-07-28 14:30:39 +0200738 mbedtls_ecp_keypair *ecp = NULL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100739
Steven Cooremanacda8342020-07-24 23:09:52 +0200740 /* Parse input */
Ronald Cron90857082020-11-25 14:58:33 +0100741 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
742 data,
743 data_length,
744 &ecp );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100745 if( status != PSA_SUCCESS )
746 goto exit;
Gilles Peskine4cd32772019-12-02 20:49:42 +0100747
Steven Cooremanacda8342020-07-24 23:09:52 +0200748 if( PSA_KEY_TYPE_ECC_GET_FAMILY( slot->attr.type ) == PSA_ECC_FAMILY_MONTGOMERY)
Steven Cooremana2371e52020-07-28 14:30:39 +0200749 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits + 1;
Steven Cooremanacda8342020-07-24 23:09:52 +0200750 else
Steven Cooremana2371e52020-07-28 14:30:39 +0200751 slot->attr.bits = (psa_key_bits_t) ecp->grp.nbits;
Steven Cooremane3fd3922020-06-11 16:50:36 +0200752
Steven Cooremanacda8342020-07-24 23:09:52 +0200753 /* Re-export the data to PSA export format. There is currently no support
754 * for other input formats then the export format, so this is a 1-1
755 * copy operation. */
756 output = mbedtls_calloc( 1, data_length );
Steven Cooremanacda8342020-07-24 23:09:52 +0200757 if( output == NULL )
758 {
759 status = PSA_ERROR_INSUFFICIENT_MEMORY;
760 goto exit;
761 }
762
Ronald Cron3c8ca3a2020-11-26 16:45:24 +0100763 status = mbedtls_psa_ecp_export_key( slot->attr.type,
764 ecp,
765 output,
766 data_length,
767 &data_length);
Gilles Peskinef76aa772018-10-29 19:24:33 +0100768exit:
Steven Cooremana2371e52020-07-28 14:30:39 +0200769 /* Always free the PK object (will also free contained ECP context) */
770 mbedtls_ecp_keypair_free( ecp );
Steven Cooreman6d839f02020-07-30 11:36:45 +0200771 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +0200772
773 /* Free the allocated buffer only on error. */
774 if( status != PSA_SUCCESS )
Gilles Peskinef76aa772018-10-29 19:24:33 +0100775 {
Steven Cooremanacda8342020-07-24 23:09:52 +0200776 mbedtls_free( output );
Steven Cooremanacda8342020-07-24 23:09:52 +0200777 return( status );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100778 }
Steven Cooremanacda8342020-07-24 23:09:52 +0200779
780 /* On success, store the allocated export-formatted key. */
Ronald Cronea0f8a62020-11-25 17:52:23 +0100781 slot->key.data = output;
782 slot->key.bytes = data_length;
Steven Cooremanacda8342020-07-24 23:09:52 +0200783
784 return( PSA_SUCCESS );
Gilles Peskinef76aa772018-10-29 19:24:33 +0100785}
John Durkop9814fa22020-11-04 12:28:15 -0800786#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
787 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskinef76aa772018-10-29 19:24:33 +0100788
Gilles Peskineb46bef22019-07-30 21:32:04 +0200789/** Return the size of the key in the given slot, in bits.
790 *
791 * \param[in] slot A key slot.
792 *
793 * \return The key size in bits, read from the metadata in the slot.
794 */
795static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
796{
797 return( slot->attr.bits );
798}
799
Steven Cooreman75b74362020-07-28 14:30:13 +0200800/** Try to allocate a buffer to an empty key slot.
801 *
802 * \param[in,out] slot Key slot to attach buffer to.
803 * \param[in] buffer_length Requested size of the buffer.
804 *
805 * \retval #PSA_SUCCESS
806 * The buffer has been successfully allocated.
807 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
808 * Not enough memory was available for allocation.
809 * \retval #PSA_ERROR_ALREADY_EXISTS
810 * Trying to allocate a buffer to a non-empty key slot.
811 */
812static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
813 size_t buffer_length )
814{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100815 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200816 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200817
Ronald Cronea0f8a62020-11-25 17:52:23 +0100818 slot->key.data = mbedtls_calloc( 1, buffer_length );
819 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200820 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200821
Ronald Cronea0f8a62020-11-25 17:52:23 +0100822 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200823 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200824}
825
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200826psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
827 const uint8_t* data,
828 size_t data_length )
829{
830 psa_status_t status = psa_allocate_buffer_to_slot( slot,
831 data_length );
832 if( status != PSA_SUCCESS )
833 return( status );
834
Ronald Cronea0f8a62020-11-25 17:52:23 +0100835 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200836 return( PSA_SUCCESS );
837}
838
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200839/** Import key data into a slot.
840 *
841 * `slot->type` must have been set previously.
842 * This function assumes that the slot does not contain any key material yet.
843 * On failure, the slot content is unchanged.
844 *
845 * Persistent storage is not affected.
846 *
847 * \param[in,out] slot The key slot to import data into.
848 * Its `type` field must have previously been set to
849 * the desired key type.
850 * It must not contain any key material yet.
851 * \param[in] data Buffer containing the key material to parse and import.
852 * \param data_length Size of \p data in bytes.
853 *
854 * \retval #PSA_SUCCESS
855 * \retval #PSA_ERROR_INVALID_ARGUMENT
856 * \retval #PSA_ERROR_NOT_SUPPORTED
857 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
858 */
859static psa_status_t psa_import_key_into_slot( psa_key_slot_t *slot,
860 const uint8_t *data,
861 size_t data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100862{
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200863 psa_status_t status = PSA_SUCCESS;
Steven Cooreman04524762020-10-13 17:43:44 +0200864 size_t bit_size;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100865
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200866 /* zero-length keys are never supported. */
867 if( data_length == 0 )
868 return( PSA_ERROR_NOT_SUPPORTED );
869
Gilles Peskine8e338702019-07-30 20:06:31 +0200870 if( key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100871 {
Steven Cooreman04524762020-10-13 17:43:44 +0200872 bit_size = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200873
Steven Cooreman75b74362020-07-28 14:30:13 +0200874 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
875 if( data_length > SIZE_MAX / 8 )
876 return( PSA_ERROR_NOT_SUPPORTED );
877
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200878 /* Enforce a size limit, and in particular ensure that the bit
879 * size fits in its representation type. */
Gilles Peskinec744d992019-07-30 17:26:54 +0200880 if( bit_size > PSA_MAX_KEY_BITS )
881 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200882
883 status = validate_unstructured_key_bit_size( slot->attr.type, bit_size );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200884 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200885 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200886
887 /* Allocate memory for the key */
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200888 status = psa_copy_key_material_into_slot( slot, data, data_length );
Steven Cooreman75b74362020-07-28 14:30:13 +0200889 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200890 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200891
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200892 /* Write the actual key size to the slot.
893 * psa_start_key_creation() wrote the size declared by the
894 * caller, which may be 0 (meaning unspecified) or wrong. */
895 slot->attr.bits = (psa_key_bits_t) bit_size;
Steven Cooreman40120f62020-10-29 11:42:22 +0100896
897 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100898 }
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200899 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200900 {
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200901 /* Try validation through accelerators first. */
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200902 psa_key_attributes_t attributes = {
903 .core = slot->attr
904 };
Ronald Cron83282872020-11-22 14:02:39 +0100905
906 status = psa_allocate_buffer_to_slot( slot, data_length );
907 if( status != PSA_SUCCESS )
908 return( status );
909
910 bit_size = slot->attr.bits;
911 status = psa_driver_wrapper_import_key( &attributes,
912 data, data_length,
913 slot->key.data,
914 slot->key.bytes,
915 &slot->key.bytes,
916 &bit_size );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200917 if( status == PSA_SUCCESS )
918 {
Ronald Cron83282872020-11-22 14:02:39 +0100919 if( slot->attr.bits == 0 )
920 slot->attr.bits = (psa_key_bits_t) bit_size;
921 else if( bit_size != slot->attr.bits )
922 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200923
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200924 return( PSA_SUCCESS );
925 }
Ronald Cron83282872020-11-22 14:02:39 +0100926 else
927 {
928 if( status != PSA_ERROR_NOT_SUPPORTED )
929 return( status );
930 }
931
932 mbedtls_platform_zeroize( slot->key.data, data_length );
933 mbedtls_free( slot->key.data );
934 slot->key.data = NULL;
935 slot->key.bytes = 0;
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200936
937 /* Key format is not supported by any accelerator, try software fallback
938 * if present. */
John Durkop9814fa22020-11-04 12:28:15 -0800939#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
940 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200941 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
942 {
Steven Cooreman40120f62020-10-29 11:42:22 +0100943 return( psa_import_ecp_key( slot, data, data_length ) );
944 }
John Durkop9814fa22020-11-04 12:28:15 -0800945#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
946 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700947#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
948 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooreman40120f62020-10-29 11:42:22 +0100949 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200950 {
Steven Cooreman40120f62020-10-29 11:42:22 +0100951 return( psa_import_rsa_key( slot, data, data_length ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200952 }
John Durkop9814fa22020-11-04 12:28:15 -0800953#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
954 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Steven Cooreman40120f62020-10-29 11:42:22 +0100955
956 /* Fell through the fallback as well, so have nothing else to try. */
957 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100958 }
959 else
Gilles Peskinec66ea6a2018-02-03 22:43:28 +0100960 {
Steven Cooreman19fd5742020-07-24 23:31:01 +0200961 /* Unknown key type */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100962 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969ac722018-01-28 18:16:59 +0100963 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100964}
965
Gilles Peskinef603c712019-01-19 13:40:11 +0100966/** Calculate the intersection of two algorithm usage policies.
967 *
968 * Return 0 (which allows no operation) on incompatibility.
969 */
970static psa_algorithm_t psa_key_policy_algorithm_intersection(
971 psa_algorithm_t alg1,
972 psa_algorithm_t alg2 )
973{
Gilles Peskine549ea862019-05-22 11:45:59 +0200974 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100975 if( alg1 == alg2 )
976 return( alg1 );
977 /* If the policies are from the same hash-and-sign family, check
978 * if one is a wildcard. If so the other has the specific algorithm. */
979 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
980 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
981 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
982 {
983 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
984 return( alg2 );
985 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
986 return( alg1 );
987 }
988 /* If the policies are incompatible, allow nothing. */
989 return( 0 );
990}
991
Gilles Peskined6f371b2019-05-10 19:33:38 +0200992static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
993 psa_algorithm_t requested_alg )
994{
Gilles Peskine549ea862019-05-22 11:45:59 +0200995 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200996 if( requested_alg == policy_alg )
997 return( 1 );
998 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200999 * and requested_alg is the same hash-and-sign family with any hash,
1000 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +02001001 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
1002 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
1003 {
1004 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
1005 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
1006 }
Steven Cooremance48e852020-10-05 16:02:45 +02001007 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001008 * a key derivation with that key agreement should also be allowed. This
1009 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +02001010 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
1011 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
1012 {
1013 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
1014 policy_alg );
1015 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001016 /* If it isn't permitted, it's forbidden. */
1017 return( 0 );
1018}
1019
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001020/** Test whether a policy permits an algorithm.
1021 *
1022 * The caller must test usage flags separately.
1023 */
1024static int psa_key_policy_permits( const psa_key_policy_t *policy,
1025 psa_algorithm_t alg )
1026{
Gilles Peskined6f371b2019-05-10 19:33:38 +02001027 return( psa_key_algorithm_permits( policy->alg, alg ) ||
1028 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001029}
1030
Gilles Peskinef603c712019-01-19 13:40:11 +01001031/** Restrict a key policy based on a constraint.
1032 *
1033 * \param[in,out] policy The policy to restrict.
1034 * \param[in] constraint The policy constraint to apply.
1035 *
1036 * \retval #PSA_SUCCESS
1037 * \c *policy contains the intersection of the original value of
1038 * \c *policy and \c *constraint.
1039 * \retval #PSA_ERROR_INVALID_ARGUMENT
1040 * \c *policy and \c *constraint are incompatible.
1041 * \c *policy is unchanged.
1042 */
1043static psa_status_t psa_restrict_key_policy(
1044 psa_key_policy_t *policy,
1045 const psa_key_policy_t *constraint )
1046{
1047 psa_algorithm_t intersection_alg =
1048 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001049 psa_algorithm_t intersection_alg2 =
1050 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001051 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
1052 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +02001053 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
1054 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 policy->usage &= constraint->usage;
1056 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001057 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +01001058 return( PSA_SUCCESS );
1059}
1060
Ronald Cron5c522922020-11-14 16:35:34 +01001061/** Get the description of a key given its identifier and policy constraints
1062 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001063 *
Ronald Cron5c522922020-11-14 16:35:34 +01001064 * The key must have allow all the usage flags set in \p usage. If \p alg is
1065 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +01001066 *
Ronald Cron5c522922020-11-14 16:35:34 +01001067 * In case of a persistent key, the function loads the description of the key
1068 * into a key slot if not already done.
1069 *
1070 * On success, the returned key slot is locked. It is the responsibility of
1071 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001072 */
Ronald Cron5c522922020-11-14 16:35:34 +01001073static psa_status_t psa_get_and_lock_key_slot_with_policy(
1074 mbedtls_svc_key_id_t key,
1075 psa_key_slot_t **p_slot,
1076 psa_key_usage_t usage,
1077 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +01001078{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1080 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001081
Ronald Cron5c522922020-11-14 16:35:34 +01001082 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +01001083 if( status != PSA_SUCCESS )
1084 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001085 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001086
1087 /* Enforce that usage policy for the key slot contains all the flags
1088 * required by the usage parameter. There is one exception: public
1089 * keys can always be exported, so we treat public key objects as
1090 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001091 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +01001092 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001093
1094 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +02001095 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001096 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001097
1098 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +02001099 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02001100 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +01001101
Darryl Green06fd18d2018-07-16 11:21:11 +01001102 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001103
1104error:
1105 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +01001106 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001107
1108 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +01001109}
Darryl Green940d72c2018-07-13 13:18:51 +01001110
Ronald Cron5c522922020-11-14 16:35:34 +01001111/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001112 *
1113 * A transparent key is a key for which the key material is directly
1114 * available, as opposed to a key in a secure element.
1115 *
Ronald Cron5c522922020-11-14 16:35:34 +01001116 * This is a temporary function to use instead of
1117 * psa_get_and_lock_key_slot_with_policy() until secure element support is
1118 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001119 *
Ronald Cron5c522922020-11-14 16:35:34 +01001120 * On success, the returned key slot is locked. It is the responsibility of the
1121 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001122 */
1123#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +01001124static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1125 mbedtls_svc_key_id_t key,
1126 psa_key_slot_t **p_slot,
1127 psa_key_usage_t usage,
1128 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001129{
Ronald Cron5c522922020-11-14 16:35:34 +01001130 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
1131 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001132 if( status != PSA_SUCCESS )
1133 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001134
Gilles Peskineadad8132019-07-25 11:31:23 +02001135 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001136 {
Ronald Cron5c522922020-11-14 16:35:34 +01001137 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +02001138 *p_slot = NULL;
1139 return( PSA_ERROR_NOT_SUPPORTED );
1140 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001141
Gilles Peskine28f8f302019-07-24 13:30:31 +02001142 return( PSA_SUCCESS );
1143}
1144#else /* MBEDTLS_PSA_CRYPTO_SE_C */
1145/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +01001146#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
1147 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +02001148#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1149
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001150/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +01001151static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +00001152{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001153 /* Data pointer will always be either a valid pointer or NULL in an
1154 * initialized slot, so we can just free it. */
1155 if( slot->key.data != NULL )
1156 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
1157
1158 mbedtls_free( slot->key.data );
1159 slot->key.data = NULL;
1160 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001161
1162 return( PSA_SUCCESS );
1163}
1164
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001165/** Completely wipe a slot in memory, including its policy.
1166 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +01001167psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001168{
1169 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +01001170
1171 /*
1172 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001173 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001174 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1175 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001176 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001177 */
Ronald Cron5c522922020-11-14 16:35:34 +01001178 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +01001179 {
1180#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +01001181 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +01001182#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001183 status = PSA_ERROR_CORRUPTION_DETECTED;
1184 }
1185
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001186 /* Multipart operations may still be using the key. This is safe
1187 * because all multipart operation objects are independent from
1188 * the key slot: if they need to access the key after the setup
1189 * phase, they have a copy of the key. Note that this means that
1190 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001191 /* At this point, key material and other type-specific content has
1192 * been wiped. Clear remaining metadata. We can call memset and not
1193 * zeroize because the metadata is not particularly sensitive. */
1194 memset( slot, 0, sizeof( *slot ) );
1195 return( status );
1196}
1197
Ronald Croncf56a0a2020-08-04 09:51:30 +02001198psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001199{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001200 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001201 psa_status_t status; /* status of the last operation */
1202 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001203#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1204 psa_se_drv_table_entry_t *driver;
1205#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001206
Ronald Croncf56a0a2020-08-04 09:51:30 +02001207 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +02001208 return( PSA_SUCCESS );
1209
Ronald Cronf2911112020-10-29 17:51:10 +01001210 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001211 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001212 * key, this will load the key description from persistent memory if not
1213 * done yet. We cannot avoid this loading as without it we don't know if
1214 * the key is operated by an SE or not and this information is needed by
1215 * the current implementation.
1216 */
Ronald Cron5c522922020-11-14 16:35:34 +01001217 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001218 if( status != PSA_SUCCESS )
1219 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +02001220
Ronald Cronf2911112020-10-29 17:51:10 +01001221 /*
1222 * If the key slot containing the key description is under access by the
1223 * library (apart from the present access), the key cannot be destroyed
1224 * yet. For the time being, just return in error. Eventually (to be
1225 * implemented), the key should be destroyed when all accesses have
1226 * stopped.
1227 */
Ronald Cron5c522922020-11-14 16:35:34 +01001228 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +01001229 {
Ronald Cron5c522922020-11-14 16:35:34 +01001230 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +01001231 return( PSA_ERROR_GENERIC_ERROR );
1232 }
1233
Gilles Peskine354f7672019-07-12 23:46:38 +02001234#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02001235 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +02001236 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +02001237 {
Gilles Peskine60450a42019-07-25 11:32:45 +02001238 /* For a key in a secure element, we need to do three things:
1239 * remove the key file in internal storage, destroy the
1240 * key inside the secure element, and update the driver's
1241 * persistent data. Start a transaction that will encompass these
1242 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001243 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +02001244 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001245 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02001246 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +02001247 status = psa_crypto_save_transaction( );
1248 if( status != PSA_SUCCESS )
1249 {
Gilles Peskine66be51c2019-07-25 18:02:52 +02001250 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001251 /* We should still try to destroy the key in the secure
1252 * element and the key metadata in storage. This is especially
1253 * important if the error is that the storage is full.
1254 * But how to do it exactly without risking an inconsistent
1255 * state after a reset?
1256 * https://github.com/ARMmbed/mbed-crypto/issues/215
1257 */
1258 overall_status = status;
1259 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001260 }
1261
Ronald Cronea0f8a62020-11-25 17:52:23 +01001262 status = psa_destroy_se_key( driver,
1263 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 if( overall_status == PSA_SUCCESS )
1265 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001266 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001267#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1268
Darryl Greend49a4992018-06-18 17:27:26 +01001269#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +02001270 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +01001271 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001272 status = psa_destroy_persistent_key( slot->attr.id );
1273 if( overall_status == PSA_SUCCESS )
1274 overall_status = status;
1275
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001276 /* TODO: other slots may have a copy of the same key. We should
1277 * invalidate them.
1278 * https://github.com/ARMmbed/mbed-crypto/issues/214
1279 */
Darryl Greend49a4992018-06-18 17:27:26 +01001280 }
1281#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001282
Gilles Peskinefc762652019-07-22 19:30:34 +02001283#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1284 if( driver != NULL )
1285 {
Gilles Peskine725f22a2019-07-25 11:31:48 +02001286 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287 if( overall_status == PSA_SUCCESS )
1288 overall_status = status;
1289 status = psa_crypto_stop_transaction( );
1290 if( overall_status == PSA_SUCCESS )
1291 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +02001292 }
1293#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1294
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001295#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1296exit:
1297#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001298 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001299 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
1300 if( overall_status == PSA_SUCCESS )
1301 overall_status = status;
1302 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001303}
1304
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001305void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +02001306{
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001308 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +02001309}
1310
Gilles Peskineb699f072019-04-26 16:06:02 +02001311psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1312 psa_key_type_t type,
1313 const uint8_t *data,
1314 size_t data_length )
1315{
1316 uint8_t *copy = NULL;
1317
1318 if( data_length != 0 )
1319 {
1320 copy = mbedtls_calloc( 1, data_length );
1321 if( copy == NULL )
1322 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1323 memcpy( copy, data, data_length );
1324 }
1325 /* After this point, this function is guaranteed to succeed, so it
1326 * can start modifying `*attributes`. */
1327
1328 if( attributes->domain_parameters != NULL )
1329 {
1330 mbedtls_free( attributes->domain_parameters );
1331 attributes->domain_parameters = NULL;
1332 attributes->domain_parameters_size = 0;
1333 }
1334
1335 attributes->domain_parameters = copy;
1336 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001337 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001338 return( PSA_SUCCESS );
1339}
1340
1341psa_status_t psa_get_key_domain_parameters(
1342 const psa_key_attributes_t *attributes,
1343 uint8_t *data, size_t data_size, size_t *data_length )
1344{
1345 if( attributes->domain_parameters_size > data_size )
1346 return( PSA_ERROR_BUFFER_TOO_SMALL );
1347 *data_length = attributes->domain_parameters_size;
1348 if( attributes->domain_parameters_size != 0 )
1349 memcpy( data, attributes->domain_parameters,
1350 attributes->domain_parameters_size );
1351 return( PSA_SUCCESS );
1352}
1353
John Durkop07cc04a2020-11-16 22:08:34 -08001354#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001355 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001356static psa_status_t psa_get_rsa_public_exponent(
1357 const mbedtls_rsa_context *rsa,
1358 psa_key_attributes_t *attributes )
1359{
1360 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001361 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001362 uint8_t *buffer = NULL;
1363 size_t buflen;
1364 mbedtls_mpi_init( &mpi );
1365
1366 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1367 if( ret != 0 )
1368 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001369 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1370 {
1371 /* It's the default value, which is reported as an empty string,
1372 * so there's nothing to do. */
1373 goto exit;
1374 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001375
1376 buflen = mbedtls_mpi_size( &mpi );
1377 buffer = mbedtls_calloc( 1, buflen );
1378 if( buffer == NULL )
1379 {
1380 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1381 goto exit;
1382 }
1383 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1384 if( ret != 0 )
1385 goto exit;
1386 attributes->domain_parameters = buffer;
1387 attributes->domain_parameters_size = buflen;
1388
1389exit:
1390 mbedtls_mpi_free( &mpi );
1391 if( ret != 0 )
1392 mbedtls_free( buffer );
1393 return( mbedtls_to_psa_error( ret ) );
1394}
John Durkop07cc04a2020-11-16 22:08:34 -08001395#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001396 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001397
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001398/** Retrieve all the publicly-accessible attributes of a key.
1399 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001400psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001401 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001402{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001404 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001405 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001406
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001407 psa_reset_key_attributes( attributes );
1408
Ronald Cron5c522922020-11-14 16:35:34 +01001409 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001410 if( status != PSA_SUCCESS )
1411 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001412
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001413 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001414 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1415 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1416
1417#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1418 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001419 psa_set_key_slot_number( attributes,
1420 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001421#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001422
Gilles Peskine8e338702019-07-30 20:06:31 +02001423 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001424 {
John Durkop07cc04a2020-11-16 22:08:34 -08001425#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001426 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001427 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001428 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001429#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001430 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001431 * is not yet implemented.
1432 * https://github.com/ARMmbed/mbed-crypto/issues/216
1433 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001434 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001435 break;
1436#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001437 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001438 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001439
Ronald Cron90857082020-11-25 14:58:33 +01001440 status = mbedtls_psa_rsa_load_representation(
1441 slot->attr.type,
1442 slot->key.data,
1443 slot->key.bytes,
1444 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001445 if( status != PSA_SUCCESS )
1446 break;
1447
Steven Cooremana2371e52020-07-28 14:30:39 +02001448 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001449 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001450 mbedtls_rsa_free( rsa );
1451 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001452 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001453 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001454#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001455 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001456 default:
1457 /* Nothing else to do. */
1458 break;
1459 }
1460
1461 if( status != PSA_SUCCESS )
1462 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001463
Ronald Cron5c522922020-11-14 16:35:34 +01001464 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001465
Ronald Cron5c522922020-11-14 16:35:34 +01001466 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001467}
1468
Gilles Peskinec8000c02019-08-02 20:15:51 +02001469#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1470psa_status_t psa_get_key_slot_number(
1471 const psa_key_attributes_t *attributes,
1472 psa_key_slot_number_t *slot_number )
1473{
1474 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1475 {
1476 *slot_number = attributes->slot_number;
1477 return( PSA_SUCCESS );
1478 }
1479 else
1480 return( PSA_ERROR_INVALID_ARGUMENT );
1481}
1482#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1483
Ronald Crond18b5f82020-11-25 16:46:05 +01001484static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1485 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001486 uint8_t *data,
1487 size_t data_size,
1488 size_t *data_length )
1489{
Ronald Crond18b5f82020-11-25 16:46:05 +01001490 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001491 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001492 memcpy( data, key_buffer, key_buffer_size );
1493 memset( data + key_buffer_size, 0,
1494 data_size - key_buffer_size );
1495 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001496 return( PSA_SUCCESS );
1497}
1498
Ronald Cron7285cda2020-11-26 14:46:37 +01001499psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001500 const psa_key_attributes_t *attributes,
1501 const uint8_t *key_buffer, size_t key_buffer_size,
1502 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001503{
Ronald Crond18b5f82020-11-25 16:46:05 +01001504 psa_key_type_t type = attributes->core.type;
1505
Ronald Crond18b5f82020-11-25 16:46:05 +01001506 if( key_type_is_raw_bytes( type ) ||
1507 PSA_KEY_TYPE_IS_RSA( type ) ||
1508 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001509 {
1510 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001511 key_buffer, key_buffer_size,
1512 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001513 }
1514 else
1515 {
1516 /* This shouldn't happen in the reference implementation, but
1517 it is valid for a special-purpose implementation to omit
1518 support for exporting certain key types. */
1519 return( PSA_ERROR_NOT_SUPPORTED );
1520 }
1521}
1522
1523psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1524 uint8_t *data,
1525 size_t data_size,
1526 size_t *data_length )
1527{
1528 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1529 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1530 psa_key_slot_t *slot;
1531
1532 /* Set the key to empty now, so that even when there are errors, we always
1533 * set data_length to a value between 0 and data_size. On error, setting
1534 * the key to empty is a good choice because an empty key representation is
1535 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001536 *data_length = 0;
1537
Ronald Cron9486f9d2020-11-26 13:36:23 +01001538 /* Export requires the EXPORT flag. There is an exception for public keys,
1539 * which don't require any flag, but
1540 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1541 */
1542 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1543 PSA_KEY_USAGE_EXPORT, 0 );
1544 if( status != PSA_SUCCESS )
1545 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001546
Gilles Peskinef9168942019-09-12 19:20:29 +02001547 /* Reject a zero-length output buffer now, since this can never be a
1548 * valid key representation. This way we know that data must be a valid
1549 * pointer and we can do things like memset(data, ..., data_size). */
1550 if( data_size == 0 )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001551 {
1552 status = PSA_ERROR_BUFFER_TOO_SMALL;
1553 goto exit;
1554 }
1555
Ronald Crond18b5f82020-11-25 16:46:05 +01001556 psa_key_attributes_t attributes = {
1557 .core = slot->attr
1558 };
Ronald Cron67227982020-11-26 15:16:05 +01001559 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001560 slot->key.data, slot->key.bytes,
1561 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001562
1563exit:
1564 unlock_status = psa_unlock_key_slot( slot );
1565
1566 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1567}
1568
Ronald Cron7285cda2020-11-26 14:46:37 +01001569psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001570 const psa_key_attributes_t *attributes,
1571 const uint8_t *key_buffer,
1572 size_t key_buffer_size,
1573 uint8_t *data,
1574 size_t data_size,
1575 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001576{
Ronald Cron67227982020-11-26 15:16:05 +01001577 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crond18b5f82020-11-25 16:46:05 +01001578 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001579
Ronald Crond18b5f82020-11-25 16:46:05 +01001580 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001581 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001582 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001583 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001584 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001585 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001586 key_buffer, key_buffer_size,
1587 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001588 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001589
Ronald Crond18b5f82020-11-25 16:46:05 +01001590 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001591 {
John Durkop0e005192020-10-31 22:06:54 -07001592#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1593 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001594 mbedtls_rsa_context *rsa = NULL;
Ronald Crond18b5f82020-11-25 16:46:05 +01001595 status = mbedtls_psa_rsa_load_representation( type,
1596 key_buffer,
1597 key_buffer_size,
Ronald Cron90857082020-11-25 14:58:33 +01001598 &rsa );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001599 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001600 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02001601
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01001602 status = mbedtls_psa_rsa_export_key( PSA_KEY_TYPE_RSA_PUBLIC_KEY,
1603 rsa,
1604 data,
1605 data_size,
1606 data_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02001607
Steven Cooremana2371e52020-07-28 14:30:39 +02001608 mbedtls_rsa_free( rsa );
1609 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001610
Steven Cooreman560c28a2020-07-24 23:20:24 +02001611 return( status );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001612#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001613 /* We don't know how to convert a private RSA key to public. */
1614 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001615#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1616 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001617 }
1618 else
Moran Pekera998bc62018-04-16 18:16:20 +03001619 {
John Durkop6ba40d12020-11-10 08:50:04 -08001620#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1621 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Steven Cooremana2371e52020-07-28 14:30:39 +02001622 mbedtls_ecp_keypair *ecp = NULL;
Ronald Crond18b5f82020-11-25 16:46:05 +01001623 status = mbedtls_psa_ecp_load_representation( type,
1624 key_buffer,
1625 key_buffer_size,
Ronald Cron90857082020-11-25 14:58:33 +01001626 &ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001627 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001628 return( status );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001629
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01001630 status = mbedtls_psa_ecp_export_key(
1631 PSA_KEY_TYPE_ECC_PUBLIC_KEY(
Ronald Crond18b5f82020-11-25 16:46:05 +01001632 PSA_KEY_TYPE_ECC_GET_FAMILY( type ) ),
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01001633 ecp,
1634 data,
1635 data_size,
1636 data_length );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001637
Steven Cooremana2371e52020-07-28 14:30:39 +02001638 mbedtls_ecp_keypair_free( ecp );
1639 mbedtls_free( ecp );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001640 return( status );
1641#else
1642 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001643 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001644#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1645 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001646 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001647 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001648 else
1649 {
1650 /* This shouldn't happen in the reference implementation, but
1651 it is valid for a special-purpose implementation to omit
1652 support for exporting certain key types. */
1653 return( PSA_ERROR_NOT_SUPPORTED );
1654 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001655}
Ronald Crond18b5f82020-11-25 16:46:05 +01001656
Ronald Croncf56a0a2020-08-04 09:51:30 +02001657psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001658 uint8_t *data,
1659 size_t data_size,
1660 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001661{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001662 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001663 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001664 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001665
1666 /* Set the key to empty now, so that even when there are errors, we always
1667 * set data_length to a value between 0 and data_size. On error, setting
1668 * the key to empty is a good choice because an empty key representation is
1669 * unlikely to be accepted anywhere. */
1670 *data_length = 0;
1671
1672 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001673 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001674 if( status != PSA_SUCCESS )
1675 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001676
Ronald Cron9486f9d2020-11-26 13:36:23 +01001677 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1678 {
1679 status = PSA_ERROR_INVALID_ARGUMENT;
1680 goto exit;
1681 }
1682
1683 /* Reject a zero-length output buffer now, since this can never be a
1684 * valid key representation. This way we know that data must be a valid
1685 * pointer and we can do things like memset(data, ..., data_size). */
1686 if( data_size == 0 )
1687 {
1688 status = PSA_ERROR_BUFFER_TOO_SMALL;
1689 goto exit;
1690 }
1691
Ronald Crond18b5f82020-11-25 16:46:05 +01001692 psa_key_attributes_t attributes = {
1693 .core = slot->attr
1694 };
Ronald Cron67227982020-11-26 15:16:05 +01001695 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001696 &attributes, slot->key.data, slot->key.bytes,
1697 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001698
1699exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001700 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001701
Ronald Cron5c522922020-11-14 16:35:34 +01001702 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001703}
1704
Gilles Peskine91e8c332019-08-02 19:19:39 +02001705#if defined(static_assert)
1706static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1707 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001708static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001709 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001710static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001711 "One or more key attribute flag is listed as both internal-only and external-only" );
1712#endif
1713
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001714/** Validate that a key policy is internally well-formed.
1715 *
1716 * This function only rejects invalid policies. It does not validate the
1717 * consistency of the policy with respect to other attributes of the key
1718 * such as the key type.
1719 */
1720static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001721{
1722 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001723 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001724 PSA_KEY_USAGE_ENCRYPT |
1725 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001726 PSA_KEY_USAGE_SIGN_HASH |
1727 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001728 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1729 return( PSA_ERROR_INVALID_ARGUMENT );
1730
Gilles Peskine4747d192019-04-17 15:05:45 +02001731 return( PSA_SUCCESS );
1732}
1733
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001734/** Validate the internal consistency of key attributes.
1735 *
1736 * This function only rejects invalid attribute values. If does not
1737 * validate the consistency of the attributes with any key data that may
1738 * be involved in the creation of the key.
1739 *
1740 * Call this function early in the key creation process.
1741 *
1742 * \param[in] attributes Key attributes for the new key.
1743 * \param[out] p_drv On any return, the driver for the key, if any.
1744 * NULL for a transparent key.
1745 *
1746 */
1747static psa_status_t psa_validate_key_attributes(
1748 const psa_key_attributes_t *attributes,
1749 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001750{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001751 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001752 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001753 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001754
Ronald Cron54b90082020-10-29 15:26:43 +01001755 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001756 if( status != PSA_SUCCESS )
1757 return( status );
1758
Ronald Crond2ed4812020-07-17 16:11:30 +02001759 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001760 if( status != PSA_SUCCESS )
1761 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001762
Ronald Cron65f38a32020-10-23 17:11:13 +02001763 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1764 {
1765 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1766 return( PSA_ERROR_INVALID_ARGUMENT );
1767 }
1768 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001769 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001770 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001771 if( status != PSA_SUCCESS )
1772 return( status );
1773 }
1774
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001775 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001776 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001777 return( status );
1778
1779 /* Refuse to create overly large keys.
1780 * Note that this doesn't trigger on import if the attributes don't
1781 * explicitly specify a size (so psa_get_key_bits returns 0), so
1782 * psa_import_key() needs its own checks. */
1783 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1784 return( PSA_ERROR_NOT_SUPPORTED );
1785
Gilles Peskine91e8c332019-08-02 19:19:39 +02001786 /* Reject invalid flags. These should not be reachable through the API. */
1787 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1788 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1789 return( PSA_ERROR_INVALID_ARGUMENT );
1790
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001791 return( PSA_SUCCESS );
1792}
1793
Gilles Peskine4747d192019-04-17 15:05:45 +02001794/** Prepare a key slot to receive key material.
1795 *
1796 * This function allocates a key slot and sets its metadata.
1797 *
1798 * If this function fails, call psa_fail_key_creation().
1799 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001800 * This function is intended to be used as follows:
1801 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001802 * it with the specified attributes, and in case of a volatile key assign it
1803 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001804 * -# Populate the slot with the key material.
1805 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1806 * In case of failure at any step, stop the sequence and call
1807 * psa_fail_key_creation().
1808 *
Ronald Cron5c522922020-11-14 16:35:34 +01001809 * On success, the key slot is locked. It is the responsibility of the caller
1810 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001811 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001812 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001813 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001814 * \param[out] p_slot On success, a pointer to the prepared slot.
1815 * \param[out] p_drv On any return, the driver for the key, if any.
1816 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001817 *
1818 * \retval #PSA_SUCCESS
1819 * The key slot is ready to receive key material.
1820 * \return If this function fails, the key slot is an invalid state.
1821 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001822 */
1823static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001824 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001825 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001826 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001827 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001828{
1829 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001830 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001831 psa_key_slot_t *slot;
1832
Gilles Peskinedf179142019-07-15 22:02:14 +02001833 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001834 *p_drv = NULL;
1835
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001836 status = psa_validate_key_attributes( attributes, p_drv );
1837 if( status != PSA_SUCCESS )
1838 return( status );
1839
Ronald Cronc4d1b512020-07-31 11:26:37 +02001840 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001841 if( status != PSA_SUCCESS )
1842 return( status );
1843 slot = *p_slot;
1844
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001845 /* We're storing the declared bit-size of the key. It's up to each
1846 * creation mechanism to verify that this information is correct.
1847 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001848 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001849 * is optional (import, copy). In case of a volatile key, assign it the
1850 * volatile key identifier associated to the slot returned to contain its
1851 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001852
1853 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001854 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1855 {
1856#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1857 slot->attr.id = volatile_key_id;
1858#else
1859 slot->attr.id.key_id = volatile_key_id;
1860#endif
1861 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001862
Gilles Peskine91e8c332019-08-02 19:19:39 +02001863 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001864 * external-only flags, query `attributes`. Thanks to the check
1865 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001866 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001867 * may have set. */
1868 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001869
Gilles Peskinecbaff462019-07-12 23:46:04 +02001870#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001871 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001872 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001873 * create the key file in internal storage, create the
1874 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001875 * persistent data. This is done by starting a transaction that will
1876 * encompass these three actions.
1877 * For registering a volatile key, we just need to find an appropriate
1878 * slot number inside the SE. Since the key is designated volatile, creating
1879 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001880 /* The first thing to do is to find a slot number for the new key.
1881 * We save the slot number in persistent storage as part of the
1882 * transaction data. It will be needed to recover if the power
1883 * fails during the key creation process, to clean up on the secure
1884 * element side after restarting. Obtaining a slot number from the
1885 * secure element driver updates its persistent state, but we do not yet
1886 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001887 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001888 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001889 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001890 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001891 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001892 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001893 if( status != PSA_SUCCESS )
1894 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001895
1896 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001897 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001898 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1899 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001900 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001901 psa_crypto_transaction.key.id = slot->attr.id;
1902 status = psa_crypto_save_transaction( );
1903 if( status != PSA_SUCCESS )
1904 {
1905 (void) psa_crypto_stop_transaction( );
1906 return( status );
1907 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001908 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001909
1910 status = psa_copy_key_material_into_slot(
1911 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001912 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001913
1914 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1915 {
1916 /* Key registration only makes sense with a secure element. */
1917 return( PSA_ERROR_INVALID_ARGUMENT );
1918 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001919#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1920
Ronald Cronc4d1b512020-07-31 11:26:37 +02001921 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001922}
Gilles Peskine4747d192019-04-17 15:05:45 +02001923
1924/** Finalize the creation of a key once its key material has been set.
1925 *
1926 * This entails writing the key to persistent storage.
1927 *
1928 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001929 * See the documentation of psa_start_key_creation() for the intended use
1930 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001931 *
Ronald Cron5c522922020-11-14 16:35:34 +01001932 * If the finalization succeeds, the function unlocks the key slot (it was
1933 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1934 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001935 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001936 * \param[in,out] slot Pointer to the slot with key material.
1937 * \param[in] driver The secure element driver for the key,
1938 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001939 * \param[out] key On success, identifier of the key. Note that the
1940 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001941 *
1942 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001943 * The key was successfully created.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001944 * \return If this function fails, the key slot is an invalid state.
1945 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001946 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001947static psa_status_t psa_finish_key_creation(
1948 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001949 psa_se_drv_table_entry_t *driver,
1950 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001951{
1952 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001953 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001954 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001955
1956#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001957 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001959#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1960 if( driver != NULL )
1961 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001962 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001963 psa_key_slot_number_t slot_number =
1964 psa_key_slot_get_slot_number( slot ) ;
1965
Gilles Peskineb46bef22019-07-30 21:32:04 +02001966#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001967 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001968 sizeof( data.slot_number ),
1969 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001970#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001971 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001972 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001973 (uint8_t*) &data,
1974 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001975 }
1976 else
1977#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1978 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001979 /* Key material is saved in export representation in the slot, so
1980 * just pass the slot buffer for storage. */
1981 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001982 slot->key.data,
1983 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001984 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001985 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001986#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1987
Gilles Peskinecbaff462019-07-12 23:46:04 +02001988#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001989 /* Finish the transaction for a key creation. This does not
1990 * happen when registering an existing key. Detect this case
1991 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001992 * creation of a persistent key in a secure element requires a transaction,
1993 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001994 if( driver != NULL &&
1995 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001996 {
1997 status = psa_save_se_persistent_data( driver );
1998 if( status != PSA_SUCCESS )
1999 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002000 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002001 return( status );
2002 }
Gilles Peskinefc762652019-07-22 19:30:34 +02002003 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02002004 }
2005#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2006
Ronald Cron50972942020-11-14 11:28:25 +01002007 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01002008 {
2009 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01002010 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01002011 if( status != PSA_SUCCESS )
2012 *key = MBEDTLS_SVC_KEY_ID_INIT;
2013 }
Ronald Cron50972942020-11-14 11:28:25 +01002014
Gilles Peskine4747d192019-04-17 15:05:45 +02002015 return( status );
2016}
2017
2018/** Abort the creation of a key.
2019 *
2020 * You may call this function after calling psa_start_key_creation(),
2021 * or after psa_finish_key_creation() fails. In other circumstances, this
2022 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002023 * See the documentation of psa_start_key_creation() for the intended use
2024 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002025 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002026 * \param[in,out] slot Pointer to the slot with key material.
2027 * \param[in] driver The secure element driver for the key,
2028 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002029 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002030static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002031 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02002032{
Gilles Peskine011e4282019-06-26 18:34:38 +02002033 (void) driver;
2034
Gilles Peskine4747d192019-04-17 15:05:45 +02002035 if( slot == NULL )
2036 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02002037
2038#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002039 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002040 * element, and the failure happened later (when saving metadata
2041 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002042 * element.
2043 * https://github.com/ARMmbed/mbed-crypto/issues/217
2044 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002045
Gilles Peskined7729582019-08-05 15:55:54 +02002046 /* Abort the ongoing transaction if any (there may not be one if
2047 * the creation process failed before starting one, or if the
2048 * key creation is a registration of a key in a secure element).
2049 * Earlier functions must already have done what it takes to undo any
2050 * partial creation. All that's left is to update the transaction data
2051 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02002052 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02002053#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2054
Gilles Peskine4747d192019-04-17 15:05:45 +02002055 psa_wipe_key_slot( slot );
2056}
2057
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002058/** Validate optional attributes during key creation.
2059 *
2060 * Some key attributes are optional during key creation. If they are
2061 * specified in the attributes structure, check that they are consistent
2062 * with the data in the slot.
2063 *
2064 * This function should be called near the end of key creation, after
2065 * the slot in memory is fully populated but before saving persistent data.
2066 */
2067static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002068 const psa_key_slot_t *slot,
2069 const psa_key_attributes_t *attributes )
2070{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002071 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002072 {
Gilles Peskine8e338702019-07-30 20:06:31 +02002073 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002074 return( PSA_ERROR_INVALID_ARGUMENT );
2075 }
2076
2077 if( attributes->domain_parameters_size != 0 )
2078 {
John Durkop0e005192020-10-31 22:06:54 -07002079#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
2080 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02002081 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002082 {
Steven Cooremana2371e52020-07-28 14:30:39 +02002083 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002084 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002085 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002086
Ronald Cron90857082020-11-25 14:58:33 +01002087 psa_status_t status = mbedtls_psa_rsa_load_representation(
2088 slot->attr.type,
2089 slot->key.data,
2090 slot->key.bytes,
2091 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02002092 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02002093 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02002094
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002095 mbedtls_mpi_init( &actual );
2096 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02002097 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002098 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02002099 mbedtls_rsa_free( rsa );
2100 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002101 if( ret != 0 )
2102 goto rsa_exit;
2103 ret = mbedtls_mpi_read_binary( &required,
2104 attributes->domain_parameters,
2105 attributes->domain_parameters_size );
2106 if( ret != 0 )
2107 goto rsa_exit;
2108 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
2109 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
2110 rsa_exit:
2111 mbedtls_mpi_free( &actual );
2112 mbedtls_mpi_free( &required );
2113 if( ret != 0)
2114 return( mbedtls_to_psa_error( ret ) );
2115 }
2116 else
John Durkop9814fa22020-11-04 12:28:15 -08002117#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2118 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002119 {
2120 return( PSA_ERROR_INVALID_ARGUMENT );
2121 }
2122 }
2123
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002124 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002125 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002126 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002127 return( PSA_ERROR_INVALID_ARGUMENT );
2128 }
2129
2130 return( PSA_SUCCESS );
2131}
2132
Gilles Peskine4747d192019-04-17 15:05:45 +02002133psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02002134 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02002135 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002136 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02002137{
2138 psa_status_t status;
2139 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002140 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002141
Ronald Cron81709fc2020-11-14 12:10:32 +01002142 *key = MBEDTLS_SVC_KEY_ID_INIT;
2143
Gilles Peskine0f84d622019-09-12 19:03:13 +02002144 /* Reject zero-length symmetric keys (including raw data key objects).
2145 * This also rejects any key which might be encoded as an empty string,
2146 * which is never valid. */
2147 if( data_length == 0 )
2148 return( PSA_ERROR_INVALID_ARGUMENT );
2149
Gilles Peskinedf179142019-07-15 22:02:14 +02002150 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002151 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002152 if( status != PSA_SUCCESS )
2153 goto exit;
2154
Gilles Peskine5d309672019-07-12 23:47:28 +02002155#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2156 if( driver != NULL )
2157 {
2158 const psa_drv_se_t *drv = psa_get_se_driver_methods( driver );
Darryl Green0892d0f2019-08-20 09:50:14 +01002159 /* The driver should set the number of key bits, however in
2160 * case it doesn't, we initialize bits to an invalid value. */
2161 size_t bits = PSA_MAX_KEY_BITS + 1;
Gilles Peskine5d309672019-07-12 23:47:28 +02002162 if( drv->key_management == NULL ||
2163 drv->key_management->p_import == NULL )
2164 {
2165 status = PSA_ERROR_NOT_SUPPORTED;
2166 goto exit;
2167 }
2168 status = drv->key_management->p_import(
2169 psa_get_se_driver_context( driver ),
Ronald Cronea0f8a62020-11-25 17:52:23 +01002170 psa_key_slot_get_slot_number( slot ),
2171 attributes, data, data_length, &bits );
Gilles Peskineb46bef22019-07-30 21:32:04 +02002172 if( status != PSA_SUCCESS )
2173 goto exit;
2174 if( bits > PSA_MAX_KEY_BITS )
2175 {
2176 status = PSA_ERROR_NOT_SUPPORTED;
2177 goto exit;
2178 }
2179 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine5d309672019-07-12 23:47:28 +02002180 }
2181 else
2182#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremanac3434f2021-01-15 17:36:02 +01002183 if( psa_key_lifetime_is_external( psa_get_key_lifetime( attributes ) ) )
2184 {
2185 /* Importing a key with external lifetime through the driver wrapper
2186 * interface is not yet supported. Return as if this was an invalid
2187 * lifetime. */
2188 status = PSA_ERROR_INVALID_ARGUMENT;
2189 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002190 }
2191 else
Gilles Peskine5d309672019-07-12 23:47:28 +02002192 {
2193 status = psa_import_key_into_slot( slot, data, data_length );
2194 if( status != PSA_SUCCESS )
2195 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002196 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002197 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02002198 if( status != PSA_SUCCESS )
2199 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002200
Ronald Cron81709fc2020-11-14 12:10:32 +01002201 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002202exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02002203 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002204 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002205
Gilles Peskine4747d192019-04-17 15:05:45 +02002206 return( status );
2207}
2208
Gilles Peskined7729582019-08-05 15:55:54 +02002209#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2210psa_status_t mbedtls_psa_register_se_key(
2211 const psa_key_attributes_t *attributes )
2212{
2213 psa_status_t status;
2214 psa_key_slot_t *slot = NULL;
2215 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002216 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002217
2218 /* Leaving attributes unspecified is not currently supported.
2219 * It could make sense to query the key type and size from the
2220 * secure element, but not all secure elements support this
2221 * and the driver HAL doesn't currently support it. */
2222 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
2223 return( PSA_ERROR_NOT_SUPPORTED );
2224 if( psa_get_key_bits( attributes ) == 0 )
2225 return( PSA_ERROR_NOT_SUPPORTED );
2226
2227 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01002228 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02002229 if( status != PSA_SUCCESS )
2230 goto exit;
2231
Ronald Cron81709fc2020-11-14 12:10:32 +01002232 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02002233
2234exit:
2235 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02002236 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002237
Gilles Peskined7729582019-08-05 15:55:54 +02002238 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002239 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02002240 return( status );
2241}
2242#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2243
Gilles Peskinef603c712019-01-19 13:40:11 +01002244static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002245 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01002246{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02002247 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002248 source->key.data,
2249 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01002250 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02002251 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002252
Steven Cooreman398aee52020-10-13 14:35:45 +02002253 target->attr.type = source->attr.type;
2254 target->attr.bits = source->attr.bits;
2255
2256 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01002257}
2258
Ronald Croncf56a0a2020-08-04 09:51:30 +02002259psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002260 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002261 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01002262{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002264 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002265 psa_key_slot_t *source_slot = NULL;
2266 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002267 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002268 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002269
Ronald Cron81709fc2020-11-14 12:10:32 +01002270 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2271
Ronald Cron5c522922020-11-14 16:35:34 +01002272 status = psa_get_and_lock_transparent_key_slot_with_policy(
2273 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01002274 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002275 goto exit;
2276
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002277 status = psa_validate_optional_attributes( source_slot,
2278 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002279 if( status != PSA_SUCCESS )
2280 goto exit;
2281
Gilles Peskine7e0cff92019-07-30 13:48:52 +02002282 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02002283 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002284 if( status != PSA_SUCCESS )
2285 goto exit;
2286
Ronald Cron81709fc2020-11-14 12:10:32 +01002287 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
2288 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002289 if( status != PSA_SUCCESS )
2290 goto exit;
2291
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002292#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2293 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01002294 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002295 /* Copying to a secure element is not implemented yet. */
2296 status = PSA_ERROR_NOT_SUPPORTED;
2297 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002298 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002299#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002300
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002301 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01002302 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002303 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002304
Ronald Cron81709fc2020-11-14 12:10:32 +01002305 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002306exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002307 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02002308 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002309
Ronald Cron5c522922020-11-14 16:35:34 +01002310 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002311
Ronald Cron5c522922020-11-14 16:35:34 +01002312 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01002313}
2314
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002315
2316
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002317/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002318/* Message digests */
2319/****************************************************************/
2320
John Durkop07cc04a2020-11-16 22:08:34 -08002321#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07002322 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
2323 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08002324 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002325static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01002326{
2327 switch( alg )
2328 {
John Durkopee4e6602020-11-27 08:48:46 -08002329#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01002330 case PSA_ALG_MD2:
2331 return( &mbedtls_md2_info );
2332#endif
John Durkopee4e6602020-11-27 08:48:46 -08002333#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01002334 case PSA_ALG_MD4:
2335 return( &mbedtls_md4_info );
2336#endif
John Durkopee4e6602020-11-27 08:48:46 -08002337#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01002338 case PSA_ALG_MD5:
2339 return( &mbedtls_md5_info );
2340#endif
John Durkopee4e6602020-11-27 08:48:46 -08002341#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01002342 case PSA_ALG_RIPEMD160:
2343 return( &mbedtls_ripemd160_info );
2344#endif
John Durkopee4e6602020-11-27 08:48:46 -08002345#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01002346 case PSA_ALG_SHA_1:
2347 return( &mbedtls_sha1_info );
2348#endif
John Durkopee4e6602020-11-27 08:48:46 -08002349#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01002350 case PSA_ALG_SHA_224:
2351 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002352#endif
2353#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002354 case PSA_ALG_SHA_256:
2355 return( &mbedtls_sha256_info );
2356#endif
John Durkopee4e6602020-11-27 08:48:46 -08002357#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002358 case PSA_ALG_SHA_384:
2359 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002360#endif
John Durkopee4e6602020-11-27 08:48:46 -08002361#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002362 case PSA_ALG_SHA_512:
2363 return( &mbedtls_sha512_info );
2364#endif
2365 default:
2366 return( NULL );
2367 }
2368}
John Durkop07cc04a2020-11-16 22:08:34 -08002369#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002370 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2371 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2372 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002373
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002374psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2375{
2376 switch( operation->alg )
2377 {
Gilles Peskine81736312018-06-26 15:04:31 +02002378 case 0:
2379 /* The object has (apparently) been initialized but it is not
2380 * in use. It's ok to call abort on such an object, and there's
2381 * nothing to do. */
2382 break;
John Durkopee4e6602020-11-27 08:48:46 -08002383#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002384 case PSA_ALG_MD2:
2385 mbedtls_md2_free( &operation->ctx.md2 );
2386 break;
2387#endif
John Durkopee4e6602020-11-27 08:48:46 -08002388#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002389 case PSA_ALG_MD4:
2390 mbedtls_md4_free( &operation->ctx.md4 );
2391 break;
2392#endif
John Durkopee4e6602020-11-27 08:48:46 -08002393#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002394 case PSA_ALG_MD5:
2395 mbedtls_md5_free( &operation->ctx.md5 );
2396 break;
2397#endif
John Durkopee4e6602020-11-27 08:48:46 -08002398#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399 case PSA_ALG_RIPEMD160:
2400 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2401 break;
2402#endif
John Durkopee4e6602020-11-27 08:48:46 -08002403#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404 case PSA_ALG_SHA_1:
2405 mbedtls_sha1_free( &operation->ctx.sha1 );
2406 break;
2407#endif
John Durkop6ca23272020-12-03 06:01:32 -08002408#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002410 mbedtls_sha256_free( &operation->ctx.sha256 );
2411 break;
2412#endif
2413#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002414 case PSA_ALG_SHA_256:
2415 mbedtls_sha256_free( &operation->ctx.sha256 );
2416 break;
2417#endif
John Durkop6ca23272020-12-03 06:01:32 -08002418#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002419 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002420 mbedtls_sha512_free( &operation->ctx.sha512 );
2421 break;
2422#endif
2423#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002424 case PSA_ALG_SHA_512:
2425 mbedtls_sha512_free( &operation->ctx.sha512 );
2426 break;
2427#endif
2428 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002429 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430 }
2431 operation->alg = 0;
2432 return( PSA_SUCCESS );
2433}
2434
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002435psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002436 psa_algorithm_t alg )
2437{
Janos Follath24eed8d2019-11-22 13:21:35 +00002438 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002439
2440 /* A context must be freshly initialized before it can be set up. */
2441 if( operation->alg != 0 )
2442 {
2443 return( PSA_ERROR_BAD_STATE );
2444 }
2445
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002446 switch( alg )
2447 {
John Durkopee4e6602020-11-27 08:48:46 -08002448#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002449 case PSA_ALG_MD2:
2450 mbedtls_md2_init( &operation->ctx.md2 );
2451 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2452 break;
2453#endif
John Durkopee4e6602020-11-27 08:48:46 -08002454#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002455 case PSA_ALG_MD4:
2456 mbedtls_md4_init( &operation->ctx.md4 );
2457 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2458 break;
2459#endif
John Durkopee4e6602020-11-27 08:48:46 -08002460#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461 case PSA_ALG_MD5:
2462 mbedtls_md5_init( &operation->ctx.md5 );
2463 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2464 break;
2465#endif
John Durkopee4e6602020-11-27 08:48:46 -08002466#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002467 case PSA_ALG_RIPEMD160:
2468 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2469 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2470 break;
2471#endif
John Durkopee4e6602020-11-27 08:48:46 -08002472#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002473 case PSA_ALG_SHA_1:
2474 mbedtls_sha1_init( &operation->ctx.sha1 );
2475 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2476 break;
2477#endif
John Durkopee4e6602020-11-27 08:48:46 -08002478#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002479 case PSA_ALG_SHA_224:
2480 mbedtls_sha256_init( &operation->ctx.sha256 );
2481 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2482 break;
John Durkopee4e6602020-11-27 08:48:46 -08002483#endif
2484#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002485 case PSA_ALG_SHA_256:
2486 mbedtls_sha256_init( &operation->ctx.sha256 );
2487 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2488 break;
2489#endif
John Durkopee4e6602020-11-27 08:48:46 -08002490#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002491 case PSA_ALG_SHA_384:
2492 mbedtls_sha512_init( &operation->ctx.sha512 );
2493 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2494 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002495#endif
John Durkopee4e6602020-11-27 08:48:46 -08002496#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002497 case PSA_ALG_SHA_512:
2498 mbedtls_sha512_init( &operation->ctx.sha512 );
2499 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2500 break;
2501#endif
2502 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002503 return( PSA_ALG_IS_HASH( alg ) ?
2504 PSA_ERROR_NOT_SUPPORTED :
2505 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002506 }
2507 if( ret == 0 )
2508 operation->alg = alg;
2509 else
2510 psa_hash_abort( operation );
2511 return( mbedtls_to_psa_error( ret ) );
2512}
2513
2514psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2515 const uint8_t *input,
2516 size_t input_length )
2517{
Janos Follath24eed8d2019-11-22 13:21:35 +00002518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002519
2520 /* Don't require hash implementations to behave correctly on a
2521 * zero-length input, which may have an invalid pointer. */
2522 if( input_length == 0 )
2523 return( PSA_SUCCESS );
2524
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002525 switch( operation->alg )
2526 {
John Durkopee4e6602020-11-27 08:48:46 -08002527#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002528 case PSA_ALG_MD2:
2529 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2530 input, input_length );
2531 break;
2532#endif
John Durkopee4e6602020-11-27 08:48:46 -08002533#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002534 case PSA_ALG_MD4:
2535 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2536 input, input_length );
2537 break;
2538#endif
John Durkopee4e6602020-11-27 08:48:46 -08002539#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002540 case PSA_ALG_MD5:
2541 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2542 input, input_length );
2543 break;
2544#endif
John Durkopee4e6602020-11-27 08:48:46 -08002545#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002546 case PSA_ALG_RIPEMD160:
2547 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2548 input, input_length );
2549 break;
2550#endif
John Durkopee4e6602020-11-27 08:48:46 -08002551#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002552 case PSA_ALG_SHA_1:
2553 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2554 input, input_length );
2555 break;
2556#endif
John Durkop6ca23272020-12-03 06:01:32 -08002557#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002558 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002559 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2560 input, input_length );
2561 break;
2562#endif
2563#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002564 case PSA_ALG_SHA_256:
2565 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2566 input, input_length );
2567 break;
2568#endif
John Durkop6ca23272020-12-03 06:01:32 -08002569#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002570 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002571 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2572 input, input_length );
2573 break;
2574#endif
2575#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002576 case PSA_ALG_SHA_512:
2577 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2578 input, input_length );
2579 break;
2580#endif
2581 default:
John Durkopee4e6602020-11-27 08:48:46 -08002582 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002583 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002584 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002585
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002586 if( ret != 0 )
2587 psa_hash_abort( operation );
2588 return( mbedtls_to_psa_error( ret ) );
2589}
2590
2591psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2592 uint8_t *hash,
2593 size_t hash_size,
2594 size_t *hash_length )
2595{
itayzafrir40835d42018-08-02 13:14:17 +03002596 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002597 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002598 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002599
2600 /* Fill the output buffer with something that isn't a valid hash
2601 * (barring an attack on the hash and deliberately-crafted input),
2602 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002603 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002604 /* If hash_size is 0 then hash may be NULL and then the
2605 * call to memset would have undefined behavior. */
2606 if( hash_size != 0 )
2607 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002608
2609 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002610 {
2611 status = PSA_ERROR_BUFFER_TOO_SMALL;
2612 goto exit;
2613 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002614
2615 switch( operation->alg )
2616 {
John Durkopee4e6602020-11-27 08:48:46 -08002617#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002618 case PSA_ALG_MD2:
2619 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2620 break;
2621#endif
John Durkopee4e6602020-11-27 08:48:46 -08002622#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002623 case PSA_ALG_MD4:
2624 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2625 break;
2626#endif
John Durkopee4e6602020-11-27 08:48:46 -08002627#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002628 case PSA_ALG_MD5:
2629 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2630 break;
2631#endif
John Durkopee4e6602020-11-27 08:48:46 -08002632#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002633 case PSA_ALG_RIPEMD160:
2634 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2635 break;
2636#endif
John Durkopee4e6602020-11-27 08:48:46 -08002637#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002638 case PSA_ALG_SHA_1:
2639 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2640 break;
2641#endif
John Durkop6ca23272020-12-03 06:01:32 -08002642#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002643 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002644 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2645 break;
2646#endif
2647#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002648 case PSA_ALG_SHA_256:
2649 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2650 break;
2651#endif
John Durkop6ca23272020-12-03 06:01:32 -08002652#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002653 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002654 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2655 break;
2656#endif
2657#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002658 case PSA_ALG_SHA_512:
2659 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2660 break;
2661#endif
2662 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002663 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002664 }
itayzafrir40835d42018-08-02 13:14:17 +03002665 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002666
itayzafrir40835d42018-08-02 13:14:17 +03002667exit:
2668 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002669 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002670 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002671 return( psa_hash_abort( operation ) );
2672 }
2673 else
2674 {
2675 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002676 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002677 }
2678}
2679
Gilles Peskine2d277862018-06-18 15:41:12 +02002680psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2681 const uint8_t *hash,
2682 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002683{
2684 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2685 size_t actual_hash_length;
2686 psa_status_t status = psa_hash_finish( operation,
2687 actual_hash, sizeof( actual_hash ),
2688 &actual_hash_length );
2689 if( status != PSA_SUCCESS )
2690 return( status );
2691 if( actual_hash_length != hash_length )
2692 return( PSA_ERROR_INVALID_SIGNATURE );
2693 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2694 return( PSA_ERROR_INVALID_SIGNATURE );
2695 return( PSA_SUCCESS );
2696}
2697
Gilles Peskine0a749c82019-11-28 19:33:58 +01002698psa_status_t psa_hash_compute( psa_algorithm_t alg,
2699 const uint8_t *input, size_t input_length,
2700 uint8_t *hash, size_t hash_size,
2701 size_t *hash_length )
2702{
2703 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2705
2706 *hash_length = hash_size;
2707 status = psa_hash_setup( &operation, alg );
2708 if( status != PSA_SUCCESS )
2709 goto exit;
2710 status = psa_hash_update( &operation, input, input_length );
2711 if( status != PSA_SUCCESS )
2712 goto exit;
2713 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2714 if( status != PSA_SUCCESS )
2715 goto exit;
2716
2717exit:
2718 if( status == PSA_SUCCESS )
2719 status = psa_hash_abort( &operation );
2720 else
2721 psa_hash_abort( &operation );
2722 return( status );
2723}
2724
2725psa_status_t psa_hash_compare( psa_algorithm_t alg,
2726 const uint8_t *input, size_t input_length,
2727 const uint8_t *hash, size_t hash_length )
2728{
2729 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2730 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2731
2732 status = psa_hash_setup( &operation, alg );
2733 if( status != PSA_SUCCESS )
2734 goto exit;
2735 status = psa_hash_update( &operation, input, input_length );
2736 if( status != PSA_SUCCESS )
2737 goto exit;
2738 status = psa_hash_verify( &operation, hash, hash_length );
2739 if( status != PSA_SUCCESS )
2740 goto exit;
2741
2742exit:
2743 if( status == PSA_SUCCESS )
2744 status = psa_hash_abort( &operation );
2745 else
2746 psa_hash_abort( &operation );
2747 return( status );
2748}
2749
Gilles Peskineeb35d782019-01-22 17:56:16 +01002750psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2751 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002752{
2753 if( target_operation->alg != 0 )
2754 return( PSA_ERROR_BAD_STATE );
2755
2756 switch( source_operation->alg )
2757 {
2758 case 0:
2759 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002760#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002761 case PSA_ALG_MD2:
2762 mbedtls_md2_clone( &target_operation->ctx.md2,
2763 &source_operation->ctx.md2 );
2764 break;
2765#endif
John Durkopee4e6602020-11-27 08:48:46 -08002766#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002767 case PSA_ALG_MD4:
2768 mbedtls_md4_clone( &target_operation->ctx.md4,
2769 &source_operation->ctx.md4 );
2770 break;
2771#endif
John Durkopee4e6602020-11-27 08:48:46 -08002772#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002773 case PSA_ALG_MD5:
2774 mbedtls_md5_clone( &target_operation->ctx.md5,
2775 &source_operation->ctx.md5 );
2776 break;
2777#endif
John Durkopee4e6602020-11-27 08:48:46 -08002778#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002779 case PSA_ALG_RIPEMD160:
2780 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2781 &source_operation->ctx.ripemd160 );
2782 break;
2783#endif
John Durkopee4e6602020-11-27 08:48:46 -08002784#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002785 case PSA_ALG_SHA_1:
2786 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2787 &source_operation->ctx.sha1 );
2788 break;
2789#endif
John Durkop6ca23272020-12-03 06:01:32 -08002790#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002791 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002792 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2793 &source_operation->ctx.sha256 );
2794 break;
2795#endif
2796#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002797 case PSA_ALG_SHA_256:
2798 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2799 &source_operation->ctx.sha256 );
2800 break;
2801#endif
John Durkop6ca23272020-12-03 06:01:32 -08002802#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002803 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002804 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2805 &source_operation->ctx.sha512 );
2806 break;
2807#endif
2808#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002809 case PSA_ALG_SHA_512:
2810 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2811 &source_operation->ctx.sha512 );
2812 break;
2813#endif
2814 default:
2815 return( PSA_ERROR_NOT_SUPPORTED );
2816 }
2817
2818 target_operation->alg = source_operation->alg;
2819 return( PSA_SUCCESS );
2820}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002821
2822
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002823/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002824/* MAC */
2825/****************************************************************/
2826
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002827static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002828 psa_algorithm_t alg,
2829 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002830 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002831 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002832{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002833 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002834 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002835
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002836 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002837 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002838
Gilles Peskine8c9def32018-02-08 10:02:12 +01002839 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2840 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002841 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002842 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002843 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002844 mode = MBEDTLS_MODE_STREAM;
2845 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002846 case PSA_ALG_CTR:
2847 mode = MBEDTLS_MODE_CTR;
2848 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002849 case PSA_ALG_CFB:
2850 mode = MBEDTLS_MODE_CFB;
2851 break;
2852 case PSA_ALG_OFB:
2853 mode = MBEDTLS_MODE_OFB;
2854 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002855 case PSA_ALG_ECB_NO_PADDING:
2856 mode = MBEDTLS_MODE_ECB;
2857 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002858 case PSA_ALG_CBC_NO_PADDING:
2859 mode = MBEDTLS_MODE_CBC;
2860 break;
2861 case PSA_ALG_CBC_PKCS7:
2862 mode = MBEDTLS_MODE_CBC;
2863 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002864 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002865 mode = MBEDTLS_MODE_CCM;
2866 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002867 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002868 mode = MBEDTLS_MODE_GCM;
2869 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002870 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2871 mode = MBEDTLS_MODE_CHACHAPOLY;
2872 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002873 default:
2874 return( NULL );
2875 }
2876 }
2877 else if( alg == PSA_ALG_CMAC )
2878 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879 else
2880 return( NULL );
2881
2882 switch( key_type )
2883 {
2884 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002885 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002886 break;
2887 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002888 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2889 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002890 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002891 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002892 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002893 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002894 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2895 * but two-key Triple-DES is functionally three-key Triple-DES
2896 * with K1=K3, so that's how we present it to mbedtls. */
2897 if( key_bits == 128 )
2898 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002899 break;
2900 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002901 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002902 break;
2903 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002904 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002905 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002906 case PSA_KEY_TYPE_CHACHA20:
2907 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2908 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002909 default:
2910 return( NULL );
2911 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002912 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002913 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002914
Jaeden Amero23bbb752018-06-26 14:16:54 +01002915 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2916 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002917}
2918
John Durkop6ba40d12020-11-10 08:50:04 -08002919#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002920static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002921{
Gilles Peskine2d277862018-06-18 15:41:12 +02002922 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002923 {
2924 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002925 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002926 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002927 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002928 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002929 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002930 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002931 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002932 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002933 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002934 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002935 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002936 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002937 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002938 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002939 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002940 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002941 return( 128 );
2942 default:
2943 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002944 }
2945}
John Durkop07cc04a2020-11-16 22:08:34 -08002946#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002947
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002948/* Initialize the MAC operation structure. Once this function has been
2949 * called, psa_mac_abort can run and will do the right thing. */
2950static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2951 psa_algorithm_t alg )
2952{
2953 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2954
2955 operation->alg = alg;
2956 operation->key_set = 0;
2957 operation->iv_set = 0;
2958 operation->iv_required = 0;
2959 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002960 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002961
2962#if defined(MBEDTLS_CMAC_C)
2963 if( alg == PSA_ALG_CMAC )
2964 {
2965 operation->iv_required = 0;
2966 mbedtls_cipher_init( &operation->ctx.cmac );
2967 status = PSA_SUCCESS;
2968 }
2969 else
2970#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002971#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002972 if( PSA_ALG_IS_HMAC( operation->alg ) )
2973 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002974 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2975 operation->ctx.hmac.hash_ctx.alg = 0;
2976 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002977 }
2978 else
John Durkopd0321952020-10-29 21:37:36 -07002979#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002980 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002981 if( ! PSA_ALG_IS_MAC( alg ) )
2982 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002983 }
2984
2985 if( status != PSA_SUCCESS )
2986 memset( operation, 0, sizeof( *operation ) );
2987 return( status );
2988}
2989
John Durkop6ba40d12020-11-10 08:50:04 -08002990#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002991static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2992{
Gilles Peskine3f108122018-12-07 18:14:53 +01002993 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002994 return( psa_hash_abort( &hmac->hash_ctx ) );
2995}
John Durkop6ba40d12020-11-10 08:50:04 -08002996#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002997
Gilles Peskine8c9def32018-02-08 10:02:12 +01002998psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2999{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003000 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003001 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003002 /* The object has (apparently) been initialized but it is not
3003 * in use. It's ok to call abort on such an object, and there's
3004 * nothing to do. */
3005 return( PSA_SUCCESS );
3006 }
3007 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003008#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003009 if( operation->alg == PSA_ALG_CMAC )
3010 {
3011 mbedtls_cipher_free( &operation->ctx.cmac );
3012 }
3013 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003014#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003015#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003016 if( PSA_ALG_IS_HMAC( operation->alg ) )
3017 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003018 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003019 }
3020 else
John Durkopd0321952020-10-29 21:37:36 -07003021#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003022 {
3023 /* Sanity check (shouldn't happen: operation->alg should
3024 * always have been initialized to a valid value). */
3025 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003026 }
Moran Peker41deec42018-04-04 15:43:05 +03003027
Gilles Peskine8c9def32018-02-08 10:02:12 +01003028 operation->alg = 0;
3029 operation->key_set = 0;
3030 operation->iv_set = 0;
3031 operation->iv_required = 0;
3032 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003033 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003034
Gilles Peskine8c9def32018-02-08 10:02:12 +01003035 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003036
3037bad_state:
3038 /* If abort is called on an uninitialized object, we can't trust
3039 * anything. Wipe the object in case it contains confidential data.
3040 * This may result in a memory leak if a pointer gets overwritten,
3041 * but it's too late to do anything about this. */
3042 memset( operation, 0, sizeof( *operation ) );
3043 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003044}
3045
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003046#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02003047static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003048 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01003049 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003050 const mbedtls_cipher_info_t *cipher_info )
3051{
Janos Follath24eed8d2019-11-22 13:21:35 +00003052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003053
3054 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003055
3056 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
3057 if( ret != 0 )
3058 return( ret );
3059
3060 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003061 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003062 key_bits );
3063 return( ret );
3064}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02003065#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003066
John Durkop6ba40d12020-11-10 08:50:04 -08003067#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003068static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
3069 const uint8_t *key,
3070 size_t key_length,
3071 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003072{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003073 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003074 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003075 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003076 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003077 psa_status_t status;
3078
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003079 /* Sanity checks on block_size, to guarantee that there won't be a buffer
3080 * overflow below. This should never trigger if the hash algorithm
3081 * is implemented correctly. */
3082 /* The size checks against the ipad and opad buffers cannot be written
3083 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
3084 * because that triggers -Wlogical-op on GCC 7.3. */
3085 if( block_size > sizeof( ipad ) )
3086 return( PSA_ERROR_NOT_SUPPORTED );
3087 if( block_size > sizeof( hmac->opad ) )
3088 return( PSA_ERROR_NOT_SUPPORTED );
3089 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003090 return( PSA_ERROR_NOT_SUPPORTED );
3091
Gilles Peskined223b522018-06-11 18:12:58 +02003092 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003093 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01003094 status = psa_hash_compute( hash_alg, key, key_length,
3095 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003096 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02003097 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003098 }
Gilles Peskine96889972018-07-12 17:07:03 +02003099 /* A 0-length key is not commonly used in HMAC when used as a MAC,
3100 * but it is permitted. It is common when HMAC is used in HKDF, for
3101 * example. Don't call `memcpy` in the 0-length because `key` could be
3102 * an invalid pointer which would make the behavior undefined. */
3103 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003104 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003105
Gilles Peskined223b522018-06-11 18:12:58 +02003106 /* ipad contains the key followed by garbage. Xor and fill with 0x36
3107 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003108 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02003109 ipad[i] ^= 0x36;
3110 memset( ipad + key_length, 0x36, block_size - key_length );
3111
3112 /* Copy the key material from ipad to opad, flipping the requisite bits,
3113 * and filling the rest of opad with the requisite constant. */
3114 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003115 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
3116 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003117
Gilles Peskine01126fa2018-07-12 17:04:55 +02003118 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003119 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003120 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003121
Gilles Peskine01126fa2018-07-12 17:04:55 +02003122 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003123
3124cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02003125 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003126
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003127 return( status );
3128}
John Durkop6ba40d12020-11-10 08:50:04 -08003129#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003130
Gilles Peskine89167cb2018-07-08 20:12:23 +02003131static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003132 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003133 psa_algorithm_t alg,
3134 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003135{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003136 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003137 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003138 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003139 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003140 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003141 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003142 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02003143 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003144
Jaeden Amero36ee5d02019-02-19 09:25:10 +00003145 /* A context must be freshly initialized before it can be set up. */
3146 if( operation->alg != 0 )
3147 {
3148 return( PSA_ERROR_BAD_STATE );
3149 }
3150
Gilles Peskined911eb72018-08-14 15:18:45 +02003151 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003152 if( status != PSA_SUCCESS )
3153 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003154 if( is_sign )
3155 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003156
Ronald Cron5c522922020-11-14 16:35:34 +01003157 status = psa_get_and_lock_transparent_key_slot_with_policy(
3158 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003159 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003160 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003161 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02003162
Gilles Peskine8c9def32018-02-08 10:02:12 +01003163#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02003164 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003165 {
3166 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02003167 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02003168 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00003169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003170 if( cipher_info == NULL )
3171 {
3172 status = PSA_ERROR_NOT_SUPPORTED;
3173 goto exit;
3174 }
3175 operation->mac_size = cipher_info->block_size;
3176 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
3177 status = mbedtls_to_psa_error( ret );
3178 }
3179 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01003180#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003181#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02003182 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02003183 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02003184 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003185 if( hash_alg == 0 )
3186 {
3187 status = PSA_ERROR_NOT_SUPPORTED;
3188 goto exit;
3189 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003190
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003191 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003192 /* Sanity check. This shouldn't fail on a valid configuration. */
3193 if( operation->mac_size == 0 ||
3194 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
3195 {
3196 status = PSA_ERROR_NOT_SUPPORTED;
3197 goto exit;
3198 }
3199
Gilles Peskine8e338702019-07-30 20:06:31 +02003200 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02003201 {
3202 status = PSA_ERROR_INVALID_ARGUMENT;
3203 goto exit;
3204 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02003205
Gilles Peskine01126fa2018-07-12 17:04:55 +02003206 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003207 slot->key.data,
3208 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02003209 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003210 }
3211 else
John Durkopd0321952020-10-29 21:37:36 -07003212#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003213 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00003214 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02003215 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003216 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003217
Gilles Peskined911eb72018-08-14 15:18:45 +02003218 if( truncated == 0 )
3219 {
3220 /* The "normal" case: untruncated algorithm. Nothing to do. */
3221 }
3222 else if( truncated < 4 )
3223 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02003224 /* A very short MAC is too short for security since it can be
3225 * brute-forced. Ancient protocols with 32-bit MACs do exist,
3226 * so we make this our minimum, even though 32 bits is still
3227 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02003228 status = PSA_ERROR_NOT_SUPPORTED;
3229 }
3230 else if( truncated > operation->mac_size )
3231 {
3232 /* It's impossible to "truncate" to a larger length. */
3233 status = PSA_ERROR_INVALID_ARGUMENT;
3234 }
3235 else
3236 operation->mac_size = truncated;
3237
Gilles Peskinefbfac682018-07-08 20:51:54 +02003238exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003239 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003240 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02003241 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003242 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003243 else
3244 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02003245 operation->key_set = 1;
3246 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003247
Ronald Cron5c522922020-11-14 16:35:34 +01003248 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003249
Ronald Cron5c522922020-11-14 16:35:34 +01003250 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003251}
3252
Gilles Peskine89167cb2018-07-08 20:12:23 +02003253psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003254 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003255 psa_algorithm_t alg )
3256{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003257 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003258}
3259
3260psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003261 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02003262 psa_algorithm_t alg )
3263{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003264 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003265}
3266
Gilles Peskine8c9def32018-02-08 10:02:12 +01003267psa_status_t psa_mac_update( psa_mac_operation_t *operation,
3268 const uint8_t *input,
3269 size_t input_length )
3270{
Gilles Peskinefbfac682018-07-08 20:51:54 +02003271 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01003272 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003273 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003274 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003275 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003276 operation->has_input = 1;
3277
Gilles Peskine8c9def32018-02-08 10:02:12 +01003278#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003279 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003280 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02003281 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
3282 input, input_length );
3283 status = mbedtls_to_psa_error( ret );
3284 }
3285 else
3286#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003287#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003288 if( PSA_ALG_IS_HMAC( operation->alg ) )
3289 {
3290 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
3291 input_length );
3292 }
3293 else
John Durkopd0321952020-10-29 21:37:36 -07003294#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003295 {
3296 /* This shouldn't happen if `operation` was initialized by
3297 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003298 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03003299 }
3300
Gilles Peskinefbfac682018-07-08 20:51:54 +02003301 if( status != PSA_SUCCESS )
3302 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02003303 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003304}
3305
John Durkop6ba40d12020-11-10 08:50:04 -08003306#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02003307static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
3308 uint8_t *mac,
3309 size_t mac_size )
3310{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003311 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02003312 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
3313 size_t hash_size = 0;
3314 size_t block_size = psa_get_hash_block_size( hash_alg );
3315 psa_status_t status;
3316
Gilles Peskine01126fa2018-07-12 17:04:55 +02003317 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3318 if( status != PSA_SUCCESS )
3319 return( status );
3320 /* From here on, tmp needs to be wiped. */
3321
3322 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
3323 if( status != PSA_SUCCESS )
3324 goto exit;
3325
3326 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
3327 if( status != PSA_SUCCESS )
3328 goto exit;
3329
3330 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
3331 if( status != PSA_SUCCESS )
3332 goto exit;
3333
Gilles Peskined911eb72018-08-14 15:18:45 +02003334 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
3335 if( status != PSA_SUCCESS )
3336 goto exit;
3337
3338 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003339
3340exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01003341 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02003342 return( status );
3343}
John Durkop6ba40d12020-11-10 08:50:04 -08003344#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02003345
mohammad16036df908f2018-04-02 08:34:15 -07003346static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02003347 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003348 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003349{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02003350 if( ! operation->key_set )
3351 return( PSA_ERROR_BAD_STATE );
3352 if( operation->iv_required && ! operation->iv_set )
3353 return( PSA_ERROR_BAD_STATE );
3354
Gilles Peskine8c9def32018-02-08 10:02:12 +01003355 if( mac_size < operation->mac_size )
3356 return( PSA_ERROR_BUFFER_TOO_SMALL );
3357
Gilles Peskine8c9def32018-02-08 10:02:12 +01003358#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003359 if( operation->alg == PSA_ALG_CMAC )
3360 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003361 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003362 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3363 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003364 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003365 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003366 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003367 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003368 else
3369#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003370#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003371 if( PSA_ALG_IS_HMAC( operation->alg ) )
3372 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003373 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003374 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003375 }
3376 else
John Durkopd0321952020-10-29 21:37:36 -07003377#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003378 {
3379 /* This shouldn't happen if `operation` was initialized by
3380 * a setup function. */
3381 return( PSA_ERROR_BAD_STATE );
3382 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003383}
3384
Gilles Peskineacd4be32018-07-08 19:56:25 +02003385psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3386 uint8_t *mac,
3387 size_t mac_size,
3388 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003389{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003390 psa_status_t status;
3391
Jaeden Amero252ef282019-02-15 14:05:35 +00003392 if( operation->alg == 0 )
3393 {
3394 return( PSA_ERROR_BAD_STATE );
3395 }
3396
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003397 /* Fill the output buffer with something that isn't a valid mac
3398 * (barring an attack on the mac and deliberately-crafted input),
3399 * in case the caller doesn't check the return status properly. */
3400 *mac_length = mac_size;
3401 /* If mac_size is 0 then mac may be NULL and then the
3402 * call to memset would have undefined behavior. */
3403 if( mac_size != 0 )
3404 memset( mac, '!', mac_size );
3405
Gilles Peskine89167cb2018-07-08 20:12:23 +02003406 if( ! operation->is_sign )
3407 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003408 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003409 }
mohammad16036df908f2018-04-02 08:34:15 -07003410
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003411 status = psa_mac_finish_internal( operation, mac, mac_size );
3412
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003413 if( status == PSA_SUCCESS )
3414 {
3415 status = psa_mac_abort( operation );
3416 if( status == PSA_SUCCESS )
3417 *mac_length = operation->mac_size;
3418 else
3419 memset( mac, '!', mac_size );
3420 }
3421 else
3422 psa_mac_abort( operation );
3423 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003424}
3425
Gilles Peskineacd4be32018-07-08 19:56:25 +02003426psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3427 const uint8_t *mac,
3428 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003429{
Gilles Peskine828ed142018-06-18 23:25:51 +02003430 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003431 psa_status_t status;
3432
Jaeden Amero252ef282019-02-15 14:05:35 +00003433 if( operation->alg == 0 )
3434 {
3435 return( PSA_ERROR_BAD_STATE );
3436 }
3437
Gilles Peskine89167cb2018-07-08 20:12:23 +02003438 if( operation->is_sign )
3439 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003440 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003441 }
3442 if( operation->mac_size != mac_length )
3443 {
3444 status = PSA_ERROR_INVALID_SIGNATURE;
3445 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003446 }
mohammad16036df908f2018-04-02 08:34:15 -07003447
3448 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003449 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003450 if( status != PSA_SUCCESS )
3451 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003452
3453 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3454 status = PSA_ERROR_INVALID_SIGNATURE;
3455
3456cleanup:
3457 if( status == PSA_SUCCESS )
3458 status = psa_mac_abort( operation );
3459 else
3460 psa_mac_abort( operation );
3461
Gilles Peskine3f108122018-12-07 18:14:53 +01003462 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003463
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003464 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003465}
3466
3467
Gilles Peskine20035e32018-02-03 22:44:14 +01003468
Gilles Peskine20035e32018-02-03 22:44:14 +01003469/****************************************************************/
3470/* Asymmetric cryptography */
3471/****************************************************************/
3472
John Durkop6ba40d12020-11-10 08:50:04 -08003473#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3474 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003475/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003476 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003477static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3478 size_t hash_length,
3479 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003480{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003481 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003482 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003483 *md_alg = mbedtls_md_get_type( md_info );
3484
3485 /* The Mbed TLS RSA module uses an unsigned int for hash length
3486 * parameters. Validate that it fits so that we don't risk an
3487 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003488#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003489 if( hash_length > UINT_MAX )
3490 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003491#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003492
John Durkop0e005192020-10-31 22:06:54 -07003493#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003494 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3495 * must be correct. */
3496 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3497 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003498 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003499 if( md_info == NULL )
3500 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003501 if( mbedtls_md_get_size( md_info ) != hash_length )
3502 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003503 }
John Durkop0e005192020-10-31 22:06:54 -07003504#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003505
John Durkop0e005192020-10-31 22:06:54 -07003506#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003507 /* PSS requires a hash internally. */
3508 if( PSA_ALG_IS_RSA_PSS( alg ) )
3509 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003510 if( md_info == NULL )
3511 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003512 }
John Durkop0e005192020-10-31 22:06:54 -07003513#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003514
Gilles Peskine61b91d42018-06-08 16:09:36 +02003515 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003516}
3517
Gilles Peskine2b450e32018-06-27 15:42:46 +02003518static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3519 psa_algorithm_t alg,
3520 const uint8_t *hash,
3521 size_t hash_length,
3522 uint8_t *signature,
3523 size_t signature_size,
3524 size_t *signature_length )
3525{
3526 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003527 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003528 mbedtls_md_type_t md_alg;
3529
3530 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3531 if( status != PSA_SUCCESS )
3532 return( status );
3533
Gilles Peskine630a18a2018-06-29 17:49:35 +02003534 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003535 return( PSA_ERROR_BUFFER_TOO_SMALL );
3536
John Durkop0e005192020-10-31 22:06:54 -07003537#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003538 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3539 {
3540 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3541 MBEDTLS_MD_NONE );
3542 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003543 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003544 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003545 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003546 md_alg,
3547 (unsigned int) hash_length,
3548 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003549 signature );
3550 }
3551 else
John Durkop0e005192020-10-31 22:06:54 -07003552#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3553#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003554 if( PSA_ALG_IS_RSA_PSS( alg ) )
3555 {
3556 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3557 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003558 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003559 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003560 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003561 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003562 (unsigned int) hash_length,
3563 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003564 signature );
3565 }
3566 else
John Durkop0e005192020-10-31 22:06:54 -07003567#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003568 {
3569 return( PSA_ERROR_INVALID_ARGUMENT );
3570 }
3571
3572 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003573 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003574 return( mbedtls_to_psa_error( ret ) );
3575}
3576
3577static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3578 psa_algorithm_t alg,
3579 const uint8_t *hash,
3580 size_t hash_length,
3581 const uint8_t *signature,
3582 size_t signature_length )
3583{
3584 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003586 mbedtls_md_type_t md_alg;
3587
3588 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3589 if( status != PSA_SUCCESS )
3590 return( status );
3591
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003592 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3593 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003594
John Durkop0e005192020-10-31 22:06:54 -07003595#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003596 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3597 {
3598 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3599 MBEDTLS_MD_NONE );
3600 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003601 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003602 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003603 MBEDTLS_RSA_PUBLIC,
3604 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003605 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003606 hash,
3607 signature );
3608 }
3609 else
John Durkop0e005192020-10-31 22:06:54 -07003610#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3611#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003612 if( PSA_ALG_IS_RSA_PSS( alg ) )
3613 {
3614 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3615 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003616 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003617 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003618 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003619 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003620 (unsigned int) hash_length,
3621 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003622 signature );
3623 }
3624 else
John Durkop0e005192020-10-31 22:06:54 -07003625#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003626 {
3627 return( PSA_ERROR_INVALID_ARGUMENT );
3628 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003629
3630 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3631 * the rest of the signature is invalid". This has little use in
3632 * practice and PSA doesn't report this distinction. */
3633 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3634 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003635 return( mbedtls_to_psa_error( ret ) );
3636}
John Durkop6ba40d12020-11-10 08:50:04 -08003637#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3638 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003639
John Durkop6ba40d12020-11-10 08:50:04 -08003640#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3641 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003642/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3643 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3644 * (even though these functions don't modify it). */
3645static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3646 psa_algorithm_t alg,
3647 const uint8_t *hash,
3648 size_t hash_length,
3649 uint8_t *signature,
3650 size_t signature_size,
3651 size_t *signature_length )
3652{
Janos Follath24eed8d2019-11-22 13:21:35 +00003653 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003654 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003655 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003656 mbedtls_mpi_init( &r );
3657 mbedtls_mpi_init( &s );
3658
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003659 if( signature_size < 2 * curve_bytes )
3660 {
3661 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3662 goto cleanup;
3663 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003664
John Durkop0ea39e02020-10-13 19:58:20 -07003665#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003666 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3667 {
3668 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3669 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3670 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003671 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3672 &ecp->d, hash,
3673 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003674 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003675 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003676 }
3677 else
John Durkop0ea39e02020-10-13 19:58:20 -07003678#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003679 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003680 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003681 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3682 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003683 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003684 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003685 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003686
3687 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3688 signature,
3689 curve_bytes ) );
3690 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3691 signature + curve_bytes,
3692 curve_bytes ) );
3693
3694cleanup:
3695 mbedtls_mpi_free( &r );
3696 mbedtls_mpi_free( &s );
3697 if( ret == 0 )
3698 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003699 return( mbedtls_to_psa_error( ret ) );
3700}
3701
3702static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3703 const uint8_t *hash,
3704 size_t hash_length,
3705 const uint8_t *signature,
3706 size_t signature_length )
3707{
Janos Follath24eed8d2019-11-22 13:21:35 +00003708 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003709 mbedtls_mpi r, s;
3710 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3711 mbedtls_mpi_init( &r );
3712 mbedtls_mpi_init( &s );
3713
3714 if( signature_length != 2 * curve_bytes )
3715 return( PSA_ERROR_INVALID_SIGNATURE );
3716
3717 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3718 signature,
3719 curve_bytes ) );
3720 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3721 signature + curve_bytes,
3722 curve_bytes ) );
3723
Steven Cooremanacda8342020-07-24 23:09:52 +02003724 /* Check whether the public part is loaded. If not, load it. */
3725 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3726 {
3727 MBEDTLS_MPI_CHK(
3728 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003729 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003730 }
3731
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003732 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3733 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003734
3735cleanup:
3736 mbedtls_mpi_free( &r );
3737 mbedtls_mpi_free( &s );
3738 return( mbedtls_to_psa_error( ret ) );
3739}
John Durkop6ba40d12020-11-10 08:50:04 -08003740#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3741 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003742
Ronald Croncf56a0a2020-08-04 09:51:30 +02003743psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003744 psa_algorithm_t alg,
3745 const uint8_t *hash,
3746 size_t hash_length,
3747 uint8_t *signature,
3748 size_t signature_size,
3749 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003750{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003751 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003752 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003753 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003754
3755 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003756 /* Immediately reject a zero-length signature buffer. This guarantees
3757 * that signature must be a valid pointer. (On the other hand, the hash
3758 * buffer can in principle be empty since it doesn't actually have
3759 * to be a hash.) */
3760 if( signature_size == 0 )
3761 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003762
Ronald Cron5c522922020-11-14 16:35:34 +01003763 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3764 PSA_KEY_USAGE_SIGN_HASH,
3765 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003766 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003767 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003768 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003769 {
3770 status = PSA_ERROR_INVALID_ARGUMENT;
3771 goto exit;
3772 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003773
Steven Cooremancd84cb42020-07-16 20:28:36 +02003774 /* Try any of the available accelerators first */
3775 status = psa_driver_wrapper_sign_hash( slot,
3776 alg,
3777 hash,
3778 hash_length,
3779 signature,
3780 signature_size,
3781 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003782 if( status != PSA_ERROR_NOT_SUPPORTED ||
3783 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003784 goto exit;
3785
Steven Cooreman7a250572020-07-17 16:43:05 +02003786 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003787#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3788 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003789 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003790 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003791 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003792
Ronald Cron90857082020-11-25 14:58:33 +01003793 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3794 slot->key.data,
3795 slot->key.bytes,
3796 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003797 if( status != PSA_SUCCESS )
3798 goto exit;
3799
Steven Cooremana2371e52020-07-28 14:30:39 +02003800 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003801 alg,
3802 hash, hash_length,
3803 signature, signature_size,
3804 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003805
Steven Cooremana2371e52020-07-28 14:30:39 +02003806 mbedtls_rsa_free( rsa );
3807 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003808 }
3809 else
John Durkop6ba40d12020-11-10 08:50:04 -08003810#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3811 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003812 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003813 {
John Durkop9814fa22020-11-04 12:28:15 -08003814#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3815 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003816 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003817#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003818 PSA_ALG_IS_ECDSA( alg )
3819#else
3820 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3821#endif
3822 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003823 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003824 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003825 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3826 slot->key.data,
3827 slot->key.bytes,
3828 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003829 if( status != PSA_SUCCESS )
3830 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003831 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003832 alg,
3833 hash, hash_length,
3834 signature, signature_size,
3835 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003836 mbedtls_ecp_keypair_free( ecp );
3837 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003838 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003839 else
John Durkop9814fa22020-11-04 12:28:15 -08003840#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3841 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003842 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003843 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003844 }
itayzafrir5c753392018-05-08 11:18:38 +03003845 }
3846 else
itayzafrir5c753392018-05-08 11:18:38 +03003847 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003848 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003849 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003850
3851exit:
3852 /* Fill the unused part of the output buffer (the whole buffer on error,
3853 * the trailing part on success) with something that isn't a valid mac
3854 * (barring an attack on the mac and deliberately-crafted input),
3855 * in case the caller doesn't check the return status properly. */
3856 if( status == PSA_SUCCESS )
3857 memset( signature + *signature_length, '!',
3858 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003859 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003860 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003861 /* If signature_size is 0 then we have nothing to do. We must not call
3862 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003863
Ronald Cron5c522922020-11-14 16:35:34 +01003864 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003865
Ronald Cron5c522922020-11-14 16:35:34 +01003866 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003867}
3868
Ronald Croncf56a0a2020-08-04 09:51:30 +02003869psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003870 psa_algorithm_t alg,
3871 const uint8_t *hash,
3872 size_t hash_length,
3873 const uint8_t *signature,
3874 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003875{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003876 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003877 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003878 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003879
Ronald Cron5c522922020-11-14 16:35:34 +01003880 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3881 PSA_KEY_USAGE_VERIFY_HASH,
3882 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003883 if( status != PSA_SUCCESS )
3884 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003885
Steven Cooreman55ae2172020-07-17 19:46:15 +02003886 /* Try any of the available accelerators first */
3887 status = psa_driver_wrapper_verify_hash( slot,
3888 alg,
3889 hash,
3890 hash_length,
3891 signature,
3892 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003893 if( status != PSA_ERROR_NOT_SUPPORTED ||
3894 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003895 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003896
John Durkop6ba40d12020-11-10 08:50:04 -08003897#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3898 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003899 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003900 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003901 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003902
Ronald Cron90857082020-11-25 14:58:33 +01003903 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3904 slot->key.data,
3905 slot->key.bytes,
3906 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003907 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003908 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003909
Steven Cooremana2371e52020-07-28 14:30:39 +02003910 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003911 alg,
3912 hash, hash_length,
3913 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003914 mbedtls_rsa_free( rsa );
3915 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003916 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003917 }
3918 else
John Durkop6ba40d12020-11-10 08:50:04 -08003919#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3920 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003921 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003922 {
John Durkop9814fa22020-11-04 12:28:15 -08003923#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3924 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003925 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003926 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003927 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003928 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3929 slot->key.data,
3930 slot->key.bytes,
3931 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003932 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003933 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003934 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003935 hash, hash_length,
3936 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003937 mbedtls_ecp_keypair_free( ecp );
3938 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003939 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003940 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003941 else
John Durkop9814fa22020-11-04 12:28:15 -08003942#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3943 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003944 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003945 status = PSA_ERROR_INVALID_ARGUMENT;
3946 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003947 }
itayzafrir5c753392018-05-08 11:18:38 +03003948 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003949 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003950 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003951 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003952 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003953
3954exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003955 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003956
Ronald Cron5c522922020-11-14 16:35:34 +01003957 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003958}
3959
John Durkop0e005192020-10-31 22:06:54 -07003960#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003961static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3962 mbedtls_rsa_context *rsa )
3963{
3964 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3965 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3966 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3967 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3968}
John Durkop0e005192020-10-31 22:06:54 -07003969#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003970
Ronald Croncf56a0a2020-08-04 09:51:30 +02003971psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003972 psa_algorithm_t alg,
3973 const uint8_t *input,
3974 size_t input_length,
3975 const uint8_t *salt,
3976 size_t salt_length,
3977 uint8_t *output,
3978 size_t output_size,
3979 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003980{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003982 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003983 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003984
Darryl Green5cc689a2018-07-24 15:34:10 +01003985 (void) input;
3986 (void) input_length;
3987 (void) salt;
3988 (void) output;
3989 (void) output_size;
3990
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003991 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003992
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003993 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3994 return( PSA_ERROR_INVALID_ARGUMENT );
3995
Ronald Cron5c522922020-11-14 16:35:34 +01003996 status = psa_get_and_lock_transparent_key_slot_with_policy(
3997 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003998 if( status != PSA_SUCCESS )
3999 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004000 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
4001 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004002 {
4003 status = PSA_ERROR_INVALID_ARGUMENT;
4004 goto exit;
4005 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004006
John Durkop6ba40d12020-11-10 08:50:04 -08004007#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4008 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004009 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004010 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004011 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004012 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
4013 slot->key.data,
4014 slot->key.bytes,
4015 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004016 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02004017 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02004018
4019 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004020 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004021 status = PSA_ERROR_BUFFER_TOO_SMALL;
4022 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004023 }
John Durkop0e005192020-10-31 22:06:54 -07004024#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004025 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004026 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004027 status = mbedtls_to_psa_error(
4028 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004029 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004030 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004031 MBEDTLS_RSA_PUBLIC,
4032 input_length,
4033 input,
4034 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004035 }
4036 else
John Durkop0e005192020-10-31 22:06:54 -07004037#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4038#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004039 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004040 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004041 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004042 status = mbedtls_to_psa_error(
4043 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004044 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004045 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004046 MBEDTLS_RSA_PUBLIC,
4047 salt, salt_length,
4048 input_length,
4049 input,
4050 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004051 }
4052 else
John Durkop0e005192020-10-31 22:06:54 -07004053#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004054 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004055 status = PSA_ERROR_INVALID_ARGUMENT;
4056 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004057 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02004058rsa_exit:
4059 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02004060 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004061
Steven Cooremana2371e52020-07-28 14:30:39 +02004062 mbedtls_rsa_free( rsa );
4063 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004064 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004065 else
John Durkop9814fa22020-11-04 12:28:15 -08004066#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08004067 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004068 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004069 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004070 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004071
4072exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004073 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004074
Ronald Cron5c522922020-11-14 16:35:34 +01004075 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004076}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004077
Ronald Croncf56a0a2020-08-04 09:51:30 +02004078psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02004079 psa_algorithm_t alg,
4080 const uint8_t *input,
4081 size_t input_length,
4082 const uint8_t *salt,
4083 size_t salt_length,
4084 uint8_t *output,
4085 size_t output_size,
4086 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004087{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004089 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004090 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004091
Darryl Green5cc689a2018-07-24 15:34:10 +01004092 (void) input;
4093 (void) input_length;
4094 (void) salt;
4095 (void) output;
4096 (void) output_size;
4097
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03004098 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004099
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02004100 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
4101 return( PSA_ERROR_INVALID_ARGUMENT );
4102
Ronald Cron5c522922020-11-14 16:35:34 +01004103 status = psa_get_and_lock_transparent_key_slot_with_policy(
4104 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004105 if( status != PSA_SUCCESS )
4106 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02004107 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004108 {
4109 status = PSA_ERROR_INVALID_ARGUMENT;
4110 goto exit;
4111 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004112
John Durkop6ba40d12020-11-10 08:50:04 -08004113#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
4114 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02004115 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004116 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004117 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01004118 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
4119 slot->key.data,
4120 slot->key.bytes,
4121 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02004122 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004123 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004124
Steven Cooremana2371e52020-07-28 14:30:39 +02004125 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02004126 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004127 status = PSA_ERROR_INVALID_ARGUMENT;
4128 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02004129 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004130
John Durkop0e005192020-10-31 22:06:54 -07004131#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02004132 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004133 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004134 status = mbedtls_to_psa_error(
4135 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004136 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004137 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004138 MBEDTLS_RSA_PRIVATE,
4139 output_length,
4140 input,
4141 output,
4142 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004143 }
4144 else
John Durkop0e005192020-10-31 22:06:54 -07004145#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
4146#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02004147 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004148 {
Steven Cooremana2371e52020-07-28 14:30:39 +02004149 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02004150 status = mbedtls_to_psa_error(
4151 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004152 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004153 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02004154 MBEDTLS_RSA_PRIVATE,
4155 salt, salt_length,
4156 output_length,
4157 input,
4158 output,
4159 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004160 }
4161 else
John Durkop0e005192020-10-31 22:06:54 -07004162#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004163 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02004164 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004165 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03004166
Steven Cooreman4fed4552020-08-03 14:46:03 +02004167rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02004168 mbedtls_rsa_free( rsa );
4169 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004170 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004171 else
John Durkop6ba40d12020-11-10 08:50:04 -08004172#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
4173 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004174 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004175 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03004176 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004177
4178exit:
Ronald Cron5c522922020-11-14 16:35:34 +01004179 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004180
Ronald Cron5c522922020-11-14 16:35:34 +01004181 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02004182}
Gilles Peskine20035e32018-02-03 22:44:14 +01004183
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004184
4185
mohammad1603503973b2018-03-12 15:59:30 +02004186/****************************************************************/
4187/* Symmetric cryptography */
4188/****************************************************************/
4189
Gilles Peskinee553c652018-06-04 16:22:46 +02004190static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004191 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02004192 psa_algorithm_t alg,
4193 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02004194{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004196 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004197 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01004198 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02004199 size_t key_bits;
4200 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004201 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
4202 PSA_KEY_USAGE_ENCRYPT :
4203 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02004204
Steven Cooremand3feccd2020-09-01 15:56:14 +02004205 /* A context must be freshly initialized before it can be set up. */
4206 if( operation->alg != 0 )
4207 return( PSA_ERROR_BAD_STATE );
4208
Steven Cooremana07b9972020-09-10 14:54:14 +02004209 /* The requested algorithm must be one that can be processed by cipher. */
4210 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02004211 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004212
Steven Cooremanef8575e2020-09-11 11:44:50 +02004213 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01004214 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004215 if( status != PSA_SUCCESS )
4216 goto exit;
4217
4218 /* Initialize the operation struct members, except for alg. The alg member
4219 * is used to indicate to psa_cipher_abort that there are resources to free,
4220 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004221 operation->key_set = 0;
4222 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004223 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02004224 operation->iv_size = 0;
4225 operation->block_size = 0;
4226 if( alg == PSA_ALG_ECB_NO_PADDING )
4227 operation->iv_required = 0;
4228 else
4229 operation->iv_required = 1;
4230
Steven Cooremana07b9972020-09-10 14:54:14 +02004231 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02004232 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004233 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004234 slot,
4235 alg );
4236 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004237 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02004238 slot,
4239 alg );
4240
Steven Cooremanef8575e2020-09-11 11:44:50 +02004241 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004242 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004243 /* Once the driver context is initialised, it needs to be freed using
4244 * psa_cipher_abort. Indicate this through setting alg. */
4245 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02004246 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02004247
Steven Cooremand3feccd2020-09-01 15:56:14 +02004248 if( status != PSA_ERROR_NOT_SUPPORTED ||
4249 psa_key_lifetime_is_external( slot->attr.lifetime ) )
4250 goto exit;
4251
Steven Cooremana07b9972020-09-10 14:54:14 +02004252 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02004253 * available for the given algorithm & key. */
4254 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02004255
Steven Cooremana07b9972020-09-10 14:54:14 +02004256 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02004257 * psa_cipher_abort. Indicate there is something to be freed through setting
4258 * alg, and indicate the operation is being done using mbedtls crypto through
4259 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02004260 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004261 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02004262
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004263 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02004264 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02004265 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004266 {
4267 status = PSA_ERROR_NOT_SUPPORTED;
4268 goto exit;
4269 }
mohammad1603503973b2018-03-12 15:59:30 +02004270
mohammad1603503973b2018-03-12 15:59:30 +02004271 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03004272 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004273 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004274
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004275#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02004276 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004277 {
4278 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02004279 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01004280 memcpy( keys, slot->key.data, 16 );
4281 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004282 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
4283 keys,
4284 192, cipher_operation );
4285 }
4286 else
4287#endif
4288 {
4289 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004290 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01004291 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02004292 }
Moran Peker41deec42018-04-04 15:43:05 +03004293 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004294 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004295
mohammad16038481e742018-03-18 13:57:31 +02004296#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004297 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02004298 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004299 case PSA_ALG_CBC_NO_PADDING:
4300 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4301 MBEDTLS_PADDING_NONE );
4302 break;
4303 case PSA_ALG_CBC_PKCS7:
4304 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
4305 MBEDTLS_PADDING_PKCS7 );
4306 break;
4307 default:
4308 /* The algorithm doesn't involve padding. */
4309 ret = 0;
4310 break;
4311 }
4312 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004313 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02004314#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
4315
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004316 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004317 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02004318 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
4319 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02004320 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004321 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02004322 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004323#if defined(MBEDTLS_CHACHA20_C)
4324 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01004325 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02004326 operation->iv_size = 12;
4327#endif
mohammad1603503973b2018-03-12 15:59:30 +02004328
Steven Cooreman7df02922020-09-09 15:28:49 +02004329 status = PSA_SUCCESS;
4330
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004331exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004332 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004333 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02004334 if( status == PSA_SUCCESS )
4335 {
4336 /* Update operation flags for both driver and software implementations */
4337 operation->key_set = 1;
4338 }
4339 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004340 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004341
Ronald Cron5c522922020-11-14 16:35:34 +01004342 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02004343
Ronald Cron5c522922020-11-14 16:35:34 +01004344 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02004345}
4346
Gilles Peskinefe119512018-07-08 21:39:34 +02004347psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004348 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004349 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004350{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004351 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004352}
4353
Gilles Peskinefe119512018-07-08 21:39:34 +02004354psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004355 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004356 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004357{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004358 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004359}
4360
Gilles Peskinefe119512018-07-08 21:39:34 +02004361psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004362 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004363 size_t iv_size,
4364 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004365{
itayzafrir534bd7c2018-08-02 13:56:32 +03004366 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004368 if( operation->iv_set || ! operation->iv_required )
4369 {
4370 return( PSA_ERROR_BAD_STATE );
4371 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004372
Steven Cooremanef8575e2020-09-11 11:44:50 +02004373 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004374 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004375 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004376 iv,
4377 iv_size,
4378 iv_length );
4379 goto exit;
4380 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004381
Moran Peker41deec42018-04-04 15:43:05 +03004382 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004383 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004384 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004385 goto exit;
4386 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004387 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004388 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004389 if( ret != 0 )
4390 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004391 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004392 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004393 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004394
mohammad16038481e742018-03-18 13:57:31 +02004395 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004396 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004397
Moran Peker395db872018-05-31 14:07:14 +03004398exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004399 if( status == PSA_SUCCESS )
4400 operation->iv_set = 1;
4401 else
Moran Peker395db872018-05-31 14:07:14 +03004402 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004403 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004404}
4405
Gilles Peskinefe119512018-07-08 21:39:34 +02004406psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004407 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004408 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004409{
itayzafrir534bd7c2018-08-02 13:56:32 +03004410 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004412 if( operation->iv_set || ! operation->iv_required )
4413 {
4414 return( PSA_ERROR_BAD_STATE );
4415 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004416
Steven Cooremanef8575e2020-09-11 11:44:50 +02004417 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004418 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004419 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004420 iv,
4421 iv_length );
4422 goto exit;
4423 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004424
Moran Pekera28258c2018-05-29 16:25:04 +03004425 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004426 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004427 status = PSA_ERROR_INVALID_ARGUMENT;
4428 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004429 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004430 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4431 status = mbedtls_to_psa_error( ret );
4432exit:
4433 if( status == PSA_SUCCESS )
4434 operation->iv_set = 1;
4435 else
mohammad1603503973b2018-03-12 15:59:30 +02004436 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004437 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004438}
4439
Steven Cooreman177deba2020-09-07 17:14:14 +02004440/* Process input for which the algorithm is set to ECB mode. This requires
4441 * manual processing, since the PSA API is defined as being able to process
4442 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4443 * underlying mbedtls_cipher_update only takes full blocks. */
4444static psa_status_t psa_cipher_update_ecb_internal(
4445 mbedtls_cipher_context_t *ctx,
4446 const uint8_t *input,
4447 size_t input_length,
4448 uint8_t *output,
4449 size_t output_size,
4450 size_t *output_length )
4451{
4452 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4453 size_t block_size = ctx->cipher_info->block_size;
4454 size_t internal_output_length = 0;
4455 *output_length = 0;
4456
4457 if( input_length == 0 )
4458 {
4459 status = PSA_SUCCESS;
4460 goto exit;
4461 }
4462
4463 if( ctx->unprocessed_len > 0 )
4464 {
4465 /* Fill up to block size, and run the block if there's a full one. */
4466 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4467
4468 if( input_length < bytes_to_copy )
4469 bytes_to_copy = input_length;
4470
4471 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4472 input, bytes_to_copy );
4473 input_length -= bytes_to_copy;
4474 input += bytes_to_copy;
4475 ctx->unprocessed_len += bytes_to_copy;
4476
4477 if( ctx->unprocessed_len == block_size )
4478 {
4479 status = mbedtls_to_psa_error(
4480 mbedtls_cipher_update( ctx,
4481 ctx->unprocessed_data,
4482 block_size,
4483 output, &internal_output_length ) );
4484
4485 if( status != PSA_SUCCESS )
4486 goto exit;
4487
4488 output += internal_output_length;
4489 output_size -= internal_output_length;
4490 *output_length += internal_output_length;
4491 ctx->unprocessed_len = 0;
4492 }
4493 }
4494
4495 while( input_length >= block_size )
4496 {
4497 /* Run all full blocks we have, one by one */
4498 status = mbedtls_to_psa_error(
4499 mbedtls_cipher_update( ctx, input,
4500 block_size,
4501 output, &internal_output_length ) );
4502
4503 if( status != PSA_SUCCESS )
4504 goto exit;
4505
4506 input_length -= block_size;
4507 input += block_size;
4508
4509 output += internal_output_length;
4510 output_size -= internal_output_length;
4511 *output_length += internal_output_length;
4512 }
4513
4514 if( input_length > 0 )
4515 {
4516 /* Save unprocessed bytes for later processing */
4517 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4518 input, input_length );
4519 ctx->unprocessed_len += input_length;
4520 }
4521
4522 status = PSA_SUCCESS;
4523
4524exit:
4525 return( status );
4526}
4527
Gilles Peskinee553c652018-06-04 16:22:46 +02004528psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4529 const uint8_t *input,
4530 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004531 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004532 size_t output_size,
4533 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004534{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004536 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004537 if( operation->alg == 0 )
4538 {
4539 return( PSA_ERROR_BAD_STATE );
4540 }
4541 if( operation->iv_required && ! operation->iv_set )
4542 {
4543 return( PSA_ERROR_BAD_STATE );
4544 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004545
Steven Cooremanef8575e2020-09-11 11:44:50 +02004546 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004547 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004548 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004549 input,
4550 input_length,
4551 output,
4552 output_size,
4553 output_length );
4554 goto exit;
4555 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004556
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004557 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004558 {
4559 /* Take the unprocessed partial block left over from previous
4560 * update calls, if any, plus the input to this call. Remove
4561 * the last partial block, if any. You get the data that will be
4562 * output in this call. */
4563 expected_output_size =
4564 ( operation->ctx.cipher.unprocessed_len + input_length )
4565 / operation->block_size * operation->block_size;
4566 }
4567 else
4568 {
4569 expected_output_size = input_length;
4570 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004571
Gilles Peskine89d789c2018-06-04 17:17:16 +02004572 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004573 {
4574 status = PSA_ERROR_BUFFER_TOO_SMALL;
4575 goto exit;
4576 }
mohammad160382759612018-03-12 18:16:40 +02004577
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004578 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4579 {
4580 /* mbedtls_cipher_update has an API inconsistency: it will only
4581 * process a single block at a time in ECB mode. Abstract away that
4582 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004583 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4584 input,
4585 input_length,
4586 output,
4587 output_size,
4588 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004589 }
4590 else
4591 {
4592 status = mbedtls_to_psa_error(
4593 mbedtls_cipher_update( &operation->ctx.cipher, input,
4594 input_length, output, output_length ) );
4595 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004596exit:
4597 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004598 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004599 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004600}
4601
Gilles Peskinee553c652018-06-04 16:22:46 +02004602psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4603 uint8_t *output,
4604 size_t output_size,
4605 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004606{
David Saadab4ecc272019-02-14 13:48:10 +02004607 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004608 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004609 if( operation->alg == 0 )
4610 {
4611 return( PSA_ERROR_BAD_STATE );
4612 }
4613 if( operation->iv_required && ! operation->iv_set )
4614 {
4615 return( PSA_ERROR_BAD_STATE );
4616 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004617
Steven Cooremanef8575e2020-09-11 11:44:50 +02004618 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004619 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004620 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004621 output,
4622 output_size,
4623 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004624 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004625 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004626
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004627 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004628 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004629 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004630 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004631 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004632 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004633 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004634 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004635 }
4636
Steven Cooremanef8575e2020-09-11 11:44:50 +02004637 status = mbedtls_to_psa_error(
4638 mbedtls_cipher_finish( &operation->ctx.cipher,
4639 temp_output_buffer,
4640 output_length ) );
4641 if( status != PSA_SUCCESS )
4642 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004643
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004644 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004645 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004646 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004647 memcpy( output, temp_output_buffer, *output_length );
4648 else
Janos Follath315b51c2018-07-09 16:04:51 +01004649 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004650
Steven Cooremanef8575e2020-09-11 11:44:50 +02004651exit:
4652 if( operation->mbedtls_in_use == 1 )
4653 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004654
Steven Cooremanef8575e2020-09-11 11:44:50 +02004655 if( status == PSA_SUCCESS )
4656 return( psa_cipher_abort( operation ) );
4657 else
4658 {
4659 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004660 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004661
Steven Cooremanef8575e2020-09-11 11:44:50 +02004662 return( status );
4663 }
mohammad1603503973b2018-03-12 15:59:30 +02004664}
4665
Gilles Peskinee553c652018-06-04 16:22:46 +02004666psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4667{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004668 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004669 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004670 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004671 * in use. It's ok to call abort on such an object, and there's
4672 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004673 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004674 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004675
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004676 /* Sanity check (shouldn't happen: operation->alg should
4677 * always have been initialized to a valid value). */
4678 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4679 return( PSA_ERROR_BAD_STATE );
4680
Steven Cooremanef8575e2020-09-11 11:44:50 +02004681 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004682 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004683 else
4684 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004685
Moran Peker41deec42018-04-04 15:43:05 +03004686 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004687 operation->key_set = 0;
4688 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004689 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004690 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004691 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004692 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004693
Moran Peker395db872018-05-31 14:07:14 +03004694 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004695}
4696
Gilles Peskinea0655c32018-04-30 17:06:50 +02004697
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004698
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004699
mohammad16035955c982018-04-26 00:53:03 +03004700/****************************************************************/
4701/* AEAD */
4702/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004703
Gilles Peskineedf9a652018-08-17 18:11:56 +02004704typedef struct
4705{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004706 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004707 const mbedtls_cipher_info_t *cipher_info;
4708 union
4709 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004710 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004711#if defined(MBEDTLS_CCM_C)
4712 mbedtls_ccm_context ccm;
4713#endif /* MBEDTLS_CCM_C */
4714#if defined(MBEDTLS_GCM_C)
4715 mbedtls_gcm_context gcm;
4716#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004717#if defined(MBEDTLS_CHACHAPOLY_C)
4718 mbedtls_chachapoly_context chachapoly;
4719#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004720 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004721 psa_algorithm_t core_alg;
4722 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004723 uint8_t tag_length;
4724} aead_operation_t;
4725
Ronald Cronf95a2b12020-10-22 15:24:49 +02004726#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4727
Gilles Peskine30a9e412019-01-14 18:36:12 +01004728static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004729{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004730 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004731 {
4732#if defined(MBEDTLS_CCM_C)
4733 case PSA_ALG_CCM:
4734 mbedtls_ccm_free( &operation->ctx.ccm );
4735 break;
4736#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004737#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004738 case PSA_ALG_GCM:
4739 mbedtls_gcm_free( &operation->ctx.gcm );
4740 break;
4741#endif /* MBEDTLS_GCM_C */
4742 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004743
Ronald Cron5c522922020-11-14 16:35:34 +01004744 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004745}
4746
4747static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004748 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004749 psa_key_usage_t usage,
4750 psa_algorithm_t alg )
4751{
4752 psa_status_t status;
4753 size_t key_bits;
4754 mbedtls_cipher_id_t cipher_id;
4755
Ronald Cron5c522922020-11-14 16:35:34 +01004756 status = psa_get_and_lock_transparent_key_slot_with_policy(
4757 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004758 if( status != PSA_SUCCESS )
4759 return( status );
4760
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004761 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004762
4763 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004764 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004765 &cipher_id );
4766 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004767 {
4768 status = PSA_ERROR_NOT_SUPPORTED;
4769 goto cleanup;
4770 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004771
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004772 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004773 {
4774#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004775 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4776 operation->core_alg = PSA_ALG_CCM;
4777 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004778 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4779 * The call to mbedtls_ccm_encrypt_and_tag or
4780 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004781 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004782 {
4783 status = PSA_ERROR_INVALID_ARGUMENT;
4784 goto cleanup;
4785 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004786 mbedtls_ccm_init( &operation->ctx.ccm );
4787 status = mbedtls_to_psa_error(
4788 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004789 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004790 (unsigned int) key_bits ) );
4791 if( status != 0 )
4792 goto cleanup;
4793 break;
4794#endif /* MBEDTLS_CCM_C */
4795
4796#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004797 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4798 operation->core_alg = PSA_ALG_GCM;
4799 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004800 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4801 * The call to mbedtls_gcm_crypt_and_tag or
4802 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004803 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004804 {
4805 status = PSA_ERROR_INVALID_ARGUMENT;
4806 goto cleanup;
4807 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004808 mbedtls_gcm_init( &operation->ctx.gcm );
4809 status = mbedtls_to_psa_error(
4810 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004811 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004812 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004813 if( status != 0 )
4814 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004815 break;
4816#endif /* MBEDTLS_GCM_C */
4817
Gilles Peskine26869f22019-05-06 15:25:00 +02004818#if defined(MBEDTLS_CHACHAPOLY_C)
4819 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4820 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4821 operation->full_tag_length = 16;
4822 /* We only support the default tag length. */
4823 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004824 {
4825 status = PSA_ERROR_NOT_SUPPORTED;
4826 goto cleanup;
4827 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004828 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4829 status = mbedtls_to_psa_error(
4830 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004831 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004832 if( status != 0 )
4833 goto cleanup;
4834 break;
4835#endif /* MBEDTLS_CHACHAPOLY_C */
4836
Gilles Peskineedf9a652018-08-17 18:11:56 +02004837 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004838 status = PSA_ERROR_NOT_SUPPORTED;
4839 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004840 }
4841
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004842 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4843 {
4844 status = PSA_ERROR_INVALID_ARGUMENT;
4845 goto cleanup;
4846 }
4847 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004848
Gilles Peskineedf9a652018-08-17 18:11:56 +02004849 return( PSA_SUCCESS );
4850
4851cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004852 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004853 return( status );
4854}
4855
Ronald Croncf56a0a2020-08-04 09:51:30 +02004856psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004857 psa_algorithm_t alg,
4858 const uint8_t *nonce,
4859 size_t nonce_length,
4860 const uint8_t *additional_data,
4861 size_t additional_data_length,
4862 const uint8_t *plaintext,
4863 size_t plaintext_length,
4864 uint8_t *ciphertext,
4865 size_t ciphertext_size,
4866 size_t *ciphertext_length )
4867{
mohammad16035955c982018-04-26 00:53:03 +03004868 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004869 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004870 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004871
mohammad1603f08a5502018-06-03 15:05:47 +03004872 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004873
Ronald Croncf56a0a2020-08-04 09:51:30 +02004874 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004875 if( status != PSA_SUCCESS )
4876 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004877
Gilles Peskineedf9a652018-08-17 18:11:56 +02004878 /* For all currently supported modes, the tag is at the end of the
4879 * ciphertext. */
4880 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4881 {
4882 status = PSA_ERROR_BUFFER_TOO_SMALL;
4883 goto exit;
4884 }
4885 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004886
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004887#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004888 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004889 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004890 status = mbedtls_to_psa_error(
4891 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4892 MBEDTLS_GCM_ENCRYPT,
4893 plaintext_length,
4894 nonce, nonce_length,
4895 additional_data, additional_data_length,
4896 plaintext, ciphertext,
4897 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004898 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004899 else
4900#endif /* MBEDTLS_GCM_C */
4901#if defined(MBEDTLS_CCM_C)
4902 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004903 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004904 status = mbedtls_to_psa_error(
4905 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4906 plaintext_length,
4907 nonce, nonce_length,
4908 additional_data,
4909 additional_data_length,
4910 plaintext, ciphertext,
4911 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004912 }
mohammad16035c8845f2018-05-09 05:40:09 -07004913 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004914#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004915#if defined(MBEDTLS_CHACHAPOLY_C)
4916 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4917 {
4918 if( nonce_length != 12 || operation.tag_length != 16 )
4919 {
4920 status = PSA_ERROR_NOT_SUPPORTED;
4921 goto exit;
4922 }
4923 status = mbedtls_to_psa_error(
4924 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4925 plaintext_length,
4926 nonce,
4927 additional_data,
4928 additional_data_length,
4929 plaintext,
4930 ciphertext,
4931 tag ) );
4932 }
4933 else
4934#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004935 {
mohammad1603554faad2018-06-03 15:07:38 +03004936 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004937 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004938
Gilles Peskineedf9a652018-08-17 18:11:56 +02004939 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4940 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004941
Gilles Peskineedf9a652018-08-17 18:11:56 +02004942exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004943 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004944 if( status == PSA_SUCCESS )
4945 *ciphertext_length = plaintext_length + operation.tag_length;
4946 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004947}
4948
Gilles Peskineee652a32018-06-01 19:23:52 +02004949/* Locate the tag in a ciphertext buffer containing the encrypted data
4950 * followed by the tag. Return the length of the part preceding the tag in
4951 * *plaintext_length. This is the size of the plaintext in modes where
4952 * the encrypted data has the same size as the plaintext, such as
4953 * CCM and GCM. */
4954static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4955 const uint8_t *ciphertext,
4956 size_t ciphertext_length,
4957 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004958 const uint8_t **p_tag )
4959{
4960 size_t payload_length;
4961 if( tag_length > ciphertext_length )
4962 return( PSA_ERROR_INVALID_ARGUMENT );
4963 payload_length = ciphertext_length - tag_length;
4964 if( payload_length > plaintext_size )
4965 return( PSA_ERROR_BUFFER_TOO_SMALL );
4966 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004967 return( PSA_SUCCESS );
4968}
4969
Ronald Croncf56a0a2020-08-04 09:51:30 +02004970psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004971 psa_algorithm_t alg,
4972 const uint8_t *nonce,
4973 size_t nonce_length,
4974 const uint8_t *additional_data,
4975 size_t additional_data_length,
4976 const uint8_t *ciphertext,
4977 size_t ciphertext_length,
4978 uint8_t *plaintext,
4979 size_t plaintext_size,
4980 size_t *plaintext_length )
4981{
mohammad16035955c982018-04-26 00:53:03 +03004982 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004983 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004984 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004985
Gilles Peskineee652a32018-06-01 19:23:52 +02004986 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004987
Ronald Croncf56a0a2020-08-04 09:51:30 +02004988 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004989 if( status != PSA_SUCCESS )
4990 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004991
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004992 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4993 ciphertext, ciphertext_length,
4994 plaintext_size, &tag );
4995 if( status != PSA_SUCCESS )
4996 goto exit;
4997
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004998#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004999 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03005000 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005001 status = mbedtls_to_psa_error(
5002 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
5003 ciphertext_length - operation.tag_length,
5004 nonce, nonce_length,
5005 additional_data,
5006 additional_data_length,
5007 tag, operation.tag_length,
5008 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03005009 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005010 else
5011#endif /* MBEDTLS_GCM_C */
5012#if defined(MBEDTLS_CCM_C)
5013 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03005014 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02005015 status = mbedtls_to_psa_error(
5016 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
5017 ciphertext_length - operation.tag_length,
5018 nonce, nonce_length,
5019 additional_data,
5020 additional_data_length,
5021 ciphertext, plaintext,
5022 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03005023 }
mohammad160339574652018-06-01 04:39:53 -07005024 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01005025#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02005026#if defined(MBEDTLS_CHACHAPOLY_C)
5027 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
5028 {
5029 if( nonce_length != 12 || operation.tag_length != 16 )
5030 {
5031 status = PSA_ERROR_NOT_SUPPORTED;
5032 goto exit;
5033 }
5034 status = mbedtls_to_psa_error(
5035 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
5036 ciphertext_length - operation.tag_length,
5037 nonce,
5038 additional_data,
5039 additional_data_length,
5040 tag,
5041 ciphertext,
5042 plaintext ) );
5043 }
5044 else
5045#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07005046 {
mohammad1603554faad2018-06-03 15:07:38 +03005047 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07005048 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02005049
Gilles Peskineedf9a652018-08-17 18:11:56 +02005050 if( status != PSA_SUCCESS && plaintext_size != 0 )
5051 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03005052
Gilles Peskineedf9a652018-08-17 18:11:56 +02005053exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01005054 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02005055 if( status == PSA_SUCCESS )
5056 *plaintext_length = ciphertext_length - operation.tag_length;
5057 return( status );
mohammad16035955c982018-04-26 00:53:03 +03005058}
5059
Gilles Peskinea0655c32018-04-30 17:06:50 +02005060
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02005061
Gilles Peskine20035e32018-02-03 22:44:14 +01005062/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005063/* Generators */
5064/****************************************************************/
5065
John Durkop07cc04a2020-11-16 22:08:34 -08005066#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
5067 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5068 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5069#define AT_LEAST_ONE_BUILTIN_KDF
5070#endif
5071
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005072#define HKDF_STATE_INIT 0 /* no input yet */
5073#define HKDF_STATE_STARTED 1 /* got salt */
5074#define HKDF_STATE_KEYED 2 /* got key */
5075#define HKDF_STATE_OUTPUT 3 /* output started */
5076
Gilles Peskinecbe66502019-05-16 16:59:18 +02005077static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005078 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005079{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005080 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
5081 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005082 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005083 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005084}
5085
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005086psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005087{
5088 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005089 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005090 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005091 {
5092 /* The object has (apparently) been initialized but it is not
5093 * in use. It's ok to call abort on such an object, and there's
5094 * nothing to do. */
5095 }
5096 else
John Durkopd0321952020-10-29 21:37:36 -07005097#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005098 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005099 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005100 mbedtls_free( operation->ctx.hkdf.info );
5101 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005102 }
John Durkop07cc04a2020-11-16 22:08:34 -08005103 else
5104#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5105#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5106 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5107 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005108 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005109 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005110 {
Janos Follath6a1d2622019-06-11 10:37:28 +01005111 if( operation->ctx.tls12_prf.seed != NULL )
5112 {
5113 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
5114 operation->ctx.tls12_prf.seed_length );
5115 mbedtls_free( operation->ctx.tls12_prf.seed );
5116 }
5117
5118 if( operation->ctx.tls12_prf.label != NULL )
5119 {
5120 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
5121 operation->ctx.tls12_prf.label_length );
5122 mbedtls_free( operation->ctx.tls12_prf.label );
5123 }
5124
5125 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
5126
5127 /* We leave the fields Ai and output_block to be erased safely by the
5128 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005129 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005130 else
John Durkop07cc04a2020-11-16 22:08:34 -08005131#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5132 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005133 {
5134 status = PSA_ERROR_BAD_STATE;
5135 }
Janos Follath083036a2019-06-11 10:22:26 +01005136 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005137 return( status );
5138}
5139
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005140psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02005141 size_t *capacity)
5142{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005143 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005144 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005145 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005146 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005147 }
5148
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005149 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005150 return( PSA_SUCCESS );
5151}
5152
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005153psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005154 size_t capacity )
5155{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005156 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005157 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005158 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005159 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005160 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005161 return( PSA_SUCCESS );
5162}
5163
John Durkopd0321952020-10-29 21:37:36 -07005164#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005165/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02005166 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02005167static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005168 psa_algorithm_t hash_alg,
5169 uint8_t *output,
5170 size_t output_length )
5171{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005172 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005173 psa_status_t status;
5174
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005175 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
5176 return( PSA_ERROR_BAD_STATE );
5177 hkdf->state = HKDF_STATE_OUTPUT;
5178
Gilles Peskinebef7f142018-07-12 17:22:21 +02005179 while( output_length != 0 )
5180 {
5181 /* Copy what remains of the current block */
5182 uint8_t n = hash_length - hkdf->offset_in_block;
5183 if( n > output_length )
5184 n = (uint8_t) output_length;
5185 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
5186 output += n;
5187 output_length -= n;
5188 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02005189 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005190 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02005191 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005192 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005194 * object was corrupted or if this function is called directly
5195 * inside the library. */
5196 if( hkdf->block_number == 0xff )
5197 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02005198
5199 /* We need a new block */
5200 ++hkdf->block_number;
5201 hkdf->offset_in_block = 0;
5202 status = psa_hmac_setup_internal( &hkdf->hmac,
5203 hkdf->prk, hash_length,
5204 hash_alg );
5205 if( status != PSA_SUCCESS )
5206 return( status );
5207 if( hkdf->block_number != 1 )
5208 {
5209 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5210 hkdf->output_block,
5211 hash_length );
5212 if( status != PSA_SUCCESS )
5213 return( status );
5214 }
5215 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5216 hkdf->info,
5217 hkdf->info_length );
5218 if( status != PSA_SUCCESS )
5219 return( status );
5220 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5221 &hkdf->block_number, 1 );
5222 if( status != PSA_SUCCESS )
5223 return( status );
5224 status = psa_hmac_finish_internal( &hkdf->hmac,
5225 hkdf->output_block,
5226 sizeof( hkdf->output_block ) );
5227 if( status != PSA_SUCCESS )
5228 return( status );
5229 }
5230
5231 return( PSA_SUCCESS );
5232}
John Durkop07cc04a2020-11-16 22:08:34 -08005233#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005234
John Durkop07cc04a2020-11-16 22:08:34 -08005235#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5236 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005237static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5238 psa_tls12_prf_key_derivation_t *tls12_prf,
5239 psa_algorithm_t alg )
5240{
5241 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005242 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01005243 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
5244 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005245
Janos Follath7742fee2019-06-17 12:58:10 +01005246 /* We can't be wanting more output after block 0xff, otherwise
5247 * the capacity check in psa_key_derivation_output_bytes() would have
5248 * prevented this call. It could happen only if the operation
5249 * object was corrupted or if this function is called directly
5250 * inside the library. */
5251 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01005252 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01005253
5254 /* We need a new block */
5255 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005256 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005257
5258 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5259 *
5260 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5261 *
5262 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5263 * HMAC_hash(secret, A(2) + seed) +
5264 * HMAC_hash(secret, A(3) + seed) + ...
5265 *
5266 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005267 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005268 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005269 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005270 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005271 * is currently extracted as `output_block` and where i is
5272 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005273 */
5274
Janos Follathea29bfb2019-06-19 12:21:20 +01005275 /* Save the hash context before using it, to preserve the hash state with
5276 * only the inner padding in it. We need this, because inner padding depends
5277 * on the key (secret in the RFC's terminology). */
5278 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
5279 if( status != PSA_SUCCESS )
5280 goto cleanup;
5281
5282 /* Calculate A(i) where i = tls12_prf->block_number. */
5283 if( tls12_prf->block_number == 1 )
5284 {
5285 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5286 * the variable seed and in this instance means it in the context of the
5287 * P_hash function, where seed = label + seed.) */
5288 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5289 tls12_prf->label, tls12_prf->label_length );
5290 if( status != PSA_SUCCESS )
5291 goto cleanup;
5292 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5293 tls12_prf->seed, tls12_prf->seed_length );
5294 if( status != PSA_SUCCESS )
5295 goto cleanup;
5296 }
5297 else
5298 {
5299 /* A(i) = HMAC_hash(secret, A(i-1)) */
5300 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5301 tls12_prf->Ai, hash_length );
5302 if( status != PSA_SUCCESS )
5303 goto cleanup;
5304 }
5305
5306 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5307 tls12_prf->Ai, hash_length );
5308 if( status != PSA_SUCCESS )
5309 goto cleanup;
5310 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5311 if( status != PSA_SUCCESS )
5312 goto cleanup;
5313
5314 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
5315 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5316 tls12_prf->Ai, hash_length );
5317 if( status != PSA_SUCCESS )
5318 goto cleanup;
5319 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5320 tls12_prf->label, tls12_prf->label_length );
5321 if( status != PSA_SUCCESS )
5322 goto cleanup;
5323 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
5324 tls12_prf->seed, tls12_prf->seed_length );
5325 if( status != PSA_SUCCESS )
5326 goto cleanup;
5327 status = psa_hmac_finish_internal( &tls12_prf->hmac,
5328 tls12_prf->output_block, hash_length );
5329 if( status != PSA_SUCCESS )
5330 goto cleanup;
5331 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
5332 if( status != PSA_SUCCESS )
5333 goto cleanup;
5334
Janos Follath7742fee2019-06-17 12:58:10 +01005335
5336cleanup:
5337
Janos Follathea29bfb2019-06-19 12:21:20 +01005338 cleanup_status = psa_hash_abort( &backup );
5339 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
5340 status = cleanup_status;
5341
5342 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01005343}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005344
Janos Follath844eb0e2019-06-19 12:10:49 +01005345static psa_status_t psa_key_derivation_tls12_prf_read(
5346 psa_tls12_prf_key_derivation_t *tls12_prf,
5347 psa_algorithm_t alg,
5348 uint8_t *output,
5349 size_t output_length )
5350{
5351 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005352 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005353 psa_status_t status;
5354 uint8_t offset, length;
5355
5356 while( output_length != 0 )
5357 {
5358 /* Check if we have fully processed the current block. */
5359 if( tls12_prf->left_in_block == 0 )
5360 {
5361 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5362 alg );
5363 if( status != PSA_SUCCESS )
5364 return( status );
5365
5366 continue;
5367 }
5368
5369 if( tls12_prf->left_in_block > output_length )
5370 length = (uint8_t) output_length;
5371 else
5372 length = tls12_prf->left_in_block;
5373
5374 offset = hash_length - tls12_prf->left_in_block;
5375 memcpy( output, tls12_prf->output_block + offset, length );
5376 output += length;
5377 output_length -= length;
5378 tls12_prf->left_in_block -= length;
5379 }
5380
5381 return( PSA_SUCCESS );
5382}
John Durkop07cc04a2020-11-16 22:08:34 -08005383#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5384 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005385
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005386psa_status_t psa_key_derivation_output_bytes(
5387 psa_key_derivation_operation_t *operation,
5388 uint8_t *output,
5389 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005390{
5391 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005392 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005393
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005394 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005395 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005396 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005397 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005398 }
5399
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005400 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005401 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005402 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005403 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005404 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005405 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005406 goto exit;
5407 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005408 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005409 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005410 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005411 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005412 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5413 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005414 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005415 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005416 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005417 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005418 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005419
John Durkopd0321952020-10-29 21:37:36 -07005420#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005421 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005422 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005423 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005424 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005425 output, output_length );
5426 }
Janos Follathadbec812019-06-14 11:05:39 +01005427 else
John Durkop07cc04a2020-11-16 22:08:34 -08005428#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5429#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5430 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005431 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005432 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005433 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005434 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005435 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005436 output_length );
5437 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005438 else
John Durkop07cc04a2020-11-16 22:08:34 -08005439#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5440 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005441 {
5442 return( PSA_ERROR_BAD_STATE );
5443 }
5444
5445exit:
5446 if( status != PSA_SUCCESS )
5447 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005448 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005449 * This allows us to differentiate between exhausted operations and
5450 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5451 * operations. */
5452 psa_algorithm_t alg = operation->alg;
5453 psa_key_derivation_abort( operation );
5454 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005455 memset( output, '!', output_length );
5456 }
5457 return( status );
5458}
5459
Gilles Peskine08542d82018-07-19 17:05:42 +02005460#if defined(MBEDTLS_DES_C)
5461static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5462{
5463 if( data_size >= 8 )
5464 mbedtls_des_key_set_parity( data );
5465 if( data_size >= 16 )
5466 mbedtls_des_key_set_parity( data + 8 );
5467 if( data_size >= 24 )
5468 mbedtls_des_key_set_parity( data + 16 );
5469}
5470#endif /* MBEDTLS_DES_C */
5471
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005472static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005473 psa_key_slot_t *slot,
5474 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005475 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005476{
5477 uint8_t *data = NULL;
5478 size_t bytes = PSA_BITS_TO_BYTES( bits );
5479 psa_status_t status;
5480
Gilles Peskine8e338702019-07-30 20:06:31 +02005481 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005482 return( PSA_ERROR_INVALID_ARGUMENT );
5483 if( bits % 8 != 0 )
5484 return( PSA_ERROR_INVALID_ARGUMENT );
5485 data = mbedtls_calloc( 1, bytes );
5486 if( data == NULL )
5487 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5488
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005489 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005490 if( status != PSA_SUCCESS )
5491 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005492#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005493 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005494 psa_des_set_key_parity( data, bytes );
5495#endif /* MBEDTLS_DES_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005496 status = psa_import_key_into_slot( slot, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005497
5498exit:
5499 mbedtls_free( data );
5500 return( status );
5501}
5502
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005503psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005504 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005505 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005506{
5507 psa_status_t status;
5508 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005509 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005510
Ronald Cron81709fc2020-11-14 12:10:32 +01005511 *key = MBEDTLS_SVC_KEY_ID_INIT;
5512
Gilles Peskine0f84d622019-09-12 19:03:13 +02005513 /* Reject any attempt to create a zero-length key so that we don't
5514 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5515 if( psa_get_key_bits( attributes ) == 0 )
5516 return( PSA_ERROR_INVALID_ARGUMENT );
5517
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005518 if( ! operation->can_output_key )
5519 return( PSA_ERROR_NOT_PERMITTED );
5520
Ronald Cron81709fc2020-11-14 12:10:32 +01005521 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5522 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005523#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5524 if( driver != NULL )
5525 {
5526 /* Deriving a key in a secure element is not implemented yet. */
5527 status = PSA_ERROR_NOT_SUPPORTED;
5528 }
5529#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005530 if( status == PSA_SUCCESS )
5531 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005532 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005533 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005534 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005535 }
5536 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005537 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005538 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005539 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005540
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005541 return( status );
5542}
5543
Gilles Peskineeab56e42018-07-12 17:12:33 +02005544
5545
5546/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005547/* Key derivation */
5548/****************************************************************/
5549
John Durkop07cc04a2020-11-16 22:08:34 -08005550#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005551static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005552 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005553 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005554{
John Durkop07cc04a2020-11-16 22:08:34 -08005555 int is_kdf_alg_supported;
5556
Janos Follath5fe19732019-06-20 15:09:30 +01005557 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5558 * initialisers for this union leave some bytes unspecified.) */
5559 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5560
Gilles Peskine969c5d62019-01-16 15:53:06 +01005561 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005562#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005563 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5564 is_kdf_alg_supported = 1;
5565 else
5566#endif
5567#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5568 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5569 is_kdf_alg_supported = 1;
5570 else
5571#endif
5572#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5573 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5574 is_kdf_alg_supported = 1;
5575 else
5576#endif
5577 is_kdf_alg_supported = 0;
5578
5579 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005580 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005581 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005582 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005583 if( hash_size == 0 )
5584 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005585 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5586 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005587 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005588 {
5589 return( PSA_ERROR_NOT_SUPPORTED );
5590 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005591 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005592 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005593 }
John Durkop07cc04a2020-11-16 22:08:34 -08005594
5595 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005596}
John Durkop07cc04a2020-11-16 22:08:34 -08005597#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005598
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005599psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005600 psa_algorithm_t alg )
5601{
5602 psa_status_t status;
5603
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005604 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005605 return( PSA_ERROR_BAD_STATE );
5606
Gilles Peskine6843c292019-01-18 16:44:49 +01005607 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5608 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005609#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005610 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005611 {
5612 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005613 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005614 }
5615 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5616 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005617 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005618 }
John Durkop07cc04a2020-11-16 22:08:34 -08005619#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005620 else
5621 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005622
5623 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005624 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005625 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005626}
5627
John Durkopd0321952020-10-29 21:37:36 -07005628#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005629static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005630 psa_algorithm_t hash_alg,
5631 psa_key_derivation_step_t step,
5632 const uint8_t *data,
5633 size_t data_length )
5634{
5635 psa_status_t status;
5636 switch( step )
5637 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005638 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005639 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005640 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005641 status = psa_hmac_setup_internal( &hkdf->hmac,
5642 data, data_length,
5643 hash_alg );
5644 if( status != PSA_SUCCESS )
5645 return( status );
5646 hkdf->state = HKDF_STATE_STARTED;
5647 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005648 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005649 /* If no salt was provided, use an empty salt. */
5650 if( hkdf->state == HKDF_STATE_INIT )
5651 {
5652 status = psa_hmac_setup_internal( &hkdf->hmac,
5653 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005654 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005655 if( status != PSA_SUCCESS )
5656 return( status );
5657 hkdf->state = HKDF_STATE_STARTED;
5658 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005659 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005660 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005661 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5662 data, data_length );
5663 if( status != PSA_SUCCESS )
5664 return( status );
5665 status = psa_hmac_finish_internal( &hkdf->hmac,
5666 hkdf->prk,
5667 sizeof( hkdf->prk ) );
5668 if( status != PSA_SUCCESS )
5669 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005670 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005671 hkdf->block_number = 0;
5672 hkdf->state = HKDF_STATE_KEYED;
5673 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005674 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005675 if( hkdf->state == HKDF_STATE_OUTPUT )
5676 return( PSA_ERROR_BAD_STATE );
5677 if( hkdf->info_set )
5678 return( PSA_ERROR_BAD_STATE );
5679 hkdf->info_length = data_length;
5680 if( data_length != 0 )
5681 {
5682 hkdf->info = mbedtls_calloc( 1, data_length );
5683 if( hkdf->info == NULL )
5684 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5685 memcpy( hkdf->info, data, data_length );
5686 }
5687 hkdf->info_set = 1;
5688 return( PSA_SUCCESS );
5689 default:
5690 return( PSA_ERROR_INVALID_ARGUMENT );
5691 }
5692}
John Durkop07cc04a2020-11-16 22:08:34 -08005693#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005694
John Durkop07cc04a2020-11-16 22:08:34 -08005695#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5696 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005697static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5698 const uint8_t *data,
5699 size_t data_length )
5700{
5701 if( prf->state != TLS12_PRF_STATE_INIT )
5702 return( PSA_ERROR_BAD_STATE );
5703
Janos Follathd6dce9f2019-07-04 09:11:38 +01005704 if( data_length != 0 )
5705 {
5706 prf->seed = mbedtls_calloc( 1, data_length );
5707 if( prf->seed == NULL )
5708 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005709
Janos Follathd6dce9f2019-07-04 09:11:38 +01005710 memcpy( prf->seed, data, data_length );
5711 prf->seed_length = data_length;
5712 }
Janos Follathf08e2652019-06-13 09:05:41 +01005713
5714 prf->state = TLS12_PRF_STATE_SEED_SET;
5715
5716 return( PSA_SUCCESS );
5717}
5718
Janos Follath81550542019-06-13 14:26:34 +01005719static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5720 psa_algorithm_t hash_alg,
5721 const uint8_t *data,
5722 size_t data_length )
5723{
5724 psa_status_t status;
5725 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5726 return( PSA_ERROR_BAD_STATE );
5727
5728 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5729 if( status != PSA_SUCCESS )
5730 return( status );
5731
5732 prf->state = TLS12_PRF_STATE_KEY_SET;
5733
5734 return( PSA_SUCCESS );
5735}
5736
Janos Follath63028dd2019-06-13 09:15:47 +01005737static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5738 const uint8_t *data,
5739 size_t data_length )
5740{
5741 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5742 return( PSA_ERROR_BAD_STATE );
5743
Janos Follathd6dce9f2019-07-04 09:11:38 +01005744 if( data_length != 0 )
5745 {
5746 prf->label = mbedtls_calloc( 1, data_length );
5747 if( prf->label == NULL )
5748 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005749
Janos Follathd6dce9f2019-07-04 09:11:38 +01005750 memcpy( prf->label, data, data_length );
5751 prf->label_length = data_length;
5752 }
Janos Follath63028dd2019-06-13 09:15:47 +01005753
5754 prf->state = TLS12_PRF_STATE_LABEL_SET;
5755
5756 return( PSA_SUCCESS );
5757}
5758
Janos Follathb03233e2019-06-11 15:30:30 +01005759static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5760 psa_algorithm_t hash_alg,
5761 psa_key_derivation_step_t step,
5762 const uint8_t *data,
5763 size_t data_length )
5764{
Janos Follathb03233e2019-06-11 15:30:30 +01005765 switch( step )
5766 {
Janos Follathf08e2652019-06-13 09:05:41 +01005767 case PSA_KEY_DERIVATION_INPUT_SEED:
5768 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005769 case PSA_KEY_DERIVATION_INPUT_SECRET:
5770 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005771 case PSA_KEY_DERIVATION_INPUT_LABEL:
5772 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005773 default:
5774 return( PSA_ERROR_INVALID_ARGUMENT );
5775 }
5776}
John Durkop07cc04a2020-11-16 22:08:34 -08005777#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5778 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5779
5780#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5781static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5782 psa_tls12_prf_key_derivation_t *prf,
5783 psa_algorithm_t hash_alg,
5784 const uint8_t *data,
5785 size_t data_length )
5786{
5787 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005788 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005789 uint8_t *cur = pms;
5790
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005791 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005792 return( PSA_ERROR_INVALID_ARGUMENT );
5793
5794 /* Quoting RFC 4279, Section 2:
5795 *
5796 * The premaster secret is formed as follows: if the PSK is N octets
5797 * long, concatenate a uint16 with the value N, N zero octets, a second
5798 * uint16 with the value N, and the PSK itself.
5799 */
5800
5801 *cur++ = ( data_length >> 8 ) & 0xff;
5802 *cur++ = ( data_length >> 0 ) & 0xff;
5803 memset( cur, 0, data_length );
5804 cur += data_length;
5805 *cur++ = pms[0];
5806 *cur++ = pms[1];
5807 memcpy( cur, data, data_length );
5808 cur += data_length;
5809
5810 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5811
5812 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5813 return( status );
5814}
Janos Follath6660f0e2019-06-17 08:44:03 +01005815
5816static psa_status_t psa_tls12_prf_psk_to_ms_input(
5817 psa_tls12_prf_key_derivation_t *prf,
5818 psa_algorithm_t hash_alg,
5819 psa_key_derivation_step_t step,
5820 const uint8_t *data,
5821 size_t data_length )
5822{
5823 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005824 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005825 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5826 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005827 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005828
5829 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5830}
John Durkop07cc04a2020-11-16 22:08:34 -08005831#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005832
Gilles Peskineb8965192019-09-24 16:21:10 +02005833/** Check whether the given key type is acceptable for the given
5834 * input step of a key derivation.
5835 *
5836 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5837 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5838 * Both secret and non-secret inputs can alternatively have the type
5839 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5840 * that the input was passed as a buffer rather than via a key object.
5841 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005842static int psa_key_derivation_check_input_type(
5843 psa_key_derivation_step_t step,
5844 psa_key_type_t key_type )
5845{
5846 switch( step )
5847 {
5848 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005849 if( key_type == PSA_KEY_TYPE_DERIVE )
5850 return( PSA_SUCCESS );
5851 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005852 return( PSA_SUCCESS );
5853 break;
5854 case PSA_KEY_DERIVATION_INPUT_LABEL:
5855 case PSA_KEY_DERIVATION_INPUT_SALT:
5856 case PSA_KEY_DERIVATION_INPUT_INFO:
5857 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005858 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5859 return( PSA_SUCCESS );
5860 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005861 return( PSA_SUCCESS );
5862 break;
5863 }
5864 return( PSA_ERROR_INVALID_ARGUMENT );
5865}
5866
Janos Follathb80a94e2019-06-12 15:54:46 +01005867static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005868 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005869 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005870 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005871 const uint8_t *data,
5872 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005873{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005874 psa_status_t status;
5875 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5876
5877 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005878 if( status != PSA_SUCCESS )
5879 goto exit;
5880
John Durkopd0321952020-10-29 21:37:36 -07005881#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005882 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005883 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005884 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005885 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005886 step, data, data_length );
5887 }
John Durkop07cc04a2020-11-16 22:08:34 -08005888 else
5889#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5890#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5891 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005892 {
Janos Follathb03233e2019-06-11 15:30:30 +01005893 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5894 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5895 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005896 }
John Durkop07cc04a2020-11-16 22:08:34 -08005897 else
5898#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5899#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5900 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005901 {
5902 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5903 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5904 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005905 }
5906 else
John Durkop07cc04a2020-11-16 22:08:34 -08005907#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005908 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005909 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005910 return( PSA_ERROR_BAD_STATE );
5911 }
5912
Gilles Peskine224b0d62019-09-23 18:13:17 +02005913exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005914 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005915 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005916 return( status );
5917}
5918
Janos Follath51f4a0f2019-06-14 11:35:55 +01005919psa_status_t psa_key_derivation_input_bytes(
5920 psa_key_derivation_operation_t *operation,
5921 psa_key_derivation_step_t step,
5922 const uint8_t *data,
5923 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005924{
Gilles Peskineb8965192019-09-24 16:21:10 +02005925 return( psa_key_derivation_input_internal( operation, step,
5926 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005927 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005928}
5929
Janos Follath51f4a0f2019-06-14 11:35:55 +01005930psa_status_t psa_key_derivation_input_key(
5931 psa_key_derivation_operation_t *operation,
5932 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005933 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005934{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005935 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005936 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005937 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005938
Ronald Cron5c522922020-11-14 16:35:34 +01005939 status = psa_get_and_lock_transparent_key_slot_with_policy(
5940 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005941 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005942 {
5943 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005944 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005945 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005946
5947 /* Passing a key object as a SECRET input unlocks the permission
5948 * to output to a key object. */
5949 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5950 operation->can_output_key = 1;
5951
Ronald Cronf95a2b12020-10-22 15:24:49 +02005952 status = psa_key_derivation_input_internal( operation,
5953 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005954 slot->key.data,
5955 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005956
Ronald Cron5c522922020-11-14 16:35:34 +01005957 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005958
Ronald Cron5c522922020-11-14 16:35:34 +01005959 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005960}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005961
5962
5963
5964/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005965/* Key agreement */
5966/****************************************************************/
5967
John Durkop6ba40d12020-11-10 08:50:04 -08005968#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005969static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5970 size_t peer_key_length,
5971 const mbedtls_ecp_keypair *our_key,
5972 uint8_t *shared_secret,
5973 size_t shared_secret_size,
5974 size_t *shared_secret_length )
5975{
Steven Cooremand4867872020-08-05 16:31:39 +02005976 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005977 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005978 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005979 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005980 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005981 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005982
Ronald Cron90857082020-11-25 14:58:33 +01005983 status = mbedtls_psa_ecp_load_representation(
5984 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5985 peer_key,
5986 peer_key_length,
5987 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005988 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005989 goto exit;
5990
Jaeden Amero97271b32019-01-10 19:38:51 +00005991 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005992 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005993 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005994 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005995 status = mbedtls_to_psa_error(
5996 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5997 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005998 goto exit;
5999
Jaeden Amero97271b32019-01-10 19:38:51 +00006000 status = mbedtls_to_psa_error(
6001 mbedtls_ecdh_calc_secret( &ecdh,
6002 shared_secret_length,
6003 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006004 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006005 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01006006 if( status != PSA_SUCCESS )
6007 goto exit;
6008 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
6009 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006010
6011exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01006012 if( status != PSA_SUCCESS )
6013 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006014 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02006015 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02006016 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02006017
Jaeden Amero97271b32019-01-10 19:38:51 +00006018 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006019}
John Durkop6ba40d12020-11-10 08:50:04 -08006020#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006021
Gilles Peskine01d718c2018-09-18 12:01:02 +02006022#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
6023
Gilles Peskine0216fe12019-04-11 21:23:21 +02006024static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
6025 psa_key_slot_t *private_key,
6026 const uint8_t *peer_key,
6027 size_t peer_key_length,
6028 uint8_t *shared_secret,
6029 size_t shared_secret_size,
6030 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006031{
Gilles Peskine0216fe12019-04-11 21:23:21 +02006032 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006033 {
John Durkop6ba40d12020-11-10 08:50:04 -08006034#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02006035 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02006036 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02006037 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02006038 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01006039 psa_status_t status = mbedtls_psa_ecp_load_representation(
6040 private_key->attr.type,
6041 private_key->key.data,
6042 private_key->key.bytes,
6043 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02006044 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006045 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006046 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02006047 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02006048 shared_secret, shared_secret_size,
6049 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02006050 mbedtls_ecp_keypair_free( ecp );
6051 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006052 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08006053#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02006054 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01006055 (void) private_key;
6056 (void) peer_key;
6057 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006058 (void) shared_secret;
6059 (void) shared_secret_size;
6060 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02006061 return( PSA_ERROR_NOT_SUPPORTED );
6062 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02006063}
6064
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02006065/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02006066 * to potentially free embedded data structures and wipe confidential data.
6067 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006068static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006069 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02006070 psa_key_slot_t *private_key,
6071 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006072 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02006073{
6074 psa_status_t status;
6075 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
6076 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006077 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02006078
6079 /* Step 1: run the secret agreement algorithm to generate the shared
6080 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02006081 status = psa_key_agreement_raw_internal( ka_alg,
6082 private_key,
6083 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03006084 shared_secret,
6085 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02006086 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02006087 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006088 goto exit;
6089
Gilles Peskineb0b255c2018-07-06 17:01:38 +02006090 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02006091 * the shared secret. A shared secret is permitted wherever a key
6092 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01006093 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006094 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01006095 shared_secret,
6096 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006097exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01006098 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006099 return( status );
6100}
6101
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006102psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006103 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006104 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02006105 const uint8_t *peer_key,
6106 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006107{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006108 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006109 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01006110 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006111
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006112 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02006113 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01006114 status = psa_get_and_lock_transparent_key_slot_with_policy(
6115 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02006116 if( status != PSA_SUCCESS )
6117 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006118 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01006119 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01006120 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01006121 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006122 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02006123 else
6124 {
6125 /* If a private key has been added as SECRET, we allow the derived
6126 * key material to be used as a key in PSA Crypto. */
6127 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
6128 operation->can_output_key = 1;
6129 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006130
Ronald Cron5c522922020-11-14 16:35:34 +01006131 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006132
Ronald Cron5c522922020-11-14 16:35:34 +01006133 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02006134}
6135
Gilles Peskinebe697d82019-05-16 18:00:41 +02006136psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006137 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02006138 const uint8_t *peer_key,
6139 size_t peer_key_length,
6140 uint8_t *output,
6141 size_t output_size,
6142 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02006143{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006144 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006145 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02006146 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02006147
6148 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
6149 {
6150 status = PSA_ERROR_INVALID_ARGUMENT;
6151 goto exit;
6152 }
Ronald Cron5c522922020-11-14 16:35:34 +01006153 status = psa_get_and_lock_transparent_key_slot_with_policy(
6154 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006155 if( status != PSA_SUCCESS )
6156 goto exit;
6157
6158 status = psa_key_agreement_raw_internal( alg, slot,
6159 peer_key, peer_key_length,
6160 output, output_size,
6161 output_length );
6162
6163exit:
6164 if( status != PSA_SUCCESS )
6165 {
6166 /* If an error happens and is not handled properly, the output
6167 * may be used as a key to protect sensitive data. Arrange for such
6168 * a key to be random, which is likely to result in decryption or
6169 * verification errors. This is better than filling the buffer with
6170 * some constant data such as zeros, which would result in the data
6171 * being protected with a reproducible, easily knowable key.
6172 */
6173 psa_generate_random( output, output_size );
6174 *output_length = output_size;
6175 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006176
Ronald Cron5c522922020-11-14 16:35:34 +01006177 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006178
Ronald Cron5c522922020-11-14 16:35:34 +01006179 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02006180}
Gilles Peskine86a440b2018-11-12 18:39:40 +01006181
6182
Gilles Peskine30524eb2020-11-13 17:02:26 +01006183
Gilles Peskine86a440b2018-11-12 18:39:40 +01006184/****************************************************************/
6185/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02006186/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02006187
Gilles Peskine30524eb2020-11-13 17:02:26 +01006188/** Initialize the PSA random generator.
6189 */
6190static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
6191{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006192#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6193 memset( rng, 0, sizeof( *rng ) );
6194#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6195
Gilles Peskine30524eb2020-11-13 17:02:26 +01006196 /* Set default configuration if
6197 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
6198 if( rng->entropy_init == NULL )
6199 rng->entropy_init = mbedtls_entropy_init;
6200 if( rng->entropy_free == NULL )
6201 rng->entropy_free = mbedtls_entropy_free;
6202
6203 rng->entropy_init( &rng->entropy );
6204#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
6205 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
6206 /* The PSA entropy injection feature depends on using NV seed as an entropy
6207 * source. Add NV seed as an entropy source for PSA entropy injection. */
6208 mbedtls_entropy_add_source( &rng->entropy,
6209 mbedtls_nv_seed_poll, NULL,
6210 MBEDTLS_ENTROPY_BLOCK_SIZE,
6211 MBEDTLS_ENTROPY_SOURCE_STRONG );
6212#endif
6213
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006214 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006215#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006216}
6217
6218/** Deinitialize the PSA random generator.
6219 */
6220static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
6221{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006222#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6223 memset( rng, 0, sizeof( *rng ) );
6224#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006225 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006226 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006227#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006228}
6229
6230/** Seed the PSA random generator.
6231 */
6232static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
6233{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006234#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6235 /* Do nothing: the external RNG seeds itself. */
6236 (void) rng;
6237 return( PSA_SUCCESS );
6238#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006239 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006240 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
6241 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006242 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006243#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01006244}
6245
Gilles Peskinee59236f2018-01-27 23:32:46 +01006246psa_status_t psa_generate_random( uint8_t *output,
6247 size_t output_size )
6248{
Gilles Peskinee59236f2018-01-27 23:32:46 +01006249 GUARD_MODULE_INITIALIZED;
6250
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006251#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6252
6253 size_t output_length = 0;
6254 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
6255 output, output_size,
6256 &output_length );
6257 if( status != PSA_SUCCESS )
6258 return( status );
6259 /* Breaking up a request into smaller chunks is currently not supported
6260 * for the extrernal RNG interface. */
6261 if( output_length != output_size )
6262 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
6263 return( PSA_SUCCESS );
6264
6265#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6266
Gilles Peskine71ddab92021-01-04 21:01:07 +01006267 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02006268 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01006269 size_t request_size =
6270 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
6271 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
6272 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006273 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
6274 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02006275 if( ret != 0 )
6276 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01006277 output_size -= request_size;
6278 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02006279 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01006280 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006281#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006282}
6283
Gilles Peskine8814fc42020-12-14 15:33:44 +01006284/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006285 *
6286 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
6287 * `psa_generate_random(...)`. The state parameter is ignored since the
6288 * PSA API doesn't support passing an explicit state.
6289 *
6290 * In the non-external case, psa_generate_random() calls an
6291 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
6292 * and semantics as mbedtls_psa_get_random(). As an optimization,
6293 * instead of doing this back-and-forth between the PSA API and the
6294 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
6295 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01006296 */
6297#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
6298int mbedtls_psa_get_random( void *p_rng,
6299 unsigned char *output,
6300 size_t output_size )
6301{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01006302 /* This function takes a pointer to the RNG state because that's what
6303 * classic mbedtls functions using an RNG expect. The PSA RNG manages
6304 * its own state internally and doesn't let the caller access that state.
6305 * So we just ignore the state parameter, and in practice we'll pass
6306 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01006307 (void) p_rng;
6308 psa_status_t status = psa_generate_random( output, output_size );
6309 if( status == PSA_SUCCESS )
6310 return( 0 );
6311 else
6312 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
6313}
6314#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
6315
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006316#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
6317#include "mbedtls/entropy_poll.h"
6318
Gilles Peskine7228da22019-07-15 11:06:15 +02006319psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006320 size_t seed_size )
6321{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006322 if( global_data.initialized )
6323 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02006324
6325 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
6326 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
6327 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
6328 return( PSA_ERROR_INVALID_ARGUMENT );
6329
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006330 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006331}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01006332#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02006333
John Durkop07cc04a2020-11-16 22:08:34 -08006334#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006335static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6336 size_t domain_parameters_size,
6337 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006338{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006339 size_t i;
6340 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006341
Gilles Peskinee56e8782019-04-26 17:34:02 +02006342 if( domain_parameters_size == 0 )
6343 {
6344 *exponent = 65537;
6345 return( PSA_SUCCESS );
6346 }
6347
6348 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6349 * support values that fit in a 32-bit integer, which is larger than
6350 * int on just about every platform anyway. */
6351 if( domain_parameters_size > sizeof( acc ) )
6352 return( PSA_ERROR_NOT_SUPPORTED );
6353 for( i = 0; i < domain_parameters_size; i++ )
6354 acc = ( acc << 8 ) | domain_parameters[i];
6355 if( acc > INT_MAX )
6356 return( PSA_ERROR_NOT_SUPPORTED );
6357 *exponent = acc;
6358 return( PSA_SUCCESS );
6359}
John Durkop07cc04a2020-11-16 22:08:34 -08006360#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006361
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006362static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006363 psa_key_slot_t *slot, size_t bits,
6364 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006365{
Gilles Peskine8e338702019-07-30 20:06:31 +02006366 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006367
Gilles Peskinee56e8782019-04-26 17:34:02 +02006368 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006369 return( PSA_ERROR_INVALID_ARGUMENT );
6370
Gilles Peskinee59236f2018-01-27 23:32:46 +01006371 if( key_type_is_raw_bytes( type ) )
6372 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006373 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006374
6375 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006376 if( status != PSA_SUCCESS )
6377 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006378
6379 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006380 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6381 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006382 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006383
Ronald Cronea0f8a62020-11-25 17:52:23 +01006384 status = psa_generate_random( slot->key.data,
6385 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006386 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006387 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006388
6389 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006390#if defined(MBEDTLS_DES_C)
6391 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006392 psa_des_set_key_parity( slot->key.data,
6393 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006394#endif /* MBEDTLS_DES_C */
6395 }
6396 else
6397
John Durkop07cc04a2020-11-16 22:08:34 -08006398#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006399 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006400 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006401 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006403 int exponent;
6404 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006405 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6406 return( PSA_ERROR_NOT_SUPPORTED );
6407 /* Accept only byte-aligned keys, for the same reasons as
6408 * in psa_import_rsa_key(). */
6409 if( bits % 8 != 0 )
6410 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006411 status = psa_read_rsa_exponent( domain_parameters,
6412 domain_parameters_size,
6413 &exponent );
6414 if( status != PSA_SUCCESS )
6415 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006416 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6417 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006418 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006419 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006420 (unsigned int) bits,
6421 exponent );
6422 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006423 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006424
6425 /* Make sure to always have an export representation available */
6426 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6427
Steven Cooreman75b74362020-07-28 14:30:13 +02006428 status = psa_allocate_buffer_to_slot( slot, bytes );
6429 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006430 {
6431 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006432 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006433 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006434
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006435 status = mbedtls_psa_rsa_export_key( type,
6436 &rsa,
6437 slot->key.data,
6438 bytes,
6439 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006440 mbedtls_rsa_free( &rsa );
6441 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006442 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006443 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006444 }
6445 else
John Durkop07cc04a2020-11-16 22:08:34 -08006446#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006447
John Durkop9814fa22020-11-04 12:28:15 -08006448#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006449 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006450 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006451 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006452 mbedtls_ecp_group_id grp_id =
6453 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006454 const mbedtls_ecp_curve_info *curve_info =
6455 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006456 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006458 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006459 return( PSA_ERROR_NOT_SUPPORTED );
6460 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6461 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006462 mbedtls_ecp_keypair_init( &ecp );
6463 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006464 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006465 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006466 if( ret != 0 )
6467 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006468 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006469 return( mbedtls_to_psa_error( ret ) );
6470 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006471
6472
6473 /* Make sure to always have an export representation available */
6474 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006475 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6476 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006477 {
6478 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006479 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006480 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006481
6482 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006483 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006484
6485 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006486 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006487 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006488 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006489 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006490 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006491 }
6492 else
John Durkop9814fa22020-11-04 12:28:15 -08006493#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006494 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006495 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006496 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006497
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006498 return( PSA_SUCCESS );
6499}
Darryl Green0c6575a2018-11-07 16:05:30 +00006500
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006501psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006502 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006503{
6504 psa_status_t status;
6505 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006506 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006507
Ronald Cron81709fc2020-11-14 12:10:32 +01006508 *key = MBEDTLS_SVC_KEY_ID_INIT;
6509
Gilles Peskine0f84d622019-09-12 19:03:13 +02006510 /* Reject any attempt to create a zero-length key so that we don't
6511 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6512 if( psa_get_key_bits( attributes ) == 0 )
6513 return( PSA_ERROR_INVALID_ARGUMENT );
6514
Ronald Cron81709fc2020-11-14 12:10:32 +01006515 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6516 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006517 if( status != PSA_SUCCESS )
6518 goto exit;
6519
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006520 status = psa_driver_wrapper_generate_key( attributes,
6521 slot );
6522 if( status != PSA_ERROR_NOT_SUPPORTED ||
6523 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6524 goto exit;
6525
6526 status = psa_generate_key_internal(
6527 slot, attributes->core.bits,
6528 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006529
6530exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006531 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006532 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006533 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006534 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006535
Darryl Green0c6575a2018-11-07 16:05:30 +00006536 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006537}
6538
6539
Gilles Peskinee59236f2018-01-27 23:32:46 +01006540
6541/****************************************************************/
6542/* Module setup */
6543/****************************************************************/
6544
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006545#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006546psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6547 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6548 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6549{
6550 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6551 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006552 global_data.rng.entropy_init = entropy_init;
6553 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006554 return( PSA_SUCCESS );
6555}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006556#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006557
Gilles Peskinee59236f2018-01-27 23:32:46 +01006558void mbedtls_psa_crypto_free( void )
6559{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006560 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006561 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6562 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006563 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006564 }
6565 /* Wipe all remaining data, including configuration.
6566 * In particular, this sets all state indicator to the value
6567 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006568 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006569#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006570 /* Unregister all secure element drivers, so that we restart from
6571 * a pristine state. */
6572 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006573#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006574}
6575
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006576#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6577/** Recover a transaction that was interrupted by a power failure.
6578 *
6579 * This function is called during initialization, before psa_crypto_init()
6580 * returns. If this function returns a failure status, the initialization
6581 * fails.
6582 */
6583static psa_status_t psa_crypto_recover_transaction(
6584 const psa_crypto_transaction_t *transaction )
6585{
6586 switch( transaction->unknown.type )
6587 {
6588 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6589 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006590 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006591 * is implemented.
6592 * https://github.com/ARMmbed/mbed-crypto/issues/218
6593 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006594 default:
6595 /* We found an unsupported transaction in the storage.
6596 * We don't know what state the storage is in. Give up. */
6597 return( PSA_ERROR_STORAGE_FAILURE );
6598 }
6599}
6600#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6601
Gilles Peskinee59236f2018-01-27 23:32:46 +01006602psa_status_t psa_crypto_init( void )
6603{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006604 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006605
Gilles Peskinec6b69072018-11-20 21:42:52 +01006606 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006607 if( global_data.initialized != 0 )
6608 return( PSA_SUCCESS );
6609
Gilles Peskine30524eb2020-11-13 17:02:26 +01006610 /* Initialize and seed the random generator. */
6611 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006612 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006613 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006614 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006615 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006616 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006617
Gilles Peskine66fb1262018-12-10 16:29:04 +01006618 status = psa_initialize_key_slots( );
6619 if( status != PSA_SUCCESS )
6620 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006621
Gilles Peskined9348f22019-10-01 15:22:29 +02006622#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6623 status = psa_init_all_se_drivers( );
6624 if( status != PSA_SUCCESS )
6625 goto exit;
6626#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6627
Gilles Peskine4b734222019-07-24 15:56:31 +02006628#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006629 status = psa_crypto_load_transaction( );
6630 if( status == PSA_SUCCESS )
6631 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006632 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6633 if( status != PSA_SUCCESS )
6634 goto exit;
6635 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006636 }
6637 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6638 {
6639 /* There's no transaction to complete. It's all good. */
6640 status = PSA_SUCCESS;
6641 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006642#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006643
Gilles Peskinec6b69072018-11-20 21:42:52 +01006644 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006645 global_data.initialized = 1;
6646
6647exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006648 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006649 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006650 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006651}
6652
6653#endif /* MBEDTLS_PSA_CRYPTO_C */