blob: 88e25e12f27c10cdaea4bd5c45525fd1c503982d [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Gilles Peskinee59236f2018-01-27 23:32:46 +01006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Gilles Peskinee59236f2018-01-27 23:32:46 +010019 */
20
Gilles Peskinedb09ef62020-06-03 01:43:33 +020021#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010022
23#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030024
John Durkop07cc04a2020-11-16 22:08:34 -080025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
26#include "check_crypto_config.h"
27#endif
28
itayzafrir7723ab12019-02-14 10:28:02 +020029#include "psa_crypto_service_integration.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010030#include "psa/crypto.h"
31
Gilles Peskine039b90c2018-12-07 18:24:41 +010032#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010033#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020034#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010035#include "psa_crypto_ecp.h"
36#include "psa_crypto_rsa.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020037#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020038#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020039#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010040#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010041/* Include internal declarations that are useful for implementing persistently
42 * stored keys. */
43#include "psa_crypto_storage.h"
44
Gilles Peskineb2b64d32020-12-14 16:43:58 +010045#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010046
Gilles Peskineb46bef22019-07-30 21:32:04 +020047#include <assert.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010048#include <stdlib.h>
49#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010050#include "mbedtls/platform.h"
Gilles Peskineff2d2002019-05-06 15:26:23 +020051#if !defined(MBEDTLS_PLATFORM_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010052#define mbedtls_calloc calloc
53#define mbedtls_free free
54#endif
55
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010056#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020058#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000059#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020060#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/blowfish.h"
62#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020063#include "mbedtls/chacha20.h"
64#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010065#include "mbedtls/cipher.h"
66#include "mbedtls/ccm.h"
67#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020069#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010070#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010071#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010072#include "mbedtls/error.h"
73#include "mbedtls/gcm.h"
74#include "mbedtls/md2.h"
75#include "mbedtls/md4.h"
76#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010077#include "mbedtls/md.h"
78#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010079#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010080#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010081#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000082#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010083#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010084#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010085#include "mbedtls/sha1.h"
86#include "mbedtls/sha256.h"
87#include "mbedtls/sha512.h"
88#include "mbedtls/xtea.h"
89
Gilles Peskine996deb12018-08-01 15:45:45 +020090#define ARRAY_LENGTH( array ) ( sizeof( array ) / sizeof( *( array ) ) )
91
Gilles Peskine9ef733f2018-02-07 21:05:37 +010092/* constant-time buffer comparison */
93static inline int safer_memcmp( const uint8_t *a, const uint8_t *b, size_t n )
94{
95 size_t i;
96 unsigned char diff = 0;
97
98 for( i = 0; i < n; i++ )
99 diff |= a[i] ^ b[i];
100
101 return( diff );
102}
103
104
105
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100106/****************************************************************/
107/* Global data, support functions and library management */
108/****************************************************************/
109
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200110static int key_type_is_raw_bytes( psa_key_type_t type )
111{
Gilles Peskine78b3bb62018-08-10 16:03:41 +0200112 return( PSA_KEY_TYPE_IS_UNSTRUCTURED( type ) );
Gilles Peskine48c0ea12018-06-21 14:15:31 +0200113}
114
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100115/* Values for psa_global_data_t::rng_state */
116#define RNG_NOT_INITIALIZED 0
117#define RNG_INITIALIZED 1
118#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +0100119
Gilles Peskine2d277862018-06-18 15:41:12 +0200120typedef struct
121{
Gilles Peskine30524eb2020-11-13 17:02:26 +0100122 mbedtls_psa_random_context_t rng;
Gilles Peskinec6b69072018-11-20 21:42:52 +0100123 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +0100124 unsigned rng_state : 2;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100125} psa_global_data_t;
126
127static psa_global_data_t global_data;
128
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100129#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
130mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
131 &global_data.rng.drbg;
132#endif
133
itayzafrir0adf0fc2018-09-06 16:24:41 +0300134#define GUARD_MODULE_INITIALIZED \
135 if( global_data.initialized == 0 ) \
136 return( PSA_ERROR_BAD_STATE );
137
Steven Cooreman01164162020-07-20 15:31:37 +0200138psa_status_t mbedtls_to_psa_error( int ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100139{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100140 /* Mbed TLS error codes can combine a high-level error code and a
141 * low-level error code. The low-level error usually reflects the
142 * root cause better, so dispatch on that preferably. */
143 int low_level_ret = - ( -ret & 0x007f );
144 switch( low_level_ret != 0 ? low_level_ret : ret )
Gilles Peskinee59236f2018-01-27 23:32:46 +0100145 {
146 case 0:
147 return( PSA_SUCCESS );
Gilles Peskinea5905292018-02-07 20:59:33 +0100148
149 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
150 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
151 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
152 return( PSA_ERROR_NOT_SUPPORTED );
153 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
154 return( PSA_ERROR_HARDWARE_FAILURE );
155
156 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
157 return( PSA_ERROR_HARDWARE_FAILURE );
158
Gilles Peskine9a944802018-06-21 09:35:35 +0200159 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
160 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
161 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
162 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
163 case MBEDTLS_ERR_ASN1_INVALID_DATA:
164 return( PSA_ERROR_INVALID_ARGUMENT );
165 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
166 return( PSA_ERROR_INSUFFICIENT_MEMORY );
167 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
168 return( PSA_ERROR_BUFFER_TOO_SMALL );
169
Jaeden Amero93e21112019-02-20 13:57:28 +0000170#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000171 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000172#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
173 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
174#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100175 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
176 return( PSA_ERROR_NOT_SUPPORTED );
177 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
178 return( PSA_ERROR_HARDWARE_FAILURE );
179
Jaeden Amero93e21112019-02-20 13:57:28 +0000180#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000181 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000182#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
183 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
184#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100185 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
186 return( PSA_ERROR_NOT_SUPPORTED );
187 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
188 return( PSA_ERROR_HARDWARE_FAILURE );
189
190 case MBEDTLS_ERR_CCM_BAD_INPUT:
191 return( PSA_ERROR_INVALID_ARGUMENT );
192 case MBEDTLS_ERR_CCM_AUTH_FAILED:
193 return( PSA_ERROR_INVALID_SIGNATURE );
194 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
195 return( PSA_ERROR_HARDWARE_FAILURE );
196
Gilles Peskine26869f22019-05-06 15:25:00 +0200197 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
198 return( PSA_ERROR_INVALID_ARGUMENT );
199
200 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
201 return( PSA_ERROR_BAD_STATE );
202 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
203 return( PSA_ERROR_INVALID_SIGNATURE );
204
Gilles Peskinea5905292018-02-07 20:59:33 +0100205 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
206 return( PSA_ERROR_NOT_SUPPORTED );
207 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
208 return( PSA_ERROR_INVALID_ARGUMENT );
209 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
210 return( PSA_ERROR_INSUFFICIENT_MEMORY );
211 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
212 return( PSA_ERROR_INVALID_PADDING );
213 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Fredrik Strupef90e3012020-09-28 16:11:33 +0200214 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100215 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
216 return( PSA_ERROR_INVALID_SIGNATURE );
217 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200218 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100219 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
220 return( PSA_ERROR_HARDWARE_FAILURE );
221
222 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
223 return( PSA_ERROR_HARDWARE_FAILURE );
224
Gilles Peskine82e57d12020-11-13 21:31:17 +0100225#if !( defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
226 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE) )
Gilles Peskinebee96c82020-11-23 21:00:09 +0100227 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
228 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100229 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
230 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
231 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
232 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
233 return( PSA_ERROR_NOT_SUPPORTED );
234 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
235 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskine82e57d12020-11-13 21:31:17 +0100236#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100237
238 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
239 return( PSA_ERROR_NOT_SUPPORTED );
240 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
241 return( PSA_ERROR_HARDWARE_FAILURE );
242
Gilles Peskinee59236f2018-01-27 23:32:46 +0100243 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
244 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
245 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
246 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100247
248 case MBEDTLS_ERR_GCM_AUTH_FAILED:
249 return( PSA_ERROR_INVALID_SIGNATURE );
250 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine8cac2e62018-08-21 15:07:38 +0200251 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
253 return( PSA_ERROR_HARDWARE_FAILURE );
254
Gilles Peskine82e57d12020-11-13 21:31:17 +0100255#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
256 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100257 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
258 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100259 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
260 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
261 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
262 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
263 return( PSA_ERROR_NOT_SUPPORTED );
264 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
265 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
266#endif
267
Gilles Peskinea5905292018-02-07 20:59:33 +0100268 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
269 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
270 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
271 return( PSA_ERROR_HARDWARE_FAILURE );
272
273 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
274 return( PSA_ERROR_NOT_SUPPORTED );
275 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
276 return( PSA_ERROR_INVALID_ARGUMENT );
277 case MBEDTLS_ERR_MD_ALLOC_FAILED:
278 return( PSA_ERROR_INSUFFICIENT_MEMORY );
279 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
280 return( PSA_ERROR_STORAGE_FAILURE );
281 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
282 return( PSA_ERROR_HARDWARE_FAILURE );
283
Gilles Peskinef76aa772018-10-29 19:24:33 +0100284 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
285 return( PSA_ERROR_STORAGE_FAILURE );
286 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
287 return( PSA_ERROR_INVALID_ARGUMENT );
288 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
289 return( PSA_ERROR_INVALID_ARGUMENT );
290 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
291 return( PSA_ERROR_BUFFER_TOO_SMALL );
292 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
293 return( PSA_ERROR_INVALID_ARGUMENT );
294 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
295 return( PSA_ERROR_INVALID_ARGUMENT );
296 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
297 return( PSA_ERROR_INVALID_ARGUMENT );
298 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
299 return( PSA_ERROR_INSUFFICIENT_MEMORY );
300
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100301 case MBEDTLS_ERR_PK_ALLOC_FAILED:
302 return( PSA_ERROR_INSUFFICIENT_MEMORY );
303 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
304 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
305 return( PSA_ERROR_INVALID_ARGUMENT );
306 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 return( PSA_ERROR_STORAGE_FAILURE );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100308 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
309 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
310 return( PSA_ERROR_INVALID_ARGUMENT );
311 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
312 return( PSA_ERROR_NOT_SUPPORTED );
313 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
314 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
315 return( PSA_ERROR_NOT_PERMITTED );
316 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
317 return( PSA_ERROR_INVALID_ARGUMENT );
318 case MBEDTLS_ERR_PK_INVALID_ALG:
319 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
320 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
321 return( PSA_ERROR_NOT_SUPPORTED );
322 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
323 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
325 return( PSA_ERROR_HARDWARE_FAILURE );
326
Gilles Peskineff2d2002019-05-06 15:26:23 +0200327 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
328 return( PSA_ERROR_HARDWARE_FAILURE );
329 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
330 return( PSA_ERROR_NOT_SUPPORTED );
331
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
333 return( PSA_ERROR_HARDWARE_FAILURE );
334
335 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
336 return( PSA_ERROR_INVALID_ARGUMENT );
337 case MBEDTLS_ERR_RSA_INVALID_PADDING:
338 return( PSA_ERROR_INVALID_PADDING );
339 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
340 return( PSA_ERROR_HARDWARE_FAILURE );
341 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
342 return( PSA_ERROR_INVALID_ARGUMENT );
343 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
344 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine4b3eb692019-05-16 21:35:18 +0200345 return( PSA_ERROR_CORRUPTION_DETECTED );
Gilles Peskinea5905292018-02-07 20:59:33 +0100346 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
347 return( PSA_ERROR_INVALID_SIGNATURE );
348 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
349 return( PSA_ERROR_BUFFER_TOO_SMALL );
350 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine40d81602020-11-25 00:09:47 +0100351 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
353 return( PSA_ERROR_NOT_SUPPORTED );
354 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
355 return( PSA_ERROR_HARDWARE_FAILURE );
356
357 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
358 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
359 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
360 return( PSA_ERROR_HARDWARE_FAILURE );
361
362 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
363 return( PSA_ERROR_INVALID_ARGUMENT );
364 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
365 return( PSA_ERROR_HARDWARE_FAILURE );
366
itayzafrir5c753392018-05-08 11:18:38 +0300367 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300368 case MBEDTLS_ERR_ECP_INVALID_KEY:
itayzafrir5c753392018-05-08 11:18:38 +0300369 return( PSA_ERROR_INVALID_ARGUMENT );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300370 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
371 return( PSA_ERROR_BUFFER_TOO_SMALL );
372 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
373 return( PSA_ERROR_NOT_SUPPORTED );
374 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
375 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
376 return( PSA_ERROR_INVALID_SIGNATURE );
377 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
378 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Gilles Peskine40d81602020-11-25 00:09:47 +0100379 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
380 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
itayzafrir7b30f8b2018-05-09 16:07:36 +0300381 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
382 return( PSA_ERROR_HARDWARE_FAILURE );
Gilles Peskine40d81602020-11-25 00:09:47 +0100383
Janos Follatha13b9052019-11-22 12:48:59 +0000384 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
385 return( PSA_ERROR_CORRUPTION_DETECTED );
itayzafrir5c753392018-05-08 11:18:38 +0300386
Gilles Peskinee59236f2018-01-27 23:32:46 +0100387 default:
David Saadab4ecc272019-02-14 13:48:10 +0200388 return( PSA_ERROR_GENERIC_ERROR );
Gilles Peskinee59236f2018-01-27 23:32:46 +0100389 }
390}
391
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200392
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200393
394
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100395/****************************************************************/
396/* Key management */
397/****************************************************************/
398
Gilles Peskine73167e12019-07-12 23:44:37 +0200399#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
400static inline int psa_key_slot_is_external( const psa_key_slot_t *slot )
401{
Gilles Peskine8e338702019-07-30 20:06:31 +0200402 return( psa_key_lifetime_is_external( slot->attr.lifetime ) );
Gilles Peskine73167e12019-07-12 23:44:37 +0200403}
404#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
405
John Durkop07cc04a2020-11-16 22:08:34 -0800406/* For now the MBEDTLS_PSA_ACCEL_ guards are also used here since the
407 * current test driver in key_management.c is using this function
408 * when accelerators are used for ECC key pair and public key.
409 * Once that dependency is resolved these guards can be removed.
410 */
John Durkop9814fa22020-11-04 12:28:15 -0800411#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800412 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
413 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) || \
414 defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY)
Paul Elliott8ff510a2020-06-02 17:19:28 +0100415mbedtls_ecp_group_id mbedtls_ecc_group_of_psa( psa_ecc_family_t curve,
Gilles Peskine5055b232019-12-12 17:49:31 +0100416 size_t byte_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +0200417{
418 switch( curve )
419 {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100420 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100421 switch( byte_length )
422 {
423 case PSA_BITS_TO_BYTES( 192 ):
424 return( MBEDTLS_ECP_DP_SECP192R1 );
425 case PSA_BITS_TO_BYTES( 224 ):
426 return( MBEDTLS_ECP_DP_SECP224R1 );
427 case PSA_BITS_TO_BYTES( 256 ):
428 return( MBEDTLS_ECP_DP_SECP256R1 );
429 case PSA_BITS_TO_BYTES( 384 ):
430 return( MBEDTLS_ECP_DP_SECP384R1 );
431 case PSA_BITS_TO_BYTES( 521 ):
432 return( MBEDTLS_ECP_DP_SECP521R1 );
433 default:
434 return( MBEDTLS_ECP_DP_NONE );
435 }
436 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100437
Paul Elliott8ff510a2020-06-02 17:19:28 +0100438 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100439 switch( byte_length )
440 {
441 case PSA_BITS_TO_BYTES( 256 ):
442 return( MBEDTLS_ECP_DP_BP256R1 );
443 case PSA_BITS_TO_BYTES( 384 ):
444 return( MBEDTLS_ECP_DP_BP384R1 );
445 case PSA_BITS_TO_BYTES( 512 ):
446 return( MBEDTLS_ECP_DP_BP512R1 );
447 default:
448 return( MBEDTLS_ECP_DP_NONE );
449 }
450 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100451
Paul Elliott8ff510a2020-06-02 17:19:28 +0100452 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine228abc52019-12-03 17:24:19 +0100453 switch( byte_length )
454 {
455 case PSA_BITS_TO_BYTES( 255 ):
456 return( MBEDTLS_ECP_DP_CURVE25519 );
457 case PSA_BITS_TO_BYTES( 448 ):
458 return( MBEDTLS_ECP_DP_CURVE448 );
459 default:
460 return( MBEDTLS_ECP_DP_NONE );
461 }
462 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100463
Paul Elliott8ff510a2020-06-02 17:19:28 +0100464 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine228abc52019-12-03 17:24:19 +0100465 switch( byte_length )
466 {
467 case PSA_BITS_TO_BYTES( 192 ):
468 return( MBEDTLS_ECP_DP_SECP192K1 );
469 case PSA_BITS_TO_BYTES( 224 ):
470 return( MBEDTLS_ECP_DP_SECP224K1 );
471 case PSA_BITS_TO_BYTES( 256 ):
472 return( MBEDTLS_ECP_DP_SECP256K1 );
473 default:
474 return( MBEDTLS_ECP_DP_NONE );
475 }
476 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100477
Gilles Peskine12313cd2018-06-20 00:20:32 +0200478 default:
479 return( MBEDTLS_ECP_DP_NONE );
480 }
481}
John Durkop9814fa22020-11-04 12:28:15 -0800482#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
John Durkop6ba40d12020-11-10 08:50:04 -0800483 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
484 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_KEY_PAIR) ||
485 * defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ECC_PUBLIC_KEY) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200486
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200487static psa_status_t validate_unstructured_key_bit_size( psa_key_type_t type,
488 size_t bits )
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200489{
490 /* Check that the bit size is acceptable for the key type */
491 switch( type )
492 {
493 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200494 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200495 case PSA_KEY_TYPE_DERIVE:
496 break;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200497#if defined(MBEDTLS_AES_C)
498 case PSA_KEY_TYPE_AES:
499 if( bits != 128 && bits != 192 && bits != 256 )
500 return( PSA_ERROR_INVALID_ARGUMENT );
501 break;
502#endif
503#if defined(MBEDTLS_CAMELLIA_C)
504 case PSA_KEY_TYPE_CAMELLIA:
505 if( bits != 128 && bits != 192 && bits != 256 )
506 return( PSA_ERROR_INVALID_ARGUMENT );
507 break;
508#endif
509#if defined(MBEDTLS_DES_C)
510 case PSA_KEY_TYPE_DES:
511 if( bits != 64 && bits != 128 && bits != 192 )
512 return( PSA_ERROR_INVALID_ARGUMENT );
513 break;
514#endif
515#if defined(MBEDTLS_ARC4_C)
516 case PSA_KEY_TYPE_ARC4:
517 if( bits < 8 || bits > 2048 )
518 return( PSA_ERROR_INVALID_ARGUMENT );
519 break;
520#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200521#if defined(MBEDTLS_CHACHA20_C)
522 case PSA_KEY_TYPE_CHACHA20:
523 if( bits != 256 )
524 return( PSA_ERROR_INVALID_ARGUMENT );
525 break;
526#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200527 default:
528 return( PSA_ERROR_NOT_SUPPORTED );
529 }
Gilles Peskineb54979a2018-06-21 09:32:47 +0200530 if( bits % 8 != 0 )
531 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200532
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200533 return( PSA_SUCCESS );
534}
535
Gilles Peskineb46bef22019-07-30 21:32:04 +0200536/** Return the size of the key in the given slot, in bits.
537 *
538 * \param[in] slot A key slot.
539 *
540 * \return The key size in bits, read from the metadata in the slot.
541 */
542static inline size_t psa_get_key_slot_bits( const psa_key_slot_t *slot )
543{
544 return( slot->attr.bits );
545}
546
Steven Cooreman75b74362020-07-28 14:30:13 +0200547/** Try to allocate a buffer to an empty key slot.
548 *
549 * \param[in,out] slot Key slot to attach buffer to.
550 * \param[in] buffer_length Requested size of the buffer.
551 *
552 * \retval #PSA_SUCCESS
553 * The buffer has been successfully allocated.
554 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
555 * Not enough memory was available for allocation.
556 * \retval #PSA_ERROR_ALREADY_EXISTS
557 * Trying to allocate a buffer to a non-empty key slot.
558 */
559static psa_status_t psa_allocate_buffer_to_slot( psa_key_slot_t *slot,
560 size_t buffer_length )
561{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100562 if( slot->key.data != NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200563 return( PSA_ERROR_ALREADY_EXISTS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200564
Ronald Cronea0f8a62020-11-25 17:52:23 +0100565 slot->key.data = mbedtls_calloc( 1, buffer_length );
566 if( slot->key.data == NULL )
Steven Cooreman29149862020-08-05 15:43:42 +0200567 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Steven Cooreman75b74362020-07-28 14:30:13 +0200568
Ronald Cronea0f8a62020-11-25 17:52:23 +0100569 slot->key.bytes = buffer_length;
Steven Cooreman29149862020-08-05 15:43:42 +0200570 return( PSA_SUCCESS );
Steven Cooreman75b74362020-07-28 14:30:13 +0200571}
572
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200573psa_status_t psa_copy_key_material_into_slot( psa_key_slot_t *slot,
574 const uint8_t* data,
575 size_t data_length )
576{
577 psa_status_t status = psa_allocate_buffer_to_slot( slot,
578 data_length );
579 if( status != PSA_SUCCESS )
580 return( status );
581
Ronald Cronea0f8a62020-11-25 17:52:23 +0100582 memcpy( slot->key.data, data, data_length );
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200583 return( PSA_SUCCESS );
584}
585
Ronald Crona0fe59f2020-11-29 11:14:53 +0100586psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100587 const psa_key_attributes_t *attributes,
588 const uint8_t *data, size_t data_length,
589 uint8_t *key_buffer, size_t key_buffer_size,
590 size_t *key_buffer_length, size_t *bits )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100591{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100592 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
593 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100594
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200595 /* zero-length keys are never supported. */
596 if( data_length == 0 )
597 return( PSA_ERROR_NOT_SUPPORTED );
598
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100599 if( key_type_is_raw_bytes( type ) )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100600 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100601 *bits = PSA_BYTES_TO_BITS( data_length );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200602
Steven Cooreman75b74362020-07-28 14:30:13 +0200603 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
604 if( data_length > SIZE_MAX / 8 )
605 return( PSA_ERROR_NOT_SUPPORTED );
606
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200607 /* Enforce a size limit, and in particular ensure that the bit
608 * size fits in its representation type. */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100609 if( ( *bits ) > PSA_MAX_KEY_BITS )
Gilles Peskinec744d992019-07-30 17:26:54 +0200610 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200611
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100612 status = validate_unstructured_key_bit_size( type, *bits );
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200613 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +0200614 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200615
Ronald Crondd04d422020-11-28 15:14:42 +0100616 /* Copy the key material. */
617 memcpy( key_buffer, data, data_length );
618 *key_buffer_length = data_length;
619 (void)key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200620
Steven Cooreman40120f62020-10-29 11:42:22 +0100621 return( PSA_SUCCESS );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100622 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100623 else if( PSA_KEY_TYPE_IS_ASYMMETRIC( type ) )
Steven Cooreman19fd5742020-07-24 23:31:01 +0200624 {
John Durkop9814fa22020-11-04 12:28:15 -0800625#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
626 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100627 if( PSA_KEY_TYPE_IS_ECC( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200628 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100629 return( mbedtls_psa_ecp_import_key( attributes,
630 data, data_length,
631 key_buffer, key_buffer_size,
632 key_buffer_length,
633 bits ) );
Steven Cooreman40120f62020-10-29 11:42:22 +0100634 }
John Durkop9814fa22020-11-04 12:28:15 -0800635#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
636 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700637#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
638 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100639 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200640 {
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100641 return( mbedtls_psa_rsa_import_key( attributes,
642 data, data_length,
643 key_buffer, key_buffer_size,
644 key_buffer_length,
645 bits ) );
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200646 }
John Durkop9814fa22020-11-04 12:28:15 -0800647#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
648 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100649 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100650
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100651 return( PSA_ERROR_NOT_SUPPORTED );
Darryl Green06fd18d2018-07-16 11:21:11 +0100652}
653
Gilles Peskinef603c712019-01-19 13:40:11 +0100654/** Calculate the intersection of two algorithm usage policies.
655 *
656 * Return 0 (which allows no operation) on incompatibility.
657 */
658static psa_algorithm_t psa_key_policy_algorithm_intersection(
659 psa_algorithm_t alg1,
660 psa_algorithm_t alg2 )
661{
Gilles Peskine549ea862019-05-22 11:45:59 +0200662 /* Common case: both sides actually specify the same policy. */
Gilles Peskinef603c712019-01-19 13:40:11 +0100663 if( alg1 == alg2 )
664 return( alg1 );
665 /* If the policies are from the same hash-and-sign family, check
666 * if one is a wildcard. If so the other has the specific algorithm. */
667 if( PSA_ALG_IS_HASH_AND_SIGN( alg1 ) &&
668 PSA_ALG_IS_HASH_AND_SIGN( alg2 ) &&
669 ( alg1 & ~PSA_ALG_HASH_MASK ) == ( alg2 & ~PSA_ALG_HASH_MASK ) )
670 {
671 if( PSA_ALG_SIGN_GET_HASH( alg1 ) == PSA_ALG_ANY_HASH )
672 return( alg2 );
673 if( PSA_ALG_SIGN_GET_HASH( alg2 ) == PSA_ALG_ANY_HASH )
674 return( alg1 );
675 }
676 /* If the policies are incompatible, allow nothing. */
677 return( 0 );
678}
679
Gilles Peskined6f371b2019-05-10 19:33:38 +0200680static int psa_key_algorithm_permits( psa_algorithm_t policy_alg,
681 psa_algorithm_t requested_alg )
682{
Gilles Peskine549ea862019-05-22 11:45:59 +0200683 /* Common case: the policy only allows requested_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200684 if( requested_alg == policy_alg )
685 return( 1 );
686 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
Gilles Peskine549ea862019-05-22 11:45:59 +0200687 * and requested_alg is the same hash-and-sign family with any hash,
688 * then requested_alg is compliant with policy_alg. */
Gilles Peskined6f371b2019-05-10 19:33:38 +0200689 if( PSA_ALG_IS_HASH_AND_SIGN( requested_alg ) &&
690 PSA_ALG_SIGN_GET_HASH( policy_alg ) == PSA_ALG_ANY_HASH )
691 {
692 return( ( policy_alg & ~PSA_ALG_HASH_MASK ) ==
693 ( requested_alg & ~PSA_ALG_HASH_MASK ) );
694 }
Steven Cooremance48e852020-10-05 16:02:45 +0200695 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200696 * a key derivation with that key agreement should also be allowed. This
697 * behaviour is expected to be defined in a future specification version. */
Steven Cooremance48e852020-10-05 16:02:45 +0200698 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( policy_alg ) &&
699 PSA_ALG_IS_KEY_AGREEMENT( requested_alg ) )
700 {
701 return( PSA_ALG_KEY_AGREEMENT_GET_BASE( requested_alg ) ==
702 policy_alg );
703 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200704 /* If it isn't permitted, it's forbidden. */
705 return( 0 );
706}
707
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100708/** Test whether a policy permits an algorithm.
709 *
710 * The caller must test usage flags separately.
711 */
712static int psa_key_policy_permits( const psa_key_policy_t *policy,
713 psa_algorithm_t alg )
714{
Gilles Peskined6f371b2019-05-10 19:33:38 +0200715 return( psa_key_algorithm_permits( policy->alg, alg ) ||
716 psa_key_algorithm_permits( policy->alg2, alg ) );
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100717}
718
Gilles Peskinef603c712019-01-19 13:40:11 +0100719/** Restrict a key policy based on a constraint.
720 *
721 * \param[in,out] policy The policy to restrict.
722 * \param[in] constraint The policy constraint to apply.
723 *
724 * \retval #PSA_SUCCESS
725 * \c *policy contains the intersection of the original value of
726 * \c *policy and \c *constraint.
727 * \retval #PSA_ERROR_INVALID_ARGUMENT
728 * \c *policy and \c *constraint are incompatible.
729 * \c *policy is unchanged.
730 */
731static psa_status_t psa_restrict_key_policy(
732 psa_key_policy_t *policy,
733 const psa_key_policy_t *constraint )
734{
735 psa_algorithm_t intersection_alg =
736 psa_key_policy_algorithm_intersection( policy->alg, constraint->alg );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200737 psa_algorithm_t intersection_alg2 =
738 psa_key_policy_algorithm_intersection( policy->alg2, constraint->alg2 );
Gilles Peskinef603c712019-01-19 13:40:11 +0100739 if( intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0 )
740 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskined6f371b2019-05-10 19:33:38 +0200741 if( intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0 )
742 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskinef603c712019-01-19 13:40:11 +0100743 policy->usage &= constraint->usage;
744 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200745 policy->alg2 = intersection_alg2;
Gilles Peskinef603c712019-01-19 13:40:11 +0100746 return( PSA_SUCCESS );
747}
748
Ronald Cron5c522922020-11-14 16:35:34 +0100749/** Get the description of a key given its identifier and policy constraints
750 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200751 *
Ronald Cron5c522922020-11-14 16:35:34 +0100752 * The key must have allow all the usage flags set in \p usage. If \p alg is
753 * nonzero, the key must allow operations with this algorithm.
Ronald Cron7587ae42020-11-11 15:04:25 +0100754 *
Ronald Cron5c522922020-11-14 16:35:34 +0100755 * In case of a persistent key, the function loads the description of the key
756 * into a key slot if not already done.
757 *
758 * On success, the returned key slot is locked. It is the responsibility of
759 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200760 */
Ronald Cron5c522922020-11-14 16:35:34 +0100761static psa_status_t psa_get_and_lock_key_slot_with_policy(
762 mbedtls_svc_key_id_t key,
763 psa_key_slot_t **p_slot,
764 psa_key_usage_t usage,
765 psa_algorithm_t alg )
Darryl Green06fd18d2018-07-16 11:21:11 +0100766{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200767 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
768 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100769
Ronald Cron5c522922020-11-14 16:35:34 +0100770 status = psa_get_and_lock_key_slot( key, p_slot );
Darryl Green06fd18d2018-07-16 11:21:11 +0100771 if( status != PSA_SUCCESS )
772 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200773 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100774
775 /* Enforce that usage policy for the key slot contains all the flags
776 * required by the usage parameter. There is one exception: public
777 * keys can always be exported, so we treat public key objects as
778 * if they had the export flag. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200779 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) )
Darryl Green06fd18d2018-07-16 11:21:11 +0100780 usage &= ~PSA_KEY_USAGE_EXPORT;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200781
782 status = PSA_ERROR_NOT_PERMITTED;
Gilles Peskine8e338702019-07-30 20:06:31 +0200783 if( ( slot->attr.policy.usage & usage ) != usage )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200784 goto error;
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100785
786 /* Enforce that the usage policy permits the requested algortihm. */
Gilles Peskine8e338702019-07-30 20:06:31 +0200787 if( alg != 0 && ! psa_key_policy_permits( &slot->attr.policy, alg ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +0200788 goto error;
Darryl Green06fd18d2018-07-16 11:21:11 +0100789
Darryl Green06fd18d2018-07-16 11:21:11 +0100790 return( PSA_SUCCESS );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200791
792error:
793 *p_slot = NULL;
Ronald Cron5c522922020-11-14 16:35:34 +0100794 psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200795
796 return( status );
Darryl Green06fd18d2018-07-16 11:21:11 +0100797}
Darryl Green940d72c2018-07-13 13:18:51 +0100798
Ronald Cron5c522922020-11-14 16:35:34 +0100799/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200800 *
801 * A transparent key is a key for which the key material is directly
802 * available, as opposed to a key in a secure element.
803 *
Ronald Cron5c522922020-11-14 16:35:34 +0100804 * This is a temporary function to use instead of
805 * psa_get_and_lock_key_slot_with_policy() until secure element support is
806 * fully implemented.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200807 *
Ronald Cron5c522922020-11-14 16:35:34 +0100808 * On success, the returned key slot is locked. It is the responsibility of the
809 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200810 */
811#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Ronald Cron5c522922020-11-14 16:35:34 +0100812static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
813 mbedtls_svc_key_id_t key,
814 psa_key_slot_t **p_slot,
815 psa_key_usage_t usage,
816 psa_algorithm_t alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200817{
Ronald Cron5c522922020-11-14 16:35:34 +0100818 psa_status_t status = psa_get_and_lock_key_slot_with_policy( key, p_slot,
819 usage, alg );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200820 if( status != PSA_SUCCESS )
821 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +0200822
Gilles Peskineadad8132019-07-25 11:31:23 +0200823 if( psa_key_slot_is_external( *p_slot ) )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200824 {
Ronald Cron5c522922020-11-14 16:35:34 +0100825 psa_unlock_key_slot( *p_slot );
Gilles Peskine28f8f302019-07-24 13:30:31 +0200826 *p_slot = NULL;
827 return( PSA_ERROR_NOT_SUPPORTED );
828 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200829
Gilles Peskine28f8f302019-07-24 13:30:31 +0200830 return( PSA_SUCCESS );
831}
832#else /* MBEDTLS_PSA_CRYPTO_SE_C */
833/* With no secure element support, all keys are transparent. */
Ronald Cron5c522922020-11-14 16:35:34 +0100834#define psa_get_and_lock_transparent_key_slot_with_policy( key, p_slot, usage, alg ) \
835 psa_get_and_lock_key_slot_with_policy( key, p_slot, usage, alg )
Gilles Peskine28f8f302019-07-24 13:30:31 +0200836#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
837
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100838/** Wipe key data from a slot. Preserve metadata such as the policy. */
Gilles Peskine2f060a82018-12-04 17:12:32 +0100839static psa_status_t psa_remove_key_data_from_memory( psa_key_slot_t *slot )
Darryl Green40225ba2018-11-15 14:48:15 +0000840{
Ronald Cronea0f8a62020-11-25 17:52:23 +0100841 /* Data pointer will always be either a valid pointer or NULL in an
842 * initialized slot, so we can just free it. */
843 if( slot->key.data != NULL )
844 mbedtls_platform_zeroize( slot->key.data, slot->key.bytes);
845
846 mbedtls_free( slot->key.data );
847 slot->key.data = NULL;
848 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +0000849
850 return( PSA_SUCCESS );
851}
852
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100853/** Completely wipe a slot in memory, including its policy.
854 * Persistent storage is not affected. */
Gilles Peskine66fb1262018-12-10 16:29:04 +0100855psa_status_t psa_wipe_key_slot( psa_key_slot_t *slot )
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100856{
857 psa_status_t status = psa_remove_key_data_from_memory( slot );
Ronald Cronddd3d052020-10-30 14:07:07 +0100858
859 /*
860 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +0100861 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +0100862 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
863 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +0100864 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +0100865 */
Ronald Cron5c522922020-11-14 16:35:34 +0100866 if( slot->lock_count != 1 )
Ronald Cronddd3d052020-10-30 14:07:07 +0100867 {
868#ifdef MBEDTLS_CHECK_PARAMS
Ronald Cron5c522922020-11-14 16:35:34 +0100869 MBEDTLS_PARAM_FAILED( slot->lock_count == 1 );
Ronald Cronddd3d052020-10-30 14:07:07 +0100870#endif
Ronald Cronddd3d052020-10-30 14:07:07 +0100871 status = PSA_ERROR_CORRUPTION_DETECTED;
872 }
873
Gilles Peskine3f7cd622019-08-13 15:01:08 +0200874 /* Multipart operations may still be using the key. This is safe
875 * because all multipart operation objects are independent from
876 * the key slot: if they need to access the key after the setup
877 * phase, they have a copy of the key. Note that this means that
878 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100879 /* At this point, key material and other type-specific content has
880 * been wiped. Clear remaining metadata. We can call memset and not
881 * zeroize because the metadata is not particularly sensitive. */
882 memset( slot, 0, sizeof( *slot ) );
883 return( status );
884}
885
Ronald Croncf56a0a2020-08-04 09:51:30 +0200886psa_status_t psa_destroy_key( mbedtls_svc_key_id_t key )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100887{
Gilles Peskine2f060a82018-12-04 17:12:32 +0100888 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200889 psa_status_t status; /* status of the last operation */
890 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +0200891#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
892 psa_se_drv_table_entry_t *driver;
893#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100894
Ronald Croncf56a0a2020-08-04 09:51:30 +0200895 if( mbedtls_svc_key_id_is_null( key ) )
Gilles Peskine1841cf42019-10-08 15:48:25 +0200896 return( PSA_SUCCESS );
897
Ronald Cronf2911112020-10-29 17:51:10 +0100898 /*
Ronald Cron19daca92020-11-10 18:08:03 +0100899 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +0100900 * key, this will load the key description from persistent memory if not
901 * done yet. We cannot avoid this loading as without it we don't know if
902 * the key is operated by an SE or not and this information is needed by
903 * the current implementation.
904 */
Ronald Cron5c522922020-11-14 16:35:34 +0100905 status = psa_get_and_lock_key_slot( key, &slot );
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200906 if( status != PSA_SUCCESS )
907 return( status );
Gilles Peskine354f7672019-07-12 23:46:38 +0200908
Ronald Cronf2911112020-10-29 17:51:10 +0100909 /*
910 * If the key slot containing the key description is under access by the
911 * library (apart from the present access), the key cannot be destroyed
912 * yet. For the time being, just return in error. Eventually (to be
913 * implemented), the key should be destroyed when all accesses have
914 * stopped.
915 */
Ronald Cron5c522922020-11-14 16:35:34 +0100916 if( slot->lock_count > 1 )
Ronald Cronf2911112020-10-29 17:51:10 +0100917 {
Ronald Cron5c522922020-11-14 16:35:34 +0100918 psa_unlock_key_slot( slot );
Ronald Cronf2911112020-10-29 17:51:10 +0100919 return( PSA_ERROR_GENERIC_ERROR );
920 }
921
Gilles Peskine354f7672019-07-12 23:46:38 +0200922#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine8e338702019-07-30 20:06:31 +0200923 driver = psa_get_se_driver_entry( slot->attr.lifetime );
Gilles Peskine354f7672019-07-12 23:46:38 +0200924 if( driver != NULL )
Gilles Peskinefc762652019-07-22 19:30:34 +0200925 {
Gilles Peskine60450a42019-07-25 11:32:45 +0200926 /* For a key in a secure element, we need to do three things:
927 * remove the key file in internal storage, destroy the
928 * key inside the secure element, and update the driver's
929 * persistent data. Start a transaction that will encompass these
930 * three actions. */
Gilles Peskinefc762652019-07-22 19:30:34 +0200931 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_DESTROY_KEY );
Gilles Peskine8e338702019-07-30 20:06:31 +0200932 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +0100933 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +0200934 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskinefc762652019-07-22 19:30:34 +0200935 status = psa_crypto_save_transaction( );
936 if( status != PSA_SUCCESS )
937 {
Gilles Peskine66be51c2019-07-25 18:02:52 +0200938 (void) psa_crypto_stop_transaction( );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200939 /* We should still try to destroy the key in the secure
940 * element and the key metadata in storage. This is especially
941 * important if the error is that the storage is full.
942 * But how to do it exactly without risking an inconsistent
943 * state after a reset?
944 * https://github.com/ARMmbed/mbed-crypto/issues/215
945 */
946 overall_status = status;
947 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +0200948 }
949
Ronald Cronea0f8a62020-11-25 17:52:23 +0100950 status = psa_destroy_se_key( driver,
951 psa_key_slot_get_slot_number( slot ) );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200952 if( overall_status == PSA_SUCCESS )
953 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +0200954 }
Gilles Peskine354f7672019-07-12 23:46:38 +0200955#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
956
Darryl Greend49a4992018-06-18 17:27:26 +0100957#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Ronald Crond98059d2020-10-23 18:00:55 +0200958 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Darryl Greend49a4992018-06-18 17:27:26 +0100959 {
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200960 status = psa_destroy_persistent_key( slot->attr.id );
961 if( overall_status == PSA_SUCCESS )
962 overall_status = status;
963
Gilles Peskine9ce31c42019-08-13 15:14:20 +0200964 /* TODO: other slots may have a copy of the same key. We should
965 * invalidate them.
966 * https://github.com/ARMmbed/mbed-crypto/issues/214
967 */
Darryl Greend49a4992018-06-18 17:27:26 +0100968 }
969#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +0200970
Gilles Peskinefc762652019-07-22 19:30:34 +0200971#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
972 if( driver != NULL )
973 {
Gilles Peskine725f22a2019-07-25 11:31:48 +0200974 status = psa_save_se_persistent_data( driver );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200975 if( overall_status == PSA_SUCCESS )
976 overall_status = status;
977 status = psa_crypto_stop_transaction( );
978 if( overall_status == PSA_SUCCESS )
979 overall_status = status;
Gilles Peskinefc762652019-07-22 19:30:34 +0200980 }
981#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
982
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200983#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
984exit:
985#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +0100986 status = psa_wipe_key_slot( slot );
Gilles Peskine4b7f3402019-08-13 15:58:36 +0200987 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
988 if( overall_status == PSA_SUCCESS )
989 overall_status = status;
990 return( overall_status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100991}
992
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200993void psa_reset_key_attributes( psa_key_attributes_t *attributes )
Gilles Peskineb870b182018-07-06 16:02:09 +0200994{
Gilles Peskineb699f072019-04-26 16:06:02 +0200995 mbedtls_free( attributes->domain_parameters );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +0200996 memset( attributes, 0, sizeof( *attributes ) );
Gilles Peskineb870b182018-07-06 16:02:09 +0200997}
998
Gilles Peskineb699f072019-04-26 16:06:02 +0200999psa_status_t psa_set_key_domain_parameters( psa_key_attributes_t *attributes,
1000 psa_key_type_t type,
1001 const uint8_t *data,
1002 size_t data_length )
1003{
1004 uint8_t *copy = NULL;
1005
1006 if( data_length != 0 )
1007 {
1008 copy = mbedtls_calloc( 1, data_length );
1009 if( copy == NULL )
1010 return( PSA_ERROR_INSUFFICIENT_MEMORY );
1011 memcpy( copy, data, data_length );
1012 }
1013 /* After this point, this function is guaranteed to succeed, so it
1014 * can start modifying `*attributes`. */
1015
1016 if( attributes->domain_parameters != NULL )
1017 {
1018 mbedtls_free( attributes->domain_parameters );
1019 attributes->domain_parameters = NULL;
1020 attributes->domain_parameters_size = 0;
1021 }
1022
1023 attributes->domain_parameters = copy;
1024 attributes->domain_parameters_size = data_length;
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001025 attributes->core.type = type;
Gilles Peskineb699f072019-04-26 16:06:02 +02001026 return( PSA_SUCCESS );
1027}
1028
1029psa_status_t psa_get_key_domain_parameters(
1030 const psa_key_attributes_t *attributes,
1031 uint8_t *data, size_t data_size, size_t *data_length )
1032{
1033 if( attributes->domain_parameters_size > data_size )
1034 return( PSA_ERROR_BUFFER_TOO_SMALL );
1035 *data_length = attributes->domain_parameters_size;
1036 if( attributes->domain_parameters_size != 0 )
1037 memcpy( data, attributes->domain_parameters,
1038 attributes->domain_parameters_size );
1039 return( PSA_SUCCESS );
1040}
1041
John Durkop07cc04a2020-11-16 22:08:34 -08001042#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001043 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001044static psa_status_t psa_get_rsa_public_exponent(
1045 const mbedtls_rsa_context *rsa,
1046 psa_key_attributes_t *attributes )
1047{
1048 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001050 uint8_t *buffer = NULL;
1051 size_t buflen;
1052 mbedtls_mpi_init( &mpi );
1053
1054 ret = mbedtls_rsa_export( rsa, NULL, NULL, NULL, NULL, &mpi );
1055 if( ret != 0 )
1056 goto exit;
Gilles Peskine772c8b12019-04-26 17:37:21 +02001057 if( mbedtls_mpi_cmp_int( &mpi, 65537 ) == 0 )
1058 {
1059 /* It's the default value, which is reported as an empty string,
1060 * so there's nothing to do. */
1061 goto exit;
1062 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001063
1064 buflen = mbedtls_mpi_size( &mpi );
1065 buffer = mbedtls_calloc( 1, buflen );
1066 if( buffer == NULL )
1067 {
1068 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1069 goto exit;
1070 }
1071 ret = mbedtls_mpi_write_binary( &mpi, buffer, buflen );
1072 if( ret != 0 )
1073 goto exit;
1074 attributes->domain_parameters = buffer;
1075 attributes->domain_parameters_size = buflen;
1076
1077exit:
1078 mbedtls_mpi_free( &mpi );
1079 if( ret != 0 )
1080 mbedtls_free( buffer );
1081 return( mbedtls_to_psa_error( ret ) );
1082}
John Durkop07cc04a2020-11-16 22:08:34 -08001083#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001084 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001085
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001086/** Retrieve all the publicly-accessible attributes of a key.
1087 */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001088psa_status_t psa_get_key_attributes( mbedtls_svc_key_id_t key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001089 psa_key_attributes_t *attributes )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001090{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001091 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001092 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001093 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001094
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001095 psa_reset_key_attributes( attributes );
1096
Ronald Cron5c522922020-11-14 16:35:34 +01001097 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02001098 if( status != PSA_SUCCESS )
1099 return( status );
Gilles Peskineb870b182018-07-06 16:02:09 +02001100
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001101 attributes->core = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001102 attributes->core.flags &= ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1103 MBEDTLS_PSA_KA_MASK_DUAL_USE );
1104
1105#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1106 if( psa_key_slot_is_external( slot ) )
Ronald Cronea0f8a62020-11-25 17:52:23 +01001107 psa_set_key_slot_number( attributes,
1108 psa_key_slot_get_slot_number( slot ) );
Gilles Peskinec8000c02019-08-02 20:15:51 +02001109#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001110
Gilles Peskine8e338702019-07-30 20:06:31 +02001111 switch( slot->attr.type )
Gilles Peskineb699f072019-04-26 16:06:02 +02001112 {
John Durkop07cc04a2020-11-16 22:08:34 -08001113#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001114 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001115 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001116 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001117#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001118 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001119 * is not yet implemented.
1120 * https://github.com/ARMmbed/mbed-crypto/issues/216
1121 */
Gilles Peskinec8000c02019-08-02 20:15:51 +02001122 if( psa_key_slot_is_external( slot ) )
Gilles Peskinedc5bfe92019-07-24 19:09:30 +02001123 break;
1124#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Steven Cooremana01795d2020-07-24 22:48:15 +02001125 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001126 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001127
Ronald Cron90857082020-11-25 14:58:33 +01001128 status = mbedtls_psa_rsa_load_representation(
1129 slot->attr.type,
1130 slot->key.data,
1131 slot->key.bytes,
1132 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001133 if( status != PSA_SUCCESS )
1134 break;
1135
Steven Cooremana2371e52020-07-28 14:30:39 +02001136 status = psa_get_rsa_public_exponent( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02001137 attributes );
Steven Cooremana2371e52020-07-28 14:30:39 +02001138 mbedtls_rsa_free( rsa );
1139 mbedtls_free( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001140 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001141 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001142#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001143 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001144 default:
1145 /* Nothing else to do. */
1146 break;
1147 }
1148
1149 if( status != PSA_SUCCESS )
1150 psa_reset_key_attributes( attributes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001151
Ronald Cron5c522922020-11-14 16:35:34 +01001152 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001153
Ronald Cron5c522922020-11-14 16:35:34 +01001154 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001155}
1156
Gilles Peskinec8000c02019-08-02 20:15:51 +02001157#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1158psa_status_t psa_get_key_slot_number(
1159 const psa_key_attributes_t *attributes,
1160 psa_key_slot_number_t *slot_number )
1161{
1162 if( attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER )
1163 {
1164 *slot_number = attributes->slot_number;
1165 return( PSA_SUCCESS );
1166 }
1167 else
1168 return( PSA_ERROR_INVALID_ARGUMENT );
1169}
1170#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1171
Ronald Crond18b5f82020-11-25 16:46:05 +01001172static psa_status_t psa_export_key_buffer_internal( const uint8_t *key_buffer,
1173 size_t key_buffer_size,
Steven Cooremana01795d2020-07-24 22:48:15 +02001174 uint8_t *data,
1175 size_t data_size,
1176 size_t *data_length )
1177{
Ronald Crond18b5f82020-11-25 16:46:05 +01001178 if( key_buffer_size > data_size )
Steven Cooremana01795d2020-07-24 22:48:15 +02001179 return( PSA_ERROR_BUFFER_TOO_SMALL );
Ronald Crond18b5f82020-11-25 16:46:05 +01001180 memcpy( data, key_buffer, key_buffer_size );
1181 memset( data + key_buffer_size, 0,
1182 data_size - key_buffer_size );
1183 *data_length = key_buffer_size;
Steven Cooremana01795d2020-07-24 22:48:15 +02001184 return( PSA_SUCCESS );
1185}
1186
Ronald Cron7285cda2020-11-26 14:46:37 +01001187psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001188 const psa_key_attributes_t *attributes,
1189 const uint8_t *key_buffer, size_t key_buffer_size,
1190 uint8_t *data, size_t data_size, size_t *data_length )
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001191{
Ronald Crond18b5f82020-11-25 16:46:05 +01001192 psa_key_type_t type = attributes->core.type;
1193
Ronald Crond18b5f82020-11-25 16:46:05 +01001194 if( key_type_is_raw_bytes( type ) ||
1195 PSA_KEY_TYPE_IS_RSA( type ) ||
1196 PSA_KEY_TYPE_IS_ECC( type ) )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001197 {
1198 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001199 key_buffer, key_buffer_size,
1200 data, data_size, data_length ) );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001201 }
1202 else
1203 {
1204 /* This shouldn't happen in the reference implementation, but
1205 it is valid for a special-purpose implementation to omit
1206 support for exporting certain key types. */
1207 return( PSA_ERROR_NOT_SUPPORTED );
1208 }
1209}
1210
1211psa_status_t psa_export_key( mbedtls_svc_key_id_t key,
1212 uint8_t *data,
1213 size_t data_size,
1214 size_t *data_length )
1215{
1216 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1217 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1218 psa_key_slot_t *slot;
1219
Ronald Crone907e552021-01-18 13:22:38 +01001220 /* Reject a zero-length output buffer now, since this can never be a
1221 * valid key representation. This way we know that data must be a valid
1222 * pointer and we can do things like memset(data, ..., data_size). */
1223 if( data_size == 0 )
1224 return( PSA_ERROR_BUFFER_TOO_SMALL );
1225
Ronald Cron9486f9d2020-11-26 13:36:23 +01001226 /* Set the key to empty now, so that even when there are errors, we always
1227 * set data_length to a value between 0 and data_size. On error, setting
1228 * the key to empty is a good choice because an empty key representation is
1229 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001230 *data_length = 0;
1231
Ronald Cron9486f9d2020-11-26 13:36:23 +01001232 /* Export requires the EXPORT flag. There is an exception for public keys,
1233 * which don't require any flag, but
1234 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1235 */
1236 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
1237 PSA_KEY_USAGE_EXPORT, 0 );
1238 if( status != PSA_SUCCESS )
1239 return( status );
mohammad160306e79202018-03-28 13:17:44 +03001240
Ronald Crond18b5f82020-11-25 16:46:05 +01001241 psa_key_attributes_t attributes = {
1242 .core = slot->attr
1243 };
Ronald Cron67227982020-11-26 15:16:05 +01001244 status = psa_driver_wrapper_export_key( &attributes,
Ronald Crond18b5f82020-11-25 16:46:05 +01001245 slot->key.data, slot->key.bytes,
1246 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001247
Ronald Cron9486f9d2020-11-26 13:36:23 +01001248 unlock_status = psa_unlock_key_slot( slot );
1249
1250 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
1251}
1252
Ronald Cron7285cda2020-11-26 14:46:37 +01001253psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001254 const psa_key_attributes_t *attributes,
1255 const uint8_t *key_buffer,
1256 size_t key_buffer_size,
1257 uint8_t *data,
1258 size_t data_size,
1259 size_t *data_length )
Ronald Cron9486f9d2020-11-26 13:36:23 +01001260{
Ronald Crond18b5f82020-11-25 16:46:05 +01001261 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001262
Ronald Crond18b5f82020-11-25 16:46:05 +01001263 if( PSA_KEY_TYPE_IS_RSA( type ) || PSA_KEY_TYPE_IS_ECC( type ) )
Moran Peker17e36e12018-05-02 12:55:20 +03001264 {
Ronald Crond18b5f82020-11-25 16:46:05 +01001265 if( PSA_KEY_TYPE_IS_PUBLIC_KEY( type ) )
Gilles Peskine969ac722018-01-28 18:16:59 +01001266 {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001267 /* Exporting public -> public */
Ronald Cron9486f9d2020-11-26 13:36:23 +01001268 return( psa_export_key_buffer_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001269 key_buffer, key_buffer_size,
1270 data, data_size, data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001271 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001272
Ronald Crond18b5f82020-11-25 16:46:05 +01001273 if( PSA_KEY_TYPE_IS_RSA( type ) )
Steven Cooreman560c28a2020-07-24 23:20:24 +02001274 {
John Durkop0e005192020-10-31 22:06:54 -07001275#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1276 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001277 return( mbedtls_psa_rsa_export_public_key( attributes,
1278 key_buffer,
1279 key_buffer_size,
1280 data,
1281 data_size,
1282 data_length ) );
Darryl Green9e2d7a02018-07-24 16:33:30 +01001283#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001284 /* We don't know how to convert a private RSA key to public. */
1285 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001286#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1287 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine969ac722018-01-28 18:16:59 +01001288 }
1289 else
Moran Pekera998bc62018-04-16 18:16:20 +03001290 {
John Durkop6ba40d12020-11-10 08:50:04 -08001291#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
1292 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
Ronald Crone5ca3d82020-11-26 16:36:16 +01001293 return( mbedtls_psa_ecp_export_public_key( attributes,
1294 key_buffer,
1295 key_buffer_size,
1296 data,
1297 data_size,
1298 data_length ) );
Steven Cooreman560c28a2020-07-24 23:20:24 +02001299#else
1300 /* We don't know how to convert a private ECC key to public */
Moran Pekera998bc62018-04-16 18:16:20 +03001301 return( PSA_ERROR_NOT_SUPPORTED );
John Durkop9814fa22020-11-04 12:28:15 -08001302#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1303 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001304 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001305 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02001306 else
1307 {
1308 /* This shouldn't happen in the reference implementation, but
1309 it is valid for a special-purpose implementation to omit
1310 support for exporting certain key types. */
1311 return( PSA_ERROR_NOT_SUPPORTED );
1312 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001313}
Ronald Crond18b5f82020-11-25 16:46:05 +01001314
Ronald Croncf56a0a2020-08-04 09:51:30 +02001315psa_status_t psa_export_public_key( mbedtls_svc_key_id_t key,
Gilles Peskine2d277862018-06-18 15:41:12 +02001316 uint8_t *data,
1317 size_t data_size,
1318 size_t *data_length )
Moran Pekerdd4ea382018-04-03 15:30:03 +03001319{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001321 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001322 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001323
Ronald Crone907e552021-01-18 13:22:38 +01001324 /* Reject a zero-length output buffer now, since this can never be a
1325 * valid key representation. This way we know that data must be a valid
1326 * pointer and we can do things like memset(data, ..., data_size). */
1327 if( data_size == 0 )
1328 return( PSA_ERROR_BUFFER_TOO_SMALL );
1329
Darryl Greendd8fb772018-11-07 16:00:44 +00001330 /* Set the key to empty now, so that even when there are errors, we always
1331 * set data_length to a value between 0 and data_size. On error, setting
1332 * the key to empty is a good choice because an empty key representation is
1333 * unlikely to be accepted anywhere. */
1334 *data_length = 0;
1335
1336 /* Exporting a public key doesn't require a usage flag. */
Ronald Cron5c522922020-11-14 16:35:34 +01001337 status = psa_get_and_lock_key_slot_with_policy( key, &slot, 0, 0 );
Darryl Greendd8fb772018-11-07 16:00:44 +00001338 if( status != PSA_SUCCESS )
1339 return( status );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001340
Ronald Cron9486f9d2020-11-26 13:36:23 +01001341 if( ! PSA_KEY_TYPE_IS_ASYMMETRIC( slot->attr.type ) )
1342 {
1343 status = PSA_ERROR_INVALID_ARGUMENT;
1344 goto exit;
1345 }
1346
Ronald Crond18b5f82020-11-25 16:46:05 +01001347 psa_key_attributes_t attributes = {
1348 .core = slot->attr
1349 };
Ronald Cron67227982020-11-26 15:16:05 +01001350 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001351 &attributes, slot->key.data, slot->key.bytes,
1352 data, data_size, data_length );
Ronald Cron9486f9d2020-11-26 13:36:23 +01001353
1354exit:
Ronald Cron5c522922020-11-14 16:35:34 +01001355 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001356
Ronald Cron5c522922020-11-14 16:35:34 +01001357 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Moran Pekerdd4ea382018-04-03 15:30:03 +03001358}
1359
Gilles Peskine91e8c332019-08-02 19:19:39 +02001360#if defined(static_assert)
1361static_assert( ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
1362 "One or more key attribute flag is listed as both external-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001363static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE ) == 0,
Gilles Peskine094dac12019-08-07 18:19:46 +02001364 "One or more key attribute flag is listed as both internal-only and dual-use" );
Gilles Peskine5a680562019-08-05 17:32:13 +02001365static_assert( ( PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY ) == 0,
Gilles Peskine91e8c332019-08-02 19:19:39 +02001366 "One or more key attribute flag is listed as both internal-only and external-only" );
1367#endif
1368
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001369/** Validate that a key policy is internally well-formed.
1370 *
1371 * This function only rejects invalid policies. It does not validate the
1372 * consistency of the policy with respect to other attributes of the key
1373 * such as the key type.
1374 */
1375static psa_status_t psa_validate_key_policy( const psa_key_policy_t *policy )
Gilles Peskine4747d192019-04-17 15:05:45 +02001376{
1377 if( ( policy->usage & ~( PSA_KEY_USAGE_EXPORT |
Gilles Peskine8e0206a2019-05-14 14:24:28 +02001378 PSA_KEY_USAGE_COPY |
Gilles Peskine4747d192019-04-17 15:05:45 +02001379 PSA_KEY_USAGE_ENCRYPT |
1380 PSA_KEY_USAGE_DECRYPT |
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01001381 PSA_KEY_USAGE_SIGN_HASH |
1382 PSA_KEY_USAGE_VERIFY_HASH |
Gilles Peskine4747d192019-04-17 15:05:45 +02001383 PSA_KEY_USAGE_DERIVE ) ) != 0 )
1384 return( PSA_ERROR_INVALID_ARGUMENT );
1385
Gilles Peskine4747d192019-04-17 15:05:45 +02001386 return( PSA_SUCCESS );
1387}
1388
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001389/** Validate the internal consistency of key attributes.
1390 *
1391 * This function only rejects invalid attribute values. If does not
1392 * validate the consistency of the attributes with any key data that may
1393 * be involved in the creation of the key.
1394 *
1395 * Call this function early in the key creation process.
1396 *
1397 * \param[in] attributes Key attributes for the new key.
1398 * \param[out] p_drv On any return, the driver for the key, if any.
1399 * NULL for a transparent key.
1400 *
1401 */
1402static psa_status_t psa_validate_key_attributes(
1403 const psa_key_attributes_t *attributes,
1404 psa_se_drv_table_entry_t **p_drv )
Darryl Green0c6575a2018-11-07 16:05:30 +00001405{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001406 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Ronald Crond2ed4812020-07-17 16:11:30 +02001407 psa_key_lifetime_t lifetime = psa_get_key_lifetime( attributes );
Ronald Cron65f38a32020-10-23 17:11:13 +02001408 mbedtls_svc_key_id_t key = psa_get_key_id( attributes );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001409
Ronald Cron54b90082020-10-29 15:26:43 +01001410 status = psa_validate_key_location( lifetime, p_drv );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001411 if( status != PSA_SUCCESS )
1412 return( status );
1413
Ronald Crond2ed4812020-07-17 16:11:30 +02001414 status = psa_validate_key_persistence( lifetime );
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001415 if( status != PSA_SUCCESS )
1416 return( status );
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001417
Ronald Cron65f38a32020-10-23 17:11:13 +02001418 if ( PSA_KEY_LIFETIME_IS_VOLATILE( lifetime ) )
1419 {
1420 if( MBEDTLS_SVC_KEY_ID_GET_KEY_ID( key ) != 0 )
1421 return( PSA_ERROR_INVALID_ARGUMENT );
1422 }
1423 else
Ronald Crond2ed4812020-07-17 16:11:30 +02001424 {
Ronald Croncbd7bea2020-11-11 14:57:44 +01001425 status = psa_validate_key_id( psa_get_key_id( attributes ), 0 );
Ronald Crond2ed4812020-07-17 16:11:30 +02001426 if( status != PSA_SUCCESS )
1427 return( status );
1428 }
1429
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001430 status = psa_validate_key_policy( &attributes->core.policy );
Darryl Green0c6575a2018-11-07 16:05:30 +00001431 if( status != PSA_SUCCESS )
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001432 return( status );
1433
1434 /* Refuse to create overly large keys.
1435 * Note that this doesn't trigger on import if the attributes don't
1436 * explicitly specify a size (so psa_get_key_bits returns 0), so
1437 * psa_import_key() needs its own checks. */
1438 if( psa_get_key_bits( attributes ) > PSA_MAX_KEY_BITS )
1439 return( PSA_ERROR_NOT_SUPPORTED );
1440
Gilles Peskine91e8c332019-08-02 19:19:39 +02001441 /* Reject invalid flags. These should not be reachable through the API. */
1442 if( attributes->core.flags & ~ ( MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1443 MBEDTLS_PSA_KA_MASK_DUAL_USE ) )
1444 return( PSA_ERROR_INVALID_ARGUMENT );
1445
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001446 return( PSA_SUCCESS );
1447}
1448
Gilles Peskine4747d192019-04-17 15:05:45 +02001449/** Prepare a key slot to receive key material.
1450 *
1451 * This function allocates a key slot and sets its metadata.
1452 *
1453 * If this function fails, call psa_fail_key_creation().
1454 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001455 * This function is intended to be used as follows:
1456 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001457 * it with the specified attributes, and in case of a volatile key assign it
1458 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001459 * -# Populate the slot with the key material.
1460 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1461 * In case of failure at any step, stop the sequence and call
1462 * psa_fail_key_creation().
1463 *
Ronald Cron5c522922020-11-14 16:35:34 +01001464 * On success, the key slot is locked. It is the responsibility of the caller
1465 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001466 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001467 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001468 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001469 * \param[out] p_slot On success, a pointer to the prepared slot.
1470 * \param[out] p_drv On any return, the driver for the key, if any.
1471 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001472 *
1473 * \retval #PSA_SUCCESS
1474 * The key slot is ready to receive key material.
1475 * \return If this function fails, the key slot is an invalid state.
1476 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001477 */
1478static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001479 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001480 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001481 psa_key_slot_t **p_slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001482 psa_se_drv_table_entry_t **p_drv )
Gilles Peskine4747d192019-04-17 15:05:45 +02001483{
1484 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001485 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001486 psa_key_slot_t *slot;
1487
Gilles Peskinedf179142019-07-15 22:02:14 +02001488 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001489 *p_drv = NULL;
1490
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001491 status = psa_validate_key_attributes( attributes, p_drv );
1492 if( status != PSA_SUCCESS )
1493 return( status );
1494
Ronald Cronc4d1b512020-07-31 11:26:37 +02001495 status = psa_get_empty_key_slot( &volatile_key_id, p_slot );
Gilles Peskine4747d192019-04-17 15:05:45 +02001496 if( status != PSA_SUCCESS )
1497 return( status );
1498 slot = *p_slot;
1499
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001500 /* We're storing the declared bit-size of the key. It's up to each
1501 * creation mechanism to verify that this information is correct.
1502 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001503 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001504 * is optional (import, copy). In case of a volatile key, assign it the
1505 * volatile key identifier associated to the slot returned to contain its
1506 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001507
1508 slot->attr = attributes->core;
Ronald Cronc4d1b512020-07-31 11:26:37 +02001509 if( PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
1510 {
1511#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1512 slot->attr.id = volatile_key_id;
1513#else
1514 slot->attr.id.key_id = volatile_key_id;
1515#endif
1516 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001517
Gilles Peskine91e8c332019-08-02 19:19:39 +02001518 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001519 * external-only flags, query `attributes`. Thanks to the check
1520 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001521 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001522 * may have set. */
1523 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001524
Gilles Peskinecbaff462019-07-12 23:46:04 +02001525#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001526 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001527 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001528 * create the key file in internal storage, create the
1529 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001530 * persistent data. This is done by starting a transaction that will
1531 * encompass these three actions.
1532 * For registering a volatile key, we just need to find an appropriate
1533 * slot number inside the SE. Since the key is designated volatile, creating
1534 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001535 /* The first thing to do is to find a slot number for the new key.
1536 * We save the slot number in persistent storage as part of the
1537 * transaction data. It will be needed to recover if the power
1538 * fails during the key creation process, to clean up on the secure
1539 * element side after restarting. Obtaining a slot number from the
1540 * secure element driver updates its persistent state, but we do not yet
1541 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001542 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001543 if( *p_drv != NULL )
Darryl Green0c6575a2018-11-07 16:05:30 +00001544 {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001545 psa_key_slot_number_t slot_number;
Gilles Peskinee88c2c12019-08-05 16:44:14 +02001546 status = psa_find_se_slot_for_key( attributes, method, *p_drv,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001547 &slot_number );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001548 if( status != PSA_SUCCESS )
1549 return( status );
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001550
1551 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( attributes->core.lifetime ) )
Gilles Peskine66be51c2019-07-25 18:02:52 +02001552 {
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001553 psa_crypto_prepare_transaction( PSA_CRYPTO_TRANSACTION_CREATE_KEY );
1554 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001555 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001556 psa_crypto_transaction.key.id = slot->attr.id;
1557 status = psa_crypto_save_transaction( );
1558 if( status != PSA_SUCCESS )
1559 {
1560 (void) psa_crypto_stop_transaction( );
1561 return( status );
1562 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001563 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001564
1565 status = psa_copy_key_material_into_slot(
1566 slot, (uint8_t *)( &slot_number ), sizeof( slot_number ) );
Darryl Green0c6575a2018-11-07 16:05:30 +00001567 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001568
1569 if( *p_drv == NULL && method == PSA_KEY_CREATION_REGISTER )
1570 {
1571 /* Key registration only makes sense with a secure element. */
1572 return( PSA_ERROR_INVALID_ARGUMENT );
1573 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001574#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1575
Ronald Cronc4d1b512020-07-31 11:26:37 +02001576 return( PSA_SUCCESS );
Darryl Green0c6575a2018-11-07 16:05:30 +00001577}
Gilles Peskine4747d192019-04-17 15:05:45 +02001578
1579/** Finalize the creation of a key once its key material has been set.
1580 *
1581 * This entails writing the key to persistent storage.
1582 *
1583 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001584 * See the documentation of psa_start_key_creation() for the intended use
1585 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001586 *
Ronald Cron5c522922020-11-14 16:35:34 +01001587 * If the finalization succeeds, the function unlocks the key slot (it was
1588 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1589 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001590 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001591 * \param[in,out] slot Pointer to the slot with key material.
1592 * \param[in] driver The secure element driver for the key,
1593 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001594 * \param[out] key On success, identifier of the key. Note that the
1595 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001596 *
1597 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001598 * The key was successfully created.
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001599 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1600 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE
1601 * \retval #PSA_ERROR_ALREADY_EXISTS
1602 * \retval #PSA_ERROR_DATA_INVALID
1603 * \retval #PSA_ERROR_DATA_CORRUPT
gabor-mezei-arm86326a92020-11-30 16:50:34 +01001604 * \retval #PSA_ERROR_STORAGE_FAILURE
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001605 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001606 * \return If this function fails, the key slot is an invalid state.
1607 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001608 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001609static psa_status_t psa_finish_key_creation(
1610 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001611 psa_se_drv_table_entry_t *driver,
1612 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001613{
1614 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001615 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001616 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001617
1618#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001619 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001620 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001621#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1622 if( driver != NULL )
1623 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001624 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001625 psa_key_slot_number_t slot_number =
1626 psa_key_slot_get_slot_number( slot ) ;
1627
Gilles Peskineb46bef22019-07-30 21:32:04 +02001628#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001629 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001630 sizeof( data.slot_number ),
1631 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001632#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001633 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001634 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001635 (uint8_t*) &data,
1636 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001637 }
1638 else
1639#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1640 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001641 /* Key material is saved in export representation in the slot, so
1642 * just pass the slot buffer for storage. */
1643 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001644 slot->key.data,
1645 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001646 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001647 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001648#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1649
Gilles Peskinecbaff462019-07-12 23:46:04 +02001650#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001651 /* Finish the transaction for a key creation. This does not
1652 * happen when registering an existing key. Detect this case
1653 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001654 * creation of a persistent key in a secure element requires a transaction,
1655 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001656 if( driver != NULL &&
1657 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001658 {
1659 status = psa_save_se_persistent_data( driver );
1660 if( status != PSA_SUCCESS )
1661 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001662 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001663 return( status );
1664 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001665 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001666 }
1667#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1668
Ronald Cron50972942020-11-14 11:28:25 +01001669 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001670 {
1671 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001672 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001673 if( status != PSA_SUCCESS )
1674 *key = MBEDTLS_SVC_KEY_ID_INIT;
1675 }
Ronald Cron50972942020-11-14 11:28:25 +01001676
Gilles Peskine4747d192019-04-17 15:05:45 +02001677 return( status );
1678}
1679
1680/** Abort the creation of a key.
1681 *
1682 * You may call this function after calling psa_start_key_creation(),
1683 * or after psa_finish_key_creation() fails. In other circumstances, this
1684 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001685 * See the documentation of psa_start_key_creation() for the intended use
1686 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001687 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001688 * \param[in,out] slot Pointer to the slot with key material.
1689 * \param[in] driver The secure element driver for the key,
1690 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001691 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001692static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001693 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001694{
Gilles Peskine011e4282019-06-26 18:34:38 +02001695 (void) driver;
1696
Gilles Peskine4747d192019-04-17 15:05:45 +02001697 if( slot == NULL )
1698 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001699
1700#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001701 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001702 * element, and the failure happened later (when saving metadata
1703 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001704 * element.
1705 * https://github.com/ARMmbed/mbed-crypto/issues/217
1706 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001707
Gilles Peskined7729582019-08-05 15:55:54 +02001708 /* Abort the ongoing transaction if any (there may not be one if
1709 * the creation process failed before starting one, or if the
1710 * key creation is a registration of a key in a secure element).
1711 * Earlier functions must already have done what it takes to undo any
1712 * partial creation. All that's left is to update the transaction data
1713 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001714 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001715#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1716
Gilles Peskine4747d192019-04-17 15:05:45 +02001717 psa_wipe_key_slot( slot );
1718}
1719
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001720/** Validate optional attributes during key creation.
1721 *
1722 * Some key attributes are optional during key creation. If they are
1723 * specified in the attributes structure, check that they are consistent
1724 * with the data in the slot.
1725 *
1726 * This function should be called near the end of key creation, after
1727 * the slot in memory is fully populated but before saving persistent data.
1728 */
1729static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001730 const psa_key_slot_t *slot,
1731 const psa_key_attributes_t *attributes )
1732{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001733 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001734 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001735 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001736 return( PSA_ERROR_INVALID_ARGUMENT );
1737 }
1738
1739 if( attributes->domain_parameters_size != 0 )
1740 {
John Durkop0e005192020-10-31 22:06:54 -07001741#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1742 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001743 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001744 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001745 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001746 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001748
Ronald Cron90857082020-11-25 14:58:33 +01001749 psa_status_t status = mbedtls_psa_rsa_load_representation(
1750 slot->attr.type,
1751 slot->key.data,
1752 slot->key.bytes,
1753 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001754 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001755 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001756
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001757 mbedtls_mpi_init( &actual );
1758 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001759 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001760 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001761 mbedtls_rsa_free( rsa );
1762 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001763 if( ret != 0 )
1764 goto rsa_exit;
1765 ret = mbedtls_mpi_read_binary( &required,
1766 attributes->domain_parameters,
1767 attributes->domain_parameters_size );
1768 if( ret != 0 )
1769 goto rsa_exit;
1770 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1771 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1772 rsa_exit:
1773 mbedtls_mpi_free( &actual );
1774 mbedtls_mpi_free( &required );
1775 if( ret != 0)
1776 return( mbedtls_to_psa_error( ret ) );
1777 }
1778 else
John Durkop9814fa22020-11-04 12:28:15 -08001779#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1780 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001781 {
1782 return( PSA_ERROR_INVALID_ARGUMENT );
1783 }
1784 }
1785
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001786 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001787 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001788 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001789 return( PSA_ERROR_INVALID_ARGUMENT );
1790 }
1791
1792 return( PSA_SUCCESS );
1793}
1794
Gilles Peskine4747d192019-04-17 15:05:45 +02001795psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001796 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001797 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001798 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001799{
1800 psa_status_t status;
1801 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001802 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001803 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001804
Ronald Cron81709fc2020-11-14 12:10:32 +01001805 *key = MBEDTLS_SVC_KEY_ID_INIT;
1806
Gilles Peskine0f84d622019-09-12 19:03:13 +02001807 /* Reject zero-length symmetric keys (including raw data key objects).
1808 * This also rejects any key which might be encoded as an empty string,
1809 * which is never valid. */
1810 if( data_length == 0 )
1811 return( PSA_ERROR_INVALID_ARGUMENT );
1812
Gilles Peskinedf179142019-07-15 22:02:14 +02001813 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001814 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001815 if( status != PSA_SUCCESS )
1816 goto exit;
1817
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001818 /* In the case of a transparent key or an opaque key stored in local
1819 * storage (thus not in the case of generating a key in a secure element
1820 * or cryptoprocessor with storage), we have to allocate a buffer to
1821 * hold the generated key material. */
1822 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001823 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001824 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001825 if( status != PSA_SUCCESS )
1826 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001827 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001828
1829 bits = slot->attr.bits;
1830 status = psa_driver_wrapper_import_key( attributes,
1831 data, data_length,
1832 slot->key.data,
1833 slot->key.bytes,
1834 &slot->key.bytes, &bits );
1835 if( status != PSA_SUCCESS )
1836 goto exit;
1837
1838 if( slot->attr.bits == 0 )
1839 slot->attr.bits = (psa_key_bits_t) bits;
1840 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001841 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001842 status = PSA_ERROR_INVALID_ARGUMENT;
1843 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001844 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001845
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001846 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001847 if( status != PSA_SUCCESS )
1848 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001849
Ronald Cron81709fc2020-11-14 12:10:32 +01001850 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001851exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001852 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001853 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001854
Gilles Peskine4747d192019-04-17 15:05:45 +02001855 return( status );
1856}
1857
Gilles Peskined7729582019-08-05 15:55:54 +02001858#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1859psa_status_t mbedtls_psa_register_se_key(
1860 const psa_key_attributes_t *attributes )
1861{
1862 psa_status_t status;
1863 psa_key_slot_t *slot = NULL;
1864 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001865 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001866
1867 /* Leaving attributes unspecified is not currently supported.
1868 * It could make sense to query the key type and size from the
1869 * secure element, but not all secure elements support this
1870 * and the driver HAL doesn't currently support it. */
1871 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1872 return( PSA_ERROR_NOT_SUPPORTED );
1873 if( psa_get_key_bits( attributes ) == 0 )
1874 return( PSA_ERROR_NOT_SUPPORTED );
1875
1876 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001877 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001878 if( status != PSA_SUCCESS )
1879 goto exit;
1880
Ronald Cron81709fc2020-11-14 12:10:32 +01001881 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001882
1883exit:
1884 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001885 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001886
Gilles Peskined7729582019-08-05 15:55:54 +02001887 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001889 return( status );
1890}
1891#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1892
Gilles Peskinef603c712019-01-19 13:40:11 +01001893static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001894 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001895{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001896 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001897 source->key.data,
1898 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001899 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001900 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001901
Steven Cooreman398aee52020-10-13 14:35:45 +02001902 target->attr.type = source->attr.type;
1903 target->attr.bits = source->attr.bits;
1904
1905 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001906}
1907
Ronald Croncf56a0a2020-08-04 09:51:30 +02001908psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001909 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001910 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001911{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001912 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001913 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01001914 psa_key_slot_t *source_slot = NULL;
1915 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001916 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001917 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001918
Ronald Cron81709fc2020-11-14 12:10:32 +01001919 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
1920
Ronald Cron5c522922020-11-14 16:35:34 +01001921 status = psa_get_and_lock_transparent_key_slot_with_policy(
1922 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001923 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001924 goto exit;
1925
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001926 status = psa_validate_optional_attributes( source_slot,
1927 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001928 if( status != PSA_SUCCESS )
1929 goto exit;
1930
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001931 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001932 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001933 if( status != PSA_SUCCESS )
1934 goto exit;
1935
Ronald Cron81709fc2020-11-14 12:10:32 +01001936 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
1937 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001938 if( status != PSA_SUCCESS )
1939 goto exit;
1940
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001941#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1942 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01001943 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001944 /* Copying to a secure element is not implemented yet. */
1945 status = PSA_ERROR_NOT_SUPPORTED;
1946 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001947 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001948#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01001949
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001950 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01001951 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001952 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001953
Ronald Cron81709fc2020-11-14 12:10:32 +01001954 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001955exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001956 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001957 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001958
Ronald Cron5c522922020-11-14 16:35:34 +01001959 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001960
Ronald Cron5c522922020-11-14 16:35:34 +01001961 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001962}
1963
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001964
1965
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001966/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001967/* Message digests */
1968/****************************************************************/
1969
John Durkop07cc04a2020-11-16 22:08:34 -08001970#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07001971 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
1972 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08001973 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001974static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001975{
1976 switch( alg )
1977 {
John Durkopee4e6602020-11-27 08:48:46 -08001978#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01001979 case PSA_ALG_MD2:
1980 return( &mbedtls_md2_info );
1981#endif
John Durkopee4e6602020-11-27 08:48:46 -08001982#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01001983 case PSA_ALG_MD4:
1984 return( &mbedtls_md4_info );
1985#endif
John Durkopee4e6602020-11-27 08:48:46 -08001986#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01001987 case PSA_ALG_MD5:
1988 return( &mbedtls_md5_info );
1989#endif
John Durkopee4e6602020-11-27 08:48:46 -08001990#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01001991 case PSA_ALG_RIPEMD160:
1992 return( &mbedtls_ripemd160_info );
1993#endif
John Durkopee4e6602020-11-27 08:48:46 -08001994#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01001995 case PSA_ALG_SHA_1:
1996 return( &mbedtls_sha1_info );
1997#endif
John Durkopee4e6602020-11-27 08:48:46 -08001998#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01001999 case PSA_ALG_SHA_224:
2000 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08002001#endif
2002#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01002003 case PSA_ALG_SHA_256:
2004 return( &mbedtls_sha256_info );
2005#endif
John Durkopee4e6602020-11-27 08:48:46 -08002006#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002007 case PSA_ALG_SHA_384:
2008 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002009#endif
John Durkopee4e6602020-11-27 08:48:46 -08002010#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002011 case PSA_ALG_SHA_512:
2012 return( &mbedtls_sha512_info );
2013#endif
2014 default:
2015 return( NULL );
2016 }
2017}
John Durkop07cc04a2020-11-16 22:08:34 -08002018#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002019 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2020 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2021 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002022
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002023psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2024{
2025 switch( operation->alg )
2026 {
Gilles Peskine81736312018-06-26 15:04:31 +02002027 case 0:
2028 /* The object has (apparently) been initialized but it is not
2029 * in use. It's ok to call abort on such an object, and there's
2030 * nothing to do. */
2031 break;
John Durkopee4e6602020-11-27 08:48:46 -08002032#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002033 case PSA_ALG_MD2:
2034 mbedtls_md2_free( &operation->ctx.md2 );
2035 break;
2036#endif
John Durkopee4e6602020-11-27 08:48:46 -08002037#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002038 case PSA_ALG_MD4:
2039 mbedtls_md4_free( &operation->ctx.md4 );
2040 break;
2041#endif
John Durkopee4e6602020-11-27 08:48:46 -08002042#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002043 case PSA_ALG_MD5:
2044 mbedtls_md5_free( &operation->ctx.md5 );
2045 break;
2046#endif
John Durkopee4e6602020-11-27 08:48:46 -08002047#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002048 case PSA_ALG_RIPEMD160:
2049 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2050 break;
2051#endif
John Durkopee4e6602020-11-27 08:48:46 -08002052#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002053 case PSA_ALG_SHA_1:
2054 mbedtls_sha1_free( &operation->ctx.sha1 );
2055 break;
2056#endif
John Durkop6ca23272020-12-03 06:01:32 -08002057#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002058 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002059 mbedtls_sha256_free( &operation->ctx.sha256 );
2060 break;
2061#endif
2062#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002063 case PSA_ALG_SHA_256:
2064 mbedtls_sha256_free( &operation->ctx.sha256 );
2065 break;
2066#endif
John Durkop6ca23272020-12-03 06:01:32 -08002067#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002068 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002069 mbedtls_sha512_free( &operation->ctx.sha512 );
2070 break;
2071#endif
2072#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002073 case PSA_ALG_SHA_512:
2074 mbedtls_sha512_free( &operation->ctx.sha512 );
2075 break;
2076#endif
2077 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002078 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002079 }
2080 operation->alg = 0;
2081 return( PSA_SUCCESS );
2082}
2083
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002084psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002085 psa_algorithm_t alg )
2086{
Janos Follath24eed8d2019-11-22 13:21:35 +00002087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002088
2089 /* A context must be freshly initialized before it can be set up. */
2090 if( operation->alg != 0 )
2091 {
2092 return( PSA_ERROR_BAD_STATE );
2093 }
2094
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002095 switch( alg )
2096 {
John Durkopee4e6602020-11-27 08:48:46 -08002097#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002098 case PSA_ALG_MD2:
2099 mbedtls_md2_init( &operation->ctx.md2 );
2100 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2101 break;
2102#endif
John Durkopee4e6602020-11-27 08:48:46 -08002103#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002104 case PSA_ALG_MD4:
2105 mbedtls_md4_init( &operation->ctx.md4 );
2106 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2107 break;
2108#endif
John Durkopee4e6602020-11-27 08:48:46 -08002109#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002110 case PSA_ALG_MD5:
2111 mbedtls_md5_init( &operation->ctx.md5 );
2112 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2113 break;
2114#endif
John Durkopee4e6602020-11-27 08:48:46 -08002115#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002116 case PSA_ALG_RIPEMD160:
2117 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2118 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2119 break;
2120#endif
John Durkopee4e6602020-11-27 08:48:46 -08002121#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002122 case PSA_ALG_SHA_1:
2123 mbedtls_sha1_init( &operation->ctx.sha1 );
2124 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2125 break;
2126#endif
John Durkopee4e6602020-11-27 08:48:46 -08002127#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002128 case PSA_ALG_SHA_224:
2129 mbedtls_sha256_init( &operation->ctx.sha256 );
2130 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2131 break;
John Durkopee4e6602020-11-27 08:48:46 -08002132#endif
2133#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002134 case PSA_ALG_SHA_256:
2135 mbedtls_sha256_init( &operation->ctx.sha256 );
2136 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2137 break;
2138#endif
John Durkopee4e6602020-11-27 08:48:46 -08002139#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002140 case PSA_ALG_SHA_384:
2141 mbedtls_sha512_init( &operation->ctx.sha512 );
2142 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2143 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002144#endif
John Durkopee4e6602020-11-27 08:48:46 -08002145#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002146 case PSA_ALG_SHA_512:
2147 mbedtls_sha512_init( &operation->ctx.sha512 );
2148 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2149 break;
2150#endif
2151 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002152 return( PSA_ALG_IS_HASH( alg ) ?
2153 PSA_ERROR_NOT_SUPPORTED :
2154 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002155 }
2156 if( ret == 0 )
2157 operation->alg = alg;
2158 else
2159 psa_hash_abort( operation );
2160 return( mbedtls_to_psa_error( ret ) );
2161}
2162
2163psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2164 const uint8_t *input,
2165 size_t input_length )
2166{
Janos Follath24eed8d2019-11-22 13:21:35 +00002167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002168
2169 /* Don't require hash implementations to behave correctly on a
2170 * zero-length input, which may have an invalid pointer. */
2171 if( input_length == 0 )
2172 return( PSA_SUCCESS );
2173
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002174 switch( operation->alg )
2175 {
John Durkopee4e6602020-11-27 08:48:46 -08002176#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002177 case PSA_ALG_MD2:
2178 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2179 input, input_length );
2180 break;
2181#endif
John Durkopee4e6602020-11-27 08:48:46 -08002182#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002183 case PSA_ALG_MD4:
2184 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2185 input, input_length );
2186 break;
2187#endif
John Durkopee4e6602020-11-27 08:48:46 -08002188#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002189 case PSA_ALG_MD5:
2190 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2191 input, input_length );
2192 break;
2193#endif
John Durkopee4e6602020-11-27 08:48:46 -08002194#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002195 case PSA_ALG_RIPEMD160:
2196 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2197 input, input_length );
2198 break;
2199#endif
John Durkopee4e6602020-11-27 08:48:46 -08002200#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002201 case PSA_ALG_SHA_1:
2202 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2203 input, input_length );
2204 break;
2205#endif
John Durkop6ca23272020-12-03 06:01:32 -08002206#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002207 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002208 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2209 input, input_length );
2210 break;
2211#endif
2212#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002213 case PSA_ALG_SHA_256:
2214 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2215 input, input_length );
2216 break;
2217#endif
John Durkop6ca23272020-12-03 06:01:32 -08002218#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002219 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002220 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2221 input, input_length );
2222 break;
2223#endif
2224#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002225 case PSA_ALG_SHA_512:
2226 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2227 input, input_length );
2228 break;
2229#endif
2230 default:
John Durkopee4e6602020-11-27 08:48:46 -08002231 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002232 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002233 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002234
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002235 if( ret != 0 )
2236 psa_hash_abort( operation );
2237 return( mbedtls_to_psa_error( ret ) );
2238}
2239
2240psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2241 uint8_t *hash,
2242 size_t hash_size,
2243 size_t *hash_length )
2244{
itayzafrir40835d42018-08-02 13:14:17 +03002245 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002247 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002248
2249 /* Fill the output buffer with something that isn't a valid hash
2250 * (barring an attack on the hash and deliberately-crafted input),
2251 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002252 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002253 /* If hash_size is 0 then hash may be NULL and then the
2254 * call to memset would have undefined behavior. */
2255 if( hash_size != 0 )
2256 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002257
2258 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002259 {
2260 status = PSA_ERROR_BUFFER_TOO_SMALL;
2261 goto exit;
2262 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002263
2264 switch( operation->alg )
2265 {
John Durkopee4e6602020-11-27 08:48:46 -08002266#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002267 case PSA_ALG_MD2:
2268 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2269 break;
2270#endif
John Durkopee4e6602020-11-27 08:48:46 -08002271#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002272 case PSA_ALG_MD4:
2273 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2274 break;
2275#endif
John Durkopee4e6602020-11-27 08:48:46 -08002276#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002277 case PSA_ALG_MD5:
2278 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2279 break;
2280#endif
John Durkopee4e6602020-11-27 08:48:46 -08002281#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002282 case PSA_ALG_RIPEMD160:
2283 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2284 break;
2285#endif
John Durkopee4e6602020-11-27 08:48:46 -08002286#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002287 case PSA_ALG_SHA_1:
2288 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2289 break;
2290#endif
John Durkop6ca23272020-12-03 06:01:32 -08002291#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002292 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002293 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2294 break;
2295#endif
2296#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002297 case PSA_ALG_SHA_256:
2298 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2299 break;
2300#endif
John Durkop6ca23272020-12-03 06:01:32 -08002301#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002302 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002303 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2304 break;
2305#endif
2306#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002307 case PSA_ALG_SHA_512:
2308 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2309 break;
2310#endif
2311 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002312 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313 }
itayzafrir40835d42018-08-02 13:14:17 +03002314 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002315
itayzafrir40835d42018-08-02 13:14:17 +03002316exit:
2317 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002318 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002319 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320 return( psa_hash_abort( operation ) );
2321 }
2322 else
2323 {
2324 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002325 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326 }
2327}
2328
Gilles Peskine2d277862018-06-18 15:41:12 +02002329psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2330 const uint8_t *hash,
2331 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332{
2333 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2334 size_t actual_hash_length;
2335 psa_status_t status = psa_hash_finish( operation,
2336 actual_hash, sizeof( actual_hash ),
2337 &actual_hash_length );
2338 if( status != PSA_SUCCESS )
2339 return( status );
2340 if( actual_hash_length != hash_length )
2341 return( PSA_ERROR_INVALID_SIGNATURE );
2342 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2343 return( PSA_ERROR_INVALID_SIGNATURE );
2344 return( PSA_SUCCESS );
2345}
2346
Gilles Peskine0a749c82019-11-28 19:33:58 +01002347psa_status_t psa_hash_compute( psa_algorithm_t alg,
2348 const uint8_t *input, size_t input_length,
2349 uint8_t *hash, size_t hash_size,
2350 size_t *hash_length )
2351{
2352 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2353 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2354
2355 *hash_length = hash_size;
2356 status = psa_hash_setup( &operation, alg );
2357 if( status != PSA_SUCCESS )
2358 goto exit;
2359 status = psa_hash_update( &operation, input, input_length );
2360 if( status != PSA_SUCCESS )
2361 goto exit;
2362 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2363 if( status != PSA_SUCCESS )
2364 goto exit;
2365
2366exit:
2367 if( status == PSA_SUCCESS )
2368 status = psa_hash_abort( &operation );
2369 else
2370 psa_hash_abort( &operation );
2371 return( status );
2372}
2373
2374psa_status_t psa_hash_compare( psa_algorithm_t alg,
2375 const uint8_t *input, size_t input_length,
2376 const uint8_t *hash, size_t hash_length )
2377{
2378 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2380
2381 status = psa_hash_setup( &operation, alg );
2382 if( status != PSA_SUCCESS )
2383 goto exit;
2384 status = psa_hash_update( &operation, input, input_length );
2385 if( status != PSA_SUCCESS )
2386 goto exit;
2387 status = psa_hash_verify( &operation, hash, hash_length );
2388 if( status != PSA_SUCCESS )
2389 goto exit;
2390
2391exit:
2392 if( status == PSA_SUCCESS )
2393 status = psa_hash_abort( &operation );
2394 else
2395 psa_hash_abort( &operation );
2396 return( status );
2397}
2398
Gilles Peskineeb35d782019-01-22 17:56:16 +01002399psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2400 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002401{
2402 if( target_operation->alg != 0 )
2403 return( PSA_ERROR_BAD_STATE );
2404
2405 switch( source_operation->alg )
2406 {
2407 case 0:
2408 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002409#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002410 case PSA_ALG_MD2:
2411 mbedtls_md2_clone( &target_operation->ctx.md2,
2412 &source_operation->ctx.md2 );
2413 break;
2414#endif
John Durkopee4e6602020-11-27 08:48:46 -08002415#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002416 case PSA_ALG_MD4:
2417 mbedtls_md4_clone( &target_operation->ctx.md4,
2418 &source_operation->ctx.md4 );
2419 break;
2420#endif
John Durkopee4e6602020-11-27 08:48:46 -08002421#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002422 case PSA_ALG_MD5:
2423 mbedtls_md5_clone( &target_operation->ctx.md5,
2424 &source_operation->ctx.md5 );
2425 break;
2426#endif
John Durkopee4e6602020-11-27 08:48:46 -08002427#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002428 case PSA_ALG_RIPEMD160:
2429 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2430 &source_operation->ctx.ripemd160 );
2431 break;
2432#endif
John Durkopee4e6602020-11-27 08:48:46 -08002433#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002434 case PSA_ALG_SHA_1:
2435 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2436 &source_operation->ctx.sha1 );
2437 break;
2438#endif
John Durkop6ca23272020-12-03 06:01:32 -08002439#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002440 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002441 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2442 &source_operation->ctx.sha256 );
2443 break;
2444#endif
2445#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002446 case PSA_ALG_SHA_256:
2447 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2448 &source_operation->ctx.sha256 );
2449 break;
2450#endif
John Durkop6ca23272020-12-03 06:01:32 -08002451#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002452 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002453 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2454 &source_operation->ctx.sha512 );
2455 break;
2456#endif
2457#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002458 case PSA_ALG_SHA_512:
2459 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2460 &source_operation->ctx.sha512 );
2461 break;
2462#endif
2463 default:
2464 return( PSA_ERROR_NOT_SUPPORTED );
2465 }
2466
2467 target_operation->alg = source_operation->alg;
2468 return( PSA_SUCCESS );
2469}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002470
2471
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002472/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002473/* MAC */
2474/****************************************************************/
2475
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002476static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002477 psa_algorithm_t alg,
2478 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002479 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002480 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002482 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002483 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002485 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002486 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002487
Gilles Peskine8c9def32018-02-08 10:02:12 +01002488 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2489 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002490 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002491 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002492 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002493 mode = MBEDTLS_MODE_STREAM;
2494 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002495 case PSA_ALG_CTR:
2496 mode = MBEDTLS_MODE_CTR;
2497 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002498 case PSA_ALG_CFB:
2499 mode = MBEDTLS_MODE_CFB;
2500 break;
2501 case PSA_ALG_OFB:
2502 mode = MBEDTLS_MODE_OFB;
2503 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002504 case PSA_ALG_ECB_NO_PADDING:
2505 mode = MBEDTLS_MODE_ECB;
2506 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002507 case PSA_ALG_CBC_NO_PADDING:
2508 mode = MBEDTLS_MODE_CBC;
2509 break;
2510 case PSA_ALG_CBC_PKCS7:
2511 mode = MBEDTLS_MODE_CBC;
2512 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002513 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002514 mode = MBEDTLS_MODE_CCM;
2515 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002516 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002517 mode = MBEDTLS_MODE_GCM;
2518 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002519 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2520 mode = MBEDTLS_MODE_CHACHAPOLY;
2521 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002522 default:
2523 return( NULL );
2524 }
2525 }
2526 else if( alg == PSA_ALG_CMAC )
2527 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002528 else
2529 return( NULL );
2530
2531 switch( key_type )
2532 {
2533 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002534 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002535 break;
2536 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002537 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2538 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002539 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002540 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002542 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002543 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2544 * but two-key Triple-DES is functionally three-key Triple-DES
2545 * with K1=K3, so that's how we present it to mbedtls. */
2546 if( key_bits == 128 )
2547 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002548 break;
2549 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002550 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551 break;
2552 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002553 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002554 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002555 case PSA_KEY_TYPE_CHACHA20:
2556 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2557 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002558 default:
2559 return( NULL );
2560 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002561 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002562 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002563
Jaeden Amero23bbb752018-06-26 14:16:54 +01002564 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2565 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002566}
2567
John Durkop6ba40d12020-11-10 08:50:04 -08002568#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002569static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002570{
Gilles Peskine2d277862018-06-18 15:41:12 +02002571 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002572 {
2573 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002574 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002575 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002576 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002577 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002578 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002579 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002580 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002581 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002582 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002583 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002584 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002585 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002586 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002587 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002588 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002589 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002590 return( 128 );
2591 default:
2592 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002593 }
2594}
John Durkop07cc04a2020-11-16 22:08:34 -08002595#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002596
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002597/* Initialize the MAC operation structure. Once this function has been
2598 * called, psa_mac_abort can run and will do the right thing. */
2599static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2600 psa_algorithm_t alg )
2601{
2602 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2603
2604 operation->alg = alg;
2605 operation->key_set = 0;
2606 operation->iv_set = 0;
2607 operation->iv_required = 0;
2608 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002609 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002610
2611#if defined(MBEDTLS_CMAC_C)
2612 if( alg == PSA_ALG_CMAC )
2613 {
2614 operation->iv_required = 0;
2615 mbedtls_cipher_init( &operation->ctx.cmac );
2616 status = PSA_SUCCESS;
2617 }
2618 else
2619#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002620#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002621 if( PSA_ALG_IS_HMAC( operation->alg ) )
2622 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002623 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2624 operation->ctx.hmac.hash_ctx.alg = 0;
2625 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002626 }
2627 else
John Durkopd0321952020-10-29 21:37:36 -07002628#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002629 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002630 if( ! PSA_ALG_IS_MAC( alg ) )
2631 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002632 }
2633
2634 if( status != PSA_SUCCESS )
2635 memset( operation, 0, sizeof( *operation ) );
2636 return( status );
2637}
2638
John Durkop6ba40d12020-11-10 08:50:04 -08002639#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002640static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2641{
Gilles Peskine3f108122018-12-07 18:14:53 +01002642 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002643 return( psa_hash_abort( &hmac->hash_ctx ) );
2644}
John Durkop6ba40d12020-11-10 08:50:04 -08002645#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002646
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2648{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002649 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002650 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002651 /* The object has (apparently) been initialized but it is not
2652 * in use. It's ok to call abort on such an object, and there's
2653 * nothing to do. */
2654 return( PSA_SUCCESS );
2655 }
2656 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002658 if( operation->alg == PSA_ALG_CMAC )
2659 {
2660 mbedtls_cipher_free( &operation->ctx.cmac );
2661 }
2662 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002663#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002664#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002665 if( PSA_ALG_IS_HMAC( operation->alg ) )
2666 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002667 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002668 }
2669 else
John Durkopd0321952020-10-29 21:37:36 -07002670#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002671 {
2672 /* Sanity check (shouldn't happen: operation->alg should
2673 * always have been initialized to a valid value). */
2674 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002675 }
Moran Peker41deec42018-04-04 15:43:05 +03002676
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677 operation->alg = 0;
2678 operation->key_set = 0;
2679 operation->iv_set = 0;
2680 operation->iv_required = 0;
2681 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002682 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002683
Gilles Peskine8c9def32018-02-08 10:02:12 +01002684 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002685
2686bad_state:
2687 /* If abort is called on an uninitialized object, we can't trust
2688 * anything. Wipe the object in case it contains confidential data.
2689 * This may result in a memory leak if a pointer gets overwritten,
2690 * but it's too late to do anything about this. */
2691 memset( operation, 0, sizeof( *operation ) );
2692 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002693}
2694
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002695#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002696static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002697 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002698 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002699 const mbedtls_cipher_info_t *cipher_info )
2700{
Janos Follath24eed8d2019-11-22 13:21:35 +00002701 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002702
2703 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002704
2705 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2706 if( ret != 0 )
2707 return( ret );
2708
2709 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002710 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002711 key_bits );
2712 return( ret );
2713}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002714#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002715
John Durkop6ba40d12020-11-10 08:50:04 -08002716#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002717static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2718 const uint8_t *key,
2719 size_t key_length,
2720 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002721{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002722 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002723 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002724 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002725 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002726 psa_status_t status;
2727
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002728 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2729 * overflow below. This should never trigger if the hash algorithm
2730 * is implemented correctly. */
2731 /* The size checks against the ipad and opad buffers cannot be written
2732 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2733 * because that triggers -Wlogical-op on GCC 7.3. */
2734 if( block_size > sizeof( ipad ) )
2735 return( PSA_ERROR_NOT_SUPPORTED );
2736 if( block_size > sizeof( hmac->opad ) )
2737 return( PSA_ERROR_NOT_SUPPORTED );
2738 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002739 return( PSA_ERROR_NOT_SUPPORTED );
2740
Gilles Peskined223b522018-06-11 18:12:58 +02002741 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002742 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002743 status = psa_hash_compute( hash_alg, key, key_length,
2744 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002745 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002746 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002747 }
Gilles Peskine96889972018-07-12 17:07:03 +02002748 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2749 * but it is permitted. It is common when HMAC is used in HKDF, for
2750 * example. Don't call `memcpy` in the 0-length because `key` could be
2751 * an invalid pointer which would make the behavior undefined. */
2752 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002753 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002754
Gilles Peskined223b522018-06-11 18:12:58 +02002755 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2756 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002757 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002758 ipad[i] ^= 0x36;
2759 memset( ipad + key_length, 0x36, block_size - key_length );
2760
2761 /* Copy the key material from ipad to opad, flipping the requisite bits,
2762 * and filling the rest of opad with the requisite constant. */
2763 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002764 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2765 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002766
Gilles Peskine01126fa2018-07-12 17:04:55 +02002767 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002768 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002769 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002770
Gilles Peskine01126fa2018-07-12 17:04:55 +02002771 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002772
2773cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002774 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002775
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002776 return( status );
2777}
John Durkop6ba40d12020-11-10 08:50:04 -08002778#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002779
Gilles Peskine89167cb2018-07-08 20:12:23 +02002780static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002781 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002782 psa_algorithm_t alg,
2783 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002784{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002785 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002786 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002787 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002789 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002790 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002791 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002792 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002793
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002794 /* A context must be freshly initialized before it can be set up. */
2795 if( operation->alg != 0 )
2796 {
2797 return( PSA_ERROR_BAD_STATE );
2798 }
2799
Gilles Peskined911eb72018-08-14 15:18:45 +02002800 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002801 if( status != PSA_SUCCESS )
2802 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002803 if( is_sign )
2804 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002805
Ronald Cron5c522922020-11-14 16:35:34 +01002806 status = psa_get_and_lock_transparent_key_slot_with_policy(
2807 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002808 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002809 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002810 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002811
Gilles Peskine8c9def32018-02-08 10:02:12 +01002812#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002813 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002814 {
2815 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002816 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002817 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002818 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002819 if( cipher_info == NULL )
2820 {
2821 status = PSA_ERROR_NOT_SUPPORTED;
2822 goto exit;
2823 }
2824 operation->mac_size = cipher_info->block_size;
2825 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2826 status = mbedtls_to_psa_error( ret );
2827 }
2828 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002829#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002830#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002831 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002832 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002833 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002834 if( hash_alg == 0 )
2835 {
2836 status = PSA_ERROR_NOT_SUPPORTED;
2837 goto exit;
2838 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002839
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002840 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002841 /* Sanity check. This shouldn't fail on a valid configuration. */
2842 if( operation->mac_size == 0 ||
2843 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2844 {
2845 status = PSA_ERROR_NOT_SUPPORTED;
2846 goto exit;
2847 }
2848
Gilles Peskine8e338702019-07-30 20:06:31 +02002849 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002850 {
2851 status = PSA_ERROR_INVALID_ARGUMENT;
2852 goto exit;
2853 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002854
Gilles Peskine01126fa2018-07-12 17:04:55 +02002855 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002856 slot->key.data,
2857 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02002858 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002859 }
2860 else
John Durkopd0321952020-10-29 21:37:36 -07002861#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002862 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002863 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002864 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002865 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002866
Gilles Peskined911eb72018-08-14 15:18:45 +02002867 if( truncated == 0 )
2868 {
2869 /* The "normal" case: untruncated algorithm. Nothing to do. */
2870 }
2871 else if( truncated < 4 )
2872 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002873 /* A very short MAC is too short for security since it can be
2874 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2875 * so we make this our minimum, even though 32 bits is still
2876 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002877 status = PSA_ERROR_NOT_SUPPORTED;
2878 }
2879 else if( truncated > operation->mac_size )
2880 {
2881 /* It's impossible to "truncate" to a larger length. */
2882 status = PSA_ERROR_INVALID_ARGUMENT;
2883 }
2884 else
2885 operation->mac_size = truncated;
2886
Gilles Peskinefbfac682018-07-08 20:51:54 +02002887exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002888 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002889 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002890 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002891 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002892 else
2893 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002894 operation->key_set = 1;
2895 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002896
Ronald Cron5c522922020-11-14 16:35:34 +01002897 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002898
Ronald Cron5c522922020-11-14 16:35:34 +01002899 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002900}
2901
Gilles Peskine89167cb2018-07-08 20:12:23 +02002902psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002903 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002904 psa_algorithm_t alg )
2905{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002906 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002907}
2908
2909psa_status_t psa_mac_verify_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002910 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002911 psa_algorithm_t alg )
2912{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002913 return( psa_mac_setup( operation, key, alg, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002914}
2915
Gilles Peskine8c9def32018-02-08 10:02:12 +01002916psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2917 const uint8_t *input,
2918 size_t input_length )
2919{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002920 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002921 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002922 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002923 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002924 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002925 operation->has_input = 1;
2926
Gilles Peskine8c9def32018-02-08 10:02:12 +01002927#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002928 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002929 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002930 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2931 input, input_length );
2932 status = mbedtls_to_psa_error( ret );
2933 }
2934 else
2935#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002936#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002937 if( PSA_ALG_IS_HMAC( operation->alg ) )
2938 {
2939 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2940 input_length );
2941 }
2942 else
John Durkopd0321952020-10-29 21:37:36 -07002943#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002944 {
2945 /* This shouldn't happen if `operation` was initialized by
2946 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002947 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002948 }
2949
Gilles Peskinefbfac682018-07-08 20:51:54 +02002950 if( status != PSA_SUCCESS )
2951 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002952 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002953}
2954
John Durkop6ba40d12020-11-10 08:50:04 -08002955#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002956static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2957 uint8_t *mac,
2958 size_t mac_size )
2959{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002960 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002961 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2962 size_t hash_size = 0;
2963 size_t block_size = psa_get_hash_block_size( hash_alg );
2964 psa_status_t status;
2965
Gilles Peskine01126fa2018-07-12 17:04:55 +02002966 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2967 if( status != PSA_SUCCESS )
2968 return( status );
2969 /* From here on, tmp needs to be wiped. */
2970
2971 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2972 if( status != PSA_SUCCESS )
2973 goto exit;
2974
2975 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2976 if( status != PSA_SUCCESS )
2977 goto exit;
2978
2979 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2980 if( status != PSA_SUCCESS )
2981 goto exit;
2982
Gilles Peskined911eb72018-08-14 15:18:45 +02002983 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2984 if( status != PSA_SUCCESS )
2985 goto exit;
2986
2987 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002988
2989exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002990 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002991 return( status );
2992}
John Durkop6ba40d12020-11-10 08:50:04 -08002993#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002994
mohammad16036df908f2018-04-02 08:34:15 -07002995static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002996 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002997 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002998{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002999 if( ! operation->key_set )
3000 return( PSA_ERROR_BAD_STATE );
3001 if( operation->iv_required && ! operation->iv_set )
3002 return( PSA_ERROR_BAD_STATE );
3003
Gilles Peskine8c9def32018-02-08 10:02:12 +01003004 if( mac_size < operation->mac_size )
3005 return( PSA_ERROR_BUFFER_TOO_SMALL );
3006
Gilles Peskine8c9def32018-02-08 10:02:12 +01003007#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003008 if( operation->alg == PSA_ALG_CMAC )
3009 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003010 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003011 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3012 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003013 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003014 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003015 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003016 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003017 else
3018#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003019#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003020 if( PSA_ALG_IS_HMAC( operation->alg ) )
3021 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003022 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003023 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003024 }
3025 else
John Durkopd0321952020-10-29 21:37:36 -07003026#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003027 {
3028 /* This shouldn't happen if `operation` was initialized by
3029 * a setup function. */
3030 return( PSA_ERROR_BAD_STATE );
3031 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003032}
3033
Gilles Peskineacd4be32018-07-08 19:56:25 +02003034psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3035 uint8_t *mac,
3036 size_t mac_size,
3037 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003038{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003039 psa_status_t status;
3040
Jaeden Amero252ef282019-02-15 14:05:35 +00003041 if( operation->alg == 0 )
3042 {
3043 return( PSA_ERROR_BAD_STATE );
3044 }
3045
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003046 /* Fill the output buffer with something that isn't a valid mac
3047 * (barring an attack on the mac and deliberately-crafted input),
3048 * in case the caller doesn't check the return status properly. */
3049 *mac_length = mac_size;
3050 /* If mac_size is 0 then mac may be NULL and then the
3051 * call to memset would have undefined behavior. */
3052 if( mac_size != 0 )
3053 memset( mac, '!', mac_size );
3054
Gilles Peskine89167cb2018-07-08 20:12:23 +02003055 if( ! operation->is_sign )
3056 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003057 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003058 }
mohammad16036df908f2018-04-02 08:34:15 -07003059
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003060 status = psa_mac_finish_internal( operation, mac, mac_size );
3061
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003062 if( status == PSA_SUCCESS )
3063 {
3064 status = psa_mac_abort( operation );
3065 if( status == PSA_SUCCESS )
3066 *mac_length = operation->mac_size;
3067 else
3068 memset( mac, '!', mac_size );
3069 }
3070 else
3071 psa_mac_abort( operation );
3072 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003073}
3074
Gilles Peskineacd4be32018-07-08 19:56:25 +02003075psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3076 const uint8_t *mac,
3077 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003078{
Gilles Peskine828ed142018-06-18 23:25:51 +02003079 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003080 psa_status_t status;
3081
Jaeden Amero252ef282019-02-15 14:05:35 +00003082 if( operation->alg == 0 )
3083 {
3084 return( PSA_ERROR_BAD_STATE );
3085 }
3086
Gilles Peskine89167cb2018-07-08 20:12:23 +02003087 if( operation->is_sign )
3088 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003089 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003090 }
3091 if( operation->mac_size != mac_length )
3092 {
3093 status = PSA_ERROR_INVALID_SIGNATURE;
3094 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003095 }
mohammad16036df908f2018-04-02 08:34:15 -07003096
3097 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003098 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003099 if( status != PSA_SUCCESS )
3100 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003101
3102 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3103 status = PSA_ERROR_INVALID_SIGNATURE;
3104
3105cleanup:
3106 if( status == PSA_SUCCESS )
3107 status = psa_mac_abort( operation );
3108 else
3109 psa_mac_abort( operation );
3110
Gilles Peskine3f108122018-12-07 18:14:53 +01003111 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003112
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003113 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003114}
3115
3116
Gilles Peskine20035e32018-02-03 22:44:14 +01003117
Gilles Peskine20035e32018-02-03 22:44:14 +01003118/****************************************************************/
3119/* Asymmetric cryptography */
3120/****************************************************************/
3121
John Durkop6ba40d12020-11-10 08:50:04 -08003122#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3123 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003124/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003125 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003126static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3127 size_t hash_length,
3128 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003129{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003130 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003131 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003132 *md_alg = mbedtls_md_get_type( md_info );
3133
3134 /* The Mbed TLS RSA module uses an unsigned int for hash length
3135 * parameters. Validate that it fits so that we don't risk an
3136 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003137#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003138 if( hash_length > UINT_MAX )
3139 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003140#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003141
John Durkop0e005192020-10-31 22:06:54 -07003142#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003143 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3144 * must be correct. */
3145 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3146 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003147 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003148 if( md_info == NULL )
3149 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003150 if( mbedtls_md_get_size( md_info ) != hash_length )
3151 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003152 }
John Durkop0e005192020-10-31 22:06:54 -07003153#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003154
John Durkop0e005192020-10-31 22:06:54 -07003155#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003156 /* PSS requires a hash internally. */
3157 if( PSA_ALG_IS_RSA_PSS( alg ) )
3158 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003159 if( md_info == NULL )
3160 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003161 }
John Durkop0e005192020-10-31 22:06:54 -07003162#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003163
Gilles Peskine61b91d42018-06-08 16:09:36 +02003164 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003165}
3166
Gilles Peskine2b450e32018-06-27 15:42:46 +02003167static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3168 psa_algorithm_t alg,
3169 const uint8_t *hash,
3170 size_t hash_length,
3171 uint8_t *signature,
3172 size_t signature_size,
3173 size_t *signature_length )
3174{
3175 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003177 mbedtls_md_type_t md_alg;
3178
3179 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3180 if( status != PSA_SUCCESS )
3181 return( status );
3182
Gilles Peskine630a18a2018-06-29 17:49:35 +02003183 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003184 return( PSA_ERROR_BUFFER_TOO_SMALL );
3185
John Durkop0e005192020-10-31 22:06:54 -07003186#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003187 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3188 {
3189 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3190 MBEDTLS_MD_NONE );
3191 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003192 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003193 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003194 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003195 md_alg,
3196 (unsigned int) hash_length,
3197 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003198 signature );
3199 }
3200 else
John Durkop0e005192020-10-31 22:06:54 -07003201#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3202#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003203 if( PSA_ALG_IS_RSA_PSS( alg ) )
3204 {
3205 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3206 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003207 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003208 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003209 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003210 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003211 (unsigned int) hash_length,
3212 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003213 signature );
3214 }
3215 else
John Durkop0e005192020-10-31 22:06:54 -07003216#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003217 {
3218 return( PSA_ERROR_INVALID_ARGUMENT );
3219 }
3220
3221 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003222 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003223 return( mbedtls_to_psa_error( ret ) );
3224}
3225
3226static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3227 psa_algorithm_t alg,
3228 const uint8_t *hash,
3229 size_t hash_length,
3230 const uint8_t *signature,
3231 size_t signature_length )
3232{
3233 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003235 mbedtls_md_type_t md_alg;
3236
3237 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3238 if( status != PSA_SUCCESS )
3239 return( status );
3240
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003241 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3242 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003243
John Durkop0e005192020-10-31 22:06:54 -07003244#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003245 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3246 {
3247 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3248 MBEDTLS_MD_NONE );
3249 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003250 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003251 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003252 MBEDTLS_RSA_PUBLIC,
3253 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003254 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003255 hash,
3256 signature );
3257 }
3258 else
John Durkop0e005192020-10-31 22:06:54 -07003259#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3260#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003261 if( PSA_ALG_IS_RSA_PSS( alg ) )
3262 {
3263 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3264 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003265 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003266 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003267 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003268 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003269 (unsigned int) hash_length,
3270 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003271 signature );
3272 }
3273 else
John Durkop0e005192020-10-31 22:06:54 -07003274#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003275 {
3276 return( PSA_ERROR_INVALID_ARGUMENT );
3277 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003278
3279 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3280 * the rest of the signature is invalid". This has little use in
3281 * practice and PSA doesn't report this distinction. */
3282 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3283 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003284 return( mbedtls_to_psa_error( ret ) );
3285}
John Durkop6ba40d12020-11-10 08:50:04 -08003286#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3287 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003288
John Durkop6ba40d12020-11-10 08:50:04 -08003289#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3290 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003291/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3292 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3293 * (even though these functions don't modify it). */
3294static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3295 psa_algorithm_t alg,
3296 const uint8_t *hash,
3297 size_t hash_length,
3298 uint8_t *signature,
3299 size_t signature_size,
3300 size_t *signature_length )
3301{
Janos Follath24eed8d2019-11-22 13:21:35 +00003302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003303 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003304 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003305 mbedtls_mpi_init( &r );
3306 mbedtls_mpi_init( &s );
3307
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003308 if( signature_size < 2 * curve_bytes )
3309 {
3310 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3311 goto cleanup;
3312 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003313
John Durkop0ea39e02020-10-13 19:58:20 -07003314#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003315 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3316 {
3317 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3318 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3319 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003320 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3321 &ecp->d, hash,
3322 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003323 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003324 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003325 }
3326 else
John Durkop0ea39e02020-10-13 19:58:20 -07003327#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003328 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003329 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003330 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3331 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003332 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003333 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003334 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003335
3336 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3337 signature,
3338 curve_bytes ) );
3339 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3340 signature + curve_bytes,
3341 curve_bytes ) );
3342
3343cleanup:
3344 mbedtls_mpi_free( &r );
3345 mbedtls_mpi_free( &s );
3346 if( ret == 0 )
3347 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003348 return( mbedtls_to_psa_error( ret ) );
3349}
3350
3351static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3352 const uint8_t *hash,
3353 size_t hash_length,
3354 const uint8_t *signature,
3355 size_t signature_length )
3356{
Janos Follath24eed8d2019-11-22 13:21:35 +00003357 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003358 mbedtls_mpi r, s;
3359 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3360 mbedtls_mpi_init( &r );
3361 mbedtls_mpi_init( &s );
3362
3363 if( signature_length != 2 * curve_bytes )
3364 return( PSA_ERROR_INVALID_SIGNATURE );
3365
3366 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3367 signature,
3368 curve_bytes ) );
3369 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3370 signature + curve_bytes,
3371 curve_bytes ) );
3372
Steven Cooremanacda8342020-07-24 23:09:52 +02003373 /* Check whether the public part is loaded. If not, load it. */
3374 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3375 {
3376 MBEDTLS_MPI_CHK(
3377 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003378 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003379 }
3380
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003381 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3382 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003383
3384cleanup:
3385 mbedtls_mpi_free( &r );
3386 mbedtls_mpi_free( &s );
3387 return( mbedtls_to_psa_error( ret ) );
3388}
John Durkop6ba40d12020-11-10 08:50:04 -08003389#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3390 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003391
Ronald Croncf56a0a2020-08-04 09:51:30 +02003392psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003393 psa_algorithm_t alg,
3394 const uint8_t *hash,
3395 size_t hash_length,
3396 uint8_t *signature,
3397 size_t signature_size,
3398 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003399{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003401 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003402 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003403
3404 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003405 /* Immediately reject a zero-length signature buffer. This guarantees
3406 * that signature must be a valid pointer. (On the other hand, the hash
3407 * buffer can in principle be empty since it doesn't actually have
3408 * to be a hash.) */
3409 if( signature_size == 0 )
3410 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003411
Ronald Cron5c522922020-11-14 16:35:34 +01003412 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3413 PSA_KEY_USAGE_SIGN_HASH,
3414 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003415 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003416 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003417 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003418 {
3419 status = PSA_ERROR_INVALID_ARGUMENT;
3420 goto exit;
3421 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003422
Steven Cooremancd84cb42020-07-16 20:28:36 +02003423 /* Try any of the available accelerators first */
3424 status = psa_driver_wrapper_sign_hash( slot,
3425 alg,
3426 hash,
3427 hash_length,
3428 signature,
3429 signature_size,
3430 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003431 if( status != PSA_ERROR_NOT_SUPPORTED ||
3432 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003433 goto exit;
3434
Steven Cooreman7a250572020-07-17 16:43:05 +02003435 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003436#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3437 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003438 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003439 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003440 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003441
Ronald Cron90857082020-11-25 14:58:33 +01003442 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3443 slot->key.data,
3444 slot->key.bytes,
3445 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003446 if( status != PSA_SUCCESS )
3447 goto exit;
3448
Steven Cooremana2371e52020-07-28 14:30:39 +02003449 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003450 alg,
3451 hash, hash_length,
3452 signature, signature_size,
3453 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003454
Steven Cooremana2371e52020-07-28 14:30:39 +02003455 mbedtls_rsa_free( rsa );
3456 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003457 }
3458 else
John Durkop6ba40d12020-11-10 08:50:04 -08003459#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3460 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003461 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003462 {
John Durkop9814fa22020-11-04 12:28:15 -08003463#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3464 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003465 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003466#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003467 PSA_ALG_IS_ECDSA( alg )
3468#else
3469 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3470#endif
3471 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003472 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003473 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003474 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3475 slot->key.data,
3476 slot->key.bytes,
3477 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003478 if( status != PSA_SUCCESS )
3479 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003480 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003481 alg,
3482 hash, hash_length,
3483 signature, signature_size,
3484 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003485 mbedtls_ecp_keypair_free( ecp );
3486 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003487 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003488 else
John Durkop9814fa22020-11-04 12:28:15 -08003489#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3490 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003491 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003492 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003493 }
itayzafrir5c753392018-05-08 11:18:38 +03003494 }
3495 else
itayzafrir5c753392018-05-08 11:18:38 +03003496 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003497 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003498 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003499
3500exit:
3501 /* Fill the unused part of the output buffer (the whole buffer on error,
3502 * the trailing part on success) with something that isn't a valid mac
3503 * (barring an attack on the mac and deliberately-crafted input),
3504 * in case the caller doesn't check the return status properly. */
3505 if( status == PSA_SUCCESS )
3506 memset( signature + *signature_length, '!',
3507 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003508 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003509 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003510 /* If signature_size is 0 then we have nothing to do. We must not call
3511 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003512
Ronald Cron5c522922020-11-14 16:35:34 +01003513 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003514
Ronald Cron5c522922020-11-14 16:35:34 +01003515 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003516}
3517
Ronald Croncf56a0a2020-08-04 09:51:30 +02003518psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003519 psa_algorithm_t alg,
3520 const uint8_t *hash,
3521 size_t hash_length,
3522 const uint8_t *signature,
3523 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003524{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003525 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003526 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003527 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003528
Ronald Cron5c522922020-11-14 16:35:34 +01003529 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3530 PSA_KEY_USAGE_VERIFY_HASH,
3531 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003532 if( status != PSA_SUCCESS )
3533 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003534
Steven Cooreman55ae2172020-07-17 19:46:15 +02003535 /* Try any of the available accelerators first */
3536 status = psa_driver_wrapper_verify_hash( slot,
3537 alg,
3538 hash,
3539 hash_length,
3540 signature,
3541 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003542 if( status != PSA_ERROR_NOT_SUPPORTED ||
3543 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003544 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003545
John Durkop6ba40d12020-11-10 08:50:04 -08003546#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3547 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003548 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003549 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003550 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003551
Ronald Cron90857082020-11-25 14:58:33 +01003552 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3553 slot->key.data,
3554 slot->key.bytes,
3555 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003556 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003557 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003558
Steven Cooremana2371e52020-07-28 14:30:39 +02003559 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003560 alg,
3561 hash, hash_length,
3562 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003563 mbedtls_rsa_free( rsa );
3564 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003565 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003566 }
3567 else
John Durkop6ba40d12020-11-10 08:50:04 -08003568#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3569 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003570 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003571 {
John Durkop9814fa22020-11-04 12:28:15 -08003572#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3573 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003574 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003575 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003576 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003577 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3578 slot->key.data,
3579 slot->key.bytes,
3580 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003581 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003582 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003583 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003584 hash, hash_length,
3585 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003586 mbedtls_ecp_keypair_free( ecp );
3587 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003588 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003589 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003590 else
John Durkop9814fa22020-11-04 12:28:15 -08003591#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3592 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003593 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003594 status = PSA_ERROR_INVALID_ARGUMENT;
3595 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003596 }
itayzafrir5c753392018-05-08 11:18:38 +03003597 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003598 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003599 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003600 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003601 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003602
3603exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003604 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003605
Ronald Cron5c522922020-11-14 16:35:34 +01003606 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003607}
3608
John Durkop0e005192020-10-31 22:06:54 -07003609#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003610static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3611 mbedtls_rsa_context *rsa )
3612{
3613 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3614 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3615 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3616 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3617}
John Durkop0e005192020-10-31 22:06:54 -07003618#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003619
Ronald Croncf56a0a2020-08-04 09:51:30 +02003620psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003621 psa_algorithm_t alg,
3622 const uint8_t *input,
3623 size_t input_length,
3624 const uint8_t *salt,
3625 size_t salt_length,
3626 uint8_t *output,
3627 size_t output_size,
3628 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003629{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003631 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003632 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003633
Darryl Green5cc689a2018-07-24 15:34:10 +01003634 (void) input;
3635 (void) input_length;
3636 (void) salt;
3637 (void) output;
3638 (void) output_size;
3639
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003640 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003641
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003642 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3643 return( PSA_ERROR_INVALID_ARGUMENT );
3644
Ronald Cron5c522922020-11-14 16:35:34 +01003645 status = psa_get_and_lock_transparent_key_slot_with_policy(
3646 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003647 if( status != PSA_SUCCESS )
3648 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003649 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3650 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003651 {
3652 status = PSA_ERROR_INVALID_ARGUMENT;
3653 goto exit;
3654 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003655
John Durkop6ba40d12020-11-10 08:50:04 -08003656#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3657 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003658 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003659 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003660 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003661 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3662 slot->key.data,
3663 slot->key.bytes,
3664 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003665 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003666 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003667
3668 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003669 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003670 status = PSA_ERROR_BUFFER_TOO_SMALL;
3671 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003672 }
John Durkop0e005192020-10-31 22:06:54 -07003673#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003674 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003675 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003676 status = mbedtls_to_psa_error(
3677 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003678 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003679 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003680 MBEDTLS_RSA_PUBLIC,
3681 input_length,
3682 input,
3683 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003684 }
3685 else
John Durkop0e005192020-10-31 22:06:54 -07003686#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3687#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003688 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003689 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003690 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003691 status = mbedtls_to_psa_error(
3692 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003693 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003694 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003695 MBEDTLS_RSA_PUBLIC,
3696 salt, salt_length,
3697 input_length,
3698 input,
3699 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003700 }
3701 else
John Durkop0e005192020-10-31 22:06:54 -07003702#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003703 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003704 status = PSA_ERROR_INVALID_ARGUMENT;
3705 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003706 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003707rsa_exit:
3708 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003709 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003710
Steven Cooremana2371e52020-07-28 14:30:39 +02003711 mbedtls_rsa_free( rsa );
3712 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003713 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003714 else
John Durkop9814fa22020-11-04 12:28:15 -08003715#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003716 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003717 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003718 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003719 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003720
3721exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003722 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003723
Ronald Cron5c522922020-11-14 16:35:34 +01003724 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003725}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003726
Ronald Croncf56a0a2020-08-04 09:51:30 +02003727psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003728 psa_algorithm_t alg,
3729 const uint8_t *input,
3730 size_t input_length,
3731 const uint8_t *salt,
3732 size_t salt_length,
3733 uint8_t *output,
3734 size_t output_size,
3735 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003736{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003737 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003738 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003739 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003740
Darryl Green5cc689a2018-07-24 15:34:10 +01003741 (void) input;
3742 (void) input_length;
3743 (void) salt;
3744 (void) output;
3745 (void) output_size;
3746
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003747 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003748
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003749 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3750 return( PSA_ERROR_INVALID_ARGUMENT );
3751
Ronald Cron5c522922020-11-14 16:35:34 +01003752 status = psa_get_and_lock_transparent_key_slot_with_policy(
3753 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003754 if( status != PSA_SUCCESS )
3755 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003756 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003757 {
3758 status = PSA_ERROR_INVALID_ARGUMENT;
3759 goto exit;
3760 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003761
John Durkop6ba40d12020-11-10 08:50:04 -08003762#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3763 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003764 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003765 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003766 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003767 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3768 slot->key.data,
3769 slot->key.bytes,
3770 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003771 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003772 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003773
Steven Cooremana2371e52020-07-28 14:30:39 +02003774 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003775 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003776 status = PSA_ERROR_INVALID_ARGUMENT;
3777 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003778 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003779
John Durkop0e005192020-10-31 22:06:54 -07003780#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003781 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003782 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003783 status = mbedtls_to_psa_error(
3784 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003785 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003786 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003787 MBEDTLS_RSA_PRIVATE,
3788 output_length,
3789 input,
3790 output,
3791 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003792 }
3793 else
John Durkop0e005192020-10-31 22:06:54 -07003794#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3795#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003796 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003797 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003798 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003799 status = mbedtls_to_psa_error(
3800 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003801 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003802 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003803 MBEDTLS_RSA_PRIVATE,
3804 salt, salt_length,
3805 output_length,
3806 input,
3807 output,
3808 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003809 }
3810 else
John Durkop0e005192020-10-31 22:06:54 -07003811#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003812 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003813 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003814 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003815
Steven Cooreman4fed4552020-08-03 14:46:03 +02003816rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003817 mbedtls_rsa_free( rsa );
3818 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003819 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003820 else
John Durkop6ba40d12020-11-10 08:50:04 -08003821#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3822 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003823 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003824 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003825 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003826
3827exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003828 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003829
Ronald Cron5c522922020-11-14 16:35:34 +01003830 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003831}
Gilles Peskine20035e32018-02-03 22:44:14 +01003832
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003833
3834
mohammad1603503973b2018-03-12 15:59:30 +02003835/****************************************************************/
3836/* Symmetric cryptography */
3837/****************************************************************/
3838
Gilles Peskinee553c652018-06-04 16:22:46 +02003839static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003840 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003841 psa_algorithm_t alg,
3842 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003843{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003844 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003845 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003846 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003847 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003848 size_t key_bits;
3849 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003850 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3851 PSA_KEY_USAGE_ENCRYPT :
3852 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003853
Steven Cooremand3feccd2020-09-01 15:56:14 +02003854 /* A context must be freshly initialized before it can be set up. */
3855 if( operation->alg != 0 )
3856 return( PSA_ERROR_BAD_STATE );
3857
Steven Cooremana07b9972020-09-10 14:54:14 +02003858 /* The requested algorithm must be one that can be processed by cipher. */
3859 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003860 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003861
Steven Cooremanef8575e2020-09-11 11:44:50 +02003862 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003863 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003864 if( status != PSA_SUCCESS )
3865 goto exit;
3866
3867 /* Initialize the operation struct members, except for alg. The alg member
3868 * is used to indicate to psa_cipher_abort that there are resources to free,
3869 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003870 operation->key_set = 0;
3871 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003872 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003873 operation->iv_size = 0;
3874 operation->block_size = 0;
3875 if( alg == PSA_ALG_ECB_NO_PADDING )
3876 operation->iv_required = 0;
3877 else
3878 operation->iv_required = 1;
3879
Steven Cooremana07b9972020-09-10 14:54:14 +02003880 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003881 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003882 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003883 slot,
3884 alg );
3885 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003886 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003887 slot,
3888 alg );
3889
Steven Cooremanef8575e2020-09-11 11:44:50 +02003890 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003891 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003892 /* Once the driver context is initialised, it needs to be freed using
3893 * psa_cipher_abort. Indicate this through setting alg. */
3894 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003895 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003896
Steven Cooremand3feccd2020-09-01 15:56:14 +02003897 if( status != PSA_ERROR_NOT_SUPPORTED ||
3898 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3899 goto exit;
3900
Steven Cooremana07b9972020-09-10 14:54:14 +02003901 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003902 * available for the given algorithm & key. */
3903 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003904
Steven Cooremana07b9972020-09-10 14:54:14 +02003905 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003906 * psa_cipher_abort. Indicate there is something to be freed through setting
3907 * alg, and indicate the operation is being done using mbedtls crypto through
3908 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003909 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003910 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003911
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003912 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003913 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003914 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003915 {
3916 status = PSA_ERROR_NOT_SUPPORTED;
3917 goto exit;
3918 }
mohammad1603503973b2018-03-12 15:59:30 +02003919
mohammad1603503973b2018-03-12 15:59:30 +02003920 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003921 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003922 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003923
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003924#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003925 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003926 {
3927 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003928 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003929 memcpy( keys, slot->key.data, 16 );
3930 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003931 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3932 keys,
3933 192, cipher_operation );
3934 }
3935 else
3936#endif
3937 {
3938 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003939 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003940 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003941 }
Moran Peker41deec42018-04-04 15:43:05 +03003942 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003943 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003944
mohammad16038481e742018-03-18 13:57:31 +02003945#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003946 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003947 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003948 case PSA_ALG_CBC_NO_PADDING:
3949 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3950 MBEDTLS_PADDING_NONE );
3951 break;
3952 case PSA_ALG_CBC_PKCS7:
3953 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3954 MBEDTLS_PADDING_PKCS7 );
3955 break;
3956 default:
3957 /* The algorithm doesn't involve padding. */
3958 ret = 0;
3959 break;
3960 }
3961 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003962 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003963#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3964
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003965 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003966 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02003967 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
3968 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02003969 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003970 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003971 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003972#if defined(MBEDTLS_CHACHA20_C)
3973 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01003974 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02003975 operation->iv_size = 12;
3976#endif
mohammad1603503973b2018-03-12 15:59:30 +02003977
Steven Cooreman7df02922020-09-09 15:28:49 +02003978 status = PSA_SUCCESS;
3979
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003980exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003981 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003982 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02003983 if( status == PSA_SUCCESS )
3984 {
3985 /* Update operation flags for both driver and software implementations */
3986 operation->key_set = 1;
3987 }
3988 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003989 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003990
Ronald Cron5c522922020-11-14 16:35:34 +01003991 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003992
Ronald Cron5c522922020-11-14 16:35:34 +01003993 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003994}
3995
Gilles Peskinefe119512018-07-08 21:39:34 +02003996psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003997 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003998 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003999{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004000 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004001}
4002
Gilles Peskinefe119512018-07-08 21:39:34 +02004003psa_status_t psa_cipher_decrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004004 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02004005 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02004006{
Ronald Croncf56a0a2020-08-04 09:51:30 +02004007 return( psa_cipher_setup( operation, key, alg, MBEDTLS_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004008}
4009
Gilles Peskinefe119512018-07-08 21:39:34 +02004010psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004011 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004012 size_t iv_size,
4013 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004014{
itayzafrir534bd7c2018-08-02 13:56:32 +03004015 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004017 if( operation->iv_set || ! operation->iv_required )
4018 {
4019 return( PSA_ERROR_BAD_STATE );
4020 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004021
Steven Cooremanef8575e2020-09-11 11:44:50 +02004022 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004023 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004024 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004025 iv,
4026 iv_size,
4027 iv_length );
4028 goto exit;
4029 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004030
Moran Peker41deec42018-04-04 15:43:05 +03004031 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004032 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004033 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004034 goto exit;
4035 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004036 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004037 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004038 if( ret != 0 )
4039 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004040 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004041 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004042 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004043
mohammad16038481e742018-03-18 13:57:31 +02004044 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004045 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004046
Moran Peker395db872018-05-31 14:07:14 +03004047exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004048 if( status == PSA_SUCCESS )
4049 operation->iv_set = 1;
4050 else
Moran Peker395db872018-05-31 14:07:14 +03004051 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004052 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004053}
4054
Gilles Peskinefe119512018-07-08 21:39:34 +02004055psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004056 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004057 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004058{
itayzafrir534bd7c2018-08-02 13:56:32 +03004059 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004060 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004061 if( operation->iv_set || ! operation->iv_required )
4062 {
4063 return( PSA_ERROR_BAD_STATE );
4064 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004065
Steven Cooremanef8575e2020-09-11 11:44:50 +02004066 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004067 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004068 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004069 iv,
4070 iv_length );
4071 goto exit;
4072 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004073
Moran Pekera28258c2018-05-29 16:25:04 +03004074 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004075 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004076 status = PSA_ERROR_INVALID_ARGUMENT;
4077 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004078 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004079 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4080 status = mbedtls_to_psa_error( ret );
4081exit:
4082 if( status == PSA_SUCCESS )
4083 operation->iv_set = 1;
4084 else
mohammad1603503973b2018-03-12 15:59:30 +02004085 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004086 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004087}
4088
Steven Cooreman177deba2020-09-07 17:14:14 +02004089/* Process input for which the algorithm is set to ECB mode. This requires
4090 * manual processing, since the PSA API is defined as being able to process
4091 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4092 * underlying mbedtls_cipher_update only takes full blocks. */
4093static psa_status_t psa_cipher_update_ecb_internal(
4094 mbedtls_cipher_context_t *ctx,
4095 const uint8_t *input,
4096 size_t input_length,
4097 uint8_t *output,
4098 size_t output_size,
4099 size_t *output_length )
4100{
4101 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4102 size_t block_size = ctx->cipher_info->block_size;
4103 size_t internal_output_length = 0;
4104 *output_length = 0;
4105
4106 if( input_length == 0 )
4107 {
4108 status = PSA_SUCCESS;
4109 goto exit;
4110 }
4111
4112 if( ctx->unprocessed_len > 0 )
4113 {
4114 /* Fill up to block size, and run the block if there's a full one. */
4115 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4116
4117 if( input_length < bytes_to_copy )
4118 bytes_to_copy = input_length;
4119
4120 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4121 input, bytes_to_copy );
4122 input_length -= bytes_to_copy;
4123 input += bytes_to_copy;
4124 ctx->unprocessed_len += bytes_to_copy;
4125
4126 if( ctx->unprocessed_len == block_size )
4127 {
4128 status = mbedtls_to_psa_error(
4129 mbedtls_cipher_update( ctx,
4130 ctx->unprocessed_data,
4131 block_size,
4132 output, &internal_output_length ) );
4133
4134 if( status != PSA_SUCCESS )
4135 goto exit;
4136
4137 output += internal_output_length;
4138 output_size -= internal_output_length;
4139 *output_length += internal_output_length;
4140 ctx->unprocessed_len = 0;
4141 }
4142 }
4143
4144 while( input_length >= block_size )
4145 {
4146 /* Run all full blocks we have, one by one */
4147 status = mbedtls_to_psa_error(
4148 mbedtls_cipher_update( ctx, input,
4149 block_size,
4150 output, &internal_output_length ) );
4151
4152 if( status != PSA_SUCCESS )
4153 goto exit;
4154
4155 input_length -= block_size;
4156 input += block_size;
4157
4158 output += internal_output_length;
4159 output_size -= internal_output_length;
4160 *output_length += internal_output_length;
4161 }
4162
4163 if( input_length > 0 )
4164 {
4165 /* Save unprocessed bytes for later processing */
4166 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4167 input, input_length );
4168 ctx->unprocessed_len += input_length;
4169 }
4170
4171 status = PSA_SUCCESS;
4172
4173exit:
4174 return( status );
4175}
4176
Gilles Peskinee553c652018-06-04 16:22:46 +02004177psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4178 const uint8_t *input,
4179 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004180 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004181 size_t output_size,
4182 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004183{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004185 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004186 if( operation->alg == 0 )
4187 {
4188 return( PSA_ERROR_BAD_STATE );
4189 }
4190 if( operation->iv_required && ! operation->iv_set )
4191 {
4192 return( PSA_ERROR_BAD_STATE );
4193 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004194
Steven Cooremanef8575e2020-09-11 11:44:50 +02004195 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004196 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004197 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004198 input,
4199 input_length,
4200 output,
4201 output_size,
4202 output_length );
4203 goto exit;
4204 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004205
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004206 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004207 {
4208 /* Take the unprocessed partial block left over from previous
4209 * update calls, if any, plus the input to this call. Remove
4210 * the last partial block, if any. You get the data that will be
4211 * output in this call. */
4212 expected_output_size =
4213 ( operation->ctx.cipher.unprocessed_len + input_length )
4214 / operation->block_size * operation->block_size;
4215 }
4216 else
4217 {
4218 expected_output_size = input_length;
4219 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004220
Gilles Peskine89d789c2018-06-04 17:17:16 +02004221 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004222 {
4223 status = PSA_ERROR_BUFFER_TOO_SMALL;
4224 goto exit;
4225 }
mohammad160382759612018-03-12 18:16:40 +02004226
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004227 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4228 {
4229 /* mbedtls_cipher_update has an API inconsistency: it will only
4230 * process a single block at a time in ECB mode. Abstract away that
4231 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004232 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4233 input,
4234 input_length,
4235 output,
4236 output_size,
4237 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004238 }
4239 else
4240 {
4241 status = mbedtls_to_psa_error(
4242 mbedtls_cipher_update( &operation->ctx.cipher, input,
4243 input_length, output, output_length ) );
4244 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004245exit:
4246 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004247 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004248 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004249}
4250
Gilles Peskinee553c652018-06-04 16:22:46 +02004251psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4252 uint8_t *output,
4253 size_t output_size,
4254 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004255{
David Saadab4ecc272019-02-14 13:48:10 +02004256 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004257 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004258 if( operation->alg == 0 )
4259 {
4260 return( PSA_ERROR_BAD_STATE );
4261 }
4262 if( operation->iv_required && ! operation->iv_set )
4263 {
4264 return( PSA_ERROR_BAD_STATE );
4265 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004266
Steven Cooremanef8575e2020-09-11 11:44:50 +02004267 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004268 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004269 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004270 output,
4271 output_size,
4272 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004273 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004274 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004275
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004276 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004277 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004278 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004279 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004280 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004281 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004282 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004283 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004284 }
4285
Steven Cooremanef8575e2020-09-11 11:44:50 +02004286 status = mbedtls_to_psa_error(
4287 mbedtls_cipher_finish( &operation->ctx.cipher,
4288 temp_output_buffer,
4289 output_length ) );
4290 if( status != PSA_SUCCESS )
4291 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004292
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004293 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004294 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004295 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004296 memcpy( output, temp_output_buffer, *output_length );
4297 else
Janos Follath315b51c2018-07-09 16:04:51 +01004298 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004299
Steven Cooremanef8575e2020-09-11 11:44:50 +02004300exit:
4301 if( operation->mbedtls_in_use == 1 )
4302 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004303
Steven Cooremanef8575e2020-09-11 11:44:50 +02004304 if( status == PSA_SUCCESS )
4305 return( psa_cipher_abort( operation ) );
4306 else
4307 {
4308 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004309 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004310
Steven Cooremanef8575e2020-09-11 11:44:50 +02004311 return( status );
4312 }
mohammad1603503973b2018-03-12 15:59:30 +02004313}
4314
Gilles Peskinee553c652018-06-04 16:22:46 +02004315psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4316{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004317 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004318 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004319 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004320 * in use. It's ok to call abort on such an object, and there's
4321 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004322 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004323 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004324
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004325 /* Sanity check (shouldn't happen: operation->alg should
4326 * always have been initialized to a valid value). */
4327 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4328 return( PSA_ERROR_BAD_STATE );
4329
Steven Cooremanef8575e2020-09-11 11:44:50 +02004330 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004331 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004332 else
4333 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004334
Moran Peker41deec42018-04-04 15:43:05 +03004335 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004336 operation->key_set = 0;
4337 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004338 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004339 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004340 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004341 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004342
Moran Peker395db872018-05-31 14:07:14 +03004343 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004344}
4345
Gilles Peskinea0655c32018-04-30 17:06:50 +02004346
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004347
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004348
mohammad16035955c982018-04-26 00:53:03 +03004349/****************************************************************/
4350/* AEAD */
4351/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004352
Gilles Peskineedf9a652018-08-17 18:11:56 +02004353typedef struct
4354{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004355 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004356 const mbedtls_cipher_info_t *cipher_info;
4357 union
4358 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004359 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004360#if defined(MBEDTLS_CCM_C)
4361 mbedtls_ccm_context ccm;
4362#endif /* MBEDTLS_CCM_C */
4363#if defined(MBEDTLS_GCM_C)
4364 mbedtls_gcm_context gcm;
4365#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004366#if defined(MBEDTLS_CHACHAPOLY_C)
4367 mbedtls_chachapoly_context chachapoly;
4368#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004369 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004370 psa_algorithm_t core_alg;
4371 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004372 uint8_t tag_length;
4373} aead_operation_t;
4374
Ronald Cronf95a2b12020-10-22 15:24:49 +02004375#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4376
Gilles Peskine30a9e412019-01-14 18:36:12 +01004377static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004378{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004379 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004380 {
4381#if defined(MBEDTLS_CCM_C)
4382 case PSA_ALG_CCM:
4383 mbedtls_ccm_free( &operation->ctx.ccm );
4384 break;
4385#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004386#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004387 case PSA_ALG_GCM:
4388 mbedtls_gcm_free( &operation->ctx.gcm );
4389 break;
4390#endif /* MBEDTLS_GCM_C */
4391 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004392
Ronald Cron5c522922020-11-14 16:35:34 +01004393 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004394}
4395
4396static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004397 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004398 psa_key_usage_t usage,
4399 psa_algorithm_t alg )
4400{
4401 psa_status_t status;
4402 size_t key_bits;
4403 mbedtls_cipher_id_t cipher_id;
4404
Ronald Cron5c522922020-11-14 16:35:34 +01004405 status = psa_get_and_lock_transparent_key_slot_with_policy(
4406 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004407 if( status != PSA_SUCCESS )
4408 return( status );
4409
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004410 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004411
4412 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004413 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004414 &cipher_id );
4415 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004416 {
4417 status = PSA_ERROR_NOT_SUPPORTED;
4418 goto cleanup;
4419 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004420
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004421 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004422 {
4423#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004424 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4425 operation->core_alg = PSA_ALG_CCM;
4426 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004427 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4428 * The call to mbedtls_ccm_encrypt_and_tag or
4429 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004430 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004431 {
4432 status = PSA_ERROR_INVALID_ARGUMENT;
4433 goto cleanup;
4434 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004435 mbedtls_ccm_init( &operation->ctx.ccm );
4436 status = mbedtls_to_psa_error(
4437 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004438 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004439 (unsigned int) key_bits ) );
4440 if( status != 0 )
4441 goto cleanup;
4442 break;
4443#endif /* MBEDTLS_CCM_C */
4444
4445#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004446 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4447 operation->core_alg = PSA_ALG_GCM;
4448 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004449 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4450 * The call to mbedtls_gcm_crypt_and_tag or
4451 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004452 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004453 {
4454 status = PSA_ERROR_INVALID_ARGUMENT;
4455 goto cleanup;
4456 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004457 mbedtls_gcm_init( &operation->ctx.gcm );
4458 status = mbedtls_to_psa_error(
4459 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004460 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004461 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004462 if( status != 0 )
4463 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004464 break;
4465#endif /* MBEDTLS_GCM_C */
4466
Gilles Peskine26869f22019-05-06 15:25:00 +02004467#if defined(MBEDTLS_CHACHAPOLY_C)
4468 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4469 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4470 operation->full_tag_length = 16;
4471 /* We only support the default tag length. */
4472 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004473 {
4474 status = PSA_ERROR_NOT_SUPPORTED;
4475 goto cleanup;
4476 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004477 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4478 status = mbedtls_to_psa_error(
4479 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004480 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004481 if( status != 0 )
4482 goto cleanup;
4483 break;
4484#endif /* MBEDTLS_CHACHAPOLY_C */
4485
Gilles Peskineedf9a652018-08-17 18:11:56 +02004486 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004487 status = PSA_ERROR_NOT_SUPPORTED;
4488 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004489 }
4490
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004491 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4492 {
4493 status = PSA_ERROR_INVALID_ARGUMENT;
4494 goto cleanup;
4495 }
4496 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004497
Gilles Peskineedf9a652018-08-17 18:11:56 +02004498 return( PSA_SUCCESS );
4499
4500cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004501 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004502 return( status );
4503}
4504
Ronald Croncf56a0a2020-08-04 09:51:30 +02004505psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004506 psa_algorithm_t alg,
4507 const uint8_t *nonce,
4508 size_t nonce_length,
4509 const uint8_t *additional_data,
4510 size_t additional_data_length,
4511 const uint8_t *plaintext,
4512 size_t plaintext_length,
4513 uint8_t *ciphertext,
4514 size_t ciphertext_size,
4515 size_t *ciphertext_length )
4516{
mohammad16035955c982018-04-26 00:53:03 +03004517 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004518 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004519 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004520
mohammad1603f08a5502018-06-03 15:05:47 +03004521 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004522
Ronald Croncf56a0a2020-08-04 09:51:30 +02004523 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004524 if( status != PSA_SUCCESS )
4525 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004526
Gilles Peskineedf9a652018-08-17 18:11:56 +02004527 /* For all currently supported modes, the tag is at the end of the
4528 * ciphertext. */
4529 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4530 {
4531 status = PSA_ERROR_BUFFER_TOO_SMALL;
4532 goto exit;
4533 }
4534 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004535
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004536#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004537 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004538 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004539 status = mbedtls_to_psa_error(
4540 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4541 MBEDTLS_GCM_ENCRYPT,
4542 plaintext_length,
4543 nonce, nonce_length,
4544 additional_data, additional_data_length,
4545 plaintext, ciphertext,
4546 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004547 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004548 else
4549#endif /* MBEDTLS_GCM_C */
4550#if defined(MBEDTLS_CCM_C)
4551 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004552 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004553 status = mbedtls_to_psa_error(
4554 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4555 plaintext_length,
4556 nonce, nonce_length,
4557 additional_data,
4558 additional_data_length,
4559 plaintext, ciphertext,
4560 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004561 }
mohammad16035c8845f2018-05-09 05:40:09 -07004562 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004563#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004564#if defined(MBEDTLS_CHACHAPOLY_C)
4565 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4566 {
4567 if( nonce_length != 12 || operation.tag_length != 16 )
4568 {
4569 status = PSA_ERROR_NOT_SUPPORTED;
4570 goto exit;
4571 }
4572 status = mbedtls_to_psa_error(
4573 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4574 plaintext_length,
4575 nonce,
4576 additional_data,
4577 additional_data_length,
4578 plaintext,
4579 ciphertext,
4580 tag ) );
4581 }
4582 else
4583#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004584 {
mohammad1603554faad2018-06-03 15:07:38 +03004585 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004586 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004587
Gilles Peskineedf9a652018-08-17 18:11:56 +02004588 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4589 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004590
Gilles Peskineedf9a652018-08-17 18:11:56 +02004591exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004592 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004593 if( status == PSA_SUCCESS )
4594 *ciphertext_length = plaintext_length + operation.tag_length;
4595 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004596}
4597
Gilles Peskineee652a32018-06-01 19:23:52 +02004598/* Locate the tag in a ciphertext buffer containing the encrypted data
4599 * followed by the tag. Return the length of the part preceding the tag in
4600 * *plaintext_length. This is the size of the plaintext in modes where
4601 * the encrypted data has the same size as the plaintext, such as
4602 * CCM and GCM. */
4603static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4604 const uint8_t *ciphertext,
4605 size_t ciphertext_length,
4606 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004607 const uint8_t **p_tag )
4608{
4609 size_t payload_length;
4610 if( tag_length > ciphertext_length )
4611 return( PSA_ERROR_INVALID_ARGUMENT );
4612 payload_length = ciphertext_length - tag_length;
4613 if( payload_length > plaintext_size )
4614 return( PSA_ERROR_BUFFER_TOO_SMALL );
4615 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004616 return( PSA_SUCCESS );
4617}
4618
Ronald Croncf56a0a2020-08-04 09:51:30 +02004619psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004620 psa_algorithm_t alg,
4621 const uint8_t *nonce,
4622 size_t nonce_length,
4623 const uint8_t *additional_data,
4624 size_t additional_data_length,
4625 const uint8_t *ciphertext,
4626 size_t ciphertext_length,
4627 uint8_t *plaintext,
4628 size_t plaintext_size,
4629 size_t *plaintext_length )
4630{
mohammad16035955c982018-04-26 00:53:03 +03004631 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004632 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004633 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004634
Gilles Peskineee652a32018-06-01 19:23:52 +02004635 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004636
Ronald Croncf56a0a2020-08-04 09:51:30 +02004637 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004638 if( status != PSA_SUCCESS )
4639 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004640
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004641 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4642 ciphertext, ciphertext_length,
4643 plaintext_size, &tag );
4644 if( status != PSA_SUCCESS )
4645 goto exit;
4646
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004647#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004648 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004649 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004650 status = mbedtls_to_psa_error(
4651 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4652 ciphertext_length - operation.tag_length,
4653 nonce, nonce_length,
4654 additional_data,
4655 additional_data_length,
4656 tag, operation.tag_length,
4657 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004658 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004659 else
4660#endif /* MBEDTLS_GCM_C */
4661#if defined(MBEDTLS_CCM_C)
4662 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004663 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004664 status = mbedtls_to_psa_error(
4665 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4666 ciphertext_length - operation.tag_length,
4667 nonce, nonce_length,
4668 additional_data,
4669 additional_data_length,
4670 ciphertext, plaintext,
4671 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004672 }
mohammad160339574652018-06-01 04:39:53 -07004673 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004674#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004675#if defined(MBEDTLS_CHACHAPOLY_C)
4676 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4677 {
4678 if( nonce_length != 12 || operation.tag_length != 16 )
4679 {
4680 status = PSA_ERROR_NOT_SUPPORTED;
4681 goto exit;
4682 }
4683 status = mbedtls_to_psa_error(
4684 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4685 ciphertext_length - operation.tag_length,
4686 nonce,
4687 additional_data,
4688 additional_data_length,
4689 tag,
4690 ciphertext,
4691 plaintext ) );
4692 }
4693 else
4694#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004695 {
mohammad1603554faad2018-06-03 15:07:38 +03004696 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004697 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004698
Gilles Peskineedf9a652018-08-17 18:11:56 +02004699 if( status != PSA_SUCCESS && plaintext_size != 0 )
4700 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004701
Gilles Peskineedf9a652018-08-17 18:11:56 +02004702exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004703 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004704 if( status == PSA_SUCCESS )
4705 *plaintext_length = ciphertext_length - operation.tag_length;
4706 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004707}
4708
Gilles Peskinea0655c32018-04-30 17:06:50 +02004709
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004710
Gilles Peskine20035e32018-02-03 22:44:14 +01004711/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004712/* Generators */
4713/****************************************************************/
4714
John Durkop07cc04a2020-11-16 22:08:34 -08004715#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4716 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4717 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4718#define AT_LEAST_ONE_BUILTIN_KDF
4719#endif
4720
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004721#define HKDF_STATE_INIT 0 /* no input yet */
4722#define HKDF_STATE_STARTED 1 /* got salt */
4723#define HKDF_STATE_KEYED 2 /* got key */
4724#define HKDF_STATE_OUTPUT 3 /* output started */
4725
Gilles Peskinecbe66502019-05-16 16:59:18 +02004726static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004727 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004728{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004729 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4730 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004731 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004732 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004733}
4734
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004735psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004736{
4737 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004738 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004739 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004740 {
4741 /* The object has (apparently) been initialized but it is not
4742 * in use. It's ok to call abort on such an object, and there's
4743 * nothing to do. */
4744 }
4745 else
John Durkopd0321952020-10-29 21:37:36 -07004746#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004747 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004748 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004749 mbedtls_free( operation->ctx.hkdf.info );
4750 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004751 }
John Durkop07cc04a2020-11-16 22:08:34 -08004752 else
4753#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4754#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4755 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4756 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004757 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004758 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004759 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004760 if( operation->ctx.tls12_prf.seed != NULL )
4761 {
4762 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4763 operation->ctx.tls12_prf.seed_length );
4764 mbedtls_free( operation->ctx.tls12_prf.seed );
4765 }
4766
4767 if( operation->ctx.tls12_prf.label != NULL )
4768 {
4769 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4770 operation->ctx.tls12_prf.label_length );
4771 mbedtls_free( operation->ctx.tls12_prf.label );
4772 }
4773
4774 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4775
4776 /* We leave the fields Ai and output_block to be erased safely by the
4777 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004778 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004779 else
John Durkop07cc04a2020-11-16 22:08:34 -08004780#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4781 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004782 {
4783 status = PSA_ERROR_BAD_STATE;
4784 }
Janos Follath083036a2019-06-11 10:22:26 +01004785 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004786 return( status );
4787}
4788
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004789psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004790 size_t *capacity)
4791{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004792 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004793 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004794 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004795 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004796 }
4797
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004798 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004799 return( PSA_SUCCESS );
4800}
4801
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004802psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004803 size_t capacity )
4804{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004805 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004806 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004807 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004808 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004809 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004810 return( PSA_SUCCESS );
4811}
4812
John Durkopd0321952020-10-29 21:37:36 -07004813#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004814/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004815 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004816static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004817 psa_algorithm_t hash_alg,
4818 uint8_t *output,
4819 size_t output_length )
4820{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004821 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004822 psa_status_t status;
4823
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004824 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4825 return( PSA_ERROR_BAD_STATE );
4826 hkdf->state = HKDF_STATE_OUTPUT;
4827
Gilles Peskinebef7f142018-07-12 17:22:21 +02004828 while( output_length != 0 )
4829 {
4830 /* Copy what remains of the current block */
4831 uint8_t n = hash_length - hkdf->offset_in_block;
4832 if( n > output_length )
4833 n = (uint8_t) output_length;
4834 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4835 output += n;
4836 output_length -= n;
4837 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004838 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004839 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004840 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004841 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004842 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004843 * object was corrupted or if this function is called directly
4844 * inside the library. */
4845 if( hkdf->block_number == 0xff )
4846 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004847
4848 /* We need a new block */
4849 ++hkdf->block_number;
4850 hkdf->offset_in_block = 0;
4851 status = psa_hmac_setup_internal( &hkdf->hmac,
4852 hkdf->prk, hash_length,
4853 hash_alg );
4854 if( status != PSA_SUCCESS )
4855 return( status );
4856 if( hkdf->block_number != 1 )
4857 {
4858 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4859 hkdf->output_block,
4860 hash_length );
4861 if( status != PSA_SUCCESS )
4862 return( status );
4863 }
4864 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4865 hkdf->info,
4866 hkdf->info_length );
4867 if( status != PSA_SUCCESS )
4868 return( status );
4869 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4870 &hkdf->block_number, 1 );
4871 if( status != PSA_SUCCESS )
4872 return( status );
4873 status = psa_hmac_finish_internal( &hkdf->hmac,
4874 hkdf->output_block,
4875 sizeof( hkdf->output_block ) );
4876 if( status != PSA_SUCCESS )
4877 return( status );
4878 }
4879
4880 return( PSA_SUCCESS );
4881}
John Durkop07cc04a2020-11-16 22:08:34 -08004882#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004883
John Durkop07cc04a2020-11-16 22:08:34 -08004884#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4885 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004886static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4887 psa_tls12_prf_key_derivation_t *tls12_prf,
4888 psa_algorithm_t alg )
4889{
4890 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004891 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004892 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4893 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004894
Janos Follath7742fee2019-06-17 12:58:10 +01004895 /* We can't be wanting more output after block 0xff, otherwise
4896 * the capacity check in psa_key_derivation_output_bytes() would have
4897 * prevented this call. It could happen only if the operation
4898 * object was corrupted or if this function is called directly
4899 * inside the library. */
4900 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004901 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004902
4903 /* We need a new block */
4904 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004905 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004906
4907 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4908 *
4909 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4910 *
4911 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4912 * HMAC_hash(secret, A(2) + seed) +
4913 * HMAC_hash(secret, A(3) + seed) + ...
4914 *
4915 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004916 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004917 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004918 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004919 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004920 * is currently extracted as `output_block` and where i is
4921 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004922 */
4923
Janos Follathea29bfb2019-06-19 12:21:20 +01004924 /* Save the hash context before using it, to preserve the hash state with
4925 * only the inner padding in it. We need this, because inner padding depends
4926 * on the key (secret in the RFC's terminology). */
4927 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4928 if( status != PSA_SUCCESS )
4929 goto cleanup;
4930
4931 /* Calculate A(i) where i = tls12_prf->block_number. */
4932 if( tls12_prf->block_number == 1 )
4933 {
4934 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4935 * the variable seed and in this instance means it in the context of the
4936 * P_hash function, where seed = label + seed.) */
4937 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4938 tls12_prf->label, tls12_prf->label_length );
4939 if( status != PSA_SUCCESS )
4940 goto cleanup;
4941 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4942 tls12_prf->seed, tls12_prf->seed_length );
4943 if( status != PSA_SUCCESS )
4944 goto cleanup;
4945 }
4946 else
4947 {
4948 /* A(i) = HMAC_hash(secret, A(i-1)) */
4949 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4950 tls12_prf->Ai, hash_length );
4951 if( status != PSA_SUCCESS )
4952 goto cleanup;
4953 }
4954
4955 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4956 tls12_prf->Ai, hash_length );
4957 if( status != PSA_SUCCESS )
4958 goto cleanup;
4959 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4960 if( status != PSA_SUCCESS )
4961 goto cleanup;
4962
4963 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4964 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4965 tls12_prf->Ai, hash_length );
4966 if( status != PSA_SUCCESS )
4967 goto cleanup;
4968 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4969 tls12_prf->label, tls12_prf->label_length );
4970 if( status != PSA_SUCCESS )
4971 goto cleanup;
4972 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4973 tls12_prf->seed, tls12_prf->seed_length );
4974 if( status != PSA_SUCCESS )
4975 goto cleanup;
4976 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4977 tls12_prf->output_block, hash_length );
4978 if( status != PSA_SUCCESS )
4979 goto cleanup;
4980 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4981 if( status != PSA_SUCCESS )
4982 goto cleanup;
4983
Janos Follath7742fee2019-06-17 12:58:10 +01004984
4985cleanup:
4986
Janos Follathea29bfb2019-06-19 12:21:20 +01004987 cleanup_status = psa_hash_abort( &backup );
4988 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4989 status = cleanup_status;
4990
4991 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004992}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004993
Janos Follath844eb0e2019-06-19 12:10:49 +01004994static psa_status_t psa_key_derivation_tls12_prf_read(
4995 psa_tls12_prf_key_derivation_t *tls12_prf,
4996 psa_algorithm_t alg,
4997 uint8_t *output,
4998 size_t output_length )
4999{
5000 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005001 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01005002 psa_status_t status;
5003 uint8_t offset, length;
5004
5005 while( output_length != 0 )
5006 {
5007 /* Check if we have fully processed the current block. */
5008 if( tls12_prf->left_in_block == 0 )
5009 {
5010 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5011 alg );
5012 if( status != PSA_SUCCESS )
5013 return( status );
5014
5015 continue;
5016 }
5017
5018 if( tls12_prf->left_in_block > output_length )
5019 length = (uint8_t) output_length;
5020 else
5021 length = tls12_prf->left_in_block;
5022
5023 offset = hash_length - tls12_prf->left_in_block;
5024 memcpy( output, tls12_prf->output_block + offset, length );
5025 output += length;
5026 output_length -= length;
5027 tls12_prf->left_in_block -= length;
5028 }
5029
5030 return( PSA_SUCCESS );
5031}
John Durkop07cc04a2020-11-16 22:08:34 -08005032#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5033 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005034
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005035psa_status_t psa_key_derivation_output_bytes(
5036 psa_key_derivation_operation_t *operation,
5037 uint8_t *output,
5038 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005039{
5040 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005041 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005042
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005043 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005044 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005045 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005046 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005047 }
5048
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005049 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005050 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005051 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005052 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005053 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005054 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005055 goto exit;
5056 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005057 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005058 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005059 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005060 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005061 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5062 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005063 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005064 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005065 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005066 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005067 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005068
John Durkopd0321952020-10-29 21:37:36 -07005069#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005070 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005071 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005072 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005073 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005074 output, output_length );
5075 }
Janos Follathadbec812019-06-14 11:05:39 +01005076 else
John Durkop07cc04a2020-11-16 22:08:34 -08005077#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5078#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5079 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005080 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005081 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005082 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005083 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005084 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005085 output_length );
5086 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005087 else
John Durkop07cc04a2020-11-16 22:08:34 -08005088#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5089 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005090 {
5091 return( PSA_ERROR_BAD_STATE );
5092 }
5093
5094exit:
5095 if( status != PSA_SUCCESS )
5096 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005097 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005098 * This allows us to differentiate between exhausted operations and
5099 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5100 * operations. */
5101 psa_algorithm_t alg = operation->alg;
5102 psa_key_derivation_abort( operation );
5103 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005104 memset( output, '!', output_length );
5105 }
5106 return( status );
5107}
5108
Gilles Peskine08542d82018-07-19 17:05:42 +02005109#if defined(MBEDTLS_DES_C)
5110static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5111{
5112 if( data_size >= 8 )
5113 mbedtls_des_key_set_parity( data );
5114 if( data_size >= 16 )
5115 mbedtls_des_key_set_parity( data + 8 );
5116 if( data_size >= 24 )
5117 mbedtls_des_key_set_parity( data + 16 );
5118}
5119#endif /* MBEDTLS_DES_C */
5120
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005121static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005122 psa_key_slot_t *slot,
5123 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005124 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005125{
5126 uint8_t *data = NULL;
5127 size_t bytes = PSA_BITS_TO_BYTES( bits );
5128 psa_status_t status;
5129
Gilles Peskine8e338702019-07-30 20:06:31 +02005130 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005131 return( PSA_ERROR_INVALID_ARGUMENT );
5132 if( bits % 8 != 0 )
5133 return( PSA_ERROR_INVALID_ARGUMENT );
5134 data = mbedtls_calloc( 1, bytes );
5135 if( data == NULL )
5136 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5137
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005138 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005139 if( status != PSA_SUCCESS )
5140 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005141#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005142 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005143 psa_des_set_key_parity( data, bytes );
5144#endif /* MBEDTLS_DES_C */
Ronald Crondd04d422020-11-28 15:14:42 +01005145
5146 status = psa_allocate_buffer_to_slot( slot, bytes );
5147 if( status != PSA_SUCCESS )
5148 return( status );
5149
Ronald Cronbf33c932020-11-28 18:06:53 +01005150 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005151 psa_key_attributes_t attributes = {
5152 .core = slot->attr
5153 };
5154
Ronald Cronbf33c932020-11-28 18:06:53 +01005155 status = psa_driver_wrapper_import_key( &attributes,
5156 data, bytes,
5157 slot->key.data,
5158 slot->key.bytes,
5159 &slot->key.bytes, &bits );
5160 if( bits != slot->attr.bits )
5161 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005162
5163exit:
5164 mbedtls_free( data );
5165 return( status );
5166}
5167
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005168psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005169 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005170 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005171{
5172 psa_status_t status;
5173 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005174 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005175
Ronald Cron81709fc2020-11-14 12:10:32 +01005176 *key = MBEDTLS_SVC_KEY_ID_INIT;
5177
Gilles Peskine0f84d622019-09-12 19:03:13 +02005178 /* Reject any attempt to create a zero-length key so that we don't
5179 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5180 if( psa_get_key_bits( attributes ) == 0 )
5181 return( PSA_ERROR_INVALID_ARGUMENT );
5182
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005183 if( ! operation->can_output_key )
5184 return( PSA_ERROR_NOT_PERMITTED );
5185
Ronald Cron81709fc2020-11-14 12:10:32 +01005186 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5187 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005188#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5189 if( driver != NULL )
5190 {
5191 /* Deriving a key in a secure element is not implemented yet. */
5192 status = PSA_ERROR_NOT_SUPPORTED;
5193 }
5194#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005195 if( status == PSA_SUCCESS )
5196 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005197 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005198 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005199 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005200 }
5201 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005202 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005203 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005204 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005205
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005206 return( status );
5207}
5208
Gilles Peskineeab56e42018-07-12 17:12:33 +02005209
5210
5211/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005212/* Key derivation */
5213/****************************************************************/
5214
John Durkop07cc04a2020-11-16 22:08:34 -08005215#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005216static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005217 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005218 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005219{
John Durkop07cc04a2020-11-16 22:08:34 -08005220 int is_kdf_alg_supported;
5221
Janos Follath5fe19732019-06-20 15:09:30 +01005222 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5223 * initialisers for this union leave some bytes unspecified.) */
5224 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5225
Gilles Peskine969c5d62019-01-16 15:53:06 +01005226 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005227#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005228 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5229 is_kdf_alg_supported = 1;
5230 else
5231#endif
5232#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5233 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5234 is_kdf_alg_supported = 1;
5235 else
5236#endif
5237#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5238 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5239 is_kdf_alg_supported = 1;
5240 else
5241#endif
5242 is_kdf_alg_supported = 0;
5243
5244 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005245 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005246 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005247 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005248 if( hash_size == 0 )
5249 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005250 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5251 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005252 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005253 {
5254 return( PSA_ERROR_NOT_SUPPORTED );
5255 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005256 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005257 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005258 }
John Durkop07cc04a2020-11-16 22:08:34 -08005259
5260 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005261}
John Durkop07cc04a2020-11-16 22:08:34 -08005262#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005263
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005264psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005265 psa_algorithm_t alg )
5266{
5267 psa_status_t status;
5268
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005269 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005270 return( PSA_ERROR_BAD_STATE );
5271
Gilles Peskine6843c292019-01-18 16:44:49 +01005272 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5273 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005274#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005275 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005276 {
5277 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005278 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005279 }
5280 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5281 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005283 }
John Durkop07cc04a2020-11-16 22:08:34 -08005284#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005285 else
5286 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005287
5288 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005289 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005290 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005291}
5292
John Durkopd0321952020-10-29 21:37:36 -07005293#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005294static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005295 psa_algorithm_t hash_alg,
5296 psa_key_derivation_step_t step,
5297 const uint8_t *data,
5298 size_t data_length )
5299{
5300 psa_status_t status;
5301 switch( step )
5302 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005303 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005304 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005305 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005306 status = psa_hmac_setup_internal( &hkdf->hmac,
5307 data, data_length,
5308 hash_alg );
5309 if( status != PSA_SUCCESS )
5310 return( status );
5311 hkdf->state = HKDF_STATE_STARTED;
5312 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005313 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005314 /* If no salt was provided, use an empty salt. */
5315 if( hkdf->state == HKDF_STATE_INIT )
5316 {
5317 status = psa_hmac_setup_internal( &hkdf->hmac,
5318 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005319 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005320 if( status != PSA_SUCCESS )
5321 return( status );
5322 hkdf->state = HKDF_STATE_STARTED;
5323 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005324 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005325 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005326 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5327 data, data_length );
5328 if( status != PSA_SUCCESS )
5329 return( status );
5330 status = psa_hmac_finish_internal( &hkdf->hmac,
5331 hkdf->prk,
5332 sizeof( hkdf->prk ) );
5333 if( status != PSA_SUCCESS )
5334 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005335 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005336 hkdf->block_number = 0;
5337 hkdf->state = HKDF_STATE_KEYED;
5338 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005339 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005340 if( hkdf->state == HKDF_STATE_OUTPUT )
5341 return( PSA_ERROR_BAD_STATE );
5342 if( hkdf->info_set )
5343 return( PSA_ERROR_BAD_STATE );
5344 hkdf->info_length = data_length;
5345 if( data_length != 0 )
5346 {
5347 hkdf->info = mbedtls_calloc( 1, data_length );
5348 if( hkdf->info == NULL )
5349 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5350 memcpy( hkdf->info, data, data_length );
5351 }
5352 hkdf->info_set = 1;
5353 return( PSA_SUCCESS );
5354 default:
5355 return( PSA_ERROR_INVALID_ARGUMENT );
5356 }
5357}
John Durkop07cc04a2020-11-16 22:08:34 -08005358#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005359
John Durkop07cc04a2020-11-16 22:08:34 -08005360#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5361 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005362static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5363 const uint8_t *data,
5364 size_t data_length )
5365{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005366 if( prf->state != PSA_TLS12_PRF_STATE_INIT )
Janos Follathf08e2652019-06-13 09:05:41 +01005367 return( PSA_ERROR_BAD_STATE );
5368
Janos Follathd6dce9f2019-07-04 09:11:38 +01005369 if( data_length != 0 )
5370 {
5371 prf->seed = mbedtls_calloc( 1, data_length );
5372 if( prf->seed == NULL )
5373 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005374
Janos Follathd6dce9f2019-07-04 09:11:38 +01005375 memcpy( prf->seed, data, data_length );
5376 prf->seed_length = data_length;
5377 }
Janos Follathf08e2652019-06-13 09:05:41 +01005378
Gilles Peskine43f958b2020-12-13 14:55:14 +01005379 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01005380
5381 return( PSA_SUCCESS );
5382}
5383
Janos Follath81550542019-06-13 14:26:34 +01005384static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5385 psa_algorithm_t hash_alg,
5386 const uint8_t *data,
5387 size_t data_length )
5388{
5389 psa_status_t status;
Gilles Peskine43f958b2020-12-13 14:55:14 +01005390 if( prf->state != PSA_TLS12_PRF_STATE_SEED_SET )
Janos Follath81550542019-06-13 14:26:34 +01005391 return( PSA_ERROR_BAD_STATE );
5392
5393 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5394 if( status != PSA_SUCCESS )
5395 return( status );
5396
Gilles Peskine43f958b2020-12-13 14:55:14 +01005397 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01005398
5399 return( PSA_SUCCESS );
5400}
5401
Janos Follath63028dd2019-06-13 09:15:47 +01005402static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5403 const uint8_t *data,
5404 size_t data_length )
5405{
Gilles Peskine43f958b2020-12-13 14:55:14 +01005406 if( prf->state != PSA_TLS12_PRF_STATE_KEY_SET )
Janos Follath63028dd2019-06-13 09:15:47 +01005407 return( PSA_ERROR_BAD_STATE );
5408
Janos Follathd6dce9f2019-07-04 09:11:38 +01005409 if( data_length != 0 )
5410 {
5411 prf->label = mbedtls_calloc( 1, data_length );
5412 if( prf->label == NULL )
5413 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005414
Janos Follathd6dce9f2019-07-04 09:11:38 +01005415 memcpy( prf->label, data, data_length );
5416 prf->label_length = data_length;
5417 }
Janos Follath63028dd2019-06-13 09:15:47 +01005418
Gilles Peskine43f958b2020-12-13 14:55:14 +01005419 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01005420
5421 return( PSA_SUCCESS );
5422}
5423
Janos Follathb03233e2019-06-11 15:30:30 +01005424static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5425 psa_algorithm_t hash_alg,
5426 psa_key_derivation_step_t step,
5427 const uint8_t *data,
5428 size_t data_length )
5429{
Janos Follathb03233e2019-06-11 15:30:30 +01005430 switch( step )
5431 {
Janos Follathf08e2652019-06-13 09:05:41 +01005432 case PSA_KEY_DERIVATION_INPUT_SEED:
5433 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005434 case PSA_KEY_DERIVATION_INPUT_SECRET:
5435 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005436 case PSA_KEY_DERIVATION_INPUT_LABEL:
5437 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005438 default:
5439 return( PSA_ERROR_INVALID_ARGUMENT );
5440 }
5441}
John Durkop07cc04a2020-11-16 22:08:34 -08005442#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5443 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5444
5445#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5446static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5447 psa_tls12_prf_key_derivation_t *prf,
5448 psa_algorithm_t hash_alg,
5449 const uint8_t *data,
5450 size_t data_length )
5451{
5452 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005453 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005454 uint8_t *cur = pms;
5455
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005456 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005457 return( PSA_ERROR_INVALID_ARGUMENT );
5458
5459 /* Quoting RFC 4279, Section 2:
5460 *
5461 * The premaster secret is formed as follows: if the PSK is N octets
5462 * long, concatenate a uint16 with the value N, N zero octets, a second
5463 * uint16 with the value N, and the PSK itself.
5464 */
5465
5466 *cur++ = ( data_length >> 8 ) & 0xff;
5467 *cur++ = ( data_length >> 0 ) & 0xff;
5468 memset( cur, 0, data_length );
5469 cur += data_length;
5470 *cur++ = pms[0];
5471 *cur++ = pms[1];
5472 memcpy( cur, data, data_length );
5473 cur += data_length;
5474
5475 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5476
5477 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5478 return( status );
5479}
Janos Follath6660f0e2019-06-17 08:44:03 +01005480
5481static psa_status_t psa_tls12_prf_psk_to_ms_input(
5482 psa_tls12_prf_key_derivation_t *prf,
5483 psa_algorithm_t hash_alg,
5484 psa_key_derivation_step_t step,
5485 const uint8_t *data,
5486 size_t data_length )
5487{
5488 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005489 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005490 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5491 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005492 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005493
5494 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5495}
John Durkop07cc04a2020-11-16 22:08:34 -08005496#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005497
Gilles Peskineb8965192019-09-24 16:21:10 +02005498/** Check whether the given key type is acceptable for the given
5499 * input step of a key derivation.
5500 *
5501 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5502 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5503 * Both secret and non-secret inputs can alternatively have the type
5504 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5505 * that the input was passed as a buffer rather than via a key object.
5506 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005507static int psa_key_derivation_check_input_type(
5508 psa_key_derivation_step_t step,
5509 psa_key_type_t key_type )
5510{
5511 switch( step )
5512 {
5513 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005514 if( key_type == PSA_KEY_TYPE_DERIVE )
5515 return( PSA_SUCCESS );
5516 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005517 return( PSA_SUCCESS );
5518 break;
5519 case PSA_KEY_DERIVATION_INPUT_LABEL:
5520 case PSA_KEY_DERIVATION_INPUT_SALT:
5521 case PSA_KEY_DERIVATION_INPUT_INFO:
5522 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005523 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5524 return( PSA_SUCCESS );
5525 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005526 return( PSA_SUCCESS );
5527 break;
5528 }
5529 return( PSA_ERROR_INVALID_ARGUMENT );
5530}
5531
Janos Follathb80a94e2019-06-12 15:54:46 +01005532static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005533 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005534 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005535 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005536 const uint8_t *data,
5537 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005538{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005539 psa_status_t status;
5540 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5541
5542 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005543 if( status != PSA_SUCCESS )
5544 goto exit;
5545
John Durkopd0321952020-10-29 21:37:36 -07005546#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005547 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005548 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005549 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005550 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005551 step, data, data_length );
5552 }
John Durkop07cc04a2020-11-16 22:08:34 -08005553 else
5554#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5555#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5556 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005557 {
Janos Follathb03233e2019-06-11 15:30:30 +01005558 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5559 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5560 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005561 }
John Durkop07cc04a2020-11-16 22:08:34 -08005562 else
5563#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5564#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5565 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005566 {
5567 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5568 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5569 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570 }
5571 else
John Durkop07cc04a2020-11-16 22:08:34 -08005572#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005573 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005574 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005575 return( PSA_ERROR_BAD_STATE );
5576 }
5577
Gilles Peskine224b0d62019-09-23 18:13:17 +02005578exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005579 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005580 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005581 return( status );
5582}
5583
Janos Follath51f4a0f2019-06-14 11:35:55 +01005584psa_status_t psa_key_derivation_input_bytes(
5585 psa_key_derivation_operation_t *operation,
5586 psa_key_derivation_step_t step,
5587 const uint8_t *data,
5588 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005589{
Gilles Peskineb8965192019-09-24 16:21:10 +02005590 return( psa_key_derivation_input_internal( operation, step,
5591 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005592 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005593}
5594
Janos Follath51f4a0f2019-06-14 11:35:55 +01005595psa_status_t psa_key_derivation_input_key(
5596 psa_key_derivation_operation_t *operation,
5597 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005598 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005599{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005600 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005601 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005602 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005603
Ronald Cron5c522922020-11-14 16:35:34 +01005604 status = psa_get_and_lock_transparent_key_slot_with_policy(
5605 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005606 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005607 {
5608 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005609 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005610 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005611
5612 /* Passing a key object as a SECRET input unlocks the permission
5613 * to output to a key object. */
5614 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5615 operation->can_output_key = 1;
5616
Ronald Cronf95a2b12020-10-22 15:24:49 +02005617 status = psa_key_derivation_input_internal( operation,
5618 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005619 slot->key.data,
5620 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005621
Ronald Cron5c522922020-11-14 16:35:34 +01005622 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005623
Ronald Cron5c522922020-11-14 16:35:34 +01005624 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005625}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005626
5627
5628
5629/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005630/* Key agreement */
5631/****************************************************************/
5632
John Durkop6ba40d12020-11-10 08:50:04 -08005633#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005634static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5635 size_t peer_key_length,
5636 const mbedtls_ecp_keypair *our_key,
5637 uint8_t *shared_secret,
5638 size_t shared_secret_size,
5639 size_t *shared_secret_length )
5640{
Steven Cooremand4867872020-08-05 16:31:39 +02005641 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005642 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005643 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005644 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005645 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005646 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005647
Ronald Cron90857082020-11-25 14:58:33 +01005648 status = mbedtls_psa_ecp_load_representation(
5649 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5650 peer_key,
5651 peer_key_length,
5652 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005653 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005654 goto exit;
5655
Jaeden Amero97271b32019-01-10 19:38:51 +00005656 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005657 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005658 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005659 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005660 status = mbedtls_to_psa_error(
5661 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5662 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005663 goto exit;
5664
Jaeden Amero97271b32019-01-10 19:38:51 +00005665 status = mbedtls_to_psa_error(
5666 mbedtls_ecdh_calc_secret( &ecdh,
5667 shared_secret_length,
5668 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005669 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005670 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005671 if( status != PSA_SUCCESS )
5672 goto exit;
5673 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5674 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005675
5676exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005677 if( status != PSA_SUCCESS )
5678 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005679 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005680 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005681 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005682
Jaeden Amero97271b32019-01-10 19:38:51 +00005683 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005684}
John Durkop6ba40d12020-11-10 08:50:04 -08005685#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005686
Gilles Peskine01d718c2018-09-18 12:01:02 +02005687#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5688
Gilles Peskine0216fe12019-04-11 21:23:21 +02005689static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5690 psa_key_slot_t *private_key,
5691 const uint8_t *peer_key,
5692 size_t peer_key_length,
5693 uint8_t *shared_secret,
5694 size_t shared_secret_size,
5695 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005696{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005697 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005698 {
John Durkop6ba40d12020-11-10 08:50:04 -08005699#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005700 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005701 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005702 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005703 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005704 psa_status_t status = mbedtls_psa_ecp_load_representation(
5705 private_key->attr.type,
5706 private_key->key.data,
5707 private_key->key.bytes,
5708 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005709 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005710 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005711 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005712 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005713 shared_secret, shared_secret_size,
5714 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005715 mbedtls_ecp_keypair_free( ecp );
5716 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005717 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005718#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005719 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005720 (void) private_key;
5721 (void) peer_key;
5722 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005723 (void) shared_secret;
5724 (void) shared_secret_size;
5725 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005726 return( PSA_ERROR_NOT_SUPPORTED );
5727 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005728}
5729
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005730/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005731 * to potentially free embedded data structures and wipe confidential data.
5732 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005734 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005735 psa_key_slot_t *private_key,
5736 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005737 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005738{
5739 psa_status_t status;
5740 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5741 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005742 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005743
5744 /* Step 1: run the secret agreement algorithm to generate the shared
5745 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005746 status = psa_key_agreement_raw_internal( ka_alg,
5747 private_key,
5748 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005749 shared_secret,
5750 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005751 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005752 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005753 goto exit;
5754
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005755 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005756 * the shared secret. A shared secret is permitted wherever a key
5757 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005758 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005759 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005760 shared_secret,
5761 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005762exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005763 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005764 return( status );
5765}
5766
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005767psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005768 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005769 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005770 const uint8_t *peer_key,
5771 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005772{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005774 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005775 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005776
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005777 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005778 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005779 status = psa_get_and_lock_transparent_key_slot_with_policy(
5780 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005781 if( status != PSA_SUCCESS )
5782 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005783 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005784 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005785 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005786 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005787 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005788 else
5789 {
5790 /* If a private key has been added as SECRET, we allow the derived
5791 * key material to be used as a key in PSA Crypto. */
5792 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5793 operation->can_output_key = 1;
5794 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005795
Ronald Cron5c522922020-11-14 16:35:34 +01005796 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005797
Ronald Cron5c522922020-11-14 16:35:34 +01005798 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005799}
5800
Gilles Peskinebe697d82019-05-16 18:00:41 +02005801psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005802 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005803 const uint8_t *peer_key,
5804 size_t peer_key_length,
5805 uint8_t *output,
5806 size_t output_size,
5807 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005808{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005809 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005810 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005811 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005812
5813 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5814 {
5815 status = PSA_ERROR_INVALID_ARGUMENT;
5816 goto exit;
5817 }
Ronald Cron5c522922020-11-14 16:35:34 +01005818 status = psa_get_and_lock_transparent_key_slot_with_policy(
5819 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005820 if( status != PSA_SUCCESS )
5821 goto exit;
5822
5823 status = psa_key_agreement_raw_internal( alg, slot,
5824 peer_key, peer_key_length,
5825 output, output_size,
5826 output_length );
5827
5828exit:
5829 if( status != PSA_SUCCESS )
5830 {
5831 /* If an error happens and is not handled properly, the output
5832 * may be used as a key to protect sensitive data. Arrange for such
5833 * a key to be random, which is likely to result in decryption or
5834 * verification errors. This is better than filling the buffer with
5835 * some constant data such as zeros, which would result in the data
5836 * being protected with a reproducible, easily knowable key.
5837 */
5838 psa_generate_random( output, output_size );
5839 *output_length = output_size;
5840 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005841
Ronald Cron5c522922020-11-14 16:35:34 +01005842 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005843
Ronald Cron5c522922020-11-14 16:35:34 +01005844 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005845}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005846
5847
Gilles Peskine30524eb2020-11-13 17:02:26 +01005848
Gilles Peskine86a440b2018-11-12 18:39:40 +01005849/****************************************************************/
5850/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005851/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005852
Gilles Peskine30524eb2020-11-13 17:02:26 +01005853/** Initialize the PSA random generator.
5854 */
5855static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5856{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005857#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5858 memset( rng, 0, sizeof( *rng ) );
5859#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5860
Gilles Peskine30524eb2020-11-13 17:02:26 +01005861 /* Set default configuration if
5862 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5863 if( rng->entropy_init == NULL )
5864 rng->entropy_init = mbedtls_entropy_init;
5865 if( rng->entropy_free == NULL )
5866 rng->entropy_free = mbedtls_entropy_free;
5867
5868 rng->entropy_init( &rng->entropy );
5869#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5870 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5871 /* The PSA entropy injection feature depends on using NV seed as an entropy
5872 * source. Add NV seed as an entropy source for PSA entropy injection. */
5873 mbedtls_entropy_add_source( &rng->entropy,
5874 mbedtls_nv_seed_poll, NULL,
5875 MBEDTLS_ENTROPY_BLOCK_SIZE,
5876 MBEDTLS_ENTROPY_SOURCE_STRONG );
5877#endif
5878
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005879 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005880#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005881}
5882
5883/** Deinitialize the PSA random generator.
5884 */
5885static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5886{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005887#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5888 memset( rng, 0, sizeof( *rng ) );
5889#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005890 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005891 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005892#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005893}
5894
5895/** Seed the PSA random generator.
5896 */
5897static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5898{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005899#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5900 /* Do nothing: the external RNG seeds itself. */
5901 (void) rng;
5902 return( PSA_SUCCESS );
5903#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005904 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005905 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5906 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005907 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005908#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005909}
5910
Gilles Peskinee59236f2018-01-27 23:32:46 +01005911psa_status_t psa_generate_random( uint8_t *output,
5912 size_t output_size )
5913{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005914 GUARD_MODULE_INITIALIZED;
5915
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005916#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5917
5918 size_t output_length = 0;
5919 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5920 output, output_size,
5921 &output_length );
5922 if( status != PSA_SUCCESS )
5923 return( status );
5924 /* Breaking up a request into smaller chunks is currently not supported
5925 * for the extrernal RNG interface. */
5926 if( output_length != output_size )
5927 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5928 return( PSA_SUCCESS );
5929
5930#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5931
Gilles Peskine71ddab92021-01-04 21:01:07 +01005932 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005933 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005934 size_t request_size =
5935 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5936 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5937 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005938 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5939 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005940 if( ret != 0 )
5941 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005942 output_size -= request_size;
5943 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005944 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005945 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005946#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005947}
5948
Gilles Peskine8814fc42020-12-14 15:33:44 +01005949/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005950 *
5951 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5952 * `psa_generate_random(...)`. The state parameter is ignored since the
5953 * PSA API doesn't support passing an explicit state.
5954 *
5955 * In the non-external case, psa_generate_random() calls an
5956 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5957 * and semantics as mbedtls_psa_get_random(). As an optimization,
5958 * instead of doing this back-and-forth between the PSA API and the
5959 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5960 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005961 */
5962#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5963int mbedtls_psa_get_random( void *p_rng,
5964 unsigned char *output,
5965 size_t output_size )
5966{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005967 /* This function takes a pointer to the RNG state because that's what
5968 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5969 * its own state internally and doesn't let the caller access that state.
5970 * So we just ignore the state parameter, and in practice we'll pass
5971 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005972 (void) p_rng;
5973 psa_status_t status = psa_generate_random( output, output_size );
5974 if( status == PSA_SUCCESS )
5975 return( 0 );
5976 else
5977 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5978}
5979#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5980
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005981#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5982#include "mbedtls/entropy_poll.h"
5983
Gilles Peskine7228da22019-07-15 11:06:15 +02005984psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005985 size_t seed_size )
5986{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005987 if( global_data.initialized )
5988 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005989
5990 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5991 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5992 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5993 return( PSA_ERROR_INVALID_ARGUMENT );
5994
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005995 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005996}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005997#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005998
John Durkop07cc04a2020-11-16 22:08:34 -08005999#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02006000static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
6001 size_t domain_parameters_size,
6002 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006003{
Gilles Peskinee56e8782019-04-26 17:34:02 +02006004 size_t i;
6005 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006006
Gilles Peskinee56e8782019-04-26 17:34:02 +02006007 if( domain_parameters_size == 0 )
6008 {
6009 *exponent = 65537;
6010 return( PSA_SUCCESS );
6011 }
6012
6013 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6014 * support values that fit in a 32-bit integer, which is larger than
6015 * int on just about every platform anyway. */
6016 if( domain_parameters_size > sizeof( acc ) )
6017 return( PSA_ERROR_NOT_SUPPORTED );
6018 for( i = 0; i < domain_parameters_size; i++ )
6019 acc = ( acc << 8 ) | domain_parameters[i];
6020 if( acc > INT_MAX )
6021 return( PSA_ERROR_NOT_SUPPORTED );
6022 *exponent = acc;
6023 return( PSA_SUCCESS );
6024}
John Durkop07cc04a2020-11-16 22:08:34 -08006025#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006026
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006027static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006028 psa_key_slot_t *slot, size_t bits,
6029 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006030{
Gilles Peskine8e338702019-07-30 20:06:31 +02006031 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006032
Gilles Peskinee56e8782019-04-26 17:34:02 +02006033 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006034 return( PSA_ERROR_INVALID_ARGUMENT );
6035
Gilles Peskinee59236f2018-01-27 23:32:46 +01006036 if( key_type_is_raw_bytes( type ) )
6037 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006038 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006039
6040 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006041 if( status != PSA_SUCCESS )
6042 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006043
6044 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006045 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6046 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006047 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006048
Ronald Cronea0f8a62020-11-25 17:52:23 +01006049 status = psa_generate_random( slot->key.data,
6050 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006051 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006053
6054 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006055#if defined(MBEDTLS_DES_C)
6056 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006057 psa_des_set_key_parity( slot->key.data,
6058 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006059#endif /* MBEDTLS_DES_C */
6060 }
6061 else
6062
John Durkop07cc04a2020-11-16 22:08:34 -08006063#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006064 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006065 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006066 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006067 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006068 int exponent;
6069 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006070 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6071 return( PSA_ERROR_NOT_SUPPORTED );
6072 /* Accept only byte-aligned keys, for the same reasons as
Ronald Cronb6420e32020-11-22 16:15:38 +01006073 * in mbedtls_psa_rsa_import_key(). */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006074 if( bits % 8 != 0 )
6075 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006076 status = psa_read_rsa_exponent( domain_parameters,
6077 domain_parameters_size,
6078 &exponent );
6079 if( status != PSA_SUCCESS )
6080 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006081 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6082 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006083 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006084 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006085 (unsigned int) bits,
6086 exponent );
6087 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006088 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006089
6090 /* Make sure to always have an export representation available */
6091 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6092
Steven Cooreman75b74362020-07-28 14:30:13 +02006093 status = psa_allocate_buffer_to_slot( slot, bytes );
6094 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006095 {
6096 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006097 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006098 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006099
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006100 status = mbedtls_psa_rsa_export_key( type,
6101 &rsa,
6102 slot->key.data,
6103 bytes,
6104 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006105 mbedtls_rsa_free( &rsa );
6106 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006107 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006108 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006109 }
6110 else
John Durkop07cc04a2020-11-16 22:08:34 -08006111#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112
John Durkop9814fa22020-11-04 12:28:15 -08006113#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006114 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006115 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006116 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006117 mbedtls_ecp_group_id grp_id =
6118 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006119 const mbedtls_ecp_curve_info *curve_info =
6120 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006121 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006122 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006123 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006124 return( PSA_ERROR_NOT_SUPPORTED );
6125 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6126 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006127 mbedtls_ecp_keypair_init( &ecp );
6128 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006129 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006130 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006131 if( ret != 0 )
6132 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006133 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006134 return( mbedtls_to_psa_error( ret ) );
6135 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006136
6137
6138 /* Make sure to always have an export representation available */
6139 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006140 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6141 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006142 {
6143 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006144 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006145 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006146
6147 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006148 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006149
6150 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006151 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006152 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006153 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006154 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006155 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006156 }
6157 else
John Durkop9814fa22020-11-04 12:28:15 -08006158#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006159 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006160 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006161 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006162
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006163 return( PSA_SUCCESS );
6164}
Darryl Green0c6575a2018-11-07 16:05:30 +00006165
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006166psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006167 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006168{
6169 psa_status_t status;
6170 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006171 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006172
Ronald Cron81709fc2020-11-14 12:10:32 +01006173 *key = MBEDTLS_SVC_KEY_ID_INIT;
6174
Gilles Peskine0f84d622019-09-12 19:03:13 +02006175 /* Reject any attempt to create a zero-length key so that we don't
6176 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6177 if( psa_get_key_bits( attributes ) == 0 )
6178 return( PSA_ERROR_INVALID_ARGUMENT );
6179
Ronald Cron81709fc2020-11-14 12:10:32 +01006180 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6181 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006182 if( status != PSA_SUCCESS )
6183 goto exit;
6184
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006185 status = psa_driver_wrapper_generate_key( attributes,
6186 slot );
6187 if( status != PSA_ERROR_NOT_SUPPORTED ||
6188 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6189 goto exit;
6190
6191 status = psa_generate_key_internal(
6192 slot, attributes->core.bits,
6193 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006194
6195exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006196 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006197 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006198 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006199 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006200
Darryl Green0c6575a2018-11-07 16:05:30 +00006201 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006202}
6203
6204
Gilles Peskinee59236f2018-01-27 23:32:46 +01006205
6206/****************************************************************/
6207/* Module setup */
6208/****************************************************************/
6209
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006210#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006211psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6212 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6213 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6214{
6215 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6216 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006217 global_data.rng.entropy_init = entropy_init;
6218 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006219 return( PSA_SUCCESS );
6220}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006221#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006222
Gilles Peskinee59236f2018-01-27 23:32:46 +01006223void mbedtls_psa_crypto_free( void )
6224{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006225 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006226 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6227 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006228 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006229 }
6230 /* Wipe all remaining data, including configuration.
6231 * In particular, this sets all state indicator to the value
6232 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006233 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006234#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006235 /* Unregister all secure element drivers, so that we restart from
6236 * a pristine state. */
6237 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006238#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006239}
6240
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006241#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6242/** Recover a transaction that was interrupted by a power failure.
6243 *
6244 * This function is called during initialization, before psa_crypto_init()
6245 * returns. If this function returns a failure status, the initialization
6246 * fails.
6247 */
6248static psa_status_t psa_crypto_recover_transaction(
6249 const psa_crypto_transaction_t *transaction )
6250{
6251 switch( transaction->unknown.type )
6252 {
6253 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6254 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006255 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006256 * is implemented.
6257 * https://github.com/ARMmbed/mbed-crypto/issues/218
6258 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006259 default:
6260 /* We found an unsupported transaction in the storage.
6261 * We don't know what state the storage is in. Give up. */
gabor-mezei-armfe309242020-11-09 17:39:56 +01006262 return( PSA_ERROR_DATA_INVALID );
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006263 }
6264}
6265#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6266
Gilles Peskinee59236f2018-01-27 23:32:46 +01006267psa_status_t psa_crypto_init( void )
6268{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006269 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006270
Gilles Peskinec6b69072018-11-20 21:42:52 +01006271 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006272 if( global_data.initialized != 0 )
6273 return( PSA_SUCCESS );
6274
Gilles Peskine30524eb2020-11-13 17:02:26 +01006275 /* Initialize and seed the random generator. */
6276 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006277 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006278 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006279 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006280 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006281 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006282
Gilles Peskine66fb1262018-12-10 16:29:04 +01006283 status = psa_initialize_key_slots( );
6284 if( status != PSA_SUCCESS )
6285 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006286
Gilles Peskined9348f22019-10-01 15:22:29 +02006287#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6288 status = psa_init_all_se_drivers( );
6289 if( status != PSA_SUCCESS )
6290 goto exit;
6291#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6292
Gilles Peskine4b734222019-07-24 15:56:31 +02006293#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006294 status = psa_crypto_load_transaction( );
6295 if( status == PSA_SUCCESS )
6296 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006297 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6298 if( status != PSA_SUCCESS )
6299 goto exit;
6300 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006301 }
6302 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6303 {
6304 /* There's no transaction to complete. It's all good. */
6305 status = PSA_SUCCESS;
6306 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006307#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006308
Gilles Peskinec6b69072018-11-20 21:42:52 +01006309 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006310 global_data.initialized = 1;
6311
6312exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006313 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006314 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006315 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006316}
6317
6318#endif /* MBEDTLS_PSA_CRYPTO_C */