blob: 2d933979a163b1b8ce7a8ab75da83f04e5d59112 [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.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001599 * \return If this function fails, the key slot is an invalid state.
1600 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001601 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001602static psa_status_t psa_finish_key_creation(
1603 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001604 psa_se_drv_table_entry_t *driver,
1605 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001606{
1607 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001608 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001609 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001610
1611#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Steven Cooremanc59de6a2020-06-08 18:28:25 +02001612 if( ! PSA_KEY_LIFETIME_IS_VOLATILE( slot->attr.lifetime ) )
Gilles Peskine4747d192019-04-17 15:05:45 +02001613 {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001614#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1615 if( driver != NULL )
1616 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001617 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001618 psa_key_slot_number_t slot_number =
1619 psa_key_slot_get_slot_number( slot ) ;
1620
Gilles Peskineb46bef22019-07-30 21:32:04 +02001621#if defined(static_assert)
Ronald Cronea0f8a62020-11-25 17:52:23 +01001622 static_assert( sizeof( slot_number ) ==
Gilles Peskineb46bef22019-07-30 21:32:04 +02001623 sizeof( data.slot_number ),
1624 "Slot number size does not match psa_se_key_data_storage_t" );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001625#endif
Ronald Cronea0f8a62020-11-25 17:52:23 +01001626 memcpy( &data.slot_number, &slot_number, sizeof( slot_number ) );
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001627 status = psa_save_persistent_key( &slot->attr,
Gilles Peskineb46bef22019-07-30 21:32:04 +02001628 (uint8_t*) &data,
1629 sizeof( data ) );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001630 }
1631 else
1632#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1633 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001634 /* Key material is saved in export representation in the slot, so
1635 * just pass the slot buffer for storage. */
1636 status = psa_save_persistent_key( &slot->attr,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001637 slot->key.data,
1638 slot->key.bytes );
Gilles Peskine1df83d42019-07-23 16:13:14 +02001639 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001640 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001641#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1642
Gilles Peskinecbaff462019-07-12 23:46:04 +02001643#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001644 /* Finish the transaction for a key creation. This does not
1645 * happen when registering an existing key. Detect this case
1646 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001647 * creation of a persistent key in a secure element requires a transaction,
1648 * but registration or volatile key creation doesn't use one). */
Gilles Peskined7729582019-08-05 15:55:54 +02001649 if( driver != NULL &&
1650 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY )
Gilles Peskinecbaff462019-07-12 23:46:04 +02001651 {
1652 status = psa_save_se_persistent_data( driver );
1653 if( status != PSA_SUCCESS )
1654 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001655 psa_destroy_persistent_key( slot->attr.id );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001656 return( status );
1657 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001658 status = psa_crypto_stop_transaction( );
Gilles Peskinecbaff462019-07-12 23:46:04 +02001659 }
1660#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1661
Ronald Cron50972942020-11-14 11:28:25 +01001662 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01001663 {
1664 *key = slot->attr.id;
Ronald Cron5c522922020-11-14 16:35:34 +01001665 status = psa_unlock_key_slot( slot );
Ronald Cron81709fc2020-11-14 12:10:32 +01001666 if( status != PSA_SUCCESS )
1667 *key = MBEDTLS_SVC_KEY_ID_INIT;
1668 }
Ronald Cron50972942020-11-14 11:28:25 +01001669
Gilles Peskine4747d192019-04-17 15:05:45 +02001670 return( status );
1671}
1672
1673/** Abort the creation of a key.
1674 *
1675 * You may call this function after calling psa_start_key_creation(),
1676 * or after psa_finish_key_creation() fails. In other circumstances, this
1677 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001678 * See the documentation of psa_start_key_creation() for the intended use
1679 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001680 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001681 * \param[in,out] slot Pointer to the slot with key material.
1682 * \param[in] driver The secure element driver for the key,
1683 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001684 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001685static void psa_fail_key_creation( psa_key_slot_t *slot,
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001686 psa_se_drv_table_entry_t *driver )
Gilles Peskine4747d192019-04-17 15:05:45 +02001687{
Gilles Peskine011e4282019-06-26 18:34:38 +02001688 (void) driver;
1689
Gilles Peskine4747d192019-04-17 15:05:45 +02001690 if( slot == NULL )
1691 return;
Gilles Peskine011e4282019-06-26 18:34:38 +02001692
1693#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001694 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001695 * element, and the failure happened later (when saving metadata
1696 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001697 * element.
1698 * https://github.com/ARMmbed/mbed-crypto/issues/217
1699 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001700
Gilles Peskined7729582019-08-05 15:55:54 +02001701 /* Abort the ongoing transaction if any (there may not be one if
1702 * the creation process failed before starting one, or if the
1703 * key creation is a registration of a key in a secure element).
1704 * Earlier functions must already have done what it takes to undo any
1705 * partial creation. All that's left is to update the transaction data
1706 * itself. */
Gilles Peskinefc762652019-07-22 19:30:34 +02001707 (void) psa_crypto_stop_transaction( );
Gilles Peskine011e4282019-06-26 18:34:38 +02001708#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1709
Gilles Peskine4747d192019-04-17 15:05:45 +02001710 psa_wipe_key_slot( slot );
1711}
1712
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001713/** Validate optional attributes during key creation.
1714 *
1715 * Some key attributes are optional during key creation. If they are
1716 * specified in the attributes structure, check that they are consistent
1717 * with the data in the slot.
1718 *
1719 * This function should be called near the end of key creation, after
1720 * the slot in memory is fully populated but before saving persistent data.
1721 */
1722static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001723 const psa_key_slot_t *slot,
1724 const psa_key_attributes_t *attributes )
1725{
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001726 if( attributes->core.type != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001727 {
Gilles Peskine8e338702019-07-30 20:06:31 +02001728 if( attributes->core.type != slot->attr.type )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001729 return( PSA_ERROR_INVALID_ARGUMENT );
1730 }
1731
1732 if( attributes->domain_parameters_size != 0 )
1733 {
John Durkop0e005192020-10-31 22:06:54 -07001734#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
1735 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskine8e338702019-07-30 20:06:31 +02001736 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001737 {
Steven Cooremana2371e52020-07-28 14:30:39 +02001738 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001739 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001741
Ronald Cron90857082020-11-25 14:58:33 +01001742 psa_status_t status = mbedtls_psa_rsa_load_representation(
1743 slot->attr.type,
1744 slot->key.data,
1745 slot->key.bytes,
1746 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02001747 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02001748 return( status );
Steven Cooreman75b74362020-07-28 14:30:13 +02001749
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001750 mbedtls_mpi_init( &actual );
1751 mbedtls_mpi_init( &required );
Steven Cooremana2371e52020-07-28 14:30:39 +02001752 ret = mbedtls_rsa_export( rsa,
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001753 NULL, NULL, NULL, NULL, &actual );
Steven Cooremana2371e52020-07-28 14:30:39 +02001754 mbedtls_rsa_free( rsa );
1755 mbedtls_free( rsa );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001756 if( ret != 0 )
1757 goto rsa_exit;
1758 ret = mbedtls_mpi_read_binary( &required,
1759 attributes->domain_parameters,
1760 attributes->domain_parameters_size );
1761 if( ret != 0 )
1762 goto rsa_exit;
1763 if( mbedtls_mpi_cmp_mpi( &actual, &required ) != 0 )
1764 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
1765 rsa_exit:
1766 mbedtls_mpi_free( &actual );
1767 mbedtls_mpi_free( &required );
1768 if( ret != 0)
1769 return( mbedtls_to_psa_error( ret ) );
1770 }
1771 else
John Durkop9814fa22020-11-04 12:28:15 -08001772#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1773 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001774 {
1775 return( PSA_ERROR_INVALID_ARGUMENT );
1776 }
1777 }
1778
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001779 if( attributes->core.bits != 0 )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001780 {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001781 if( attributes->core.bits != slot->attr.bits )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001782 return( PSA_ERROR_INVALID_ARGUMENT );
1783 }
1784
1785 return( PSA_SUCCESS );
1786}
1787
Gilles Peskine4747d192019-04-17 15:05:45 +02001788psa_status_t psa_import_key( const psa_key_attributes_t *attributes,
Gilles Peskine4747d192019-04-17 15:05:45 +02001789 const uint8_t *data,
Gilles Peskine73676cb2019-05-15 20:15:10 +02001790 size_t data_length,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001791 mbedtls_svc_key_id_t *key )
Gilles Peskine4747d192019-04-17 15:05:45 +02001792{
1793 psa_status_t status;
1794 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001795 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001796 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001797
Ronald Cron81709fc2020-11-14 12:10:32 +01001798 *key = MBEDTLS_SVC_KEY_ID_INIT;
1799
Gilles Peskine0f84d622019-09-12 19:03:13 +02001800 /* Reject zero-length symmetric keys (including raw data key objects).
1801 * This also rejects any key which might be encoded as an empty string,
1802 * which is never valid. */
1803 if( data_length == 0 )
1804 return( PSA_ERROR_INVALID_ARGUMENT );
1805
Gilles Peskinedf179142019-07-15 22:02:14 +02001806 status = psa_start_key_creation( PSA_KEY_CREATION_IMPORT, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001807 &slot, &driver );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001808 if( status != PSA_SUCCESS )
1809 goto exit;
1810
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001811 /* In the case of a transparent key or an opaque key stored in local
1812 * storage (thus not in the case of generating a key in a secure element
1813 * or cryptoprocessor with storage), we have to allocate a buffer to
1814 * hold the generated key material. */
1815 if( slot->key.data == NULL )
Gilles Peskine5d309672019-07-12 23:47:28 +02001816 {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001817 status = psa_allocate_buffer_to_slot( slot, data_length );
Gilles Peskineb46bef22019-07-30 21:32:04 +02001818 if( status != PSA_SUCCESS )
1819 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001820 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001821
1822 bits = slot->attr.bits;
1823 status = psa_driver_wrapper_import_key( attributes,
1824 data, data_length,
1825 slot->key.data,
1826 slot->key.bytes,
1827 &slot->key.bytes, &bits );
1828 if( status != PSA_SUCCESS )
1829 goto exit;
1830
1831 if( slot->attr.bits == 0 )
1832 slot->attr.bits = (psa_key_bits_t) bits;
1833 else if( bits != slot->attr.bits )
Steven Cooremanac3434f2021-01-15 17:36:02 +01001834 {
Steven Cooremanac3434f2021-01-15 17:36:02 +01001835 status = PSA_ERROR_INVALID_ARGUMENT;
1836 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02001837 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01001838
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001839 status = psa_validate_optional_attributes( slot, attributes );
Gilles Peskine18017402019-07-24 20:25:59 +02001840 if( status != PSA_SUCCESS )
1841 goto exit;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001842
Ronald Cron81709fc2020-11-14 12:10:32 +01001843 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001844exit:
Gilles Peskine4747d192019-04-17 15:05:45 +02001845 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001846 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001847
Gilles Peskine4747d192019-04-17 15:05:45 +02001848 return( status );
1849}
1850
Gilles Peskined7729582019-08-05 15:55:54 +02001851#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1852psa_status_t mbedtls_psa_register_se_key(
1853 const psa_key_attributes_t *attributes )
1854{
1855 psa_status_t status;
1856 psa_key_slot_t *slot = NULL;
1857 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02001858 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02001859
1860 /* Leaving attributes unspecified is not currently supported.
1861 * It could make sense to query the key type and size from the
1862 * secure element, but not all secure elements support this
1863 * and the driver HAL doesn't currently support it. */
1864 if( psa_get_key_type( attributes ) == PSA_KEY_TYPE_NONE )
1865 return( PSA_ERROR_NOT_SUPPORTED );
1866 if( psa_get_key_bits( attributes ) == 0 )
1867 return( PSA_ERROR_NOT_SUPPORTED );
1868
1869 status = psa_start_key_creation( PSA_KEY_CREATION_REGISTER, attributes,
Ronald Cron81709fc2020-11-14 12:10:32 +01001870 &slot, &driver );
Gilles Peskined7729582019-08-05 15:55:54 +02001871 if( status != PSA_SUCCESS )
1872 goto exit;
1873
Ronald Cron81709fc2020-11-14 12:10:32 +01001874 status = psa_finish_key_creation( slot, driver, &key );
Gilles Peskined7729582019-08-05 15:55:54 +02001875
1876exit:
1877 if( status != PSA_SUCCESS )
Gilles Peskined7729582019-08-05 15:55:54 +02001878 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001879
Gilles Peskined7729582019-08-05 15:55:54 +02001880 /* Registration doesn't keep the key in RAM. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001881 psa_close_key( key );
Gilles Peskined7729582019-08-05 15:55:54 +02001882 return( status );
1883}
1884#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1885
Gilles Peskinef603c712019-01-19 13:40:11 +01001886static psa_status_t psa_copy_key_material( const psa_key_slot_t *source,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001887 psa_key_slot_t *target )
Gilles Peskinef603c712019-01-19 13:40:11 +01001888{
Steven Cooremanf7cebd42020-10-13 20:27:40 +02001889 psa_status_t status = psa_copy_key_material_into_slot( target,
Ronald Cronea0f8a62020-11-25 17:52:23 +01001890 source->key.data,
1891 source->key.bytes );
Gilles Peskinef603c712019-01-19 13:40:11 +01001892 if( status != PSA_SUCCESS )
Steven Cooreman398aee52020-10-13 14:35:45 +02001893 return( status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001894
Steven Cooreman398aee52020-10-13 14:35:45 +02001895 target->attr.type = source->attr.type;
1896 target->attr.bits = source->attr.bits;
1897
1898 return( PSA_SUCCESS );
Gilles Peskinef603c712019-01-19 13:40:11 +01001899}
1900
Ronald Croncf56a0a2020-08-04 09:51:30 +02001901psa_status_t psa_copy_key( mbedtls_svc_key_id_t source_key,
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001902 const psa_key_attributes_t *specified_attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02001903 mbedtls_svc_key_id_t *target_key )
Gilles Peskinef603c712019-01-19 13:40:11 +01001904{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001906 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01001907 psa_key_slot_t *source_slot = NULL;
1908 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001909 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001910 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01001911
Ronald Cron81709fc2020-11-14 12:10:32 +01001912 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
1913
Ronald Cron5c522922020-11-14 16:35:34 +01001914 status = psa_get_and_lock_transparent_key_slot_with_policy(
1915 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0 );
Gilles Peskinef603c712019-01-19 13:40:11 +01001916 if( status != PSA_SUCCESS )
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001917 goto exit;
1918
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001919 status = psa_validate_optional_attributes( source_slot,
1920 specified_attributes );
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001921 if( status != PSA_SUCCESS )
1922 goto exit;
1923
Gilles Peskine7e0cff92019-07-30 13:48:52 +02001924 status = psa_restrict_key_policy( &actual_attributes.core.policy,
Gilles Peskine8e338702019-07-30 20:06:31 +02001925 &source_slot->attr.policy );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001926 if( status != PSA_SUCCESS )
1927 goto exit;
1928
Ronald Cron81709fc2020-11-14 12:10:32 +01001929 status = psa_start_key_creation( PSA_KEY_CREATION_COPY, &actual_attributes,
1930 &target_slot, &driver );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001931 if( status != PSA_SUCCESS )
1932 goto exit;
1933
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001934#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1935 if( driver != NULL )
Gilles Peskinef603c712019-01-19 13:40:11 +01001936 {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001937 /* Copying to a secure element is not implemented yet. */
1938 status = PSA_ERROR_NOT_SUPPORTED;
1939 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001940 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02001941#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01001942
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001943 status = psa_copy_key_material( source_slot, target_slot );
Gilles Peskinef603c712019-01-19 13:40:11 +01001944 if( status != PSA_SUCCESS )
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001945 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01001946
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 status = psa_finish_key_creation( target_slot, driver, target_key );
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001948exit:
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001949 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02001950 psa_fail_key_creation( target_slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001951
Ronald Cron5c522922020-11-14 16:35:34 +01001952 unlock_status = psa_unlock_key_slot( source_slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02001953
Ronald Cron5c522922020-11-14 16:35:34 +01001954 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskinef603c712019-01-19 13:40:11 +01001955}
1956
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02001957
1958
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001959/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01001960/* Message digests */
1961/****************************************************************/
1962
John Durkop07cc04a2020-11-16 22:08:34 -08001963#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
John Durkop0e005192020-10-31 22:06:54 -07001964 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) || \
1965 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) || \
John Durkop9814fa22020-11-04 12:28:15 -08001966 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinedc2fc842018-03-07 16:42:59 +01001967static const mbedtls_md_info_t *mbedtls_md_info_from_psa( psa_algorithm_t alg )
Gilles Peskine20035e32018-02-03 22:44:14 +01001968{
1969 switch( alg )
1970 {
John Durkopee4e6602020-11-27 08:48:46 -08001971#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine20035e32018-02-03 22:44:14 +01001972 case PSA_ALG_MD2:
1973 return( &mbedtls_md2_info );
1974#endif
John Durkopee4e6602020-11-27 08:48:46 -08001975#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine20035e32018-02-03 22:44:14 +01001976 case PSA_ALG_MD4:
1977 return( &mbedtls_md4_info );
1978#endif
John Durkopee4e6602020-11-27 08:48:46 -08001979#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine20035e32018-02-03 22:44:14 +01001980 case PSA_ALG_MD5:
1981 return( &mbedtls_md5_info );
1982#endif
John Durkopee4e6602020-11-27 08:48:46 -08001983#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine20035e32018-02-03 22:44:14 +01001984 case PSA_ALG_RIPEMD160:
1985 return( &mbedtls_ripemd160_info );
1986#endif
John Durkopee4e6602020-11-27 08:48:46 -08001987#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine20035e32018-02-03 22:44:14 +01001988 case PSA_ALG_SHA_1:
1989 return( &mbedtls_sha1_info );
1990#endif
John Durkopee4e6602020-11-27 08:48:46 -08001991#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine20035e32018-02-03 22:44:14 +01001992 case PSA_ALG_SHA_224:
1993 return( &mbedtls_sha224_info );
John Durkopee4e6602020-11-27 08:48:46 -08001994#endif
1995#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine20035e32018-02-03 22:44:14 +01001996 case PSA_ALG_SHA_256:
1997 return( &mbedtls_sha256_info );
1998#endif
John Durkopee4e6602020-11-27 08:48:46 -08001999#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine20035e32018-02-03 22:44:14 +01002000 case PSA_ALG_SHA_384:
2001 return( &mbedtls_sha384_info );
Manuel Pégourié-Gonnardd6020842019-07-17 16:28:21 +02002002#endif
John Durkopee4e6602020-11-27 08:48:46 -08002003#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine20035e32018-02-03 22:44:14 +01002004 case PSA_ALG_SHA_512:
2005 return( &mbedtls_sha512_info );
2006#endif
2007 default:
2008 return( NULL );
2009 }
2010}
John Durkop07cc04a2020-11-16 22:08:34 -08002011#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
John Durkop9814fa22020-11-04 12:28:15 -08002012 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) ||
2013 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) ||
2014 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine20035e32018-02-03 22:44:14 +01002015
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002016psa_status_t psa_hash_abort( psa_hash_operation_t *operation )
2017{
2018 switch( operation->alg )
2019 {
Gilles Peskine81736312018-06-26 15:04:31 +02002020 case 0:
2021 /* The object has (apparently) been initialized but it is not
2022 * in use. It's ok to call abort on such an object, and there's
2023 * nothing to do. */
2024 break;
John Durkopee4e6602020-11-27 08:48:46 -08002025#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002026 case PSA_ALG_MD2:
2027 mbedtls_md2_free( &operation->ctx.md2 );
2028 break;
2029#endif
John Durkopee4e6602020-11-27 08:48:46 -08002030#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002031 case PSA_ALG_MD4:
2032 mbedtls_md4_free( &operation->ctx.md4 );
2033 break;
2034#endif
John Durkopee4e6602020-11-27 08:48:46 -08002035#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002036 case PSA_ALG_MD5:
2037 mbedtls_md5_free( &operation->ctx.md5 );
2038 break;
2039#endif
John Durkopee4e6602020-11-27 08:48:46 -08002040#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002041 case PSA_ALG_RIPEMD160:
2042 mbedtls_ripemd160_free( &operation->ctx.ripemd160 );
2043 break;
2044#endif
John Durkopee4e6602020-11-27 08:48:46 -08002045#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002046 case PSA_ALG_SHA_1:
2047 mbedtls_sha1_free( &operation->ctx.sha1 );
2048 break;
2049#endif
John Durkop6ca23272020-12-03 06:01:32 -08002050#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002051 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002052 mbedtls_sha256_free( &operation->ctx.sha256 );
2053 break;
2054#endif
2055#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002056 case PSA_ALG_SHA_256:
2057 mbedtls_sha256_free( &operation->ctx.sha256 );
2058 break;
2059#endif
John Durkop6ca23272020-12-03 06:01:32 -08002060#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002061 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002062 mbedtls_sha512_free( &operation->ctx.sha512 );
2063 break;
2064#endif
2065#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002066 case PSA_ALG_SHA_512:
2067 mbedtls_sha512_free( &operation->ctx.sha512 );
2068 break;
2069#endif
2070 default:
Gilles Peskinef9c2c092018-06-21 16:57:07 +02002071 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002072 }
2073 operation->alg = 0;
2074 return( PSA_SUCCESS );
2075}
2076
Gilles Peskineda8191d1c2018-07-08 19:46:38 +02002077psa_status_t psa_hash_setup( psa_hash_operation_t *operation,
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002078 psa_algorithm_t alg )
2079{
Janos Follath24eed8d2019-11-22 13:21:35 +00002080 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002081
2082 /* A context must be freshly initialized before it can be set up. */
2083 if( operation->alg != 0 )
2084 {
2085 return( PSA_ERROR_BAD_STATE );
2086 }
2087
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002088 switch( alg )
2089 {
John Durkopee4e6602020-11-27 08:48:46 -08002090#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002091 case PSA_ALG_MD2:
2092 mbedtls_md2_init( &operation->ctx.md2 );
2093 ret = mbedtls_md2_starts_ret( &operation->ctx.md2 );
2094 break;
2095#endif
John Durkopee4e6602020-11-27 08:48:46 -08002096#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002097 case PSA_ALG_MD4:
2098 mbedtls_md4_init( &operation->ctx.md4 );
2099 ret = mbedtls_md4_starts_ret( &operation->ctx.md4 );
2100 break;
2101#endif
John Durkopee4e6602020-11-27 08:48:46 -08002102#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002103 case PSA_ALG_MD5:
2104 mbedtls_md5_init( &operation->ctx.md5 );
2105 ret = mbedtls_md5_starts_ret( &operation->ctx.md5 );
2106 break;
2107#endif
John Durkopee4e6602020-11-27 08:48:46 -08002108#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002109 case PSA_ALG_RIPEMD160:
2110 mbedtls_ripemd160_init( &operation->ctx.ripemd160 );
2111 ret = mbedtls_ripemd160_starts_ret( &operation->ctx.ripemd160 );
2112 break;
2113#endif
John Durkopee4e6602020-11-27 08:48:46 -08002114#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002115 case PSA_ALG_SHA_1:
2116 mbedtls_sha1_init( &operation->ctx.sha1 );
2117 ret = mbedtls_sha1_starts_ret( &operation->ctx.sha1 );
2118 break;
2119#endif
John Durkopee4e6602020-11-27 08:48:46 -08002120#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002121 case PSA_ALG_SHA_224:
2122 mbedtls_sha256_init( &operation->ctx.sha256 );
2123 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 1 );
2124 break;
John Durkopee4e6602020-11-27 08:48:46 -08002125#endif
2126#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002127 case PSA_ALG_SHA_256:
2128 mbedtls_sha256_init( &operation->ctx.sha256 );
2129 ret = mbedtls_sha256_starts_ret( &operation->ctx.sha256, 0 );
2130 break;
2131#endif
John Durkopee4e6602020-11-27 08:48:46 -08002132#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002133 case PSA_ALG_SHA_384:
2134 mbedtls_sha512_init( &operation->ctx.sha512 );
2135 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 1 );
2136 break;
Manuel Pégourié-Gonnard792b16d2020-01-07 10:13:18 +01002137#endif
John Durkopee4e6602020-11-27 08:48:46 -08002138#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002139 case PSA_ALG_SHA_512:
2140 mbedtls_sha512_init( &operation->ctx.sha512 );
2141 ret = mbedtls_sha512_starts_ret( &operation->ctx.sha512, 0 );
2142 break;
2143#endif
2144 default:
Gilles Peskinec06e0712018-06-20 16:21:04 +02002145 return( PSA_ALG_IS_HASH( alg ) ?
2146 PSA_ERROR_NOT_SUPPORTED :
2147 PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002148 }
2149 if( ret == 0 )
2150 operation->alg = alg;
2151 else
2152 psa_hash_abort( operation );
2153 return( mbedtls_to_psa_error( ret ) );
2154}
2155
2156psa_status_t psa_hash_update( psa_hash_operation_t *operation,
2157 const uint8_t *input,
2158 size_t input_length )
2159{
Janos Follath24eed8d2019-11-22 13:21:35 +00002160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine94e44542018-07-12 16:58:43 +02002161
2162 /* Don't require hash implementations to behave correctly on a
2163 * zero-length input, which may have an invalid pointer. */
2164 if( input_length == 0 )
2165 return( PSA_SUCCESS );
2166
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002167 switch( operation->alg )
2168 {
John Durkopee4e6602020-11-27 08:48:46 -08002169#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002170 case PSA_ALG_MD2:
2171 ret = mbedtls_md2_update_ret( &operation->ctx.md2,
2172 input, input_length );
2173 break;
2174#endif
John Durkopee4e6602020-11-27 08:48:46 -08002175#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002176 case PSA_ALG_MD4:
2177 ret = mbedtls_md4_update_ret( &operation->ctx.md4,
2178 input, input_length );
2179 break;
2180#endif
John Durkopee4e6602020-11-27 08:48:46 -08002181#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002182 case PSA_ALG_MD5:
2183 ret = mbedtls_md5_update_ret( &operation->ctx.md5,
2184 input, input_length );
2185 break;
2186#endif
John Durkopee4e6602020-11-27 08:48:46 -08002187#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002188 case PSA_ALG_RIPEMD160:
2189 ret = mbedtls_ripemd160_update_ret( &operation->ctx.ripemd160,
2190 input, input_length );
2191 break;
2192#endif
John Durkopee4e6602020-11-27 08:48:46 -08002193#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002194 case PSA_ALG_SHA_1:
2195 ret = mbedtls_sha1_update_ret( &operation->ctx.sha1,
2196 input, input_length );
2197 break;
2198#endif
John Durkop6ca23272020-12-03 06:01:32 -08002199#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002201 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2202 input, input_length );
2203 break;
2204#endif
2205#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002206 case PSA_ALG_SHA_256:
2207 ret = mbedtls_sha256_update_ret( &operation->ctx.sha256,
2208 input, input_length );
2209 break;
2210#endif
John Durkop6ca23272020-12-03 06:01:32 -08002211#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002212 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002213 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2214 input, input_length );
2215 break;
2216#endif
2217#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002218 case PSA_ALG_SHA_512:
2219 ret = mbedtls_sha512_update_ret( &operation->ctx.sha512,
2220 input, input_length );
2221 break;
2222#endif
2223 default:
John Durkopee4e6602020-11-27 08:48:46 -08002224 (void)input;
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002225 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002226 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002227
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002228 if( ret != 0 )
2229 psa_hash_abort( operation );
2230 return( mbedtls_to_psa_error( ret ) );
2231}
2232
2233psa_status_t psa_hash_finish( psa_hash_operation_t *operation,
2234 uint8_t *hash,
2235 size_t hash_size,
2236 size_t *hash_length )
2237{
itayzafrir40835d42018-08-02 13:14:17 +03002238 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00002239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002240 size_t actual_hash_length = PSA_HASH_LENGTH( operation->alg );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002241
2242 /* Fill the output buffer with something that isn't a valid hash
2243 * (barring an attack on the hash and deliberately-crafted input),
2244 * in case the caller doesn't check the return status properly. */
Gilles Peskineaee13332018-07-02 12:15:28 +02002245 *hash_length = hash_size;
Gilles Peskine46f1fd72018-06-28 19:31:31 +02002246 /* If hash_size is 0 then hash may be NULL and then the
2247 * call to memset would have undefined behavior. */
2248 if( hash_size != 0 )
2249 memset( hash, '!', hash_size );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002250
2251 if( hash_size < actual_hash_length )
itayzafrir40835d42018-08-02 13:14:17 +03002252 {
2253 status = PSA_ERROR_BUFFER_TOO_SMALL;
2254 goto exit;
2255 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002256
2257 switch( operation->alg )
2258 {
John Durkopee4e6602020-11-27 08:48:46 -08002259#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002260 case PSA_ALG_MD2:
2261 ret = mbedtls_md2_finish_ret( &operation->ctx.md2, hash );
2262 break;
2263#endif
John Durkopee4e6602020-11-27 08:48:46 -08002264#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002265 case PSA_ALG_MD4:
2266 ret = mbedtls_md4_finish_ret( &operation->ctx.md4, hash );
2267 break;
2268#endif
John Durkopee4e6602020-11-27 08:48:46 -08002269#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270 case PSA_ALG_MD5:
2271 ret = mbedtls_md5_finish_ret( &operation->ctx.md5, hash );
2272 break;
2273#endif
John Durkopee4e6602020-11-27 08:48:46 -08002274#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002275 case PSA_ALG_RIPEMD160:
2276 ret = mbedtls_ripemd160_finish_ret( &operation->ctx.ripemd160, hash );
2277 break;
2278#endif
John Durkopee4e6602020-11-27 08:48:46 -08002279#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280 case PSA_ALG_SHA_1:
2281 ret = mbedtls_sha1_finish_ret( &operation->ctx.sha1, hash );
2282 break;
2283#endif
John Durkop6ca23272020-12-03 06:01:32 -08002284#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002285 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002286 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2287 break;
2288#endif
2289#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290 case PSA_ALG_SHA_256:
2291 ret = mbedtls_sha256_finish_ret( &operation->ctx.sha256, hash );
2292 break;
2293#endif
John Durkop6ca23272020-12-03 06:01:32 -08002294#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002295 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002296 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2297 break;
2298#endif
2299#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002300 case PSA_ALG_SHA_512:
2301 ret = mbedtls_sha512_finish_ret( &operation->ctx.sha512, hash );
2302 break;
2303#endif
2304 default:
Jaeden Ameroa0f625a2019-02-15 13:52:25 +00002305 return( PSA_ERROR_BAD_STATE );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002306 }
itayzafrir40835d42018-08-02 13:14:17 +03002307 status = mbedtls_to_psa_error( ret );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002308
itayzafrir40835d42018-08-02 13:14:17 +03002309exit:
2310 if( status == PSA_SUCCESS )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002311 {
Gilles Peskineaee13332018-07-02 12:15:28 +02002312 *hash_length = actual_hash_length;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313 return( psa_hash_abort( operation ) );
2314 }
2315 else
2316 {
2317 psa_hash_abort( operation );
itayzafrir40835d42018-08-02 13:14:17 +03002318 return( status );
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319 }
2320}
2321
Gilles Peskine2d277862018-06-18 15:41:12 +02002322psa_status_t psa_hash_verify( psa_hash_operation_t *operation,
2323 const uint8_t *hash,
2324 size_t hash_length )
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325{
2326 uint8_t actual_hash[MBEDTLS_MD_MAX_SIZE];
2327 size_t actual_hash_length;
2328 psa_status_t status = psa_hash_finish( operation,
2329 actual_hash, sizeof( actual_hash ),
2330 &actual_hash_length );
2331 if( status != PSA_SUCCESS )
2332 return( status );
2333 if( actual_hash_length != hash_length )
2334 return( PSA_ERROR_INVALID_SIGNATURE );
2335 if( safer_memcmp( hash, actual_hash, actual_hash_length ) != 0 )
2336 return( PSA_ERROR_INVALID_SIGNATURE );
2337 return( PSA_SUCCESS );
2338}
2339
Gilles Peskine0a749c82019-11-28 19:33:58 +01002340psa_status_t psa_hash_compute( psa_algorithm_t alg,
2341 const uint8_t *input, size_t input_length,
2342 uint8_t *hash, size_t hash_size,
2343 size_t *hash_length )
2344{
2345 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2346 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2347
2348 *hash_length = hash_size;
2349 status = psa_hash_setup( &operation, alg );
2350 if( status != PSA_SUCCESS )
2351 goto exit;
2352 status = psa_hash_update( &operation, input, input_length );
2353 if( status != PSA_SUCCESS )
2354 goto exit;
2355 status = psa_hash_finish( &operation, hash, hash_size, hash_length );
2356 if( status != PSA_SUCCESS )
2357 goto exit;
2358
2359exit:
2360 if( status == PSA_SUCCESS )
2361 status = psa_hash_abort( &operation );
2362 else
2363 psa_hash_abort( &operation );
2364 return( status );
2365}
2366
2367psa_status_t psa_hash_compare( psa_algorithm_t alg,
2368 const uint8_t *input, size_t input_length,
2369 const uint8_t *hash, size_t hash_length )
2370{
2371 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
2372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2373
2374 status = psa_hash_setup( &operation, alg );
2375 if( status != PSA_SUCCESS )
2376 goto exit;
2377 status = psa_hash_update( &operation, input, input_length );
2378 if( status != PSA_SUCCESS )
2379 goto exit;
2380 status = psa_hash_verify( &operation, hash, hash_length );
2381 if( status != PSA_SUCCESS )
2382 goto exit;
2383
2384exit:
2385 if( status == PSA_SUCCESS )
2386 status = psa_hash_abort( &operation );
2387 else
2388 psa_hash_abort( &operation );
2389 return( status );
2390}
2391
Gilles Peskineeb35d782019-01-22 17:56:16 +01002392psa_status_t psa_hash_clone( const psa_hash_operation_t *source_operation,
2393 psa_hash_operation_t *target_operation )
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002394{
2395 if( target_operation->alg != 0 )
2396 return( PSA_ERROR_BAD_STATE );
2397
2398 switch( source_operation->alg )
2399 {
2400 case 0:
2401 return( PSA_ERROR_BAD_STATE );
John Durkopee4e6602020-11-27 08:48:46 -08002402#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD2)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002403 case PSA_ALG_MD2:
2404 mbedtls_md2_clone( &target_operation->ctx.md2,
2405 &source_operation->ctx.md2 );
2406 break;
2407#endif
John Durkopee4e6602020-11-27 08:48:46 -08002408#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD4)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002409 case PSA_ALG_MD4:
2410 mbedtls_md4_clone( &target_operation->ctx.md4,
2411 &source_operation->ctx.md4 );
2412 break;
2413#endif
John Durkopee4e6602020-11-27 08:48:46 -08002414#if defined(MBEDTLS_PSA_BUILTIN_ALG_MD5)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002415 case PSA_ALG_MD5:
2416 mbedtls_md5_clone( &target_operation->ctx.md5,
2417 &source_operation->ctx.md5 );
2418 break;
2419#endif
John Durkopee4e6602020-11-27 08:48:46 -08002420#if defined(MBEDTLS_PSA_BUILTIN_ALG_RIPEMD160)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002421 case PSA_ALG_RIPEMD160:
2422 mbedtls_ripemd160_clone( &target_operation->ctx.ripemd160,
2423 &source_operation->ctx.ripemd160 );
2424 break;
2425#endif
John Durkopee4e6602020-11-27 08:48:46 -08002426#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_1)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002427 case PSA_ALG_SHA_1:
2428 mbedtls_sha1_clone( &target_operation->ctx.sha1,
2429 &source_operation->ctx.sha1 );
2430 break;
2431#endif
John Durkop6ca23272020-12-03 06:01:32 -08002432#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_224)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002433 case PSA_ALG_SHA_224:
John Durkop6ca23272020-12-03 06:01:32 -08002434 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2435 &source_operation->ctx.sha256 );
2436 break;
2437#endif
2438#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_256)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002439 case PSA_ALG_SHA_256:
2440 mbedtls_sha256_clone( &target_operation->ctx.sha256,
2441 &source_operation->ctx.sha256 );
2442 break;
2443#endif
John Durkop6ca23272020-12-03 06:01:32 -08002444#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_384)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002445 case PSA_ALG_SHA_384:
John Durkop6ca23272020-12-03 06:01:32 -08002446 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2447 &source_operation->ctx.sha512 );
2448 break;
2449#endif
2450#if defined(MBEDTLS_PSA_BUILTIN_ALG_SHA_512)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002451 case PSA_ALG_SHA_512:
2452 mbedtls_sha512_clone( &target_operation->ctx.sha512,
2453 &source_operation->ctx.sha512 );
2454 break;
2455#endif
2456 default:
2457 return( PSA_ERROR_NOT_SUPPORTED );
2458 }
2459
2460 target_operation->alg = source_operation->alg;
2461 return( PSA_SUCCESS );
2462}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002463
2464
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002465/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002466/* MAC */
2467/****************************************************************/
2468
Gilles Peskinedc2fc842018-03-07 16:42:59 +01002469static const mbedtls_cipher_info_t *mbedtls_cipher_info_from_psa(
Gilles Peskine8c9def32018-02-08 10:02:12 +01002470 psa_algorithm_t alg,
2471 psa_key_type_t key_type,
Gilles Peskine2d277862018-06-18 15:41:12 +02002472 size_t key_bits,
mohammad1603f4f0d612018-06-03 15:04:51 +03002473 mbedtls_cipher_id_t* cipher_id )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002474{
Gilles Peskine8c9def32018-02-08 10:02:12 +01002475 mbedtls_cipher_mode_t mode;
mohammad1603f4f0d612018-06-03 15:04:51 +03002476 mbedtls_cipher_id_t cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002477
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002478 if( PSA_ALG_IS_AEAD( alg ) )
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002479 alg = PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02002480
Gilles Peskine8c9def32018-02-08 10:02:12 +01002481 if( PSA_ALG_IS_CIPHER( alg ) || PSA_ALG_IS_AEAD( alg ) )
2482 {
Nir Sonnenscheine9664c32018-06-17 14:41:30 +03002483 switch( alg )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484 {
Bence Szépkúti1de907d2020-12-07 18:20:28 +01002485 case PSA_ALG_STREAM_CIPHER:
Gilles Peskine8c9def32018-02-08 10:02:12 +01002486 mode = MBEDTLS_MODE_STREAM;
2487 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002488 case PSA_ALG_CTR:
2489 mode = MBEDTLS_MODE_CTR;
2490 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002491 case PSA_ALG_CFB:
2492 mode = MBEDTLS_MODE_CFB;
2493 break;
2494 case PSA_ALG_OFB:
2495 mode = MBEDTLS_MODE_OFB;
2496 break;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02002497 case PSA_ALG_ECB_NO_PADDING:
2498 mode = MBEDTLS_MODE_ECB;
2499 break;
Gilles Peskinedaea26f2018-08-21 14:02:45 +02002500 case PSA_ALG_CBC_NO_PADDING:
2501 mode = MBEDTLS_MODE_CBC;
2502 break;
2503 case PSA_ALG_CBC_PKCS7:
2504 mode = MBEDTLS_MODE_CBC;
2505 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002506 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002507 mode = MBEDTLS_MODE_CCM;
2508 break;
Gilles Peskine57fbdb12018-10-17 18:29:17 +02002509 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
Gilles Peskine8c9def32018-02-08 10:02:12 +01002510 mode = MBEDTLS_MODE_GCM;
2511 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002512 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
2513 mode = MBEDTLS_MODE_CHACHAPOLY;
2514 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515 default:
2516 return( NULL );
2517 }
2518 }
2519 else if( alg == PSA_ALG_CMAC )
2520 mode = MBEDTLS_MODE_ECB;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521 else
2522 return( NULL );
2523
2524 switch( key_type )
2525 {
2526 case PSA_KEY_TYPE_AES:
mohammad1603f4f0d612018-06-03 15:04:51 +03002527 cipher_id_tmp = MBEDTLS_CIPHER_ID_AES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002528 break;
2529 case PSA_KEY_TYPE_DES:
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002530 /* key_bits is 64 for Single-DES, 128 for two-key Triple-DES,
2531 * and 192 for three-key Triple-DES. */
Gilles Peskine8c9def32018-02-08 10:02:12 +01002532 if( key_bits == 64 )
mohammad1603f4f0d612018-06-03 15:04:51 +03002533 cipher_id_tmp = MBEDTLS_CIPHER_ID_DES;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002534 else
mohammad1603f4f0d612018-06-03 15:04:51 +03002535 cipher_id_tmp = MBEDTLS_CIPHER_ID_3DES;
Gilles Peskine9ad29e22018-06-21 09:40:04 +02002536 /* mbedtls doesn't recognize two-key Triple-DES as an algorithm,
2537 * but two-key Triple-DES is functionally three-key Triple-DES
2538 * with K1=K3, so that's how we present it to mbedtls. */
2539 if( key_bits == 128 )
2540 key_bits = 192;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002541 break;
2542 case PSA_KEY_TYPE_CAMELLIA:
mohammad1603f4f0d612018-06-03 15:04:51 +03002543 cipher_id_tmp = MBEDTLS_CIPHER_ID_CAMELLIA;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002544 break;
2545 case PSA_KEY_TYPE_ARC4:
mohammad1603f4f0d612018-06-03 15:04:51 +03002546 cipher_id_tmp = MBEDTLS_CIPHER_ID_ARC4;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002547 break;
Gilles Peskine26869f22019-05-06 15:25:00 +02002548 case PSA_KEY_TYPE_CHACHA20:
2549 cipher_id_tmp = MBEDTLS_CIPHER_ID_CHACHA20;
2550 break;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002551 default:
2552 return( NULL );
2553 }
mohammad1603f4f0d612018-06-03 15:04:51 +03002554 if( cipher_id != NULL )
mohammad160360a64d02018-06-03 17:20:42 +03002555 *cipher_id = cipher_id_tmp;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002556
Jaeden Amero23bbb752018-06-26 14:16:54 +01002557 return( mbedtls_cipher_info_from_values( cipher_id_tmp,
2558 (int) key_bits, mode ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002559}
2560
John Durkop6ba40d12020-11-10 08:50:04 -08002561#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002562static size_t psa_get_hash_block_size( psa_algorithm_t alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002563{
Gilles Peskine2d277862018-06-18 15:41:12 +02002564 switch( alg )
Nir Sonnenschein96272412018-06-17 14:41:10 +03002565 {
2566 case PSA_ALG_MD2:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002567 return( 16 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002568 case PSA_ALG_MD4:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002569 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002570 case PSA_ALG_MD5:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002571 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002572 case PSA_ALG_RIPEMD160:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002573 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002574 case PSA_ALG_SHA_1:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002575 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002576 case PSA_ALG_SHA_224:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002577 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002578 case PSA_ALG_SHA_256:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002579 return( 64 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002580 case PSA_ALG_SHA_384:
Nir Sonnenscheinaa5aea02018-06-18 12:24:33 +03002581 return( 128 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002582 case PSA_ALG_SHA_512:
Gilles Peskine2d277862018-06-18 15:41:12 +02002583 return( 128 );
2584 default:
2585 return( 0 );
Nir Sonnenschein96272412018-06-17 14:41:10 +03002586 }
2587}
John Durkop07cc04a2020-11-16 22:08:34 -08002588#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC) */
Nir Sonnenschein0c9ec532018-06-07 13:27:47 +03002589
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002590/* Initialize the MAC operation structure. Once this function has been
2591 * called, psa_mac_abort can run and will do the right thing. */
2592static psa_status_t psa_mac_init( psa_mac_operation_t *operation,
2593 psa_algorithm_t alg )
2594{
2595 psa_status_t status = PSA_ERROR_NOT_SUPPORTED;
2596
2597 operation->alg = alg;
2598 operation->key_set = 0;
2599 operation->iv_set = 0;
2600 operation->iv_required = 0;
2601 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002602 operation->is_sign = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002603
2604#if defined(MBEDTLS_CMAC_C)
2605 if( alg == PSA_ALG_CMAC )
2606 {
2607 operation->iv_required = 0;
2608 mbedtls_cipher_init( &operation->ctx.cmac );
2609 status = PSA_SUCCESS;
2610 }
2611 else
2612#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002613#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002614 if( PSA_ALG_IS_HMAC( operation->alg ) )
2615 {
Gilles Peskineff94abd2018-07-12 17:07:52 +02002616 /* We'll set up the hash operation later in psa_hmac_setup_internal. */
2617 operation->ctx.hmac.hash_ctx.alg = 0;
2618 status = PSA_SUCCESS;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002619 }
2620 else
John Durkopd0321952020-10-29 21:37:36 -07002621#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002622 {
Gilles Peskinec06e0712018-06-20 16:21:04 +02002623 if( ! PSA_ALG_IS_MAC( alg ) )
2624 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002625 }
2626
2627 if( status != PSA_SUCCESS )
2628 memset( operation, 0, sizeof( *operation ) );
2629 return( status );
2630}
2631
John Durkop6ba40d12020-11-10 08:50:04 -08002632#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002633static psa_status_t psa_hmac_abort_internal( psa_hmac_internal_data *hmac )
2634{
Gilles Peskine3f108122018-12-07 18:14:53 +01002635 mbedtls_platform_zeroize( hmac->opad, sizeof( hmac->opad ) );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002636 return( psa_hash_abort( &hmac->hash_ctx ) );
2637}
John Durkop6ba40d12020-11-10 08:50:04 -08002638#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002639
Gilles Peskine8c9def32018-02-08 10:02:12 +01002640psa_status_t psa_mac_abort( psa_mac_operation_t *operation )
2641{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002642 if( operation->alg == 0 )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002644 /* The object has (apparently) been initialized but it is not
2645 * in use. It's ok to call abort on such an object, and there's
2646 * nothing to do. */
2647 return( PSA_SUCCESS );
2648 }
2649 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002650#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002651 if( operation->alg == PSA_ALG_CMAC )
2652 {
2653 mbedtls_cipher_free( &operation->ctx.cmac );
2654 }
2655 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002657#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002658 if( PSA_ALG_IS_HMAC( operation->alg ) )
2659 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02002660 psa_hmac_abort_internal( &operation->ctx.hmac );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002661 }
2662 else
John Durkopd0321952020-10-29 21:37:36 -07002663#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002664 {
2665 /* Sanity check (shouldn't happen: operation->alg should
2666 * always have been initialized to a valid value). */
2667 goto bad_state;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002668 }
Moran Peker41deec42018-04-04 15:43:05 +03002669
Gilles Peskine8c9def32018-02-08 10:02:12 +01002670 operation->alg = 0;
2671 operation->key_set = 0;
2672 operation->iv_set = 0;
2673 operation->iv_required = 0;
2674 operation->has_input = 0;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002675 operation->is_sign = 0;
Moran Peker41deec42018-04-04 15:43:05 +03002676
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677 return( PSA_SUCCESS );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002678
2679bad_state:
2680 /* If abort is called on an uninitialized object, we can't trust
2681 * anything. Wipe the object in case it contains confidential data.
2682 * This may result in a memory leak if a pointer gets overwritten,
2683 * but it's too late to do anything about this. */
2684 memset( operation, 0, sizeof( *operation ) );
2685 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002686}
2687
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002688#if defined(MBEDTLS_CMAC_C)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002689static int psa_cmac_setup( psa_mac_operation_t *operation,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002690 size_t key_bits,
Gilles Peskine2f060a82018-12-04 17:12:32 +01002691 psa_key_slot_t *slot,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002692 const mbedtls_cipher_info_t *cipher_info )
2693{
Janos Follath24eed8d2019-11-22 13:21:35 +00002694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002695
2696 operation->mac_size = cipher_info->block_size;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002697
2698 ret = mbedtls_cipher_setup( &operation->ctx.cmac, cipher_info );
2699 if( ret != 0 )
2700 return( ret );
2701
2702 ret = mbedtls_cipher_cmac_starts( &operation->ctx.cmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002703 slot->key.data,
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002704 key_bits );
2705 return( ret );
2706}
Gilles Peskinee3b07d82018-06-19 11:57:35 +02002707#endif /* MBEDTLS_CMAC_C */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002708
John Durkop6ba40d12020-11-10 08:50:04 -08002709#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002710static psa_status_t psa_hmac_setup_internal( psa_hmac_internal_data *hmac,
2711 const uint8_t *key,
2712 size_t key_length,
2713 psa_algorithm_t hash_alg )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002714{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002715 uint8_t ipad[PSA_HMAC_MAX_HASH_BLOCK_SIZE];
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002716 size_t i;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002717 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002718 size_t block_size = psa_get_hash_block_size( hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002719 psa_status_t status;
2720
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002721 /* Sanity checks on block_size, to guarantee that there won't be a buffer
2722 * overflow below. This should never trigger if the hash algorithm
2723 * is implemented correctly. */
2724 /* The size checks against the ipad and opad buffers cannot be written
2725 * `block_size > sizeof( ipad ) || block_size > sizeof( hmac->opad )`
2726 * because that triggers -Wlogical-op on GCC 7.3. */
2727 if( block_size > sizeof( ipad ) )
2728 return( PSA_ERROR_NOT_SUPPORTED );
2729 if( block_size > sizeof( hmac->opad ) )
2730 return( PSA_ERROR_NOT_SUPPORTED );
2731 if( block_size < hash_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002732 return( PSA_ERROR_NOT_SUPPORTED );
2733
Gilles Peskined223b522018-06-11 18:12:58 +02002734 if( key_length > block_size )
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002735 {
Gilles Peskine84b8fc82019-11-28 20:07:20 +01002736 status = psa_hash_compute( hash_alg, key, key_length,
2737 ipad, sizeof( ipad ), &key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002738 if( status != PSA_SUCCESS )
Gilles Peskineb8be2882018-07-17 16:24:34 +02002739 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002740 }
Gilles Peskine96889972018-07-12 17:07:03 +02002741 /* A 0-length key is not commonly used in HMAC when used as a MAC,
2742 * but it is permitted. It is common when HMAC is used in HKDF, for
2743 * example. Don't call `memcpy` in the 0-length because `key` could be
2744 * an invalid pointer which would make the behavior undefined. */
2745 else if( key_length != 0 )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002746 memcpy( ipad, key, key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002747
Gilles Peskined223b522018-06-11 18:12:58 +02002748 /* ipad contains the key followed by garbage. Xor and fill with 0x36
2749 * to create the ipad value. */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002750 for( i = 0; i < key_length; i++ )
Gilles Peskined223b522018-06-11 18:12:58 +02002751 ipad[i] ^= 0x36;
2752 memset( ipad + key_length, 0x36, block_size - key_length );
2753
2754 /* Copy the key material from ipad to opad, flipping the requisite bits,
2755 * and filling the rest of opad with the requisite constant. */
2756 for( i = 0; i < key_length; i++ )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002757 hmac->opad[i] = ipad[i] ^ 0x36 ^ 0x5C;
2758 memset( hmac->opad + key_length, 0x5C, block_size - key_length );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002759
Gilles Peskine01126fa2018-07-12 17:04:55 +02002760 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002761 if( status != PSA_SUCCESS )
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002762 goto cleanup;
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002763
Gilles Peskine01126fa2018-07-12 17:04:55 +02002764 status = psa_hash_update( &hmac->hash_ctx, ipad, block_size );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002765
2766cleanup:
Steven Cooreman29149862020-08-05 15:43:42 +02002767 mbedtls_platform_zeroize( ipad, sizeof( ipad ) );
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002768
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002769 return( status );
2770}
John Durkop6ba40d12020-11-10 08:50:04 -08002771#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002772
Gilles Peskine89167cb2018-07-08 20:12:23 +02002773static psa_status_t psa_mac_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002774 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002775 psa_algorithm_t alg,
2776 int is_sign )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002778 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002779 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01002780 psa_key_slot_t *slot;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002781 size_t key_bits;
Gilles Peskine89167cb2018-07-08 20:12:23 +02002782 psa_key_usage_t usage =
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01002783 is_sign ? PSA_KEY_USAGE_SIGN_HASH : PSA_KEY_USAGE_VERIFY_HASH;
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002784 uint8_t truncated = PSA_MAC_TRUNCATED_LENGTH( alg );
Gilles Peskinee0e9c7c2018-10-17 18:28:05 +02002785 psa_algorithm_t full_length_alg = PSA_ALG_FULL_LENGTH_MAC( alg );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002786
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002787 /* A context must be freshly initialized before it can be set up. */
2788 if( operation->alg != 0 )
2789 {
2790 return( PSA_ERROR_BAD_STATE );
2791 }
2792
Gilles Peskined911eb72018-08-14 15:18:45 +02002793 status = psa_mac_init( operation, full_length_alg );
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002794 if( status != PSA_SUCCESS )
2795 return( status );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002796 if( is_sign )
2797 operation->is_sign = 1;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002798
Ronald Cron5c522922020-11-14 16:35:34 +01002799 status = psa_get_and_lock_transparent_key_slot_with_policy(
2800 key, &slot, usage, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02002801 if( status != PSA_SUCCESS )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002802 goto exit;
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02002803 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002804
Gilles Peskine8c9def32018-02-08 10:02:12 +01002805#if defined(MBEDTLS_CMAC_C)
Gilles Peskined911eb72018-08-14 15:18:45 +02002806 if( full_length_alg == PSA_ALG_CMAC )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002807 {
2808 const mbedtls_cipher_info_t *cipher_info =
Gilles Peskined911eb72018-08-14 15:18:45 +02002809 mbedtls_cipher_info_from_psa( full_length_alg,
Gilles Peskine8e338702019-07-30 20:06:31 +02002810 slot->attr.type, key_bits, NULL );
Janos Follath24eed8d2019-11-22 13:21:35 +00002811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002812 if( cipher_info == NULL )
2813 {
2814 status = PSA_ERROR_NOT_SUPPORTED;
2815 goto exit;
2816 }
2817 operation->mac_size = cipher_info->block_size;
2818 ret = psa_cmac_setup( operation, key_bits, slot, cipher_info );
2819 status = mbedtls_to_psa_error( ret );
2820 }
2821 else
Gilles Peskine8c9def32018-02-08 10:02:12 +01002822#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002823#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskined911eb72018-08-14 15:18:45 +02002824 if( PSA_ALG_IS_HMAC( full_length_alg ) )
Gilles Peskinefbfac682018-07-08 20:51:54 +02002825 {
Gilles Peskine00709fa2018-08-22 18:25:41 +02002826 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH( alg );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002827 if( hash_alg == 0 )
2828 {
2829 status = PSA_ERROR_NOT_SUPPORTED;
2830 goto exit;
2831 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002832
gabor-mezei-armcbcec212020-12-18 14:23:51 +01002833 operation->mac_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002834 /* Sanity check. This shouldn't fail on a valid configuration. */
2835 if( operation->mac_size == 0 ||
2836 operation->mac_size > sizeof( operation->ctx.hmac.opad ) )
2837 {
2838 status = PSA_ERROR_NOT_SUPPORTED;
2839 goto exit;
2840 }
2841
Gilles Peskine8e338702019-07-30 20:06:31 +02002842 if( slot->attr.type != PSA_KEY_TYPE_HMAC )
Gilles Peskine01126fa2018-07-12 17:04:55 +02002843 {
2844 status = PSA_ERROR_INVALID_ARGUMENT;
2845 goto exit;
2846 }
Gilles Peskine9aa369e2018-07-16 00:36:29 +02002847
Gilles Peskine01126fa2018-07-12 17:04:55 +02002848 status = psa_hmac_setup_internal( &operation->ctx.hmac,
Ronald Cronea0f8a62020-11-25 17:52:23 +01002849 slot->key.data,
2850 slot->key.bytes,
Gilles Peskine01126fa2018-07-12 17:04:55 +02002851 hash_alg );
Gilles Peskinefbfac682018-07-08 20:51:54 +02002852 }
2853 else
John Durkopd0321952020-10-29 21:37:36 -07002854#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002855 {
Jaeden Amero82df32e2018-11-23 15:11:20 +00002856 (void) key_bits;
Gilles Peskinefbfac682018-07-08 20:51:54 +02002857 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002858 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002859
Gilles Peskined911eb72018-08-14 15:18:45 +02002860 if( truncated == 0 )
2861 {
2862 /* The "normal" case: untruncated algorithm. Nothing to do. */
2863 }
2864 else if( truncated < 4 )
2865 {
Gilles Peskine6d72ff92018-08-21 14:55:08 +02002866 /* A very short MAC is too short for security since it can be
2867 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2868 * so we make this our minimum, even though 32 bits is still
2869 * too small for security. */
Gilles Peskined911eb72018-08-14 15:18:45 +02002870 status = PSA_ERROR_NOT_SUPPORTED;
2871 }
2872 else if( truncated > operation->mac_size )
2873 {
2874 /* It's impossible to "truncate" to a larger length. */
2875 status = PSA_ERROR_INVALID_ARGUMENT;
2876 }
2877 else
2878 operation->mac_size = truncated;
2879
Gilles Peskinefbfac682018-07-08 20:51:54 +02002880exit:
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002881 if( status != PSA_SUCCESS )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002882 {
Gilles Peskine6a0a44e2018-06-11 17:42:48 +02002883 psa_mac_abort( operation );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002884 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002885 else
2886 {
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002887 operation->key_set = 1;
2888 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002889
Ronald Cron5c522922020-11-14 16:35:34 +01002890 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02002891
Ronald Cron5c522922020-11-14 16:35:34 +01002892 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002893}
2894
Gilles Peskine89167cb2018-07-08 20:12:23 +02002895psa_status_t psa_mac_sign_setup( psa_mac_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002896 mbedtls_svc_key_id_t key,
Gilles Peskine89167cb2018-07-08 20:12:23 +02002897 psa_algorithm_t alg )
2898{
Ronald Croncf56a0a2020-08-04 09:51:30 +02002899 return( psa_mac_setup( operation, key, alg, 1 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002900}
2901
2902psa_status_t psa_mac_verify_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, 0 ) );
Gilles Peskine89167cb2018-07-08 20:12:23 +02002907}
2908
Gilles Peskine8c9def32018-02-08 10:02:12 +01002909psa_status_t psa_mac_update( psa_mac_operation_t *operation,
2910 const uint8_t *input,
2911 size_t input_length )
2912{
Gilles Peskinefbfac682018-07-08 20:51:54 +02002913 psa_status_t status = PSA_ERROR_BAD_STATE;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002914 if( ! operation->key_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002915 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002916 if( operation->iv_required && ! operation->iv_set )
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002917 return( PSA_ERROR_BAD_STATE );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002918 operation->has_input = 1;
2919
Gilles Peskine8c9def32018-02-08 10:02:12 +01002920#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002921 if( operation->alg == PSA_ALG_CMAC )
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002922 {
Gilles Peskinefbfac682018-07-08 20:51:54 +02002923 int ret = mbedtls_cipher_cmac_update( &operation->ctx.cmac,
2924 input, input_length );
2925 status = mbedtls_to_psa_error( ret );
2926 }
2927 else
2928#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07002929#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02002930 if( PSA_ALG_IS_HMAC( operation->alg ) )
2931 {
2932 status = psa_hash_update( &operation->ctx.hmac.hash_ctx, input,
2933 input_length );
2934 }
2935 else
John Durkopd0321952020-10-29 21:37:36 -07002936#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02002937 {
2938 /* This shouldn't happen if `operation` was initialized by
2939 * a setup function. */
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00002940 return( PSA_ERROR_BAD_STATE );
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002941 }
2942
Gilles Peskinefbfac682018-07-08 20:51:54 +02002943 if( status != PSA_SUCCESS )
2944 psa_mac_abort( operation );
Gilles Peskinec1bb6c82018-06-18 16:04:39 +02002945 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01002946}
2947
John Durkop6ba40d12020-11-10 08:50:04 -08002948#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskine01126fa2018-07-12 17:04:55 +02002949static psa_status_t psa_hmac_finish_internal( psa_hmac_internal_data *hmac,
2950 uint8_t *mac,
2951 size_t mac_size )
2952{
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02002953 uint8_t tmp[MBEDTLS_MD_MAX_SIZE];
Gilles Peskine01126fa2018-07-12 17:04:55 +02002954 psa_algorithm_t hash_alg = hmac->hash_ctx.alg;
2955 size_t hash_size = 0;
2956 size_t block_size = psa_get_hash_block_size( hash_alg );
2957 psa_status_t status;
2958
Gilles Peskine01126fa2018-07-12 17:04:55 +02002959 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2960 if( status != PSA_SUCCESS )
2961 return( status );
2962 /* From here on, tmp needs to be wiped. */
2963
2964 status = psa_hash_setup( &hmac->hash_ctx, hash_alg );
2965 if( status != PSA_SUCCESS )
2966 goto exit;
2967
2968 status = psa_hash_update( &hmac->hash_ctx, hmac->opad, block_size );
2969 if( status != PSA_SUCCESS )
2970 goto exit;
2971
2972 status = psa_hash_update( &hmac->hash_ctx, tmp, hash_size );
2973 if( status != PSA_SUCCESS )
2974 goto exit;
2975
Gilles Peskined911eb72018-08-14 15:18:45 +02002976 status = psa_hash_finish( &hmac->hash_ctx, tmp, sizeof( tmp ), &hash_size );
2977 if( status != PSA_SUCCESS )
2978 goto exit;
2979
2980 memcpy( mac, tmp, mac_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002981
2982exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01002983 mbedtls_platform_zeroize( tmp, hash_size );
Gilles Peskine01126fa2018-07-12 17:04:55 +02002984 return( status );
2985}
John Durkop6ba40d12020-11-10 08:50:04 -08002986#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskine01126fa2018-07-12 17:04:55 +02002987
mohammad16036df908f2018-04-02 08:34:15 -07002988static psa_status_t psa_mac_finish_internal( psa_mac_operation_t *operation,
Gilles Peskine2d277862018-06-18 15:41:12 +02002989 uint8_t *mac,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002990 size_t mac_size )
Gilles Peskine8c9def32018-02-08 10:02:12 +01002991{
Gilles Peskine1d96fff2018-07-02 12:15:39 +02002992 if( ! operation->key_set )
2993 return( PSA_ERROR_BAD_STATE );
2994 if( operation->iv_required && ! operation->iv_set )
2995 return( PSA_ERROR_BAD_STATE );
2996
Gilles Peskine8c9def32018-02-08 10:02:12 +01002997 if( mac_size < operation->mac_size )
2998 return( PSA_ERROR_BUFFER_TOO_SMALL );
2999
Gilles Peskine8c9def32018-02-08 10:02:12 +01003000#if defined(MBEDTLS_CMAC_C)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003001 if( operation->alg == PSA_ALG_CMAC )
3002 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003003 uint8_t tmp[PSA_BLOCK_CIPHER_BLOCK_MAX_SIZE];
Gilles Peskined911eb72018-08-14 15:18:45 +02003004 int ret = mbedtls_cipher_cmac_finish( &operation->ctx.cmac, tmp );
3005 if( ret == 0 )
Gilles Peskine87b0ac42018-08-21 14:55:49 +02003006 memcpy( mac, tmp, operation->mac_size );
Gilles Peskine3f108122018-12-07 18:14:53 +01003007 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003008 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003009 }
Gilles Peskinefbfac682018-07-08 20:51:54 +02003010 else
3011#endif /* MBEDTLS_CMAC_C */
John Durkopd0321952020-10-29 21:37:36 -07003012#if defined(MBEDTLS_PSA_BUILTIN_ALG_HMAC)
Gilles Peskinefbfac682018-07-08 20:51:54 +02003013 if( PSA_ALG_IS_HMAC( operation->alg ) )
3014 {
Gilles Peskine01126fa2018-07-12 17:04:55 +02003015 return( psa_hmac_finish_internal( &operation->ctx.hmac,
Gilles Peskined911eb72018-08-14 15:18:45 +02003016 mac, operation->mac_size ) );
Gilles Peskinefbfac682018-07-08 20:51:54 +02003017 }
3018 else
John Durkopd0321952020-10-29 21:37:36 -07003019#endif /* MBEDTLS_PSA_BUILTIN_ALG_HMAC */
Gilles Peskinefbfac682018-07-08 20:51:54 +02003020 {
3021 /* This shouldn't happen if `operation` was initialized by
3022 * a setup function. */
3023 return( PSA_ERROR_BAD_STATE );
3024 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01003025}
3026
Gilles Peskineacd4be32018-07-08 19:56:25 +02003027psa_status_t psa_mac_sign_finish( psa_mac_operation_t *operation,
3028 uint8_t *mac,
3029 size_t mac_size,
3030 size_t *mac_length )
mohammad16036df908f2018-04-02 08:34:15 -07003031{
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003032 psa_status_t status;
3033
Jaeden Amero252ef282019-02-15 14:05:35 +00003034 if( operation->alg == 0 )
3035 {
3036 return( PSA_ERROR_BAD_STATE );
3037 }
3038
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003039 /* Fill the output buffer with something that isn't a valid mac
3040 * (barring an attack on the mac and deliberately-crafted input),
3041 * in case the caller doesn't check the return status properly. */
3042 *mac_length = mac_size;
3043 /* If mac_size is 0 then mac may be NULL and then the
3044 * call to memset would have undefined behavior. */
3045 if( mac_size != 0 )
3046 memset( mac, '!', mac_size );
3047
Gilles Peskine89167cb2018-07-08 20:12:23 +02003048 if( ! operation->is_sign )
3049 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003050 return( PSA_ERROR_BAD_STATE );
Gilles Peskine89167cb2018-07-08 20:12:23 +02003051 }
mohammad16036df908f2018-04-02 08:34:15 -07003052
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003053 status = psa_mac_finish_internal( operation, mac, mac_size );
3054
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003055 if( status == PSA_SUCCESS )
3056 {
3057 status = psa_mac_abort( operation );
3058 if( status == PSA_SUCCESS )
3059 *mac_length = operation->mac_size;
3060 else
3061 memset( mac, '!', mac_size );
3062 }
3063 else
3064 psa_mac_abort( operation );
3065 return( status );
mohammad16036df908f2018-04-02 08:34:15 -07003066}
3067
Gilles Peskineacd4be32018-07-08 19:56:25 +02003068psa_status_t psa_mac_verify_finish( psa_mac_operation_t *operation,
3069 const uint8_t *mac,
3070 size_t mac_length )
Gilles Peskine8c9def32018-02-08 10:02:12 +01003071{
Gilles Peskine828ed142018-06-18 23:25:51 +02003072 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
mohammad16036df908f2018-04-02 08:34:15 -07003073 psa_status_t status;
3074
Jaeden Amero252ef282019-02-15 14:05:35 +00003075 if( operation->alg == 0 )
3076 {
3077 return( PSA_ERROR_BAD_STATE );
3078 }
3079
Gilles Peskine89167cb2018-07-08 20:12:23 +02003080 if( operation->is_sign )
3081 {
Jaeden Ameroe236c2a2019-02-20 15:37:15 +00003082 return( PSA_ERROR_BAD_STATE );
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003083 }
3084 if( operation->mac_size != mac_length )
3085 {
3086 status = PSA_ERROR_INVALID_SIGNATURE;
3087 goto cleanup;
Gilles Peskine89167cb2018-07-08 20:12:23 +02003088 }
mohammad16036df908f2018-04-02 08:34:15 -07003089
3090 status = psa_mac_finish_internal( operation,
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003091 actual_mac, sizeof( actual_mac ) );
Gilles Peskine28cd4162020-01-20 16:31:06 +01003092 if( status != PSA_SUCCESS )
3093 goto cleanup;
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003094
3095 if( safer_memcmp( mac, actual_mac, mac_length ) != 0 )
3096 status = PSA_ERROR_INVALID_SIGNATURE;
3097
3098cleanup:
3099 if( status == PSA_SUCCESS )
3100 status = psa_mac_abort( operation );
3101 else
3102 psa_mac_abort( operation );
3103
Gilles Peskine3f108122018-12-07 18:14:53 +01003104 mbedtls_platform_zeroize( actual_mac, sizeof( actual_mac ) );
Gilles Peskined911eb72018-08-14 15:18:45 +02003105
Gilles Peskine5d0b8642018-07-08 20:35:02 +02003106 return( status );
Gilles Peskine8c9def32018-02-08 10:02:12 +01003107}
3108
3109
Gilles Peskine20035e32018-02-03 22:44:14 +01003110
Gilles Peskine20035e32018-02-03 22:44:14 +01003111/****************************************************************/
3112/* Asymmetric cryptography */
3113/****************************************************************/
3114
John Durkop6ba40d12020-11-10 08:50:04 -08003115#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3116 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003117/* Decode the hash algorithm from alg and store the mbedtls encoding in
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003118 * md_alg. Verify that the hash length is acceptable. */
Gilles Peskine8b18a4f2018-06-08 16:34:46 +02003119static psa_status_t psa_rsa_decode_md_type( psa_algorithm_t alg,
3120 size_t hash_length,
3121 mbedtls_md_type_t *md_alg )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003122{
Gilles Peskine7ed29c52018-06-26 15:50:08 +02003123 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003124 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003125 *md_alg = mbedtls_md_get_type( md_info );
3126
3127 /* The Mbed TLS RSA module uses an unsigned int for hash length
3128 * parameters. Validate that it fits so that we don't risk an
3129 * overflow later. */
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003130#if SIZE_MAX > UINT_MAX
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003131 if( hash_length > UINT_MAX )
3132 return( PSA_ERROR_INVALID_ARGUMENT );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003133#endif
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003134
John Durkop0e005192020-10-31 22:06:54 -07003135#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003136 /* For PKCS#1 v1.5 signature, if using a hash, the hash length
3137 * must be correct. */
3138 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) &&
3139 alg != PSA_ALG_RSA_PKCS1V15_SIGN_RAW )
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003140 {
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003141 if( md_info == NULL )
3142 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine61b91d42018-06-08 16:09:36 +02003143 if( mbedtls_md_get_size( md_info ) != hash_length )
3144 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003145 }
John Durkop0e005192020-10-31 22:06:54 -07003146#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003147
John Durkop0e005192020-10-31 22:06:54 -07003148#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003149 /* PSS requires a hash internally. */
3150 if( PSA_ALG_IS_RSA_PSS( alg ) )
3151 {
Gilles Peskine61b91d42018-06-08 16:09:36 +02003152 if( md_info == NULL )
3153 return( PSA_ERROR_NOT_SUPPORTED );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003154 }
John Durkop0e005192020-10-31 22:06:54 -07003155#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003156
Gilles Peskine61b91d42018-06-08 16:09:36 +02003157 return( PSA_SUCCESS );
Nir Sonnenschein4db79eb2018-06-04 16:40:31 +03003158}
3159
Gilles Peskine2b450e32018-06-27 15:42:46 +02003160static psa_status_t psa_rsa_sign( mbedtls_rsa_context *rsa,
3161 psa_algorithm_t alg,
3162 const uint8_t *hash,
3163 size_t hash_length,
3164 uint8_t *signature,
3165 size_t signature_size,
3166 size_t *signature_length )
3167{
3168 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003170 mbedtls_md_type_t md_alg;
3171
3172 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3173 if( status != PSA_SUCCESS )
3174 return( status );
3175
Gilles Peskine630a18a2018-06-29 17:49:35 +02003176 if( signature_size < mbedtls_rsa_get_len( rsa ) )
Gilles Peskine2b450e32018-06-27 15:42:46 +02003177 return( PSA_ERROR_BUFFER_TOO_SMALL );
3178
John Durkop0e005192020-10-31 22:06:54 -07003179#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003180 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3181 {
3182 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3183 MBEDTLS_MD_NONE );
3184 ret = mbedtls_rsa_pkcs1_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003185 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003186 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003187 MBEDTLS_RSA_PRIVATE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003188 md_alg,
3189 (unsigned int) hash_length,
3190 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003191 signature );
3192 }
3193 else
John Durkop0e005192020-10-31 22:06:54 -07003194#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3195#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003196 if( PSA_ALG_IS_RSA_PSS( alg ) )
3197 {
3198 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3199 ret = mbedtls_rsa_rsassa_pss_sign( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003200 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003201 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003202 MBEDTLS_RSA_PRIVATE,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003203 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003204 (unsigned int) hash_length,
3205 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003206 signature );
3207 }
3208 else
John Durkop0e005192020-10-31 22:06:54 -07003209#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003210 {
3211 return( PSA_ERROR_INVALID_ARGUMENT );
3212 }
3213
3214 if( ret == 0 )
Gilles Peskine630a18a2018-06-29 17:49:35 +02003215 *signature_length = mbedtls_rsa_get_len( rsa );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003216 return( mbedtls_to_psa_error( ret ) );
3217}
3218
3219static psa_status_t psa_rsa_verify( mbedtls_rsa_context *rsa,
3220 psa_algorithm_t alg,
3221 const uint8_t *hash,
3222 size_t hash_length,
3223 const uint8_t *signature,
3224 size_t signature_length )
3225{
3226 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00003227 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003228 mbedtls_md_type_t md_alg;
3229
3230 status = psa_rsa_decode_md_type( alg, hash_length, &md_alg );
3231 if( status != PSA_SUCCESS )
3232 return( status );
3233
Gilles Peskine89cc74f2019-09-12 22:08:23 +02003234 if( signature_length != mbedtls_rsa_get_len( rsa ) )
3235 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003236
John Durkop0e005192020-10-31 22:06:54 -07003237#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003238 if( PSA_ALG_IS_RSA_PKCS1V15_SIGN( alg ) )
3239 {
3240 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V15,
3241 MBEDTLS_MD_NONE );
3242 ret = mbedtls_rsa_pkcs1_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003243 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003244 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003245 MBEDTLS_RSA_PUBLIC,
3246 md_alg,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003247 (unsigned int) hash_length,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003248 hash,
3249 signature );
3250 }
3251 else
John Durkop0e005192020-10-31 22:06:54 -07003252#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN */
3253#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine2b450e32018-06-27 15:42:46 +02003254 if( PSA_ALG_IS_RSA_PSS( alg ) )
3255 {
3256 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3257 ret = mbedtls_rsa_rsassa_pss_verify( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003258 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003259 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003260 MBEDTLS_RSA_PUBLIC,
Gilles Peskine71ac7b12018-06-29 23:36:35 +02003261 MBEDTLS_MD_NONE,
Jaeden Amerobbf97e32018-06-26 14:20:51 +01003262 (unsigned int) hash_length,
3263 hash,
Gilles Peskine2b450e32018-06-27 15:42:46 +02003264 signature );
3265 }
3266 else
John Durkop0e005192020-10-31 22:06:54 -07003267#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003268 {
3269 return( PSA_ERROR_INVALID_ARGUMENT );
3270 }
Gilles Peskineef12c632018-09-13 20:37:48 +02003271
3272 /* Mbed TLS distinguishes "invalid padding" from "valid padding but
3273 * the rest of the signature is invalid". This has little use in
3274 * practice and PSA doesn't report this distinction. */
3275 if( ret == MBEDTLS_ERR_RSA_INVALID_PADDING )
3276 return( PSA_ERROR_INVALID_SIGNATURE );
Gilles Peskine2b450e32018-06-27 15:42:46 +02003277 return( mbedtls_to_psa_error( ret ) );
3278}
John Durkop6ba40d12020-11-10 08:50:04 -08003279#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3280 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine2b450e32018-06-27 15:42:46 +02003281
John Durkop6ba40d12020-11-10 08:50:04 -08003282#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3283 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003284/* `ecp` cannot be const because `ecp->grp` needs to be non-const
3285 * for mbedtls_ecdsa_sign() and mbedtls_ecdsa_sign_det()
3286 * (even though these functions don't modify it). */
3287static psa_status_t psa_ecdsa_sign( mbedtls_ecp_keypair *ecp,
3288 psa_algorithm_t alg,
3289 const uint8_t *hash,
3290 size_t hash_length,
3291 uint8_t *signature,
3292 size_t signature_size,
3293 size_t *signature_length )
3294{
Janos Follath24eed8d2019-11-22 13:21:35 +00003295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003296 mbedtls_mpi r, s;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003297 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003298 mbedtls_mpi_init( &r );
3299 mbedtls_mpi_init( &s );
3300
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003301 if( signature_size < 2 * curve_bytes )
3302 {
3303 ret = MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL;
3304 goto cleanup;
3305 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003306
John Durkop0ea39e02020-10-13 19:58:20 -07003307#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003308 if( PSA_ALG_DSA_IS_DETERMINISTIC( alg ) )
3309 {
3310 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH( alg );
3311 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3312 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
Darryl Green5e843fa2019-09-05 14:06:34 +01003313 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign_det_ext( &ecp->grp, &r, &s,
3314 &ecp->d, hash,
3315 hash_length, md_alg,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003316 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003317 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003318 }
3319 else
John Durkop0ea39e02020-10-13 19:58:20 -07003320#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003321 {
Gilles Peskinea05219c2018-11-16 16:02:56 +01003322 (void) alg;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003323 MBEDTLS_MPI_CHK( mbedtls_ecdsa_sign( &ecp->grp, &r, &s, &ecp->d,
3324 hash, hash_length,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003325 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003326 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003327 }
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003328
3329 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &r,
3330 signature,
3331 curve_bytes ) );
3332 MBEDTLS_MPI_CHK( mbedtls_mpi_write_binary( &s,
3333 signature + curve_bytes,
3334 curve_bytes ) );
3335
3336cleanup:
3337 mbedtls_mpi_free( &r );
3338 mbedtls_mpi_free( &s );
3339 if( ret == 0 )
3340 *signature_length = 2 * curve_bytes;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003341 return( mbedtls_to_psa_error( ret ) );
3342}
3343
3344static psa_status_t psa_ecdsa_verify( mbedtls_ecp_keypair *ecp,
3345 const uint8_t *hash,
3346 size_t hash_length,
3347 const uint8_t *signature,
3348 size_t signature_length )
3349{
Janos Follath24eed8d2019-11-22 13:21:35 +00003350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003351 mbedtls_mpi r, s;
3352 size_t curve_bytes = PSA_BITS_TO_BYTES( ecp->grp.pbits );
3353 mbedtls_mpi_init( &r );
3354 mbedtls_mpi_init( &s );
3355
3356 if( signature_length != 2 * curve_bytes )
3357 return( PSA_ERROR_INVALID_SIGNATURE );
3358
3359 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &r,
3360 signature,
3361 curve_bytes ) );
3362 MBEDTLS_MPI_CHK( mbedtls_mpi_read_binary( &s,
3363 signature + curve_bytes,
3364 curve_bytes ) );
3365
Steven Cooremanacda8342020-07-24 23:09:52 +02003366 /* Check whether the public part is loaded. If not, load it. */
3367 if( mbedtls_ecp_is_zero( &ecp->Q ) )
3368 {
3369 MBEDTLS_MPI_CHK(
3370 mbedtls_ecp_mul( &ecp->grp, &ecp->Q, &ecp->d, &ecp->grp.G,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003371 mbedtls_psa_get_random, MBEDTLS_PSA_RANDOM_STATE ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02003372 }
3373
Gilles Peskineeae6eee2018-06-28 13:56:01 +02003374 ret = mbedtls_ecdsa_verify( &ecp->grp, hash, hash_length,
3375 &ecp->Q, &r, &s );
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003376
3377cleanup:
3378 mbedtls_mpi_free( &r );
3379 mbedtls_mpi_free( &s );
3380 return( mbedtls_to_psa_error( ret ) );
3381}
John Durkop6ba40d12020-11-10 08:50:04 -08003382#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3383 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003384
Ronald Croncf56a0a2020-08-04 09:51:30 +02003385psa_status_t psa_sign_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003386 psa_algorithm_t alg,
3387 const uint8_t *hash,
3388 size_t hash_length,
3389 uint8_t *signature,
3390 size_t signature_size,
3391 size_t *signature_length )
Gilles Peskine20035e32018-02-03 22:44:14 +01003392{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003393 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003394 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003395 psa_key_slot_t *slot;
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003396
3397 *signature_length = signature_size;
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003398 /* Immediately reject a zero-length signature buffer. This guarantees
3399 * that signature must be a valid pointer. (On the other hand, the hash
3400 * buffer can in principle be empty since it doesn't actually have
3401 * to be a hash.) */
3402 if( signature_size == 0 )
3403 return( PSA_ERROR_BUFFER_TOO_SMALL );
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003404
Ronald Cron5c522922020-11-14 16:35:34 +01003405 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3406 PSA_KEY_USAGE_SIGN_HASH,
3407 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003408 if( status != PSA_SUCCESS )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003409 goto exit;
Gilles Peskine8e338702019-07-30 20:06:31 +02003410 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003411 {
3412 status = PSA_ERROR_INVALID_ARGUMENT;
3413 goto exit;
3414 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003415
Steven Cooremancd84cb42020-07-16 20:28:36 +02003416 /* Try any of the available accelerators first */
3417 status = psa_driver_wrapper_sign_hash( slot,
3418 alg,
3419 hash,
3420 hash_length,
3421 signature,
3422 signature_size,
3423 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003424 if( status != PSA_ERROR_NOT_SUPPORTED ||
3425 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Steven Cooremancd84cb42020-07-16 20:28:36 +02003426 goto exit;
3427
Steven Cooreman7a250572020-07-17 16:43:05 +02003428 /* If the operation was not supported by any accelerator, try fallback. */
John Durkop6ba40d12020-11-10 08:50:04 -08003429#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3430 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003431 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskine20035e32018-02-03 22:44:14 +01003432 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003433 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003434
Ronald Cron90857082020-11-25 14:58:33 +01003435 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3436 slot->key.data,
3437 slot->key.bytes,
3438 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003439 if( status != PSA_SUCCESS )
3440 goto exit;
3441
Steven Cooremana2371e52020-07-28 14:30:39 +02003442 status = psa_rsa_sign( rsa,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003443 alg,
3444 hash, hash_length,
3445 signature, signature_size,
3446 signature_length );
Steven Cooremana01795d2020-07-24 22:48:15 +02003447
Steven Cooremana2371e52020-07-28 14:30:39 +02003448 mbedtls_rsa_free( rsa );
3449 mbedtls_free( rsa );
Gilles Peskine20035e32018-02-03 22:44:14 +01003450 }
3451 else
John Durkop6ba40d12020-11-10 08:50:04 -08003452#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3453 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003454 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
Gilles Peskine20035e32018-02-03 22:44:14 +01003455 {
John Durkop9814fa22020-11-04 12:28:15 -08003456#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3457 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003458 if(
John Durkop0ea39e02020-10-13 19:58:20 -07003459#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea05219c2018-11-16 16:02:56 +01003460 PSA_ALG_IS_ECDSA( alg )
3461#else
3462 PSA_ALG_IS_RANDOMIZED_ECDSA( alg )
3463#endif
3464 )
Steven Cooremanacda8342020-07-24 23:09:52 +02003465 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003466 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003467 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3468 slot->key.data,
3469 slot->key.bytes,
3470 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003471 if( status != PSA_SUCCESS )
3472 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003473 status = psa_ecdsa_sign( ecp,
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003474 alg,
3475 hash, hash_length,
3476 signature, signature_size,
3477 signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003478 mbedtls_ecp_keypair_free( ecp );
3479 mbedtls_free( ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003480 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003481 else
John Durkop9814fa22020-11-04 12:28:15 -08003482#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3483 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003484 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003485 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003486 }
itayzafrir5c753392018-05-08 11:18:38 +03003487 }
3488 else
itayzafrir5c753392018-05-08 11:18:38 +03003489 {
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003490 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003491 }
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003492
3493exit:
3494 /* Fill the unused part of the output buffer (the whole buffer on error,
3495 * the trailing part on success) with something that isn't a valid mac
3496 * (barring an attack on the mac and deliberately-crafted input),
3497 * in case the caller doesn't check the return status properly. */
3498 if( status == PSA_SUCCESS )
3499 memset( signature + *signature_length, '!',
3500 signature_size - *signature_length );
Gilles Peskine4019f0e2019-09-12 22:05:59 +02003501 else
Gilles Peskinea26ff6a2018-06-28 12:21:19 +02003502 memset( signature, '!', signature_size );
Gilles Peskine46f1fd72018-06-28 19:31:31 +02003503 /* If signature_size is 0 then we have nothing to do. We must not call
3504 * memset because signature may be NULL in this case. */
Ronald Cronf95a2b12020-10-22 15:24:49 +02003505
Ronald Cron5c522922020-11-14 16:35:34 +01003506 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003507
Ronald Cron5c522922020-11-14 16:35:34 +01003508 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
itayzafrir5c753392018-05-08 11:18:38 +03003509}
3510
Ronald Croncf56a0a2020-08-04 09:51:30 +02003511psa_status_t psa_verify_hash( mbedtls_svc_key_id_t key,
Gilles Peskine89d8c5c2019-11-26 17:01:59 +01003512 psa_algorithm_t alg,
3513 const uint8_t *hash,
3514 size_t hash_length,
3515 const uint8_t *signature,
3516 size_t signature_length )
itayzafrir5c753392018-05-08 11:18:38 +03003517{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003518 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003519 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003520 psa_key_slot_t *slot;
Gilles Peskine2b450e32018-06-27 15:42:46 +02003521
Ronald Cron5c522922020-11-14 16:35:34 +01003522 status = psa_get_and_lock_key_slot_with_policy( key, &slot,
3523 PSA_KEY_USAGE_VERIFY_HASH,
3524 alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003525 if( status != PSA_SUCCESS )
3526 return( status );
itayzafrir5c753392018-05-08 11:18:38 +03003527
Steven Cooreman55ae2172020-07-17 19:46:15 +02003528 /* Try any of the available accelerators first */
3529 status = psa_driver_wrapper_verify_hash( slot,
3530 alg,
3531 hash,
3532 hash_length,
3533 signature,
3534 signature_length );
Steven Cooreman8d2bde72020-09-04 13:06:39 +02003535 if( status != PSA_ERROR_NOT_SUPPORTED ||
3536 psa_key_lifetime_is_external( slot->attr.lifetime ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003537 goto exit;
Steven Cooreman55ae2172020-07-17 19:46:15 +02003538
John Durkop6ba40d12020-11-10 08:50:04 -08003539#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
3540 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
Gilles Peskine8e338702019-07-30 20:06:31 +02003541 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003542 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003543 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02003544
Ronald Cron90857082020-11-25 14:58:33 +01003545 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3546 slot->key.data,
3547 slot->key.bytes,
3548 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003549 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003550 goto exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003551
Steven Cooremana2371e52020-07-28 14:30:39 +02003552 status = psa_rsa_verify( rsa,
Steven Cooremana01795d2020-07-24 22:48:15 +02003553 alg,
3554 hash, hash_length,
3555 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003556 mbedtls_rsa_free( rsa );
3557 mbedtls_free( rsa );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003558 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003559 }
3560 else
John Durkop6ba40d12020-11-10 08:50:04 -08003561#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3562 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine8e338702019-07-30 20:06:31 +02003563 if( PSA_KEY_TYPE_IS_ECC( slot->attr.type ) )
itayzafrir5c753392018-05-08 11:18:38 +03003564 {
John Durkop9814fa22020-11-04 12:28:15 -08003565#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3566 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003567 if( PSA_ALG_IS_ECDSA( alg ) )
Steven Cooremanacda8342020-07-24 23:09:52 +02003568 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003569 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003570 status = mbedtls_psa_ecp_load_representation( slot->attr.type,
3571 slot->key.data,
3572 slot->key.bytes,
3573 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02003574 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003575 goto exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003576 status = psa_ecdsa_verify( ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02003577 hash, hash_length,
3578 signature, signature_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02003579 mbedtls_ecp_keypair_free( ecp );
3580 mbedtls_free( ecp );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003581 goto exit;
Steven Cooremanacda8342020-07-24 23:09:52 +02003582 }
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003583 else
John Durkop9814fa22020-11-04 12:28:15 -08003584#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3585 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003586 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003587 status = PSA_ERROR_INVALID_ARGUMENT;
3588 goto exit;
Gilles Peskinea81d85b2018-06-26 16:10:23 +02003589 }
itayzafrir5c753392018-05-08 11:18:38 +03003590 }
Gilles Peskine20035e32018-02-03 22:44:14 +01003591 else
Gilles Peskine20035e32018-02-03 22:44:14 +01003592 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003593 status = PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine20035e32018-02-03 22:44:14 +01003594 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003595
3596exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003597 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003598
Ronald Cron5c522922020-11-14 16:35:34 +01003599 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine20035e32018-02-03 22:44:14 +01003600}
3601
John Durkop0e005192020-10-31 22:06:54 -07003602#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine072ac562018-06-30 00:21:29 +02003603static void psa_rsa_oaep_set_padding_mode( psa_algorithm_t alg,
3604 mbedtls_rsa_context *rsa )
3605{
3606 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH( alg );
3607 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa( hash_alg );
3608 mbedtls_md_type_t md_alg = mbedtls_md_get_type( md_info );
3609 mbedtls_rsa_set_padding( rsa, MBEDTLS_RSA_PKCS_V21, md_alg );
3610}
John Durkop0e005192020-10-31 22:06:54 -07003611#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003612
Ronald Croncf56a0a2020-08-04 09:51:30 +02003613psa_status_t psa_asymmetric_encrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003614 psa_algorithm_t alg,
3615 const uint8_t *input,
3616 size_t input_length,
3617 const uint8_t *salt,
3618 size_t salt_length,
3619 uint8_t *output,
3620 size_t output_size,
3621 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003622{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003624 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003625 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003626
Darryl Green5cc689a2018-07-24 15:34:10 +01003627 (void) input;
3628 (void) input_length;
3629 (void) salt;
3630 (void) output;
3631 (void) output_size;
3632
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003633 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003634
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003635 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3636 return( PSA_ERROR_INVALID_ARGUMENT );
3637
Ronald Cron5c522922020-11-14 16:35:34 +01003638 status = psa_get_and_lock_transparent_key_slot_with_policy(
3639 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003640 if( status != PSA_SUCCESS )
3641 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003642 if( ! ( PSA_KEY_TYPE_IS_PUBLIC_KEY( slot->attr.type ) ||
3643 PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003644 {
3645 status = PSA_ERROR_INVALID_ARGUMENT;
3646 goto exit;
3647 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003648
John Durkop6ba40d12020-11-10 08:50:04 -08003649#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3650 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003651 if( PSA_KEY_TYPE_IS_RSA( slot->attr.type ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003652 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003653 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003654 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3655 slot->key.data,
3656 slot->key.bytes,
3657 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003658 if( status != PSA_SUCCESS )
Steven Cooreman4fed4552020-08-03 14:46:03 +02003659 goto rsa_exit;
Steven Cooremana2371e52020-07-28 14:30:39 +02003660
3661 if( output_size < mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003662 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003663 status = PSA_ERROR_BUFFER_TOO_SMALL;
3664 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003665 }
John Durkop0e005192020-10-31 22:06:54 -07003666#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003667 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003668 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003669 status = mbedtls_to_psa_error(
3670 mbedtls_rsa_pkcs1_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003671 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003672 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003673 MBEDTLS_RSA_PUBLIC,
3674 input_length,
3675 input,
3676 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003677 }
3678 else
John Durkop0e005192020-10-31 22:06:54 -07003679#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3680#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003681 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003682 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003683 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003684 status = mbedtls_to_psa_error(
3685 mbedtls_rsa_rsaes_oaep_encrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003686 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003687 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003688 MBEDTLS_RSA_PUBLIC,
3689 salt, salt_length,
3690 input_length,
3691 input,
3692 output ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003693 }
3694 else
John Durkop0e005192020-10-31 22:06:54 -07003695#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003696 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003697 status = PSA_ERROR_INVALID_ARGUMENT;
3698 goto rsa_exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003699 }
Steven Cooreman4fed4552020-08-03 14:46:03 +02003700rsa_exit:
3701 if( status == PSA_SUCCESS )
Steven Cooremana2371e52020-07-28 14:30:39 +02003702 *output_length = mbedtls_rsa_get_len( rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003703
Steven Cooremana2371e52020-07-28 14:30:39 +02003704 mbedtls_rsa_free( rsa );
3705 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003706 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003707 else
John Durkop9814fa22020-11-04 12:28:15 -08003708#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003709 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003710 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003711 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003712 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003713
3714exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003715 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003716
Ronald Cron5c522922020-11-14 16:35:34 +01003717 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003718}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003719
Ronald Croncf56a0a2020-08-04 09:51:30 +02003720psa_status_t psa_asymmetric_decrypt( mbedtls_svc_key_id_t key,
Gilles Peskine61b91d42018-06-08 16:09:36 +02003721 psa_algorithm_t alg,
3722 const uint8_t *input,
3723 size_t input_length,
3724 const uint8_t *salt,
3725 size_t salt_length,
3726 uint8_t *output,
3727 size_t output_size,
3728 size_t *output_length )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003729{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003730 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003731 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003732 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003733
Darryl Green5cc689a2018-07-24 15:34:10 +01003734 (void) input;
3735 (void) input_length;
3736 (void) salt;
3737 (void) output;
3738 (void) output_size;
3739
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003740 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003741
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003742 if( ! PSA_ALG_IS_RSA_OAEP( alg ) && salt_length != 0 )
3743 return( PSA_ERROR_INVALID_ARGUMENT );
3744
Ronald Cron5c522922020-11-14 16:35:34 +01003745 status = psa_get_and_lock_transparent_key_slot_with_policy(
3746 key, &slot, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003747 if( status != PSA_SUCCESS )
3748 return( status );
Gilles Peskine8e338702019-07-30 20:06:31 +02003749 if( ! PSA_KEY_TYPE_IS_KEY_PAIR( slot->attr.type ) )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003750 {
3751 status = PSA_ERROR_INVALID_ARGUMENT;
3752 goto exit;
3753 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003754
John Durkop6ba40d12020-11-10 08:50:04 -08003755#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
3756 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine8e338702019-07-30 20:06:31 +02003757 if( slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003758 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003759 mbedtls_rsa_context *rsa = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01003760 status = mbedtls_psa_rsa_load_representation( slot->attr.type,
3761 slot->key.data,
3762 slot->key.bytes,
3763 &rsa );
Steven Cooremana01795d2020-07-24 22:48:15 +02003764 if( status != PSA_SUCCESS )
Ronald Cronf95a2b12020-10-22 15:24:49 +02003765 goto exit;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003766
Steven Cooremana2371e52020-07-28 14:30:39 +02003767 if( input_length != mbedtls_rsa_get_len( rsa ) )
Steven Cooremana01795d2020-07-24 22:48:15 +02003768 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003769 status = PSA_ERROR_INVALID_ARGUMENT;
3770 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003771 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003772
John Durkop0e005192020-10-31 22:06:54 -07003773#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Gilles Peskine6afe7892018-05-31 13:16:08 +02003774 if( alg == PSA_ALG_RSA_PKCS1V15_CRYPT )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003775 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003776 status = mbedtls_to_psa_error(
3777 mbedtls_rsa_pkcs1_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003778 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003779 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003780 MBEDTLS_RSA_PRIVATE,
3781 output_length,
3782 input,
3783 output,
3784 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003785 }
3786 else
John Durkop0e005192020-10-31 22:06:54 -07003787#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
3788#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine55bf3d12018-06-26 15:53:48 +02003789 if( PSA_ALG_IS_RSA_OAEP( alg ) )
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003790 {
Steven Cooremana2371e52020-07-28 14:30:39 +02003791 psa_rsa_oaep_set_padding_mode( alg, rsa );
Steven Cooreman4fed4552020-08-03 14:46:03 +02003792 status = mbedtls_to_psa_error(
3793 mbedtls_rsa_rsaes_oaep_decrypt( rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01003794 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01003795 MBEDTLS_PSA_RANDOM_STATE,
Steven Cooreman4fed4552020-08-03 14:46:03 +02003796 MBEDTLS_RSA_PRIVATE,
3797 salt, salt_length,
3798 output_length,
3799 input,
3800 output,
3801 output_size ) );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003802 }
3803 else
John Durkop0e005192020-10-31 22:06:54 -07003804#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003805 {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003806 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003807 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003808
Steven Cooreman4fed4552020-08-03 14:46:03 +02003809rsa_exit:
Steven Cooremana2371e52020-07-28 14:30:39 +02003810 mbedtls_rsa_free( rsa );
3811 mbedtls_free( rsa );
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003812 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003813 else
John Durkop6ba40d12020-11-10 08:50:04 -08003814#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3815 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003816 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003817 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003818 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003819
3820exit:
Ronald Cron5c522922020-11-14 16:35:34 +01003821 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003822
Ronald Cron5c522922020-11-14 16:35:34 +01003823 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003824}
Gilles Peskine20035e32018-02-03 22:44:14 +01003825
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003826
3827
mohammad1603503973b2018-03-12 15:59:30 +02003828/****************************************************************/
3829/* Symmetric cryptography */
3830/****************************************************************/
3831
Gilles Peskinee553c652018-06-04 16:22:46 +02003832static psa_status_t psa_cipher_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003833 mbedtls_svc_key_id_t key,
Gilles Peskine7e928852018-06-04 16:23:10 +02003834 psa_algorithm_t alg,
3835 mbedtls_operation_t cipher_operation )
mohammad1603503973b2018-03-12 15:59:30 +02003836{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003837 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003838 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003839 int ret = 0;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003840 psa_key_slot_t *slot;
mohammad1603503973b2018-03-12 15:59:30 +02003841 size_t key_bits;
3842 const mbedtls_cipher_info_t *cipher_info = NULL;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003843 psa_key_usage_t usage = ( cipher_operation == MBEDTLS_ENCRYPT ?
3844 PSA_KEY_USAGE_ENCRYPT :
3845 PSA_KEY_USAGE_DECRYPT );
mohammad1603503973b2018-03-12 15:59:30 +02003846
Steven Cooremand3feccd2020-09-01 15:56:14 +02003847 /* A context must be freshly initialized before it can be set up. */
3848 if( operation->alg != 0 )
3849 return( PSA_ERROR_BAD_STATE );
3850
Steven Cooremana07b9972020-09-10 14:54:14 +02003851 /* The requested algorithm must be one that can be processed by cipher. */
3852 if( ! PSA_ALG_IS_CIPHER( alg ) )
Steven Cooremana07b9972020-09-10 14:54:14 +02003853 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremand3feccd2020-09-01 15:56:14 +02003854
Steven Cooremanef8575e2020-09-11 11:44:50 +02003855 /* Fetch key material from key storage. */
Ronald Cron5c522922020-11-14 16:35:34 +01003856 status = psa_get_and_lock_key_slot_with_policy( key, &slot, usage, alg );
Steven Cooremanef8575e2020-09-11 11:44:50 +02003857 if( status != PSA_SUCCESS )
3858 goto exit;
3859
3860 /* Initialize the operation struct members, except for alg. The alg member
3861 * is used to indicate to psa_cipher_abort that there are resources to free,
3862 * so we only set it after resources have been allocated/initialized. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003863 operation->key_set = 0;
3864 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003865 operation->mbedtls_in_use = 0;
Steven Cooremana07b9972020-09-10 14:54:14 +02003866 operation->iv_size = 0;
3867 operation->block_size = 0;
3868 if( alg == PSA_ALG_ECB_NO_PADDING )
3869 operation->iv_required = 0;
3870 else
3871 operation->iv_required = 1;
3872
Steven Cooremana07b9972020-09-10 14:54:14 +02003873 /* Try doing the operation through a driver before using software fallback. */
Steven Cooreman37941cb2020-07-28 18:49:51 +02003874 if( cipher_operation == MBEDTLS_ENCRYPT )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003875 status = psa_driver_wrapper_cipher_encrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003876 slot,
3877 alg );
3878 else
Steven Cooremanfb81aa52020-09-09 12:01:43 +02003879 status = psa_driver_wrapper_cipher_decrypt_setup( &operation->ctx.driver,
Steven Cooreman37941cb2020-07-28 18:49:51 +02003880 slot,
3881 alg );
3882
Steven Cooremanef8575e2020-09-11 11:44:50 +02003883 if( status == PSA_SUCCESS )
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003884 {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003885 /* Once the driver context is initialised, it needs to be freed using
3886 * psa_cipher_abort. Indicate this through setting alg. */
3887 operation->alg = alg;
Steven Cooreman6d81f7e2020-09-14 13:14:31 +02003888 }
Steven Cooremanef8575e2020-09-11 11:44:50 +02003889
Steven Cooremand3feccd2020-09-01 15:56:14 +02003890 if( status != PSA_ERROR_NOT_SUPPORTED ||
3891 psa_key_lifetime_is_external( slot->attr.lifetime ) )
3892 goto exit;
3893
Steven Cooremana07b9972020-09-10 14:54:14 +02003894 /* Proceed with initializing an mbed TLS cipher context if no driver is
Steven Cooremand3feccd2020-09-01 15:56:14 +02003895 * available for the given algorithm & key. */
3896 mbedtls_cipher_init( &operation->ctx.cipher );
mohammad1603503973b2018-03-12 15:59:30 +02003897
Steven Cooremana07b9972020-09-10 14:54:14 +02003898 /* Once the cipher context is initialised, it needs to be freed using
Steven Cooremanef8575e2020-09-11 11:44:50 +02003899 * psa_cipher_abort. Indicate there is something to be freed through setting
3900 * alg, and indicate the operation is being done using mbedtls crypto through
3901 * setting mbedtls_in_use. */
Steven Cooremana07b9972020-09-10 14:54:14 +02003902 operation->alg = alg;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003903 operation->mbedtls_in_use = 1;
Steven Cooremana07b9972020-09-10 14:54:14 +02003904
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02003905 key_bits = psa_get_key_slot_bits( slot );
Gilles Peskine8e338702019-07-30 20:06:31 +02003906 cipher_info = mbedtls_cipher_info_from_psa( alg, slot->attr.type, key_bits, NULL );
mohammad1603503973b2018-03-12 15:59:30 +02003907 if( cipher_info == NULL )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003908 {
3909 status = PSA_ERROR_NOT_SUPPORTED;
3910 goto exit;
3911 }
mohammad1603503973b2018-03-12 15:59:30 +02003912
mohammad1603503973b2018-03-12 15:59:30 +02003913 ret = mbedtls_cipher_setup( &operation->ctx.cipher, cipher_info );
Moran Peker41deec42018-04-04 15:43:05 +03003914 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003915 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003916
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003917#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02003918 if( slot->attr.type == PSA_KEY_TYPE_DES && key_bits == 128 )
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003919 {
3920 /* Two-key Triple-DES is 3-key Triple-DES with K1=K3 */
Gilles Peskinec11c4dc2019-07-15 11:06:38 +02003921 uint8_t keys[24];
Ronald Cronea0f8a62020-11-25 17:52:23 +01003922 memcpy( keys, slot->key.data, 16 );
3923 memcpy( keys + 16, slot->key.data, 8 );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003924 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
3925 keys,
3926 192, cipher_operation );
3927 }
3928 else
3929#endif
3930 {
3931 ret = mbedtls_cipher_setkey( &operation->ctx.cipher,
Ronald Cronea0f8a62020-11-25 17:52:23 +01003932 slot->key.data,
Jaeden Amero23bbb752018-06-26 14:16:54 +01003933 (int) key_bits, cipher_operation );
Gilles Peskine9ad29e22018-06-21 09:40:04 +02003934 }
Moran Peker41deec42018-04-04 15:43:05 +03003935 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003936 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02003937
mohammad16038481e742018-03-18 13:57:31 +02003938#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003939 switch( alg )
mohammad16038481e742018-03-18 13:57:31 +02003940 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003941 case PSA_ALG_CBC_NO_PADDING:
3942 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3943 MBEDTLS_PADDING_NONE );
3944 break;
3945 case PSA_ALG_CBC_PKCS7:
3946 ret = mbedtls_cipher_set_padding_mode( &operation->ctx.cipher,
3947 MBEDTLS_PADDING_PKCS7 );
3948 break;
3949 default:
3950 /* The algorithm doesn't involve padding. */
3951 ret = 0;
3952 break;
3953 }
3954 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003955 goto exit;
mohammad16038481e742018-03-18 13:57:31 +02003956#endif //MBEDTLS_CIPHER_MODE_WITH_PADDING
3957
Gilles Peskinedaea26f2018-08-21 14:02:45 +02003958 operation->block_size = ( PSA_ALG_IS_STREAM_CIPHER( alg ) ? 1 :
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003959 PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type ) );
Steven Cooremana6033e92020-08-25 11:47:50 +02003960 if( ( alg & PSA_ALG_CIPHER_FROM_BLOCK_FLAG ) != 0 &&
3961 alg != PSA_ALG_ECB_NO_PADDING )
mohammad16038481e742018-03-18 13:57:31 +02003962 {
gabor-mezei-armcbcec212020-12-18 14:23:51 +01003963 operation->iv_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( slot->attr.type );
mohammad16038481e742018-03-18 13:57:31 +02003964 }
Gilles Peskine26869f22019-05-06 15:25:00 +02003965#if defined(MBEDTLS_CHACHA20_C)
3966 else
Bence Szépkúticbe39532020-12-08 00:01:31 +01003967 if( alg == PSA_ALG_STREAM_CIPHER && slot->attr.type == PSA_KEY_TYPE_CHACHA20 )
Gilles Peskine26869f22019-05-06 15:25:00 +02003968 operation->iv_size = 12;
3969#endif
mohammad1603503973b2018-03-12 15:59:30 +02003970
Steven Cooreman7df02922020-09-09 15:28:49 +02003971 status = PSA_SUCCESS;
3972
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003973exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02003974 if( ret != 0 )
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003975 status = mbedtls_to_psa_error( ret );
Steven Cooreman7df02922020-09-09 15:28:49 +02003976 if( status == PSA_SUCCESS )
3977 {
3978 /* Update operation flags for both driver and software implementations */
3979 operation->key_set = 1;
3980 }
3981 else
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003982 psa_cipher_abort( operation );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003983
Ronald Cron5c522922020-11-14 16:35:34 +01003984 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02003985
Ronald Cron5c522922020-11-14 16:35:34 +01003986 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
mohammad1603503973b2018-03-12 15:59:30 +02003987}
3988
Gilles Peskinefe119512018-07-08 21:39:34 +02003989psa_status_t psa_cipher_encrypt_setup( psa_cipher_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003990 mbedtls_svc_key_id_t key,
Gilles Peskinefe119512018-07-08 21:39:34 +02003991 psa_algorithm_t alg )
mohammad16038481e742018-03-18 13:57:31 +02003992{
Ronald Croncf56a0a2020-08-04 09:51:30 +02003993 return( psa_cipher_setup( operation, key, alg, MBEDTLS_ENCRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02003994}
3995
Gilles Peskinefe119512018-07-08 21:39:34 +02003996psa_status_t psa_cipher_decrypt_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_DECRYPT ) );
mohammad16038481e742018-03-18 13:57:31 +02004001}
4002
Gilles Peskinefe119512018-07-08 21:39:34 +02004003psa_status_t psa_cipher_generate_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004004 uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004005 size_t iv_size,
4006 size_t *iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004007{
itayzafrir534bd7c2018-08-02 13:56:32 +03004008 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004009 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004010 if( operation->iv_set || ! operation->iv_required )
4011 {
4012 return( PSA_ERROR_BAD_STATE );
4013 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004014
Steven Cooremanef8575e2020-09-11 11:44:50 +02004015 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004016 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004017 status = psa_driver_wrapper_cipher_generate_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004018 iv,
4019 iv_size,
4020 iv_length );
4021 goto exit;
4022 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004023
Moran Peker41deec42018-04-04 15:43:05 +03004024 if( iv_size < operation->iv_size )
mohammad1603503973b2018-03-12 15:59:30 +02004025 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004026 status = PSA_ERROR_BUFFER_TOO_SMALL;
Moran Peker41deec42018-04-04 15:43:05 +03004027 goto exit;
4028 }
Gilles Peskine5894e8e2020-12-14 14:54:06 +01004029 ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskine30524eb2020-11-13 17:02:26 +01004030 iv, operation->iv_size );
Moran Peker41deec42018-04-04 15:43:05 +03004031 if( ret != 0 )
4032 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004033 status = mbedtls_to_psa_error( ret );
Gilles Peskinee553c652018-06-04 16:22:46 +02004034 goto exit;
mohammad1603503973b2018-03-12 15:59:30 +02004035 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004036
mohammad16038481e742018-03-18 13:57:31 +02004037 *iv_length = operation->iv_size;
itayzafrir534bd7c2018-08-02 13:56:32 +03004038 status = psa_cipher_set_iv( operation, iv, *iv_length );
Moran Peker41deec42018-04-04 15:43:05 +03004039
Moran Peker395db872018-05-31 14:07:14 +03004040exit:
Steven Cooreman7df02922020-09-09 15:28:49 +02004041 if( status == PSA_SUCCESS )
4042 operation->iv_set = 1;
4043 else
Moran Peker395db872018-05-31 14:07:14 +03004044 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004045 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004046}
4047
Gilles Peskinefe119512018-07-08 21:39:34 +02004048psa_status_t psa_cipher_set_iv( psa_cipher_operation_t *operation,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004049 const uint8_t *iv,
Gilles Peskinefe119512018-07-08 21:39:34 +02004050 size_t iv_length )
mohammad1603503973b2018-03-12 15:59:30 +02004051{
itayzafrir534bd7c2018-08-02 13:56:32 +03004052 psa_status_t status;
Janos Follath24eed8d2019-11-22 13:21:35 +00004053 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooreman7df02922020-09-09 15:28:49 +02004054 if( operation->iv_set || ! operation->iv_required )
4055 {
4056 return( PSA_ERROR_BAD_STATE );
4057 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004058
Steven Cooremanef8575e2020-09-11 11:44:50 +02004059 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004060 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004061 status = psa_driver_wrapper_cipher_set_iv( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004062 iv,
4063 iv_length );
4064 goto exit;
4065 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004066
Moran Pekera28258c2018-05-29 16:25:04 +03004067 if( iv_length != operation->iv_size )
Moran Peker71f19ae2018-04-22 20:23:16 +03004068 {
itayzafrir534bd7c2018-08-02 13:56:32 +03004069 status = PSA_ERROR_INVALID_ARGUMENT;
4070 goto exit;
Moran Peker71f19ae2018-04-22 20:23:16 +03004071 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004072 ret = mbedtls_cipher_set_iv( &operation->ctx.cipher, iv, iv_length );
4073 status = mbedtls_to_psa_error( ret );
4074exit:
4075 if( status == PSA_SUCCESS )
4076 operation->iv_set = 1;
4077 else
mohammad1603503973b2018-03-12 15:59:30 +02004078 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004079 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004080}
4081
Steven Cooreman177deba2020-09-07 17:14:14 +02004082/* Process input for which the algorithm is set to ECB mode. This requires
4083 * manual processing, since the PSA API is defined as being able to process
4084 * arbitrary-length calls to psa_cipher_update() with ECB mode, but the
4085 * underlying mbedtls_cipher_update only takes full blocks. */
4086static psa_status_t psa_cipher_update_ecb_internal(
4087 mbedtls_cipher_context_t *ctx,
4088 const uint8_t *input,
4089 size_t input_length,
4090 uint8_t *output,
4091 size_t output_size,
4092 size_t *output_length )
4093{
4094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4095 size_t block_size = ctx->cipher_info->block_size;
4096 size_t internal_output_length = 0;
4097 *output_length = 0;
4098
4099 if( input_length == 0 )
4100 {
4101 status = PSA_SUCCESS;
4102 goto exit;
4103 }
4104
4105 if( ctx->unprocessed_len > 0 )
4106 {
4107 /* Fill up to block size, and run the block if there's a full one. */
4108 size_t bytes_to_copy = block_size - ctx->unprocessed_len;
4109
4110 if( input_length < bytes_to_copy )
4111 bytes_to_copy = input_length;
4112
4113 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4114 input, bytes_to_copy );
4115 input_length -= bytes_to_copy;
4116 input += bytes_to_copy;
4117 ctx->unprocessed_len += bytes_to_copy;
4118
4119 if( ctx->unprocessed_len == block_size )
4120 {
4121 status = mbedtls_to_psa_error(
4122 mbedtls_cipher_update( ctx,
4123 ctx->unprocessed_data,
4124 block_size,
4125 output, &internal_output_length ) );
4126
4127 if( status != PSA_SUCCESS )
4128 goto exit;
4129
4130 output += internal_output_length;
4131 output_size -= internal_output_length;
4132 *output_length += internal_output_length;
4133 ctx->unprocessed_len = 0;
4134 }
4135 }
4136
4137 while( input_length >= block_size )
4138 {
4139 /* Run all full blocks we have, one by one */
4140 status = mbedtls_to_psa_error(
4141 mbedtls_cipher_update( ctx, input,
4142 block_size,
4143 output, &internal_output_length ) );
4144
4145 if( status != PSA_SUCCESS )
4146 goto exit;
4147
4148 input_length -= block_size;
4149 input += block_size;
4150
4151 output += internal_output_length;
4152 output_size -= internal_output_length;
4153 *output_length += internal_output_length;
4154 }
4155
4156 if( input_length > 0 )
4157 {
4158 /* Save unprocessed bytes for later processing */
4159 memcpy( &( ctx->unprocessed_data[ctx->unprocessed_len] ),
4160 input, input_length );
4161 ctx->unprocessed_len += input_length;
4162 }
4163
4164 status = PSA_SUCCESS;
4165
4166exit:
4167 return( status );
4168}
4169
Gilles Peskinee553c652018-06-04 16:22:46 +02004170psa_status_t psa_cipher_update( psa_cipher_operation_t *operation,
4171 const uint8_t *input,
4172 size_t input_length,
Andrew Thoelke163639b2019-05-15 12:33:23 +01004173 uint8_t *output,
Gilles Peskinee553c652018-06-04 16:22:46 +02004174 size_t output_size,
4175 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004176{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004177 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine89d789c2018-06-04 17:17:16 +02004178 size_t expected_output_size;
Steven Cooreman7df02922020-09-09 15:28:49 +02004179 if( operation->alg == 0 )
4180 {
4181 return( PSA_ERROR_BAD_STATE );
4182 }
4183 if( operation->iv_required && ! operation->iv_set )
4184 {
4185 return( PSA_ERROR_BAD_STATE );
4186 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004187
Steven Cooremanef8575e2020-09-11 11:44:50 +02004188 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004189 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004190 status = psa_driver_wrapper_cipher_update( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004191 input,
4192 input_length,
4193 output,
4194 output_size,
4195 output_length );
4196 goto exit;
4197 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004198
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004199 if( ! PSA_ALG_IS_STREAM_CIPHER( operation->alg ) )
Gilles Peskine89d789c2018-06-04 17:17:16 +02004200 {
4201 /* Take the unprocessed partial block left over from previous
4202 * update calls, if any, plus the input to this call. Remove
4203 * the last partial block, if any. You get the data that will be
4204 * output in this call. */
4205 expected_output_size =
4206 ( operation->ctx.cipher.unprocessed_len + input_length )
4207 / operation->block_size * operation->block_size;
4208 }
4209 else
4210 {
4211 expected_output_size = input_length;
4212 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004213
Gilles Peskine89d789c2018-06-04 17:17:16 +02004214 if( output_size < expected_output_size )
itayzafrir534bd7c2018-08-02 13:56:32 +03004215 {
4216 status = PSA_ERROR_BUFFER_TOO_SMALL;
4217 goto exit;
4218 }
mohammad160382759612018-03-12 18:16:40 +02004219
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004220 if( operation->alg == PSA_ALG_ECB_NO_PADDING )
4221 {
4222 /* mbedtls_cipher_update has an API inconsistency: it will only
4223 * process a single block at a time in ECB mode. Abstract away that
4224 * inconsistency here to match the PSA API behaviour. */
Steven Cooreman177deba2020-09-07 17:14:14 +02004225 status = psa_cipher_update_ecb_internal( &operation->ctx.cipher,
4226 input,
4227 input_length,
4228 output,
4229 output_size,
4230 output_length );
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004231 }
4232 else
4233 {
4234 status = mbedtls_to_psa_error(
4235 mbedtls_cipher_update( &operation->ctx.cipher, input,
4236 input_length, output, output_length ) );
4237 }
itayzafrir534bd7c2018-08-02 13:56:32 +03004238exit:
4239 if( status != PSA_SUCCESS )
mohammad1603503973b2018-03-12 15:59:30 +02004240 psa_cipher_abort( operation );
itayzafrir534bd7c2018-08-02 13:56:32 +03004241 return( status );
mohammad1603503973b2018-03-12 15:59:30 +02004242}
4243
Gilles Peskinee553c652018-06-04 16:22:46 +02004244psa_status_t psa_cipher_finish( psa_cipher_operation_t *operation,
4245 uint8_t *output,
4246 size_t output_size,
4247 size_t *output_length )
mohammad1603503973b2018-03-12 15:59:30 +02004248{
David Saadab4ecc272019-02-14 13:48:10 +02004249 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee553c652018-06-04 16:22:46 +02004250 uint8_t temp_output_buffer[MBEDTLS_MAX_BLOCK_LENGTH];
Steven Cooreman7df02922020-09-09 15:28:49 +02004251 if( operation->alg == 0 )
4252 {
4253 return( PSA_ERROR_BAD_STATE );
4254 }
4255 if( operation->iv_required && ! operation->iv_set )
4256 {
4257 return( PSA_ERROR_BAD_STATE );
4258 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004259
Steven Cooremanef8575e2020-09-11 11:44:50 +02004260 if( operation->mbedtls_in_use == 0 )
Steven Cooreman8b122252020-09-03 15:30:32 +02004261 {
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004262 status = psa_driver_wrapper_cipher_finish( &operation->ctx.driver,
Steven Cooreman8b122252020-09-03 15:30:32 +02004263 output,
4264 output_size,
4265 output_length );
Steven Cooremanef8575e2020-09-11 11:44:50 +02004266 goto exit;
Steven Cooreman8b122252020-09-03 15:30:32 +02004267 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004268
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004269 if( operation->ctx.cipher.unprocessed_len != 0 )
Moran Peker7cb22b82018-06-05 11:40:02 +03004270 {
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004271 if( operation->alg == PSA_ALG_ECB_NO_PADDING ||
Fredrik Strupef90e3012020-09-28 16:11:33 +02004272 operation->alg == PSA_ALG_CBC_NO_PADDING )
Steven Cooremana6033e92020-08-25 11:47:50 +02004273 {
Gilles Peskinedaea26f2018-08-21 14:02:45 +02004274 status = PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004275 goto exit;
Steven Cooremaned3c9ec2020-07-06 14:08:59 +02004276 }
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004277 }
4278
Steven Cooremanef8575e2020-09-11 11:44:50 +02004279 status = mbedtls_to_psa_error(
4280 mbedtls_cipher_finish( &operation->ctx.cipher,
4281 temp_output_buffer,
4282 output_length ) );
4283 if( status != PSA_SUCCESS )
4284 goto exit;
Janos Follath315b51c2018-07-09 16:04:51 +01004285
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004286 if( *output_length == 0 )
Janos Follath315b51c2018-07-09 16:04:51 +01004287 ; /* Nothing to copy. Note that output may be NULL in this case. */
Gilles Peskine46f1fd72018-06-28 19:31:31 +02004288 else if( output_size >= *output_length )
Moran Pekerdc38ebc2018-04-30 15:45:34 +03004289 memcpy( output, temp_output_buffer, *output_length );
4290 else
Janos Follath315b51c2018-07-09 16:04:51 +01004291 status = PSA_ERROR_BUFFER_TOO_SMALL;
mohammad1603503973b2018-03-12 15:59:30 +02004292
Steven Cooremanef8575e2020-09-11 11:44:50 +02004293exit:
4294 if( operation->mbedtls_in_use == 1 )
4295 mbedtls_platform_zeroize( temp_output_buffer, sizeof( temp_output_buffer ) );
Janos Follath315b51c2018-07-09 16:04:51 +01004296
Steven Cooremanef8575e2020-09-11 11:44:50 +02004297 if( status == PSA_SUCCESS )
4298 return( psa_cipher_abort( operation ) );
4299 else
4300 {
4301 *output_length = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004302 (void) psa_cipher_abort( operation );
Janos Follath315b51c2018-07-09 16:04:51 +01004303
Steven Cooremanef8575e2020-09-11 11:44:50 +02004304 return( status );
4305 }
mohammad1603503973b2018-03-12 15:59:30 +02004306}
4307
Gilles Peskinee553c652018-06-04 16:22:46 +02004308psa_status_t psa_cipher_abort( psa_cipher_operation_t *operation )
4309{
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004310 if( operation->alg == 0 )
Gilles Peskine81736312018-06-26 15:04:31 +02004311 {
Steven Cooremana07b9972020-09-10 14:54:14 +02004312 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004313 * in use. It's ok to call abort on such an object, and there's
4314 * nothing to do. */
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004315 return( PSA_SUCCESS );
Gilles Peskine81736312018-06-26 15:04:31 +02004316 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004317
Gilles Peskinef9c2c092018-06-21 16:57:07 +02004318 /* Sanity check (shouldn't happen: operation->alg should
4319 * always have been initialized to a valid value). */
4320 if( ! PSA_ALG_IS_CIPHER( operation->alg ) )
4321 return( PSA_ERROR_BAD_STATE );
4322
Steven Cooremanef8575e2020-09-11 11:44:50 +02004323 if( operation->mbedtls_in_use == 0 )
Steven Cooremanfb81aa52020-09-09 12:01:43 +02004324 psa_driver_wrapper_cipher_abort( &operation->ctx.driver );
Steven Cooremand3feccd2020-09-01 15:56:14 +02004325 else
4326 mbedtls_cipher_free( &operation->ctx.cipher );
Gilles Peskinee553c652018-06-04 16:22:46 +02004327
Moran Peker41deec42018-04-04 15:43:05 +03004328 operation->alg = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004329 operation->key_set = 0;
4330 operation->iv_set = 0;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004331 operation->mbedtls_in_use = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004332 operation->iv_size = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004333 operation->block_size = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004334 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004335
Moran Peker395db872018-05-31 14:07:14 +03004336 return( PSA_SUCCESS );
mohammad1603503973b2018-03-12 15:59:30 +02004337}
4338
Gilles Peskinea0655c32018-04-30 17:06:50 +02004339
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004340
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004341
mohammad16035955c982018-04-26 00:53:03 +03004342/****************************************************************/
4343/* AEAD */
4344/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004345
Gilles Peskineedf9a652018-08-17 18:11:56 +02004346typedef struct
4347{
Gilles Peskine2f060a82018-12-04 17:12:32 +01004348 psa_key_slot_t *slot;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004349 const mbedtls_cipher_info_t *cipher_info;
4350 union
4351 {
Ronald Cronf95a2b12020-10-22 15:24:49 +02004352 unsigned dummy; /* Make the union non-empty even with no supported algorithms. */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004353#if defined(MBEDTLS_CCM_C)
4354 mbedtls_ccm_context ccm;
4355#endif /* MBEDTLS_CCM_C */
4356#if defined(MBEDTLS_GCM_C)
4357 mbedtls_gcm_context gcm;
4358#endif /* MBEDTLS_GCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004359#if defined(MBEDTLS_CHACHAPOLY_C)
4360 mbedtls_chachapoly_context chachapoly;
4361#endif /* MBEDTLS_CHACHAPOLY_C */
Gilles Peskineedf9a652018-08-17 18:11:56 +02004362 } ctx;
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004363 psa_algorithm_t core_alg;
4364 uint8_t full_tag_length;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004365 uint8_t tag_length;
4366} aead_operation_t;
4367
Ronald Cronf95a2b12020-10-22 15:24:49 +02004368#define AEAD_OPERATION_INIT {0, 0, {0}, 0, 0, 0}
4369
Gilles Peskine30a9e412019-01-14 18:36:12 +01004370static void psa_aead_abort_internal( aead_operation_t *operation )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004371{
Gilles Peskinef8a8fe62018-08-21 16:38:05 +02004372 switch( operation->core_alg )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004373 {
4374#if defined(MBEDTLS_CCM_C)
4375 case PSA_ALG_CCM:
4376 mbedtls_ccm_free( &operation->ctx.ccm );
4377 break;
4378#endif /* MBEDTLS_CCM_C */
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004379#if defined(MBEDTLS_GCM_C)
Gilles Peskineedf9a652018-08-17 18:11:56 +02004380 case PSA_ALG_GCM:
4381 mbedtls_gcm_free( &operation->ctx.gcm );
4382 break;
4383#endif /* MBEDTLS_GCM_C */
4384 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004385
Ronald Cron5c522922020-11-14 16:35:34 +01004386 psa_unlock_key_slot( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004387}
4388
4389static psa_status_t psa_aead_setup( aead_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02004390 mbedtls_svc_key_id_t key,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004391 psa_key_usage_t usage,
4392 psa_algorithm_t alg )
4393{
4394 psa_status_t status;
4395 size_t key_bits;
4396 mbedtls_cipher_id_t cipher_id;
4397
Ronald Cron5c522922020-11-14 16:35:34 +01004398 status = psa_get_and_lock_transparent_key_slot_with_policy(
4399 key, &operation->slot, usage, alg );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004400 if( status != PSA_SUCCESS )
4401 return( status );
4402
Gilles Peskinedb4b3ab2019-04-18 12:53:01 +02004403 key_bits = psa_get_key_slot_bits( operation->slot );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004404
4405 operation->cipher_info =
Gilles Peskine8e338702019-07-30 20:06:31 +02004406 mbedtls_cipher_info_from_psa( alg, operation->slot->attr.type, key_bits,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004407 &cipher_id );
4408 if( operation->cipher_info == NULL )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004409 {
4410 status = PSA_ERROR_NOT_SUPPORTED;
4411 goto cleanup;
4412 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004413
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004414 switch( PSA_ALG_AEAD_WITH_TAG_LENGTH( alg, 0 ) )
Gilles Peskineedf9a652018-08-17 18:11:56 +02004415 {
4416#if defined(MBEDTLS_CCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004417 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CCM, 0 ):
4418 operation->core_alg = PSA_ALG_CCM;
4419 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004420 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.
4421 * The call to mbedtls_ccm_encrypt_and_tag or
4422 * mbedtls_ccm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004423 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004424 {
4425 status = PSA_ERROR_INVALID_ARGUMENT;
4426 goto cleanup;
4427 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004428 mbedtls_ccm_init( &operation->ctx.ccm );
4429 status = mbedtls_to_psa_error(
4430 mbedtls_ccm_setkey( &operation->ctx.ccm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004431 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004432 (unsigned int) key_bits ) );
4433 if( status != 0 )
4434 goto cleanup;
4435 break;
4436#endif /* MBEDTLS_CCM_C */
4437
4438#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004439 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_GCM, 0 ):
4440 operation->core_alg = PSA_ALG_GCM;
4441 operation->full_tag_length = 16;
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004442 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16.
4443 * The call to mbedtls_gcm_crypt_and_tag or
4444 * mbedtls_gcm_auth_decrypt will validate the tag length. */
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004445 if( PSA_BLOCK_CIPHER_BLOCK_LENGTH( operation->slot->attr.type ) != 16 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004446 {
4447 status = PSA_ERROR_INVALID_ARGUMENT;
4448 goto cleanup;
4449 }
Gilles Peskineedf9a652018-08-17 18:11:56 +02004450 mbedtls_gcm_init( &operation->ctx.gcm );
4451 status = mbedtls_to_psa_error(
4452 mbedtls_gcm_setkey( &operation->ctx.gcm, cipher_id,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004453 operation->slot->key.data,
Gilles Peskineedf9a652018-08-17 18:11:56 +02004454 (unsigned int) key_bits ) );
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004455 if( status != 0 )
4456 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004457 break;
4458#endif /* MBEDTLS_GCM_C */
4459
Gilles Peskine26869f22019-05-06 15:25:00 +02004460#if defined(MBEDTLS_CHACHAPOLY_C)
4461 case PSA_ALG_AEAD_WITH_TAG_LENGTH( PSA_ALG_CHACHA20_POLY1305, 0 ):
4462 operation->core_alg = PSA_ALG_CHACHA20_POLY1305;
4463 operation->full_tag_length = 16;
4464 /* We only support the default tag length. */
4465 if( alg != PSA_ALG_CHACHA20_POLY1305 )
Ronald Cronf95a2b12020-10-22 15:24:49 +02004466 {
4467 status = PSA_ERROR_NOT_SUPPORTED;
4468 goto cleanup;
4469 }
Gilles Peskine26869f22019-05-06 15:25:00 +02004470 mbedtls_chachapoly_init( &operation->ctx.chachapoly );
4471 status = mbedtls_to_psa_error(
4472 mbedtls_chachapoly_setkey( &operation->ctx.chachapoly,
Ronald Cronea0f8a62020-11-25 17:52:23 +01004473 operation->slot->key.data ) );
Gilles Peskine26869f22019-05-06 15:25:00 +02004474 if( status != 0 )
4475 goto cleanup;
4476 break;
4477#endif /* MBEDTLS_CHACHAPOLY_C */
4478
Gilles Peskineedf9a652018-08-17 18:11:56 +02004479 default:
Ronald Cronf95a2b12020-10-22 15:24:49 +02004480 status = PSA_ERROR_NOT_SUPPORTED;
4481 goto cleanup;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004482 }
4483
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004484 if( PSA_AEAD_TAG_LENGTH( alg ) > operation->full_tag_length )
4485 {
4486 status = PSA_ERROR_INVALID_ARGUMENT;
4487 goto cleanup;
4488 }
4489 operation->tag_length = PSA_AEAD_TAG_LENGTH( alg );
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004490
Gilles Peskineedf9a652018-08-17 18:11:56 +02004491 return( PSA_SUCCESS );
4492
4493cleanup:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004494 psa_aead_abort_internal( operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004495 return( status );
4496}
4497
Ronald Croncf56a0a2020-08-04 09:51:30 +02004498psa_status_t psa_aead_encrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004499 psa_algorithm_t alg,
4500 const uint8_t *nonce,
4501 size_t nonce_length,
4502 const uint8_t *additional_data,
4503 size_t additional_data_length,
4504 const uint8_t *plaintext,
4505 size_t plaintext_length,
4506 uint8_t *ciphertext,
4507 size_t ciphertext_size,
4508 size_t *ciphertext_length )
4509{
mohammad16035955c982018-04-26 00:53:03 +03004510 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004511 aead_operation_t operation = AEAD_OPERATION_INIT;
mohammad160315223a82018-06-03 17:19:55 +03004512 uint8_t *tag;
Gilles Peskine2d277862018-06-18 15:41:12 +02004513
mohammad1603f08a5502018-06-03 15:05:47 +03004514 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004515
Ronald Croncf56a0a2020-08-04 09:51:30 +02004516 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_ENCRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004517 if( status != PSA_SUCCESS )
4518 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004519
Gilles Peskineedf9a652018-08-17 18:11:56 +02004520 /* For all currently supported modes, the tag is at the end of the
4521 * ciphertext. */
4522 if( ciphertext_size < ( plaintext_length + operation.tag_length ) )
4523 {
4524 status = PSA_ERROR_BUFFER_TOO_SMALL;
4525 goto exit;
4526 }
4527 tag = ciphertext + plaintext_length;
mohammad16035955c982018-04-26 00:53:03 +03004528
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004529#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004530 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004531 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004532 status = mbedtls_to_psa_error(
4533 mbedtls_gcm_crypt_and_tag( &operation.ctx.gcm,
4534 MBEDTLS_GCM_ENCRYPT,
4535 plaintext_length,
4536 nonce, nonce_length,
4537 additional_data, additional_data_length,
4538 plaintext, ciphertext,
4539 operation.tag_length, tag ) );
mohammad16035955c982018-04-26 00:53:03 +03004540 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004541 else
4542#endif /* MBEDTLS_GCM_C */
4543#if defined(MBEDTLS_CCM_C)
4544 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004545 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004546 status = mbedtls_to_psa_error(
4547 mbedtls_ccm_encrypt_and_tag( &operation.ctx.ccm,
4548 plaintext_length,
4549 nonce, nonce_length,
4550 additional_data,
4551 additional_data_length,
4552 plaintext, ciphertext,
4553 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004554 }
mohammad16035c8845f2018-05-09 05:40:09 -07004555 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004556#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004557#if defined(MBEDTLS_CHACHAPOLY_C)
4558 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4559 {
4560 if( nonce_length != 12 || operation.tag_length != 16 )
4561 {
4562 status = PSA_ERROR_NOT_SUPPORTED;
4563 goto exit;
4564 }
4565 status = mbedtls_to_psa_error(
4566 mbedtls_chachapoly_encrypt_and_tag( &operation.ctx.chachapoly,
4567 plaintext_length,
4568 nonce,
4569 additional_data,
4570 additional_data_length,
4571 plaintext,
4572 ciphertext,
4573 tag ) );
4574 }
4575 else
4576#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad16035c8845f2018-05-09 05:40:09 -07004577 {
mohammad1603554faad2018-06-03 15:07:38 +03004578 return( PSA_ERROR_NOT_SUPPORTED );
mohammad16035c8845f2018-05-09 05:40:09 -07004579 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004580
Gilles Peskineedf9a652018-08-17 18:11:56 +02004581 if( status != PSA_SUCCESS && ciphertext_size != 0 )
4582 memset( ciphertext, 0, ciphertext_size );
Gilles Peskine2d277862018-06-18 15:41:12 +02004583
Gilles Peskineedf9a652018-08-17 18:11:56 +02004584exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004585 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004586 if( status == PSA_SUCCESS )
4587 *ciphertext_length = plaintext_length + operation.tag_length;
4588 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004589}
4590
Gilles Peskineee652a32018-06-01 19:23:52 +02004591/* Locate the tag in a ciphertext buffer containing the encrypted data
4592 * followed by the tag. Return the length of the part preceding the tag in
4593 * *plaintext_length. This is the size of the plaintext in modes where
4594 * the encrypted data has the same size as the plaintext, such as
4595 * CCM and GCM. */
4596static psa_status_t psa_aead_unpadded_locate_tag( size_t tag_length,
4597 const uint8_t *ciphertext,
4598 size_t ciphertext_length,
4599 size_t plaintext_size,
Gilles Peskineee652a32018-06-01 19:23:52 +02004600 const uint8_t **p_tag )
4601{
4602 size_t payload_length;
4603 if( tag_length > ciphertext_length )
4604 return( PSA_ERROR_INVALID_ARGUMENT );
4605 payload_length = ciphertext_length - tag_length;
4606 if( payload_length > plaintext_size )
4607 return( PSA_ERROR_BUFFER_TOO_SMALL );
4608 *p_tag = ciphertext + payload_length;
Gilles Peskineee652a32018-06-01 19:23:52 +02004609 return( PSA_SUCCESS );
4610}
4611
Ronald Croncf56a0a2020-08-04 09:51:30 +02004612psa_status_t psa_aead_decrypt( mbedtls_svc_key_id_t key,
mohammad16035955c982018-04-26 00:53:03 +03004613 psa_algorithm_t alg,
4614 const uint8_t *nonce,
4615 size_t nonce_length,
4616 const uint8_t *additional_data,
4617 size_t additional_data_length,
4618 const uint8_t *ciphertext,
4619 size_t ciphertext_length,
4620 uint8_t *plaintext,
4621 size_t plaintext_size,
4622 size_t *plaintext_length )
4623{
mohammad16035955c982018-04-26 00:53:03 +03004624 psa_status_t status;
Ronald Cronf95a2b12020-10-22 15:24:49 +02004625 aead_operation_t operation = AEAD_OPERATION_INIT;
Gilles Peskineedf9a652018-08-17 18:11:56 +02004626 const uint8_t *tag = NULL;
Gilles Peskine2d277862018-06-18 15:41:12 +02004627
Gilles Peskineee652a32018-06-01 19:23:52 +02004628 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004629
Ronald Croncf56a0a2020-08-04 09:51:30 +02004630 status = psa_aead_setup( &operation, key, PSA_KEY_USAGE_DECRYPT, alg );
Gilles Peskineb0b255c2018-07-06 17:01:38 +02004631 if( status != PSA_SUCCESS )
4632 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004633
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004634 status = psa_aead_unpadded_locate_tag( operation.tag_length,
4635 ciphertext, ciphertext_length,
4636 plaintext_size, &tag );
4637 if( status != PSA_SUCCESS )
4638 goto exit;
4639
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004640#if defined(MBEDTLS_GCM_C)
Gilles Peskine23cc2ff2018-08-17 19:47:52 +02004641 if( operation.core_alg == PSA_ALG_GCM )
mohammad16035955c982018-04-26 00:53:03 +03004642 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004643 status = mbedtls_to_psa_error(
4644 mbedtls_gcm_auth_decrypt( &operation.ctx.gcm,
4645 ciphertext_length - operation.tag_length,
4646 nonce, nonce_length,
4647 additional_data,
4648 additional_data_length,
4649 tag, operation.tag_length,
4650 ciphertext, plaintext ) );
mohammad16035955c982018-04-26 00:53:03 +03004651 }
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004652 else
4653#endif /* MBEDTLS_GCM_C */
4654#if defined(MBEDTLS_CCM_C)
4655 if( operation.core_alg == PSA_ALG_CCM )
mohammad16035955c982018-04-26 00:53:03 +03004656 {
Gilles Peskineedf9a652018-08-17 18:11:56 +02004657 status = mbedtls_to_psa_error(
4658 mbedtls_ccm_auth_decrypt( &operation.ctx.ccm,
4659 ciphertext_length - operation.tag_length,
4660 nonce, nonce_length,
4661 additional_data,
4662 additional_data_length,
4663 ciphertext, plaintext,
4664 tag, operation.tag_length ) );
mohammad16035955c982018-04-26 00:53:03 +03004665 }
mohammad160339574652018-06-01 04:39:53 -07004666 else
Gilles Peskineb0b189f2018-11-28 17:30:58 +01004667#endif /* MBEDTLS_CCM_C */
Gilles Peskine26869f22019-05-06 15:25:00 +02004668#if defined(MBEDTLS_CHACHAPOLY_C)
4669 if( operation.core_alg == PSA_ALG_CHACHA20_POLY1305 )
4670 {
4671 if( nonce_length != 12 || operation.tag_length != 16 )
4672 {
4673 status = PSA_ERROR_NOT_SUPPORTED;
4674 goto exit;
4675 }
4676 status = mbedtls_to_psa_error(
4677 mbedtls_chachapoly_auth_decrypt( &operation.ctx.chachapoly,
4678 ciphertext_length - operation.tag_length,
4679 nonce,
4680 additional_data,
4681 additional_data_length,
4682 tag,
4683 ciphertext,
4684 plaintext ) );
4685 }
4686 else
4687#endif /* MBEDTLS_CHACHAPOLY_C */
mohammad160339574652018-06-01 04:39:53 -07004688 {
mohammad1603554faad2018-06-03 15:07:38 +03004689 return( PSA_ERROR_NOT_SUPPORTED );
mohammad160339574652018-06-01 04:39:53 -07004690 }
Gilles Peskinea40d7742018-06-01 16:28:30 +02004691
Gilles Peskineedf9a652018-08-17 18:11:56 +02004692 if( status != PSA_SUCCESS && plaintext_size != 0 )
4693 memset( plaintext, 0, plaintext_size );
mohammad160360a64d02018-06-03 17:20:42 +03004694
Gilles Peskineedf9a652018-08-17 18:11:56 +02004695exit:
Gilles Peskine30a9e412019-01-14 18:36:12 +01004696 psa_aead_abort_internal( &operation );
Gilles Peskineedf9a652018-08-17 18:11:56 +02004697 if( status == PSA_SUCCESS )
4698 *plaintext_length = ciphertext_length - operation.tag_length;
4699 return( status );
mohammad16035955c982018-04-26 00:53:03 +03004700}
4701
Gilles Peskinea0655c32018-04-30 17:06:50 +02004702
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004703
Gilles Peskine20035e32018-02-03 22:44:14 +01004704/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004705/* Generators */
4706/****************************************************************/
4707
John Durkop07cc04a2020-11-16 22:08:34 -08004708#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4709 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4710 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4711#define AT_LEAST_ONE_BUILTIN_KDF
4712#endif
4713
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004714#define HKDF_STATE_INIT 0 /* no input yet */
4715#define HKDF_STATE_STARTED 1 /* got salt */
4716#define HKDF_STATE_KEYED 2 /* got key */
4717#define HKDF_STATE_OUTPUT 3 /* output started */
4718
Gilles Peskinecbe66502019-05-16 16:59:18 +02004719static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004720 const psa_key_derivation_operation_t *operation )
Gilles Peskine969c5d62019-01-16 15:53:06 +01004721{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004722 if ( PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
4723 return( PSA_ALG_KEY_AGREEMENT_GET_KDF( operation->alg ) );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004724 else
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004725 return( operation->alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004726}
4727
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004728psa_status_t psa_key_derivation_abort( psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004729{
4730 psa_status_t status = PSA_SUCCESS;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004731 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskine969c5d62019-01-16 15:53:06 +01004732 if( kdf_alg == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02004733 {
4734 /* The object has (apparently) been initialized but it is not
4735 * in use. It's ok to call abort on such an object, and there's
4736 * nothing to do. */
4737 }
4738 else
John Durkopd0321952020-10-29 21:37:36 -07004739#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004740 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004741 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004742 mbedtls_free( operation->ctx.hkdf.info );
4743 status = psa_hmac_abort_internal( &operation->ctx.hkdf.hmac );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004744 }
John Durkop07cc04a2020-11-16 22:08:34 -08004745 else
4746#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4747#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4748 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4749 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004750 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004751 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004752 {
Janos Follath6a1d2622019-06-11 10:37:28 +01004753 if( operation->ctx.tls12_prf.seed != NULL )
4754 {
4755 mbedtls_platform_zeroize( operation->ctx.tls12_prf.seed,
4756 operation->ctx.tls12_prf.seed_length );
4757 mbedtls_free( operation->ctx.tls12_prf.seed );
4758 }
4759
4760 if( operation->ctx.tls12_prf.label != NULL )
4761 {
4762 mbedtls_platform_zeroize( operation->ctx.tls12_prf.label,
4763 operation->ctx.tls12_prf.label_length );
4764 mbedtls_free( operation->ctx.tls12_prf.label );
4765 }
4766
4767 status = psa_hmac_abort_internal( &operation->ctx.tls12_prf.hmac );
4768
4769 /* We leave the fields Ai and output_block to be erased safely by the
4770 * mbedtls_platform_zeroize() in the end of this function. */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004771 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004772 else
John Durkop07cc04a2020-11-16 22:08:34 -08004773#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4774 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004775 {
4776 status = PSA_ERROR_BAD_STATE;
4777 }
Janos Follath083036a2019-06-11 10:22:26 +01004778 mbedtls_platform_zeroize( operation, sizeof( *operation ) );
Gilles Peskineeab56e42018-07-12 17:12:33 +02004779 return( status );
4780}
4781
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004782psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskineeab56e42018-07-12 17:12:33 +02004783 size_t *capacity)
4784{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004785 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004786 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004787 /* This is a blank key derivation operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02004788 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004789 }
4790
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004791 *capacity = operation->capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004792 return( PSA_SUCCESS );
4793}
4794
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004795psa_status_t psa_key_derivation_set_capacity( psa_key_derivation_operation_t *operation,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004796 size_t capacity )
4797{
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004798 if( operation->alg == 0 )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004799 return( PSA_ERROR_BAD_STATE );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004800 if( capacity > operation->capacity )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004801 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004802 operation->capacity = capacity;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004803 return( PSA_SUCCESS );
4804}
4805
John Durkopd0321952020-10-29 21:37:36 -07004806#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004807/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004808 * of the expand phase of the HKDF algorithm. */
Gilles Peskinecbe66502019-05-16 16:59:18 +02004809static psa_status_t psa_key_derivation_hkdf_read( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskinebef7f142018-07-12 17:22:21 +02004810 psa_algorithm_t hash_alg,
4811 uint8_t *output,
4812 size_t output_length )
4813{
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004814 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004815 psa_status_t status;
4816
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004817 if( hkdf->state < HKDF_STATE_KEYED || ! hkdf->info_set )
4818 return( PSA_ERROR_BAD_STATE );
4819 hkdf->state = HKDF_STATE_OUTPUT;
4820
Gilles Peskinebef7f142018-07-12 17:22:21 +02004821 while( output_length != 0 )
4822 {
4823 /* Copy what remains of the current block */
4824 uint8_t n = hash_length - hkdf->offset_in_block;
4825 if( n > output_length )
4826 n = (uint8_t) output_length;
4827 memcpy( output, hkdf->output_block + hkdf->offset_in_block, n );
4828 output += n;
4829 output_length -= n;
4830 hkdf->offset_in_block += n;
Gilles Peskined54931c2018-07-17 21:06:59 +02004831 if( output_length == 0 )
Gilles Peskinebef7f142018-07-12 17:22:21 +02004832 break;
Gilles Peskined54931c2018-07-17 21:06:59 +02004833 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004834 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004835 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004836 * object was corrupted or if this function is called directly
4837 * inside the library. */
4838 if( hkdf->block_number == 0xff )
4839 return( PSA_ERROR_BAD_STATE );
Gilles Peskinebef7f142018-07-12 17:22:21 +02004840
4841 /* We need a new block */
4842 ++hkdf->block_number;
4843 hkdf->offset_in_block = 0;
4844 status = psa_hmac_setup_internal( &hkdf->hmac,
4845 hkdf->prk, hash_length,
4846 hash_alg );
4847 if( status != PSA_SUCCESS )
4848 return( status );
4849 if( hkdf->block_number != 1 )
4850 {
4851 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4852 hkdf->output_block,
4853 hash_length );
4854 if( status != PSA_SUCCESS )
4855 return( status );
4856 }
4857 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4858 hkdf->info,
4859 hkdf->info_length );
4860 if( status != PSA_SUCCESS )
4861 return( status );
4862 status = psa_hash_update( &hkdf->hmac.hash_ctx,
4863 &hkdf->block_number, 1 );
4864 if( status != PSA_SUCCESS )
4865 return( status );
4866 status = psa_hmac_finish_internal( &hkdf->hmac,
4867 hkdf->output_block,
4868 sizeof( hkdf->output_block ) );
4869 if( status != PSA_SUCCESS )
4870 return( status );
4871 }
4872
4873 return( PSA_SUCCESS );
4874}
John Durkop07cc04a2020-11-16 22:08:34 -08004875#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004876
John Durkop07cc04a2020-11-16 22:08:34 -08004877#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4878 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004879static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4880 psa_tls12_prf_key_derivation_t *tls12_prf,
4881 psa_algorithm_t alg )
4882{
4883 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004884 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follathea29bfb2019-06-19 12:21:20 +01004885 psa_hash_operation_t backup = PSA_HASH_OPERATION_INIT;
4886 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004887
Janos Follath7742fee2019-06-17 12:58:10 +01004888 /* We can't be wanting more output after block 0xff, otherwise
4889 * the capacity check in psa_key_derivation_output_bytes() would have
4890 * prevented this call. It could happen only if the operation
4891 * object was corrupted or if this function is called directly
4892 * inside the library. */
4893 if( tls12_prf->block_number == 0xff )
Janos Follath30090bc2019-06-25 10:15:04 +01004894 return( PSA_ERROR_CORRUPTION_DETECTED );
Janos Follath7742fee2019-06-17 12:58:10 +01004895
4896 /* We need a new block */
4897 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004898 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004899
4900 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4901 *
4902 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4903 *
4904 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4905 * HMAC_hash(secret, A(2) + seed) +
4906 * HMAC_hash(secret, A(3) + seed) + ...
4907 *
4908 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004909 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004910 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004911 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004912 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004913 * is currently extracted as `output_block` and where i is
4914 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004915 */
4916
Janos Follathea29bfb2019-06-19 12:21:20 +01004917 /* Save the hash context before using it, to preserve the hash state with
4918 * only the inner padding in it. We need this, because inner padding depends
4919 * on the key (secret in the RFC's terminology). */
4920 status = psa_hash_clone( &tls12_prf->hmac.hash_ctx, &backup );
4921 if( status != PSA_SUCCESS )
4922 goto cleanup;
4923
4924 /* Calculate A(i) where i = tls12_prf->block_number. */
4925 if( tls12_prf->block_number == 1 )
4926 {
4927 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4928 * the variable seed and in this instance means it in the context of the
4929 * P_hash function, where seed = label + seed.) */
4930 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4931 tls12_prf->label, tls12_prf->label_length );
4932 if( status != PSA_SUCCESS )
4933 goto cleanup;
4934 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4935 tls12_prf->seed, tls12_prf->seed_length );
4936 if( status != PSA_SUCCESS )
4937 goto cleanup;
4938 }
4939 else
4940 {
4941 /* A(i) = HMAC_hash(secret, A(i-1)) */
4942 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4943 tls12_prf->Ai, hash_length );
4944 if( status != PSA_SUCCESS )
4945 goto cleanup;
4946 }
4947
4948 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4949 tls12_prf->Ai, hash_length );
4950 if( status != PSA_SUCCESS )
4951 goto cleanup;
4952 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4953 if( status != PSA_SUCCESS )
4954 goto cleanup;
4955
4956 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
4957 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4958 tls12_prf->Ai, hash_length );
4959 if( status != PSA_SUCCESS )
4960 goto cleanup;
4961 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4962 tls12_prf->label, tls12_prf->label_length );
4963 if( status != PSA_SUCCESS )
4964 goto cleanup;
4965 status = psa_hash_update( &tls12_prf->hmac.hash_ctx,
4966 tls12_prf->seed, tls12_prf->seed_length );
4967 if( status != PSA_SUCCESS )
4968 goto cleanup;
4969 status = psa_hmac_finish_internal( &tls12_prf->hmac,
4970 tls12_prf->output_block, hash_length );
4971 if( status != PSA_SUCCESS )
4972 goto cleanup;
4973 status = psa_hash_clone( &backup, &tls12_prf->hmac.hash_ctx );
4974 if( status != PSA_SUCCESS )
4975 goto cleanup;
4976
Janos Follath7742fee2019-06-17 12:58:10 +01004977
4978cleanup:
4979
Janos Follathea29bfb2019-06-19 12:21:20 +01004980 cleanup_status = psa_hash_abort( &backup );
4981 if( status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS )
4982 status = cleanup_status;
4983
4984 return( status );
Janos Follath7742fee2019-06-17 12:58:10 +01004985}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004986
Janos Follath844eb0e2019-06-19 12:10:49 +01004987static psa_status_t psa_key_derivation_tls12_prf_read(
4988 psa_tls12_prf_key_derivation_t *tls12_prf,
4989 psa_algorithm_t alg,
4990 uint8_t *output,
4991 size_t output_length )
4992{
4993 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH( alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01004994 uint8_t hash_length = PSA_HASH_LENGTH( hash_alg );
Janos Follath844eb0e2019-06-19 12:10:49 +01004995 psa_status_t status;
4996 uint8_t offset, length;
4997
4998 while( output_length != 0 )
4999 {
5000 /* Check if we have fully processed the current block. */
5001 if( tls12_prf->left_in_block == 0 )
5002 {
5003 status = psa_key_derivation_tls12_prf_generate_next_block( tls12_prf,
5004 alg );
5005 if( status != PSA_SUCCESS )
5006 return( status );
5007
5008 continue;
5009 }
5010
5011 if( tls12_prf->left_in_block > output_length )
5012 length = (uint8_t) output_length;
5013 else
5014 length = tls12_prf->left_in_block;
5015
5016 offset = hash_length - tls12_prf->left_in_block;
5017 memcpy( output, tls12_prf->output_block + offset, length );
5018 output += length;
5019 output_length -= length;
5020 tls12_prf->left_in_block -= length;
5021 }
5022
5023 return( PSA_SUCCESS );
5024}
John Durkop07cc04a2020-11-16 22:08:34 -08005025#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5026 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005027
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005028psa_status_t psa_key_derivation_output_bytes(
5029 psa_key_derivation_operation_t *operation,
5030 uint8_t *output,
5031 size_t output_length )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005032{
5033 psa_status_t status;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005034 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005035
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005036 if( operation->alg == 0 )
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005037 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005038 /* This is a blank operation. */
Steven Cooreman29149862020-08-05 15:43:42 +02005039 return( PSA_ERROR_BAD_STATE );
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005040 }
5041
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005042 if( output_length > operation->capacity )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005043 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005044 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005045 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005046 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005047 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005048 goto exit;
5049 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005050 if( output_length == 0 && operation->capacity == 0 )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005051 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005052 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005053 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005054 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5055 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005056 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005057 * output_length > 0. */
David Saadab4ecc272019-02-14 13:48:10 +02005058 return( PSA_ERROR_INSUFFICIENT_DATA );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005059 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005060 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005061
John Durkopd0321952020-10-29 21:37:36 -07005062#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005063 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskinebef7f142018-07-12 17:22:21 +02005064 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005065 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005066 status = psa_key_derivation_hkdf_read( &operation->ctx.hkdf, hash_alg,
Gilles Peskinebef7f142018-07-12 17:22:21 +02005067 output, output_length );
5068 }
Janos Follathadbec812019-06-14 11:05:39 +01005069 else
John Durkop07cc04a2020-11-16 22:08:34 -08005070#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5071#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5072 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathadbec812019-06-14 11:05:39 +01005073 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
John Durkop07cc04a2020-11-16 22:08:34 -08005074 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005075 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005076 status = psa_key_derivation_tls12_prf_read( &operation->ctx.tls12_prf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005077 kdf_alg, output,
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005078 output_length );
5079 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005080 else
John Durkop07cc04a2020-11-16 22:08:34 -08005081#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5082 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005083 {
5084 return( PSA_ERROR_BAD_STATE );
5085 }
5086
5087exit:
5088 if( status != PSA_SUCCESS )
5089 {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005090 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005091 * This allows us to differentiate between exhausted operations and
5092 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5093 * operations. */
5094 psa_algorithm_t alg = operation->alg;
5095 psa_key_derivation_abort( operation );
5096 operation->alg = alg;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005097 memset( output, '!', output_length );
5098 }
5099 return( status );
5100}
5101
Gilles Peskine08542d82018-07-19 17:05:42 +02005102#if defined(MBEDTLS_DES_C)
5103static void psa_des_set_key_parity( uint8_t *data, size_t data_size )
5104{
5105 if( data_size >= 8 )
5106 mbedtls_des_key_set_parity( data );
5107 if( data_size >= 16 )
5108 mbedtls_des_key_set_parity( data + 8 );
5109 if( data_size >= 24 )
5110 mbedtls_des_key_set_parity( data + 16 );
5111}
5112#endif /* MBEDTLS_DES_C */
5113
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005114static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005115 psa_key_slot_t *slot,
5116 size_t bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005117 psa_key_derivation_operation_t *operation )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005118{
5119 uint8_t *data = NULL;
5120 size_t bytes = PSA_BITS_TO_BYTES( bits );
5121 psa_status_t status;
5122
Gilles Peskine8e338702019-07-30 20:06:31 +02005123 if( ! key_type_is_raw_bytes( slot->attr.type ) )
Gilles Peskineeab56e42018-07-12 17:12:33 +02005124 return( PSA_ERROR_INVALID_ARGUMENT );
5125 if( bits % 8 != 0 )
5126 return( PSA_ERROR_INVALID_ARGUMENT );
5127 data = mbedtls_calloc( 1, bytes );
5128 if( data == NULL )
5129 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5130
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005131 status = psa_key_derivation_output_bytes( operation, data, bytes );
Gilles Peskineeab56e42018-07-12 17:12:33 +02005132 if( status != PSA_SUCCESS )
5133 goto exit;
Gilles Peskine08542d82018-07-19 17:05:42 +02005134#if defined(MBEDTLS_DES_C)
Gilles Peskine8e338702019-07-30 20:06:31 +02005135 if( slot->attr.type == PSA_KEY_TYPE_DES )
Gilles Peskine08542d82018-07-19 17:05:42 +02005136 psa_des_set_key_parity( data, bytes );
5137#endif /* MBEDTLS_DES_C */
Ronald Crondd04d422020-11-28 15:14:42 +01005138
5139 status = psa_allocate_buffer_to_slot( slot, bytes );
5140 if( status != PSA_SUCCESS )
5141 return( status );
5142
Ronald Cronbf33c932020-11-28 18:06:53 +01005143 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005144 psa_key_attributes_t attributes = {
5145 .core = slot->attr
5146 };
5147
Ronald Cronbf33c932020-11-28 18:06:53 +01005148 status = psa_driver_wrapper_import_key( &attributes,
5149 data, bytes,
5150 slot->key.data,
5151 slot->key.bytes,
5152 &slot->key.bytes, &bits );
5153 if( bits != slot->attr.bits )
5154 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005155
5156exit:
5157 mbedtls_free( data );
5158 return( status );
5159}
5160
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005161psa_status_t psa_key_derivation_output_key( const psa_key_attributes_t *attributes,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005162 psa_key_derivation_operation_t *operation,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005163 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005164{
5165 psa_status_t status;
5166 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005167 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02005168
Ronald Cron81709fc2020-11-14 12:10:32 +01005169 *key = MBEDTLS_SVC_KEY_ID_INIT;
5170
Gilles Peskine0f84d622019-09-12 19:03:13 +02005171 /* Reject any attempt to create a zero-length key so that we don't
5172 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
5173 if( psa_get_key_bits( attributes ) == 0 )
5174 return( PSA_ERROR_INVALID_ARGUMENT );
5175
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005176 if( ! operation->can_output_key )
5177 return( PSA_ERROR_NOT_PERMITTED );
5178
Ronald Cron81709fc2020-11-14 12:10:32 +01005179 status = psa_start_key_creation( PSA_KEY_CREATION_DERIVE, attributes,
5180 &slot, &driver );
Gilles Peskinef4ee6622019-07-24 13:44:30 +02005181#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
5182 if( driver != NULL )
5183 {
5184 /* Deriving a key in a secure element is not implemented yet. */
5185 status = PSA_ERROR_NOT_SUPPORTED;
5186 }
5187#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005188 if( status == PSA_SUCCESS )
5189 {
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005190 status = psa_generate_derived_key_internal( slot,
Gilles Peskine7e0cff92019-07-30 13:48:52 +02005191 attributes->core.bits,
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005192 operation );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005193 }
5194 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01005195 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005196 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02005197 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005198
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005199 return( status );
5200}
5201
Gilles Peskineeab56e42018-07-12 17:12:33 +02005202
5203
5204/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02005205/* Key derivation */
5206/****************************************************************/
5207
John Durkop07cc04a2020-11-16 22:08:34 -08005208#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine969c5d62019-01-16 15:53:06 +01005209static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005211 psa_algorithm_t kdf_alg )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005212{
John Durkop07cc04a2020-11-16 22:08:34 -08005213 int is_kdf_alg_supported;
5214
Janos Follath5fe19732019-06-20 15:09:30 +01005215 /* Make sure that operation->ctx is properly zero-initialised. (Macro
5216 * initialisers for this union leave some bytes unspecified.) */
5217 memset( &operation->ctx, 0, sizeof( operation->ctx ) );
5218
Gilles Peskine969c5d62019-01-16 15:53:06 +01005219 /* Make sure that kdf_alg is a supported key derivation algorithm. */
John Durkopd0321952020-10-29 21:37:36 -07005220#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
John Durkop07cc04a2020-11-16 22:08:34 -08005221 if( PSA_ALG_IS_HKDF( kdf_alg ) )
5222 is_kdf_alg_supported = 1;
5223 else
5224#endif
5225#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5226 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
5227 is_kdf_alg_supported = 1;
5228 else
5229#endif
5230#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5231 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
5232 is_kdf_alg_supported = 1;
5233 else
5234#endif
5235 is_kdf_alg_supported = 0;
5236
5237 if( is_kdf_alg_supported )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005238 {
Gilles Peskine969c5d62019-01-16 15:53:06 +01005239 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH( kdf_alg );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005240 size_t hash_size = PSA_HASH_LENGTH( hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005241 if( hash_size == 0 )
5242 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005243 if( ( PSA_ALG_IS_TLS12_PRF( kdf_alg ) ||
5244 PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) ) &&
Gilles Peskineab4b2012019-04-12 15:06:27 +02005245 ! ( hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384 ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005246 {
5247 return( PSA_ERROR_NOT_SUPPORTED );
5248 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005249 operation->capacity = 255 * hash_size;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005250 return( PSA_SUCCESS );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005251 }
John Durkop07cc04a2020-11-16 22:08:34 -08005252
5253 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005254}
John Durkop07cc04a2020-11-16 22:08:34 -08005255#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01005256
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005257psa_status_t psa_key_derivation_setup( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005258 psa_algorithm_t alg )
5259{
5260 psa_status_t status;
5261
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005262 if( operation->alg != 0 )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005263 return( PSA_ERROR_BAD_STATE );
5264
Gilles Peskine6843c292019-01-18 16:44:49 +01005265 if( PSA_ALG_IS_RAW_KEY_AGREEMENT( alg ) )
5266 return( PSA_ERROR_INVALID_ARGUMENT );
John Durkop07cc04a2020-11-16 22:08:34 -08005267#ifdef AT_LEAST_ONE_BUILTIN_KDF
Gilles Peskine6843c292019-01-18 16:44:49 +01005268 else if( PSA_ALG_IS_KEY_AGREEMENT( alg ) )
Gilles Peskine969c5d62019-01-16 15:53:06 +01005269 {
5270 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF( alg );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005271 status = psa_key_derivation_setup_kdf( operation, kdf_alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005272 }
5273 else if( PSA_ALG_IS_KEY_DERIVATION( alg ) )
5274 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005275 status = psa_key_derivation_setup_kdf( operation, alg );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005276 }
John Durkop07cc04a2020-11-16 22:08:34 -08005277#endif
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005278 else
5279 return( PSA_ERROR_INVALID_ARGUMENT );
Gilles Peskine969c5d62019-01-16 15:53:06 +01005280
5281 if( status == PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005282 operation->alg = alg;
Gilles Peskine969c5d62019-01-16 15:53:06 +01005283 return( status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005284}
5285
John Durkopd0321952020-10-29 21:37:36 -07005286#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskinecbe66502019-05-16 16:59:18 +02005287static psa_status_t psa_hkdf_input( psa_hkdf_key_derivation_t *hkdf,
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005288 psa_algorithm_t hash_alg,
5289 psa_key_derivation_step_t step,
5290 const uint8_t *data,
5291 size_t data_length )
5292{
5293 psa_status_t status;
5294 switch( step )
5295 {
Gilles Peskine03410b52019-05-16 16:05:19 +02005296 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine2b522db2019-04-12 15:11:49 +02005297 if( hkdf->state != HKDF_STATE_INIT )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005298 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005299 status = psa_hmac_setup_internal( &hkdf->hmac,
5300 data, data_length,
5301 hash_alg );
5302 if( status != PSA_SUCCESS )
5303 return( status );
5304 hkdf->state = HKDF_STATE_STARTED;
5305 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005306 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005307 /* If no salt was provided, use an empty salt. */
5308 if( hkdf->state == HKDF_STATE_INIT )
5309 {
5310 status = psa_hmac_setup_internal( &hkdf->hmac,
5311 NULL, 0,
Gilles Peskinef9ee6332019-04-11 21:22:52 +02005312 hash_alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005313 if( status != PSA_SUCCESS )
5314 return( status );
5315 hkdf->state = HKDF_STATE_STARTED;
5316 }
Gilles Peskine2b522db2019-04-12 15:11:49 +02005317 if( hkdf->state != HKDF_STATE_STARTED )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005318 return( PSA_ERROR_BAD_STATE );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005319 status = psa_hash_update( &hkdf->hmac.hash_ctx,
5320 data, data_length );
5321 if( status != PSA_SUCCESS )
5322 return( status );
5323 status = psa_hmac_finish_internal( &hkdf->hmac,
5324 hkdf->prk,
5325 sizeof( hkdf->prk ) );
5326 if( status != PSA_SUCCESS )
5327 return( status );
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005328 hkdf->offset_in_block = PSA_HASH_LENGTH( hash_alg );
Gilles Peskine2b522db2019-04-12 15:11:49 +02005329 hkdf->block_number = 0;
5330 hkdf->state = HKDF_STATE_KEYED;
5331 return( PSA_SUCCESS );
Gilles Peskine03410b52019-05-16 16:05:19 +02005332 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005333 if( hkdf->state == HKDF_STATE_OUTPUT )
5334 return( PSA_ERROR_BAD_STATE );
5335 if( hkdf->info_set )
5336 return( PSA_ERROR_BAD_STATE );
5337 hkdf->info_length = data_length;
5338 if( data_length != 0 )
5339 {
5340 hkdf->info = mbedtls_calloc( 1, data_length );
5341 if( hkdf->info == NULL )
5342 return( PSA_ERROR_INSUFFICIENT_MEMORY );
5343 memcpy( hkdf->info, data, data_length );
5344 }
5345 hkdf->info_set = 1;
5346 return( PSA_SUCCESS );
5347 default:
5348 return( PSA_ERROR_INVALID_ARGUMENT );
5349 }
5350}
John Durkop07cc04a2020-11-16 22:08:34 -08005351#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01005352
John Durkop07cc04a2020-11-16 22:08:34 -08005353#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5354 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follathf08e2652019-06-13 09:05:41 +01005355static psa_status_t psa_tls12_prf_set_seed( psa_tls12_prf_key_derivation_t *prf,
5356 const uint8_t *data,
5357 size_t data_length )
5358{
5359 if( prf->state != TLS12_PRF_STATE_INIT )
5360 return( PSA_ERROR_BAD_STATE );
5361
Janos Follathd6dce9f2019-07-04 09:11:38 +01005362 if( data_length != 0 )
5363 {
5364 prf->seed = mbedtls_calloc( 1, data_length );
5365 if( prf->seed == NULL )
5366 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follathf08e2652019-06-13 09:05:41 +01005367
Janos Follathd6dce9f2019-07-04 09:11:38 +01005368 memcpy( prf->seed, data, data_length );
5369 prf->seed_length = data_length;
5370 }
Janos Follathf08e2652019-06-13 09:05:41 +01005371
5372 prf->state = TLS12_PRF_STATE_SEED_SET;
5373
5374 return( PSA_SUCCESS );
5375}
5376
Janos Follath81550542019-06-13 14:26:34 +01005377static psa_status_t psa_tls12_prf_set_key( psa_tls12_prf_key_derivation_t *prf,
5378 psa_algorithm_t hash_alg,
5379 const uint8_t *data,
5380 size_t data_length )
5381{
5382 psa_status_t status;
5383 if( prf->state != TLS12_PRF_STATE_SEED_SET )
5384 return( PSA_ERROR_BAD_STATE );
5385
5386 status = psa_hmac_setup_internal( &prf->hmac, data, data_length, hash_alg );
5387 if( status != PSA_SUCCESS )
5388 return( status );
5389
5390 prf->state = TLS12_PRF_STATE_KEY_SET;
5391
5392 return( PSA_SUCCESS );
5393}
5394
Janos Follath63028dd2019-06-13 09:15:47 +01005395static psa_status_t psa_tls12_prf_set_label( psa_tls12_prf_key_derivation_t *prf,
5396 const uint8_t *data,
5397 size_t data_length )
5398{
5399 if( prf->state != TLS12_PRF_STATE_KEY_SET )
5400 return( PSA_ERROR_BAD_STATE );
5401
Janos Follathd6dce9f2019-07-04 09:11:38 +01005402 if( data_length != 0 )
5403 {
5404 prf->label = mbedtls_calloc( 1, data_length );
5405 if( prf->label == NULL )
5406 return( PSA_ERROR_INSUFFICIENT_MEMORY );
Janos Follath63028dd2019-06-13 09:15:47 +01005407
Janos Follathd6dce9f2019-07-04 09:11:38 +01005408 memcpy( prf->label, data, data_length );
5409 prf->label_length = data_length;
5410 }
Janos Follath63028dd2019-06-13 09:15:47 +01005411
5412 prf->state = TLS12_PRF_STATE_LABEL_SET;
5413
5414 return( PSA_SUCCESS );
5415}
5416
Janos Follathb03233e2019-06-11 15:30:30 +01005417static psa_status_t psa_tls12_prf_input( psa_tls12_prf_key_derivation_t *prf,
5418 psa_algorithm_t hash_alg,
5419 psa_key_derivation_step_t step,
5420 const uint8_t *data,
5421 size_t data_length )
5422{
Janos Follathb03233e2019-06-11 15:30:30 +01005423 switch( step )
5424 {
Janos Follathf08e2652019-06-13 09:05:41 +01005425 case PSA_KEY_DERIVATION_INPUT_SEED:
5426 return( psa_tls12_prf_set_seed( prf, data, data_length ) );
Janos Follath81550542019-06-13 14:26:34 +01005427 case PSA_KEY_DERIVATION_INPUT_SECRET:
5428 return( psa_tls12_prf_set_key( prf, hash_alg, data, data_length ) );
Janos Follath63028dd2019-06-13 09:15:47 +01005429 case PSA_KEY_DERIVATION_INPUT_LABEL:
5430 return( psa_tls12_prf_set_label( prf, data, data_length ) );
Janos Follathb03233e2019-06-11 15:30:30 +01005431 default:
5432 return( PSA_ERROR_INVALID_ARGUMENT );
5433 }
5434}
John Durkop07cc04a2020-11-16 22:08:34 -08005435#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5436 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
5437
5438#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5439static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
5440 psa_tls12_prf_key_derivation_t *prf,
5441 psa_algorithm_t hash_alg,
5442 const uint8_t *data,
5443 size_t data_length )
5444{
5445 psa_status_t status;
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005446 uint8_t pms[ 4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE ];
John Durkop07cc04a2020-11-16 22:08:34 -08005447 uint8_t *cur = pms;
5448
gabor-mezei-armcbcec212020-12-18 14:23:51 +01005449 if( data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE )
John Durkop07cc04a2020-11-16 22:08:34 -08005450 return( PSA_ERROR_INVALID_ARGUMENT );
5451
5452 /* Quoting RFC 4279, Section 2:
5453 *
5454 * The premaster secret is formed as follows: if the PSK is N octets
5455 * long, concatenate a uint16 with the value N, N zero octets, a second
5456 * uint16 with the value N, and the PSK itself.
5457 */
5458
5459 *cur++ = ( data_length >> 8 ) & 0xff;
5460 *cur++ = ( data_length >> 0 ) & 0xff;
5461 memset( cur, 0, data_length );
5462 cur += data_length;
5463 *cur++ = pms[0];
5464 *cur++ = pms[1];
5465 memcpy( cur, data, data_length );
5466 cur += data_length;
5467
5468 status = psa_tls12_prf_set_key( prf, hash_alg, pms, cur - pms );
5469
5470 mbedtls_platform_zeroize( pms, sizeof( pms ) );
5471 return( status );
5472}
Janos Follath6660f0e2019-06-17 08:44:03 +01005473
5474static psa_status_t psa_tls12_prf_psk_to_ms_input(
5475 psa_tls12_prf_key_derivation_t *prf,
5476 psa_algorithm_t hash_alg,
5477 psa_key_derivation_step_t step,
5478 const uint8_t *data,
5479 size_t data_length )
5480{
5481 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
Janos Follath0c1ed842019-06-28 13:35:36 +01005482 {
Janos Follath6660f0e2019-06-17 08:44:03 +01005483 return( psa_tls12_prf_psk_to_ms_set_key( prf, hash_alg,
5484 data, data_length ) );
Janos Follath0c1ed842019-06-28 13:35:36 +01005485 }
Janos Follath6660f0e2019-06-17 08:44:03 +01005486
5487 return( psa_tls12_prf_input( prf, hash_alg, step, data, data_length ) );
5488}
John Durkop07cc04a2020-11-16 22:08:34 -08005489#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005490
Gilles Peskineb8965192019-09-24 16:21:10 +02005491/** Check whether the given key type is acceptable for the given
5492 * input step of a key derivation.
5493 *
5494 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
5495 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
5496 * Both secret and non-secret inputs can alternatively have the type
5497 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
5498 * that the input was passed as a buffer rather than via a key object.
5499 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02005500static int psa_key_derivation_check_input_type(
5501 psa_key_derivation_step_t step,
5502 psa_key_type_t key_type )
5503{
5504 switch( step )
5505 {
5506 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb8965192019-09-24 16:21:10 +02005507 if( key_type == PSA_KEY_TYPE_DERIVE )
5508 return( PSA_SUCCESS );
5509 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005510 return( PSA_SUCCESS );
5511 break;
5512 case PSA_KEY_DERIVATION_INPUT_LABEL:
5513 case PSA_KEY_DERIVATION_INPUT_SALT:
5514 case PSA_KEY_DERIVATION_INPUT_INFO:
5515 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskineb8965192019-09-24 16:21:10 +02005516 if( key_type == PSA_KEY_TYPE_RAW_DATA )
5517 return( PSA_SUCCESS );
5518 if( key_type == PSA_KEY_TYPE_NONE )
Gilles Peskine224b0d62019-09-23 18:13:17 +02005519 return( PSA_SUCCESS );
5520 break;
5521 }
5522 return( PSA_ERROR_INVALID_ARGUMENT );
5523}
5524
Janos Follathb80a94e2019-06-12 15:54:46 +01005525static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005526 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005527 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005528 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005529 const uint8_t *data,
5530 size_t data_length )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005531{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02005532 psa_status_t status;
5533 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg( operation );
5534
5535 status = psa_key_derivation_check_input_type( step, key_type );
Gilles Peskine224b0d62019-09-23 18:13:17 +02005536 if( status != PSA_SUCCESS )
5537 goto exit;
5538
John Durkopd0321952020-10-29 21:37:36 -07005539#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005540 if( PSA_ALG_IS_HKDF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005541 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005542 status = psa_hkdf_input( &operation->ctx.hkdf,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005543 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005544 step, data, data_length );
5545 }
John Durkop07cc04a2020-11-16 22:08:34 -08005546 else
5547#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
5548#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
5549 if( PSA_ALG_IS_TLS12_PRF( kdf_alg ) )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005550 {
Janos Follathb03233e2019-06-11 15:30:30 +01005551 status = psa_tls12_prf_input( &operation->ctx.tls12_prf,
5552 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5553 step, data, data_length );
Janos Follath6660f0e2019-06-17 08:44:03 +01005554 }
John Durkop07cc04a2020-11-16 22:08:34 -08005555 else
5556#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5557#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5558 if( PSA_ALG_IS_TLS12_PSK_TO_MS( kdf_alg ) )
Janos Follath6660f0e2019-06-17 08:44:03 +01005559 {
5560 status = psa_tls12_prf_psk_to_ms_input( &operation->ctx.tls12_prf,
5561 PSA_ALG_HKDF_GET_HASH( kdf_alg ),
5562 step, data, data_length );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005563 }
5564 else
John Durkop07cc04a2020-11-16 22:08:34 -08005565#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005566 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005567 /* This can't happen unless the operation object was not initialized */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005568 return( PSA_ERROR_BAD_STATE );
5569 }
5570
Gilles Peskine224b0d62019-09-23 18:13:17 +02005571exit:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005572 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005573 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005574 return( status );
5575}
5576
Janos Follath51f4a0f2019-06-14 11:35:55 +01005577psa_status_t psa_key_derivation_input_bytes(
5578 psa_key_derivation_operation_t *operation,
5579 psa_key_derivation_step_t step,
5580 const uint8_t *data,
5581 size_t data_length )
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005582{
Gilles Peskineb8965192019-09-24 16:21:10 +02005583 return( psa_key_derivation_input_internal( operation, step,
5584 PSA_KEY_TYPE_NONE,
Janos Follathc5621512019-06-14 11:27:57 +01005585 data, data_length ) );
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005586}
5587
Janos Follath51f4a0f2019-06-14 11:35:55 +01005588psa_status_t psa_key_derivation_input_key(
5589 psa_key_derivation_operation_t *operation,
5590 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005591 mbedtls_svc_key_id_t key )
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005592{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005593 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005594 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005595 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005596
Ronald Cron5c522922020-11-14 16:35:34 +01005597 status = psa_get_and_lock_transparent_key_slot_with_policy(
5598 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005599 if( status != PSA_SUCCESS )
Gilles Peskine593773d2019-09-23 18:17:40 +02005600 {
5601 psa_key_derivation_abort( operation );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005602 return( status );
Gilles Peskine593773d2019-09-23 18:17:40 +02005603 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005604
5605 /* Passing a key object as a SECRET input unlocks the permission
5606 * to output to a key object. */
5607 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5608 operation->can_output_key = 1;
5609
Ronald Cronf95a2b12020-10-22 15:24:49 +02005610 status = psa_key_derivation_input_internal( operation,
5611 step, slot->attr.type,
Ronald Cronea0f8a62020-11-25 17:52:23 +01005612 slot->key.data,
5613 slot->key.bytes );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005614
Ronald Cron5c522922020-11-14 16:35:34 +01005615 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005616
Ronald Cron5c522922020-11-14 16:35:34 +01005617 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005618}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005619
5620
5621
5622/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005623/* Key agreement */
5624/****************************************************************/
5625
John Durkop6ba40d12020-11-10 08:50:04 -08005626#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005627static psa_status_t psa_key_agreement_ecdh( const uint8_t *peer_key,
5628 size_t peer_key_length,
5629 const mbedtls_ecp_keypair *our_key,
5630 uint8_t *shared_secret,
5631 size_t shared_secret_size,
5632 size_t *shared_secret_length )
5633{
Steven Cooremand4867872020-08-05 16:31:39 +02005634 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005635 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005636 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005637 size_t bits = 0;
Paul Elliott8ff510a2020-06-02 17:19:28 +01005638 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa( our_key->grp.id, &bits );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005639 mbedtls_ecdh_init( &ecdh );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005640
Ronald Cron90857082020-11-25 14:58:33 +01005641 status = mbedtls_psa_ecp_load_representation(
5642 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5643 peer_key,
5644 peer_key_length,
5645 &their_key );
Jaeden Amero97271b32019-01-10 19:38:51 +00005646 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005647 goto exit;
5648
Jaeden Amero97271b32019-01-10 19:38:51 +00005649 status = mbedtls_to_psa_error(
Steven Cooremana2371e52020-07-28 14:30:39 +02005650 mbedtls_ecdh_get_params( &ecdh, their_key, MBEDTLS_ECDH_THEIRS ) );
Jaeden Amero97271b32019-01-10 19:38:51 +00005651 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005652 goto exit;
Jaeden Amero97271b32019-01-10 19:38:51 +00005653 status = mbedtls_to_psa_error(
5654 mbedtls_ecdh_get_params( &ecdh, our_key, MBEDTLS_ECDH_OURS ) );
5655 if( status != PSA_SUCCESS )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005656 goto exit;
5657
Jaeden Amero97271b32019-01-10 19:38:51 +00005658 status = mbedtls_to_psa_error(
5659 mbedtls_ecdh_calc_secret( &ecdh,
5660 shared_secret_length,
5661 shared_secret, shared_secret_size,
Gilles Peskine30524eb2020-11-13 17:02:26 +01005662 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005663 MBEDTLS_PSA_RANDOM_STATE ) );
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005664 if( status != PSA_SUCCESS )
5665 goto exit;
5666 if( PSA_BITS_TO_BYTES( bits ) != *shared_secret_length )
5667 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005668
5669exit:
Gilles Peskine3e819b72019-12-20 14:09:55 +01005670 if( status != PSA_SUCCESS )
5671 mbedtls_platform_zeroize( shared_secret, shared_secret_size );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005672 mbedtls_ecdh_free( &ecdh );
Steven Cooremana2371e52020-07-28 14:30:39 +02005673 mbedtls_ecp_keypair_free( their_key );
Steven Cooreman6d839f02020-07-30 11:36:45 +02005674 mbedtls_free( their_key );
Steven Cooremana2371e52020-07-28 14:30:39 +02005675
Jaeden Amero97271b32019-01-10 19:38:51 +00005676 return( status );
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005677}
John Durkop6ba40d12020-11-10 08:50:04 -08005678#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005679
Gilles Peskine01d718c2018-09-18 12:01:02 +02005680#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5681
Gilles Peskine0216fe12019-04-11 21:23:21 +02005682static psa_status_t psa_key_agreement_raw_internal( psa_algorithm_t alg,
5683 psa_key_slot_t *private_key,
5684 const uint8_t *peer_key,
5685 size_t peer_key_length,
5686 uint8_t *shared_secret,
5687 size_t shared_secret_size,
5688 size_t *shared_secret_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005689{
Gilles Peskine0216fe12019-04-11 21:23:21 +02005690 switch( alg )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005691 {
John Durkop6ba40d12020-11-10 08:50:04 -08005692#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005693 case PSA_ALG_ECDH:
Gilles Peskine8e338702019-07-30 20:06:31 +02005694 if( ! PSA_KEY_TYPE_IS_ECC_KEY_PAIR( private_key->attr.type ) )
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005695 return( PSA_ERROR_INVALID_ARGUMENT );
Steven Cooremana2371e52020-07-28 14:30:39 +02005696 mbedtls_ecp_keypair *ecp = NULL;
Ronald Cron90857082020-11-25 14:58:33 +01005697 psa_status_t status = mbedtls_psa_ecp_load_representation(
5698 private_key->attr.type,
5699 private_key->key.data,
5700 private_key->key.bytes,
5701 &ecp );
Steven Cooremanacda8342020-07-24 23:09:52 +02005702 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02005703 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02005704 status = psa_key_agreement_ecdh( peer_key, peer_key_length,
Steven Cooremana2371e52020-07-28 14:30:39 +02005705 ecp,
Steven Cooremanacda8342020-07-24 23:09:52 +02005706 shared_secret, shared_secret_size,
5707 shared_secret_length );
Steven Cooremana2371e52020-07-28 14:30:39 +02005708 mbedtls_ecp_keypair_free( ecp );
5709 mbedtls_free( ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02005710 return( status );
John Durkop6ba40d12020-11-10 08:50:04 -08005711#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005712 default:
Gilles Peskine93f85002018-11-16 16:43:31 +01005713 (void) private_key;
5714 (void) peer_key;
5715 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005716 (void) shared_secret;
5717 (void) shared_secret_size;
5718 (void) shared_secret_length;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005719 return( PSA_ERROR_NOT_SUPPORTED );
5720 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005721}
5722
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005723/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005724 * to potentially free embedded data structures and wipe confidential data.
5725 */
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005726static psa_status_t psa_key_agreement_internal( psa_key_derivation_operation_t *operation,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005727 psa_key_derivation_step_t step,
Gilles Peskine01d718c2018-09-18 12:01:02 +02005728 psa_key_slot_t *private_key,
5729 const uint8_t *peer_key,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005730 size_t peer_key_length )
Gilles Peskine01d718c2018-09-18 12:01:02 +02005731{
5732 psa_status_t status;
5733 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5734 size_t shared_secret_length = 0;
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005735 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE( operation->alg );
Gilles Peskine01d718c2018-09-18 12:01:02 +02005736
5737 /* Step 1: run the secret agreement algorithm to generate the shared
5738 * secret. */
Gilles Peskine0216fe12019-04-11 21:23:21 +02005739 status = psa_key_agreement_raw_internal( ka_alg,
5740 private_key,
5741 peer_key, peer_key_length,
itayzafrir0adf0fc2018-09-06 16:24:41 +03005742 shared_secret,
5743 sizeof( shared_secret ),
Gilles Peskine05d69892018-06-19 22:00:52 +02005744 &shared_secret_length );
Gilles Peskine53d991e2018-07-12 01:14:59 +02005745 if( status != PSA_SUCCESS )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005746 goto exit;
5747
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005748 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005749 * the shared secret. A shared secret is permitted wherever a key
5750 * of type DERIVE is permitted. */
Janos Follathb80a94e2019-06-12 15:54:46 +01005751 status = psa_key_derivation_input_internal( operation, step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02005752 PSA_KEY_TYPE_DERIVE,
Janos Follathb80a94e2019-06-12 15:54:46 +01005753 shared_secret,
5754 shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005755exit:
Gilles Peskine3f108122018-12-07 18:14:53 +01005756 mbedtls_platform_zeroize( shared_secret, shared_secret_length );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005757 return( status );
5758}
5759
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005760psa_status_t psa_key_derivation_key_agreement( psa_key_derivation_operation_t *operation,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005761 psa_key_derivation_step_t step,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005762 mbedtls_svc_key_id_t private_key,
Gilles Peskinecf7292e2019-05-16 17:53:40 +02005763 const uint8_t *peer_key,
5764 size_t peer_key_length )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005765{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005766 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005767 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005768 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005769
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005770 if( ! PSA_ALG_IS_KEY_AGREEMENT( operation->alg ) )
Gilles Peskine12313cd2018-06-20 00:20:32 +02005771 return( PSA_ERROR_INVALID_ARGUMENT );
Ronald Cron5c522922020-11-14 16:35:34 +01005772 status = psa_get_and_lock_transparent_key_slot_with_policy(
5773 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg );
Gilles Peskine12313cd2018-06-20 00:20:32 +02005774 if( status != PSA_SUCCESS )
5775 return( status );
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005776 status = psa_key_agreement_internal( operation, step,
Gilles Peskine346797d2018-11-16 16:05:06 +01005777 slot,
Gilles Peskine969c5d62019-01-16 15:53:06 +01005778 peer_key, peer_key_length );
Gilles Peskine346797d2018-11-16 16:05:06 +01005779 if( status != PSA_SUCCESS )
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005780 psa_key_derivation_abort( operation );
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005781 else
5782 {
5783 /* If a private key has been added as SECRET, we allow the derived
5784 * key material to be used as a key in PSA Crypto. */
5785 if( step == PSA_KEY_DERIVATION_INPUT_SECRET )
5786 operation->can_output_key = 1;
5787 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005788
Ronald Cron5c522922020-11-14 16:35:34 +01005789 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005790
Ronald Cron5c522922020-11-14 16:35:34 +01005791 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005792}
5793
Gilles Peskinebe697d82019-05-16 18:00:41 +02005794psa_status_t psa_raw_key_agreement( psa_algorithm_t alg,
Ronald Croncf56a0a2020-08-04 09:51:30 +02005795 mbedtls_svc_key_id_t private_key,
Gilles Peskinebe697d82019-05-16 18:00:41 +02005796 const uint8_t *peer_key,
5797 size_t peer_key_length,
5798 uint8_t *output,
5799 size_t output_size,
5800 size_t *output_length )
Gilles Peskine0216fe12019-04-11 21:23:21 +02005801{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005802 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005803 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005804 psa_key_slot_t *slot = NULL;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005805
5806 if( ! PSA_ALG_IS_KEY_AGREEMENT( alg ) )
5807 {
5808 status = PSA_ERROR_INVALID_ARGUMENT;
5809 goto exit;
5810 }
Ronald Cron5c522922020-11-14 16:35:34 +01005811 status = psa_get_and_lock_transparent_key_slot_with_policy(
5812 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005813 if( status != PSA_SUCCESS )
5814 goto exit;
5815
5816 status = psa_key_agreement_raw_internal( alg, slot,
5817 peer_key, peer_key_length,
5818 output, output_size,
5819 output_length );
5820
5821exit:
5822 if( status != PSA_SUCCESS )
5823 {
5824 /* If an error happens and is not handled properly, the output
5825 * may be used as a key to protect sensitive data. Arrange for such
5826 * a key to be random, which is likely to result in decryption or
5827 * verification errors. This is better than filling the buffer with
5828 * some constant data such as zeros, which would result in the data
5829 * being protected with a reproducible, easily knowable key.
5830 */
5831 psa_generate_random( output, output_size );
5832 *output_length = output_size;
5833 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005834
Ronald Cron5c522922020-11-14 16:35:34 +01005835 unlock_status = psa_unlock_key_slot( slot );
Ronald Cronf95a2b12020-10-22 15:24:49 +02005836
Ronald Cron5c522922020-11-14 16:35:34 +01005837 return( ( status == PSA_SUCCESS ) ? unlock_status : status );
Gilles Peskine0216fe12019-04-11 21:23:21 +02005838}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005839
5840
Gilles Peskine30524eb2020-11-13 17:02:26 +01005841
Gilles Peskine86a440b2018-11-12 18:39:40 +01005842/****************************************************************/
5843/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005844/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005845
Gilles Peskine30524eb2020-11-13 17:02:26 +01005846/** Initialize the PSA random generator.
5847 */
5848static void mbedtls_psa_random_init( mbedtls_psa_random_context_t *rng )
5849{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005850#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5851 memset( rng, 0, sizeof( *rng ) );
5852#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5853
Gilles Peskine30524eb2020-11-13 17:02:26 +01005854 /* Set default configuration if
5855 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
5856 if( rng->entropy_init == NULL )
5857 rng->entropy_init = mbedtls_entropy_init;
5858 if( rng->entropy_free == NULL )
5859 rng->entropy_free = mbedtls_entropy_free;
5860
5861 rng->entropy_init( &rng->entropy );
5862#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5863 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5864 /* The PSA entropy injection feature depends on using NV seed as an entropy
5865 * source. Add NV seed as an entropy source for PSA entropy injection. */
5866 mbedtls_entropy_add_source( &rng->entropy,
5867 mbedtls_nv_seed_poll, NULL,
5868 MBEDTLS_ENTROPY_BLOCK_SIZE,
5869 MBEDTLS_ENTROPY_SOURCE_STRONG );
5870#endif
5871
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005872 mbedtls_psa_drbg_init( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005873#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005874}
5875
5876/** Deinitialize the PSA random generator.
5877 */
5878static void mbedtls_psa_random_free( mbedtls_psa_random_context_t *rng )
5879{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005880#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5881 memset( rng, 0, sizeof( *rng ) );
5882#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005883 mbedtls_psa_drbg_free( MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005884 rng->entropy_free( &rng->entropy );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005885#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005886}
5887
5888/** Seed the PSA random generator.
5889 */
5890static psa_status_t mbedtls_psa_random_seed( mbedtls_psa_random_context_t *rng )
5891{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005892#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5893 /* Do nothing: the external RNG seeds itself. */
5894 (void) rng;
5895 return( PSA_SUCCESS );
5896#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005897 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine5894e8e2020-12-14 14:54:06 +01005898 int ret = mbedtls_psa_drbg_seed( &rng->entropy,
5899 drbg_seed, sizeof( drbg_seed ) - 1 );
Gilles Peskine30524eb2020-11-13 17:02:26 +01005900 return mbedtls_to_psa_error( ret );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005901#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005902}
5903
Gilles Peskinee59236f2018-01-27 23:32:46 +01005904psa_status_t psa_generate_random( uint8_t *output,
5905 size_t output_size )
5906{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005907 GUARD_MODULE_INITIALIZED;
5908
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005909#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5910
5911 size_t output_length = 0;
5912 psa_status_t status = mbedtls_psa_external_get_random( &global_data.rng,
5913 output, output_size,
5914 &output_length );
5915 if( status != PSA_SUCCESS )
5916 return( status );
5917 /* Breaking up a request into smaller chunks is currently not supported
5918 * for the extrernal RNG interface. */
5919 if( output_length != output_size )
5920 return( PSA_ERROR_INSUFFICIENT_ENTROPY );
5921 return( PSA_SUCCESS );
5922
5923#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5924
Gilles Peskine71ddab92021-01-04 21:01:07 +01005925 while( output_size > 0 )
Gilles Peskinef181eca2019-08-07 13:49:00 +02005926 {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005927 size_t request_size =
5928 ( output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5929 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5930 output_size );
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005931 int ret = mbedtls_psa_get_random( MBEDTLS_PSA_RANDOM_STATE,
5932 output, request_size );
Gilles Peskinef181eca2019-08-07 13:49:00 +02005933 if( ret != 0 )
5934 return( mbedtls_to_psa_error( ret ) );
Gilles Peskine71ddab92021-01-04 21:01:07 +01005935 output_size -= request_size;
5936 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005937 }
Gilles Peskine0c59ba82021-01-05 14:10:59 +01005938 return( PSA_SUCCESS );
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005939#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005940}
5941
Gilles Peskine8814fc42020-12-14 15:33:44 +01005942/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005943 *
5944 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5945 * `psa_generate_random(...)`. The state parameter is ignored since the
5946 * PSA API doesn't support passing an explicit state.
5947 *
5948 * In the non-external case, psa_generate_random() calls an
5949 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5950 * and semantics as mbedtls_psa_get_random(). As an optimization,
5951 * instead of doing this back-and-forth between the PSA API and the
5952 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5953 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005954 */
5955#if defined (MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5956int mbedtls_psa_get_random( void *p_rng,
5957 unsigned char *output,
5958 size_t output_size )
5959{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005960 /* This function takes a pointer to the RNG state because that's what
5961 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5962 * its own state internally and doesn't let the caller access that state.
5963 * So we just ignore the state parameter, and in practice we'll pass
5964 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005965 (void) p_rng;
5966 psa_status_t status = psa_generate_random( output, output_size );
5967 if( status == PSA_SUCCESS )
5968 return( 0 );
5969 else
5970 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
5971}
5972#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5973
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005974#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5975#include "mbedtls/entropy_poll.h"
5976
Gilles Peskine7228da22019-07-15 11:06:15 +02005977psa_status_t mbedtls_psa_inject_entropy( const uint8_t *seed,
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005978 size_t seed_size )
5979{
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005980 if( global_data.initialized )
5981 return( PSA_ERROR_NOT_PERMITTED );
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005982
5983 if( ( ( seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM ) ||
5984 ( seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE ) ) ||
5985 ( seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE ) )
5986 return( PSA_ERROR_INVALID_ARGUMENT );
5987
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005988 return( mbedtls_psa_storage_inject_entropy( seed, seed_size ) );
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005989}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005990#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005991
John Durkop07cc04a2020-11-16 22:08:34 -08005992#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinee56e8782019-04-26 17:34:02 +02005993static psa_status_t psa_read_rsa_exponent( const uint8_t *domain_parameters,
5994 size_t domain_parameters_size,
5995 int *exponent )
Gilles Peskinee59236f2018-01-27 23:32:46 +01005996{
Gilles Peskinee56e8782019-04-26 17:34:02 +02005997 size_t i;
5998 uint32_t acc = 0;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005999
Gilles Peskinee56e8782019-04-26 17:34:02 +02006000 if( domain_parameters_size == 0 )
6001 {
6002 *exponent = 65537;
6003 return( PSA_SUCCESS );
6004 }
6005
6006 /* Mbed TLS encodes the public exponent as an int. For simplicity, only
6007 * support values that fit in a 32-bit integer, which is larger than
6008 * int on just about every platform anyway. */
6009 if( domain_parameters_size > sizeof( acc ) )
6010 return( PSA_ERROR_NOT_SUPPORTED );
6011 for( i = 0; i < domain_parameters_size; i++ )
6012 acc = ( acc << 8 ) | domain_parameters[i];
6013 if( acc > INT_MAX )
6014 return( PSA_ERROR_NOT_SUPPORTED );
6015 *exponent = acc;
6016 return( PSA_SUCCESS );
6017}
John Durkop07cc04a2020-11-16 22:08:34 -08006018#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee56e8782019-04-26 17:34:02 +02006019
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006020static psa_status_t psa_generate_key_internal(
Gilles Peskinee56e8782019-04-26 17:34:02 +02006021 psa_key_slot_t *slot, size_t bits,
6022 const uint8_t *domain_parameters, size_t domain_parameters_size )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006023{
Gilles Peskine8e338702019-07-30 20:06:31 +02006024 psa_key_type_t type = slot->attr.type;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006025
Gilles Peskinee56e8782019-04-26 17:34:02 +02006026 if( domain_parameters == NULL && domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006027 return( PSA_ERROR_INVALID_ARGUMENT );
6028
Gilles Peskinee59236f2018-01-27 23:32:46 +01006029 if( key_type_is_raw_bytes( type ) )
6030 {
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006031 psa_status_t status;
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006032
6033 status = validate_unstructured_key_bit_size( slot->attr.type, bits );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006034 if( status != PSA_SUCCESS )
6035 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006036
6037 /* Allocate memory for the key */
Steven Cooreman75b74362020-07-28 14:30:13 +02006038 status = psa_allocate_buffer_to_slot( slot, PSA_BITS_TO_BYTES( bits ) );
6039 if( status != PSA_SUCCESS )
Steven Cooreman29149862020-08-05 15:43:42 +02006040 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006041
Ronald Cronea0f8a62020-11-25 17:52:23 +01006042 status = psa_generate_random( slot->key.data,
6043 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006044 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006045 return( status );
Steven Cooreman81be2fa2020-07-24 22:04:59 +02006046
6047 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006048#if defined(MBEDTLS_DES_C)
6049 if( type == PSA_KEY_TYPE_DES )
Ronald Cronea0f8a62020-11-25 17:52:23 +01006050 psa_des_set_key_parity( slot->key.data,
6051 slot->key.bytes );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006052#endif /* MBEDTLS_DES_C */
6053 }
6054 else
6055
John Durkop07cc04a2020-11-16 22:08:34 -08006056#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006057 if ( type == PSA_KEY_TYPE_RSA_KEY_PAIR )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006058 {
Steven Cooremana01795d2020-07-24 22:48:15 +02006059 mbedtls_rsa_context rsa;
Janos Follath24eed8d2019-11-22 13:21:35 +00006060 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006061 int exponent;
6062 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006063 if( bits > PSA_VENDOR_RSA_MAX_KEY_BITS )
6064 return( PSA_ERROR_NOT_SUPPORTED );
6065 /* Accept only byte-aligned keys, for the same reasons as
Ronald Cronb6420e32020-11-22 16:15:38 +01006066 * in mbedtls_psa_rsa_import_key(). */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006067 if( bits % 8 != 0 )
6068 return( PSA_ERROR_NOT_SUPPORTED );
Gilles Peskinee56e8782019-04-26 17:34:02 +02006069 status = psa_read_rsa_exponent( domain_parameters,
6070 domain_parameters_size,
6071 &exponent );
6072 if( status != PSA_SUCCESS )
6073 return( status );
Steven Cooremana01795d2020-07-24 22:48:15 +02006074 mbedtls_rsa_init( &rsa, MBEDTLS_RSA_PKCS_V15, MBEDTLS_MD_NONE );
6075 ret = mbedtls_rsa_gen_key( &rsa,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006076 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006077 MBEDTLS_PSA_RANDOM_STATE,
Gilles Peskinee59236f2018-01-27 23:32:46 +01006078 (unsigned int) bits,
6079 exponent );
6080 if( ret != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006081 return( mbedtls_to_psa_error( ret ) );
Steven Cooremana01795d2020-07-24 22:48:15 +02006082
6083 /* Make sure to always have an export representation available */
6084 size_t bytes = PSA_KEY_EXPORT_RSA_KEY_PAIR_MAX_SIZE( bits );
6085
Steven Cooreman75b74362020-07-28 14:30:13 +02006086 status = psa_allocate_buffer_to_slot( slot, bytes );
6087 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006088 {
6089 mbedtls_rsa_free( &rsa );
Steven Cooreman29149862020-08-05 15:43:42 +02006090 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006091 }
Steven Cooremana01795d2020-07-24 22:48:15 +02006092
Ronald Cron3c8ca3a2020-11-26 16:45:24 +01006093 status = mbedtls_psa_rsa_export_key( type,
6094 &rsa,
6095 slot->key.data,
6096 bytes,
6097 &slot->key.bytes );
Steven Cooremana01795d2020-07-24 22:48:15 +02006098 mbedtls_rsa_free( &rsa );
6099 if( status != PSA_SUCCESS )
Steven Cooremana01795d2020-07-24 22:48:15 +02006100 psa_remove_key_data_from_memory( slot );
Steven Cooreman560c28a2020-07-24 23:20:24 +02006101 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006102 }
6103 else
John Durkop07cc04a2020-11-16 22:08:34 -08006104#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006105
John Durkop9814fa22020-11-04 12:28:15 -08006106#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02006107 if ( PSA_KEY_TYPE_IS_ECC( type ) && PSA_KEY_TYPE_IS_KEY_PAIR( type ) )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006108 {
Paul Elliott8ff510a2020-06-02 17:19:28 +01006109 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY( type );
Gilles Peskine4295e8b2019-12-02 21:39:10 +01006110 mbedtls_ecp_group_id grp_id =
6111 mbedtls_ecc_group_of_psa( curve, PSA_BITS_TO_BYTES( bits ) );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006112 const mbedtls_ecp_curve_info *curve_info =
6113 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Steven Cooremanacda8342020-07-24 23:09:52 +02006114 mbedtls_ecp_keypair ecp;
Janos Follath24eed8d2019-11-22 13:21:35 +00006115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee56e8782019-04-26 17:34:02 +02006116 if( domain_parameters_size != 0 )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006117 return( PSA_ERROR_NOT_SUPPORTED );
6118 if( grp_id == MBEDTLS_ECP_DP_NONE || curve_info == NULL )
6119 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooremanacda8342020-07-24 23:09:52 +02006120 mbedtls_ecp_keypair_init( &ecp );
6121 ret = mbedtls_ecp_gen_key( grp_id, &ecp,
Gilles Peskine30524eb2020-11-13 17:02:26 +01006122 mbedtls_psa_get_random,
Gilles Peskine5894e8e2020-12-14 14:54:06 +01006123 MBEDTLS_PSA_RANDOM_STATE );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006124 if( ret != 0 )
6125 {
Steven Cooremanacda8342020-07-24 23:09:52 +02006126 mbedtls_ecp_keypair_free( &ecp );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006127 return( mbedtls_to_psa_error( ret ) );
6128 }
Steven Cooremanacda8342020-07-24 23:09:52 +02006129
6130
6131 /* Make sure to always have an export representation available */
6132 size_t bytes = PSA_BITS_TO_BYTES( bits );
Steven Cooreman75b74362020-07-28 14:30:13 +02006133 psa_status_t status = psa_allocate_buffer_to_slot( slot, bytes );
6134 if( status != PSA_SUCCESS )
Steven Cooremanacda8342020-07-24 23:09:52 +02006135 {
6136 mbedtls_ecp_keypair_free( &ecp );
Steven Cooreman29149862020-08-05 15:43:42 +02006137 return( status );
Steven Cooremanacda8342020-07-24 23:09:52 +02006138 }
Steven Cooreman75b74362020-07-28 14:30:13 +02006139
6140 status = mbedtls_to_psa_error(
Ronald Cronea0f8a62020-11-25 17:52:23 +01006141 mbedtls_ecp_write_key( &ecp, slot->key.data, bytes ) );
Steven Cooremanacda8342020-07-24 23:09:52 +02006142
6143 mbedtls_ecp_keypair_free( &ecp );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006144 if( status != PSA_SUCCESS ) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01006145 memset( slot->key.data, 0, bytes );
Steven Cooremanacda8342020-07-24 23:09:52 +02006146 psa_remove_key_data_from_memory( slot );
Steven Cooremanb7f6dea2020-08-05 16:07:20 +02006147 }
Steven Cooreman560c28a2020-07-24 23:20:24 +02006148 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006149 }
6150 else
John Durkop9814fa22020-11-04 12:28:15 -08006151#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02006152 {
Gilles Peskinee59236f2018-01-27 23:32:46 +01006153 return( PSA_ERROR_NOT_SUPPORTED );
Steven Cooreman29149862020-08-05 15:43:42 +02006154 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01006155
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006156 return( PSA_SUCCESS );
6157}
Darryl Green0c6575a2018-11-07 16:05:30 +00006158
Gilles Peskine35ef36b2019-05-16 19:42:05 +02006159psa_status_t psa_generate_key( const psa_key_attributes_t *attributes,
Ronald Croncf56a0a2020-08-04 09:51:30 +02006160 mbedtls_svc_key_id_t *key )
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006161{
6162 psa_status_t status;
6163 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006164 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine11792082019-08-06 18:36:36 +02006165
Ronald Cron81709fc2020-11-14 12:10:32 +01006166 *key = MBEDTLS_SVC_KEY_ID_INIT;
6167
Gilles Peskine0f84d622019-09-12 19:03:13 +02006168 /* Reject any attempt to create a zero-length key so that we don't
6169 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
6170 if( psa_get_key_bits( attributes ) == 0 )
6171 return( PSA_ERROR_INVALID_ARGUMENT );
6172
Ronald Cron81709fc2020-11-14 12:10:32 +01006173 status = psa_start_key_creation( PSA_KEY_CREATION_GENERATE, attributes,
6174 &slot, &driver );
Gilles Peskine11792082019-08-06 18:36:36 +02006175 if( status != PSA_SUCCESS )
6176 goto exit;
6177
Steven Cooreman2a1664c2020-07-20 15:33:08 +02006178 status = psa_driver_wrapper_generate_key( attributes,
6179 slot );
6180 if( status != PSA_ERROR_NOT_SUPPORTED ||
6181 psa_key_lifetime_is_external( attributes->core.lifetime ) )
6182 goto exit;
6183
6184 status = psa_generate_key_internal(
6185 slot, attributes->core.bits,
6186 attributes->domain_parameters, attributes->domain_parameters_size );
Gilles Peskine11792082019-08-06 18:36:36 +02006187
6188exit:
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006189 if( status == PSA_SUCCESS )
Ronald Cron81709fc2020-11-14 12:10:32 +01006190 status = psa_finish_key_creation( slot, driver, key );
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006191 if( status != PSA_SUCCESS )
Gilles Peskine011e4282019-06-26 18:34:38 +02006192 psa_fail_key_creation( slot, driver );
Ronald Cronf95a2b12020-10-22 15:24:49 +02006193
Darryl Green0c6575a2018-11-07 16:05:30 +00006194 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006195}
6196
6197
Gilles Peskinee59236f2018-01-27 23:32:46 +01006198
6199/****************************************************************/
6200/* Module setup */
6201/****************************************************************/
6202
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006203#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01006204psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
6205 void (* entropy_init )( mbedtls_entropy_context *ctx ),
6206 void (* entropy_free )( mbedtls_entropy_context *ctx ) )
6207{
6208 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6209 return( PSA_ERROR_BAD_STATE );
Gilles Peskine30524eb2020-11-13 17:02:26 +01006210 global_data.rng.entropy_init = entropy_init;
6211 global_data.rng.entropy_free = entropy_free;
Gilles Peskine5e769522018-11-20 21:59:56 +01006212 return( PSA_SUCCESS );
6213}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01006214#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01006215
Gilles Peskinee59236f2018-01-27 23:32:46 +01006216void mbedtls_psa_crypto_free( void )
6217{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006218 psa_wipe_all_key_slots( );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006219 if( global_data.rng_state != RNG_NOT_INITIALIZED )
6220 {
Gilles Peskine30524eb2020-11-13 17:02:26 +01006221 mbedtls_psa_random_free( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006222 }
6223 /* Wipe all remaining data, including configuration.
6224 * In particular, this sets all state indicator to the value
6225 * indicating "uninitialized". */
Gilles Peskine3f108122018-12-07 18:14:53 +01006226 mbedtls_platform_zeroize( &global_data, sizeof( global_data ) );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006227#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +02006228 /* Unregister all secure element drivers, so that we restart from
6229 * a pristine state. */
6230 psa_unregister_all_se_drivers( );
Gilles Peskinea8ade162019-06-26 11:24:49 +02006231#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006232}
6233
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006234#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
6235/** Recover a transaction that was interrupted by a power failure.
6236 *
6237 * This function is called during initialization, before psa_crypto_init()
6238 * returns. If this function returns a failure status, the initialization
6239 * fails.
6240 */
6241static psa_status_t psa_crypto_recover_transaction(
6242 const psa_crypto_transaction_t *transaction )
6243{
6244 switch( transaction->unknown.type )
6245 {
6246 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
6247 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01006248 /* TODO - fall through to the failure case until this
Gilles Peskinec9d7f942019-08-13 16:17:16 +02006249 * is implemented.
6250 * https://github.com/ARMmbed/mbed-crypto/issues/218
6251 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006252 default:
6253 /* We found an unsupported transaction in the storage.
6254 * We don't know what state the storage is in. Give up. */
6255 return( PSA_ERROR_STORAGE_FAILURE );
6256 }
6257}
6258#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
6259
Gilles Peskinee59236f2018-01-27 23:32:46 +01006260psa_status_t psa_crypto_init( void )
6261{
Gilles Peskine66fb1262018-12-10 16:29:04 +01006262 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006263
Gilles Peskinec6b69072018-11-20 21:42:52 +01006264 /* Double initialization is explicitly allowed. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006265 if( global_data.initialized != 0 )
6266 return( PSA_SUCCESS );
6267
Gilles Peskine30524eb2020-11-13 17:02:26 +01006268 /* Initialize and seed the random generator. */
6269 mbedtls_psa_random_init( &global_data.rng );
Gilles Peskinec6b69072018-11-20 21:42:52 +01006270 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine30524eb2020-11-13 17:02:26 +01006271 status = mbedtls_psa_random_seed( &global_data.rng );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006272 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006273 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006274 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01006275
Gilles Peskine66fb1262018-12-10 16:29:04 +01006276 status = psa_initialize_key_slots( );
6277 if( status != PSA_SUCCESS )
6278 goto exit;
Gilles Peskinec6b69072018-11-20 21:42:52 +01006279
Gilles Peskined9348f22019-10-01 15:22:29 +02006280#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
6281 status = psa_init_all_se_drivers( );
6282 if( status != PSA_SUCCESS )
6283 goto exit;
6284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
6285
Gilles Peskine4b734222019-07-24 15:56:31 +02006286#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskinefc762652019-07-22 19:30:34 +02006287 status = psa_crypto_load_transaction( );
6288 if( status == PSA_SUCCESS )
6289 {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02006290 status = psa_crypto_recover_transaction( &psa_crypto_transaction );
6291 if( status != PSA_SUCCESS )
6292 goto exit;
6293 status = psa_crypto_stop_transaction( );
Gilles Peskinefc762652019-07-22 19:30:34 +02006294 }
6295 else if( status == PSA_ERROR_DOES_NOT_EXIST )
6296 {
6297 /* There's no transaction to complete. It's all good. */
6298 status = PSA_SUCCESS;
6299 }
Gilles Peskine4b734222019-07-24 15:56:31 +02006300#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02006301
Gilles Peskinec6b69072018-11-20 21:42:52 +01006302 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01006303 global_data.initialized = 1;
6304
6305exit:
Gilles Peskine66fb1262018-12-10 16:29:04 +01006306 if( status != PSA_SUCCESS )
Gilles Peskinee59236f2018-01-27 23:32:46 +01006307 mbedtls_psa_crypto_free( );
Gilles Peskine66fb1262018-12-10 16:29:04 +01006308 return( status );
Gilles Peskinee59236f2018-01-27 23:32:46 +01006309}
6310
6311#endif /* MBEDTLS_PSA_CRYPTO_C */